@orq-ai/node 3.6.5 → 3.6.7

package/packages/orq-rc/src/funcs/contactsRetrieve.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Retrieve a contact
+ *
+ * @remarks
+ * Retrieves detailed information about a specific contact using their contact ID or external ID from your system.
+ */
+export function contactsRetrieve(
+  client: OrqCore,
+  request: operations.RetrieveContactRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.RetrieveContactResponseBody,
+    | errors.RetrieveContactResponseBody
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.RetrieveContactRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.RetrieveContactResponseBody,
+      | errors.RetrieveContactResponseBody
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.RetrieveContactRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/contacts/{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 = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "RetrieveContact",
+    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,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.RetrieveContactResponseBody,
+    | errors.RetrieveContactResponseBody
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.RetrieveContactResponseBody$inboundSchema),
+    M.jsonErr(404, errors.RetrieveContactResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/funcs/contactsUpdate.ts

@@ -0,0 +1,172 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+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 * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update a contact
+ *
+ * @remarks
+ * Updates specific fields of an existing contact. Only the fields provided in the request body will be updated.
+ */
+export function contactsUpdate(
+  client: OrqCore,
+  request: operations.UpdateContactRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdateContactResponseBody,
+    | errors.UpdateContactResponseBody
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.UpdateContactRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.UpdateContactResponseBody,
+      | errors.UpdateContactResponseBody
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.UpdateContactRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/contacts/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "UpdateContact",
+    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: "PATCH",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.UpdateContactResponseBody,
+    | errors.UpdateContactResponseBody
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, operations.UpdateContactResponseBody$inboundSchema),
+    M.jsonErr(404, errors.UpdateContactResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/packages/orq-rc/src/lib/config.ts

@@ -68,7 +68,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "3.7.0-rc.8",
-  genVersion: "2.618.0",
-  userAgent: "speakeasy-sdk/typescript 3.7.0-rc.8 2.618.0 2.0 @orq-ai/node",
+  sdkVersion: "3.8.0-rc.1",
+  genVersion: "2.620.2",
+  userAgent: "speakeasy-sdk/typescript 3.8.0-rc.1 2.620.2 2.0 @orq-ai/node",
 } as const;

package/packages/orq-rc/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "3.7.0-rc.8",
+    currentVersion: "3.8.0-rc.1",
   },
 });
 

package/packages/orq-rc/src/mcp-server/server.ts

