@orq-ai/node 3.0.1 → 3.1.0-rc.26

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

@@ -24,11 +24,11 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Duplicate a prompt
+ * Delete a prompt snippet
  */
-export async function promptsDuplicate(
+export async function promptSnippetsDelete(
   client: OrqCore,
-  request: operations.DuplicatePromptRequest,
+  request: operations.DeletePromptSnippetRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
@@ -44,7 +44,8 @@ export async function promptsDuplicate(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.DuplicatePromptRequest$outboundSchema.parse(value),
+    (value) =>
+      operations.DeletePromptSnippetRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -60,10 +61,14 @@ export async function promptsDuplicate(
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/{id}/duplicate")(pathParams);
+  const path = pathToFunc("/v2/resources/prompts/snippets/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "*/*",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -71,7 +76,7 @@ export async function promptsDuplicate(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "DuplicatePrompt",
+    operationID: "DeletePromptSnippet",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -85,7 +90,7 @@ export async function promptsDuplicate(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "GET",
+    method: "DELETE",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -119,7 +124,8 @@ export async function promptsDuplicate(
     | ConnectionError
   >(
     M.nil(200, z.void()),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
     return result;

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

@@ -23,9 +23,9 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get one prompt snippet
+ * Retrieve a prompt snippet
  */
-export async function promptSnippetsFindOne(
+export async function promptSnippetsGet(
   client: OrqCore,
   request: operations.FindOnePromptSnippetRequest,
   options?: RequestOptions,
@@ -54,16 +54,20 @@ export async function promptSnippetsFindOne(
   const body = null;
 
   const pathParams = {
-    key: encodeSimple("key", payload.key, {
+    id: encodeSimple("id", payload.id, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/snippets/{key}")(pathParams);
+  const path = pathToFunc("/v2/resources/prompts/snippets/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -119,7 +123,8 @@ export async function promptSnippetsFindOne(
     | ConnectionError
   >(
     M.json(200, operations.FindOnePromptSnippetResponseBody$inboundSchema),
-    M.fail([400, 404, "4XX", "5XX"]),
+    M.fail([400, 404, "4XX"]),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
     return result;

package/{packages/orq-rc/src/funcs/promptSnippetsFindOne.ts → src/funcs/promptSnippetsGetByKey.ts}

@@ -5,6 +5,7 @@
 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";
@@ -22,15 +23,15 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get one prompt snippet
+ * Retrieve a prompt snippet by key
  */
-export async function promptSnippetsFindOne(
+export async function promptSnippetsGetByKey(
   client: OrqCore,
-  request: operations.FindOnePromptSnippetRequest,
+  request: operations.FindOneByKeyPromptSnippetRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.FindOnePromptSnippetResponseBody,
+    operations.FindOneByKeyPromptSnippetResponseBody,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -43,7 +44,7 @@ export async function promptSnippetsFindOne(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.FindOnePromptSnippetRequest$outboundSchema.parse(value),
+      operations.FindOneByKeyPromptSnippetRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -59,18 +60,24 @@ export async function promptSnippetsFindOne(
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/snippets/{key}")(pathParams);
+  const path = pathToFunc("/v2/resources/prompts/snippets/key/{key}")(
+    pathParams,
+  );
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     Accept: "application/json",
-  });
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
+  }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
   const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "FindOnePromptSnippet",
+    operationID: "FindOneByKeyPromptSnippet",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -108,7 +115,7 @@ export async function promptSnippetsFindOne(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.FindOnePromptSnippetResponseBody,
+    operations.FindOneByKeyPromptSnippetResponseBody,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -117,8 +124,9 @@ export async function promptSnippetsFindOne(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.FindOnePromptSnippetResponseBody$inboundSchema),
-    M.fail([400, 404, "4XX", "5XX"]),
+    M.json(200, operations.FindOneByKeyPromptSnippetResponseBody$inboundSchema),
+    M.fail([400, 404, "4XX"]),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
     return result;

package/{packages/orq-rc/src/funcs/promptsUpdate.ts → src/funcs/promptSnippetsUpdate.ts}

@@ -5,6 +5,7 @@
 import { OrqCore } from "../core.js";
 import { encodeJSON, 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";
@@ -23,16 +24,16 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update a prompt
+ * Update a prompt snippet
  */
-export async function promptsUpdate(
+export async function promptSnippetsUpdate(
   client: OrqCore,
-  request: operations.UpdatePromptRequest,
+  request: operations.UpdatePromptSnippetRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.UpdatePromptResponseBody,
-    | errors.UpdatePromptResponseBody
+    operations.UpdatePromptSnippetResponseBody,
+    | errors.UpdatePromptSnippetResponseBody
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -44,7 +45,8 @@ export async function promptsUpdate(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.UpdatePromptRequest$outboundSchema.parse(value),
+    (value) =>
+      operations.UpdatePromptSnippetRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -60,19 +62,23 @@ export async function promptsUpdate(
     }),
   };
 
-  const path = pathToFunc("/v2/resources/prompts/{id}")(pathParams);
+  const path = pathToFunc("/v2/resources/prompts/snippets/{id}")(pathParams);
 
-  const headers = new Headers({
+  const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
-  });
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
+  }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
   const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "UpdatePrompt",
+    operationID: "UpdatePromptSnippet",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -114,8 +120,8 @@ export async function promptsUpdate(
   };
 
   const [result] = await M.match<
-    operations.UpdatePromptResponseBody,
-    | errors.UpdatePromptResponseBody
+    operations.UpdatePromptSnippetResponseBody,
+    | errors.UpdatePromptSnippetResponseBody
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -124,9 +130,10 @@ export async function promptsUpdate(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.UpdatePromptResponseBody$inboundSchema),
-    M.jsonErr(404, errors.UpdatePromptResponseBody$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.json(200, operations.UpdatePromptSnippetResponseBody$inboundSchema),
+    M.jsonErr(404, errors.UpdatePromptSnippetResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
     return result;

package/src/funcs/promptsCreate.ts

@@ -3,7 +3,7 @@
  */
 
 import { OrqCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -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,11 +55,15 @@ 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",
     Accept: "application/json",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -115,7 +119,8 @@ export async function promptsCreate(
     | ConnectionError
   >(
     M.json(200, operations.CreatePromptResponseBody$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
     return result;

package/src/funcs/promptsDelete.ts

@@ -60,10 +60,14 @@ 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: "*/*",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -119,7 +123,8 @@ export async function promptsDelete(
     | ConnectionError
   >(
     M.nil(200, z.void()),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
     return result;

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

@@ -24,9 +24,9 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get one prompt
+ * Retrieve a prompt
  */
-export async function promptsGetOne(
+export async function promptsGet(
   client: OrqCore,
   request: operations.GetOnePromptRequest,
   options?: RequestOptions,
@@ -60,10 +60,14 @@ 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: "*/*",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -119,7 +123,8 @@ export async function promptsGetOne(
     | ConnectionError
   >(
     M.nil(200, z.void()),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   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, encodeSimple } 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,11 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get all prompts
+ * List all prompts
  */
-export async function promptsGetAll(
+export async function promptsList(
   client: OrqCore,
-  request?: operations.GetAllPromptsRequestBody | undefined,
+  request?: operations.GetAllPromptsRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   Result<
@@ -44,24 +44,29 @@ 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",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -83,10 +88,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);
@@ -117,7 +123,8 @@ export async function promptsGetAll(
     | ConnectionError
   >(
     M.json(200, operations.GetAllPromptsResponseBody$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response);
   if (!result.ok) {
     return result;

package/src/funcs/promptsUpdate.ts

@@ -61,11 +61,15 @@ 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",
     Accept: "application/json",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -127,7 +131,8 @@ export async function promptsUpdate(
   >(
     M.json(200, operations.UpdatePromptResponseBody$inboundSchema),
     M.jsonErr(404, errors.UpdatePromptResponseBody$inboundSchema),
-    M.fail(["4XX", "5XX"]),
+    M.fail("4XX"),
+    M.fail("5XX"),
   )(response, { extraFields: responseFields });
   if (!result.ok) {
     return result;

package/src/funcs/remoteconfigGetConfig.ts

@@ -3,7 +3,7 @@
  */
 
 import { OrqCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -61,6 +61,10 @@ export async function remoteconfigGetConfig(
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
     Accept: "application/json",
+    "contactId": encodeSimple("contactId", client._options.contactId, {
+      explode: false,
+      charEncoding: "none",
+    }),
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -116,7 +120,8 @@ export async function remoteconfigGetConfig(
     | ConnectionError
   >(
     M.json(200, operations.RemoteConfigsGetConfigResponseBody$inboundSchema),
-    M.fail([400, 401, 404, "4XX", 500, "5XX"]),
+    M.fail([400, 401, 404, "4XX"]),
+    M.fail([500, "5XX"]),
   )(response);
   if (!result.ok) {
     return result;

package/src/hooks/global.ts

@@ -0,0 +1,38 @@
+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 ('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.0.1",
-  genVersion: "2.493.15",
-  userAgent: "speakeasy-sdk/typescript 3.0.1 2.493.15 2.0 @orq-ai/node",
+  sdkVersion: "3.1.0-rc.26",
+  genVersion: "2.499.1",
+  userAgent: "speakeasy-sdk/typescript 3.1.0-rc.26 2.499.1 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;
+}