@@ -14,6 +14,10 @@ import {
 import { MCPScope } from "./scopes.js";
 import { createRegisterTool } from "./tools.js";
 import { tool$contactsCreate } from "./tools/contactsCreate.js";
+import { tool$contactsDelete } from "./tools/contactsDelete.js";
+import { tool$contactsList } from "./tools/contactsList.js";
+import { tool$contactsRetrieve } from "./tools/contactsRetrieve.js";
+import { tool$contactsUpdate } from "./tools/contactsUpdate.js";
 import { tool$datasetsClear } from "./tools/datasetsClear.js";
 import { tool$datasetsCreate } from "./tools/datasetsCreate.js";
 import { tool$datasetsCreateDatapoint } from "./tools/datasetsCreateDatapoint.js";
@@ -110,7 +114,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Orq",
-    version: "3.7.0-rc.8",
+    version: "3.8.0-rc.1",
   });
 
   const client = new OrqCore({
@@ -143,6 +147,10 @@ export function createMCPServer(deps: {
   void register; // suppress unused warnings
 
   tool(tool$contactsCreate);
+  tool(tool$contactsList);
+  tool(tool$contactsRetrieve);
+  tool(tool$contactsUpdate);
+  tool(tool$contactsDelete);
   tool(tool$feedbackCreate);
   tool(tool$deploymentsList);
   tool(tool$deploymentsGetConfig);

package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts

@@ -7,14 +7,14 @@ import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.CreateContactRequestBody$inboundSchema,
+  request: operations.CreateContactRequestBody$inboundSchema.optional(),
 };
 
 export const tool$contactsCreate: ToolDefinition<typeof args> = {
   name: "contacts-create",
-  description: `Update user information
+  description: `Create a contact
 
-Update or add user information to workspace`,
+Creates a new contact or updates an existing one based on external_id. Use this endpoint to add users from your system to orq.ai for tracking their usage and engagement.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await contactsCreate(

package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsDelete } from "../../funcs/contactsDelete.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DeleteContactRequest$inboundSchema,
+};
+
+export const tool$contactsDelete: ToolDefinition<typeof args> = {
+  name: "contacts-delete",
+  description: `Delete a contact
+
+Permanently deletes a contact from your workspace. This action cannot be undone.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await contactsDelete(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

package/packages/orq-rc/src/mcp-server/tools/contactsList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsList } from "../../funcs/contactsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListContactsRequest$inboundSchema.optional(),
+};
+
+export const tool$contactsList: ToolDefinition<typeof args> = {
+  name: "contacts-list",
+  description: `List contacts
+
+Retrieves a paginated list of contacts in your workspace. Use pagination parameters to navigate through large contact lists efficiently.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await contactsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsRetrieve } from "../../funcs/contactsRetrieve.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.RetrieveContactRequest$inboundSchema,
+};
+
+export const tool$contactsRetrieve: ToolDefinition<typeof args> = {
+  name: "contacts-retrieve",
+  description: `Retrieve a contact
+
+Retrieves detailed information about a specific contact using their contact ID or external ID from your system.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await contactsRetrieve(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contactsUpdate } from "../../funcs/contactsUpdate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.UpdateContactRequest$inboundSchema,
+};
+
+export const tool$contactsUpdate: ToolDefinition<typeof args> = {
+  name: "contacts-update",
+  description: `Update a contact
+
+Updates specific fields of an existing contact. Only the fields provided in the request body will be updated.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await contactsUpdate(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/packages/orq-rc/src/models/errors/apierror.ts

@@ -3,22 +3,37 @@
  */
 
 export class APIError extends Error {
+  /**
+   * HTTP status code
+   */
   public readonly statusCode: number;
+  /**
+   * HTTP content type
+   */
   public readonly contentType: string;
+  /**
+   * HTTP body
+   */
+  public readonly body: string;
+  /**
+   * Raw response
+   */
+  public readonly rawResponse: Response;
 
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    rawResponse: Response,
+    body: string = "",
   ) {
     const statusCode = rawResponse.status;
     const contentType = rawResponse.headers.get("content-type") || "";
     const bodyString = body.length > 0 ? `\n${body}` : "";
-
     super(
       `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
     );
 
+    this.body = body;
+    this.rawResponse = rawResponse;
     this.statusCode = statusCode;
     this.contentType = contentType;
 

package/packages/orq-rc/src/models/errors/deletecontact.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Contact not found
+ */
+export type DeleteContactResponseBodyData = {
+  /**
+   * Error message
+   */
+  error: string;
+};
+
+/**
+ * Contact not found
+ */
+export class DeleteContactResponseBody extends Error {
+  /**
+   * Error message
+   */
+  error: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: DeleteContactResponseBodyData;
+
+  constructor(err: DeleteContactResponseBodyData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.error = err.error;
+
+    this.name = "DeleteContactResponseBody";
+  }
+}
+
+/** @internal */
+export const DeleteContactResponseBody$inboundSchema: z.ZodType<
+  DeleteContactResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+})
+  .transform((v) => {
+    return new DeleteContactResponseBody(v);
+  });
+
+/** @internal */
+export type DeleteContactResponseBody$Outbound = {
+  error: string;
+};
+
+/** @internal */
+export const DeleteContactResponseBody$outboundSchema: z.ZodType<
+  DeleteContactResponseBody$Outbound,
+  z.ZodTypeDef,
+  DeleteContactResponseBody
+> = z.instanceof(DeleteContactResponseBody)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: 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 DeleteContactResponseBody$ {
+  /** @deprecated use `DeleteContactResponseBody$inboundSchema` instead. */
+  export const inboundSchema = DeleteContactResponseBody$inboundSchema;
+  /** @deprecated use `DeleteContactResponseBody$outboundSchema` instead. */
+  export const outboundSchema = DeleteContactResponseBody$outboundSchema;
+  /** @deprecated use `DeleteContactResponseBody$Outbound` instead. */
+  export type Outbound = DeleteContactResponseBody$Outbound;
+}