@orq-ai/node 4.2.0 → 4.2.4

package/packages/orq-rc/src/models/operations/updatecontact.ts

@@ -1,188 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * Contact fields to update
- */
-export type UpdateContactRequestBody = {
-  /**
-   * Display name or nickname of the contact user. This is typically shown in user interfaces.
-   */
-  displayName?: string | null | undefined;
-  /**
-   * Email address of the contact user
-   */
-  email?: string | null | undefined;
-  /**
-   * URL linking to the contact user's avatar image
-   */
-  avatarUrl?: string | null | undefined;
-  /**
-   * Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
-   */
-  tags?: Array<string> | undefined;
-  /**
-   * Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
-   */
-  metadata?: { [k: string]: any } | undefined;
-};
-
-export type UpdateContactRequest = {
-  /**
-   * Unique contact id or external id
-   */
-  id: string;
-  /**
-   * Contact fields to update
-   */
-  requestBody?: UpdateContactRequestBody | undefined;
-};
-
-/**
- * Updated contact
- */
-export type UpdateContactResponseBody = {
-  /**
-   * Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
-   */
-  id: string;
-  /**
-   * Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.
-   */
-  externalId: string;
-  /**
-   * Display name or nickname of the contact user. This is typically shown in user interfaces.
-   */
-  displayName?: string | null | undefined;
-  /**
-   * Email address of the contact user
-   */
-  email?: string | null | undefined;
-  /**
-   * URL linking to the contact user's avatar image
-   */
-  avatarUrl?: string | null | undefined;
-  /**
-   * Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
-   */
-  tags?: Array<string> | undefined;
-  /**
-   * Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
-   */
-  metadata?: { [k: string]: any } | undefined;
-  /**
-   * The date and time the resource was created
-   */
-  created?: Date | undefined;
-  /**
-   * The date and time the resource was last updated
-   */
-  updated: Date;
-};
-
-/** @internal */
-export type UpdateContactRequestBody$Outbound = {
-  display_name?: string | null | undefined;
-  email?: string | null | undefined;
-  avatar_url?: string | null | undefined;
-  tags?: Array<string> | undefined;
-  metadata?: { [k: string]: any } | undefined;
-};
-
-/** @internal */
-export const UpdateContactRequestBody$outboundSchema: z.ZodType<
-  UpdateContactRequestBody$Outbound,
-  z.ZodTypeDef,
-  UpdateContactRequestBody
-> = z.object({
-  displayName: z.nullable(z.string()).optional(),
-  email: z.nullable(z.string()).optional(),
-  avatarUrl: z.nullable(z.string()).optional(),
-  tags: z.array(z.string()).optional(),
-  metadata: z.record(z.any()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    displayName: "display_name",
-    avatarUrl: "avatar_url",
-  });
-});
-
-export function updateContactRequestBodyToJSON(
-  updateContactRequestBody: UpdateContactRequestBody,
-): string {
-  return JSON.stringify(
-    UpdateContactRequestBody$outboundSchema.parse(updateContactRequestBody),
-  );
-}
-
-/** @internal */
-export type UpdateContactRequest$Outbound = {
-  id: string;
-  RequestBody?: UpdateContactRequestBody$Outbound | undefined;
-};
-
-/** @internal */
-export const UpdateContactRequest$outboundSchema: z.ZodType<
-  UpdateContactRequest$Outbound,
-  z.ZodTypeDef,
-  UpdateContactRequest
-> = z.object({
-  id: z.string(),
-  requestBody: z.lazy(() => UpdateContactRequestBody$outboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    requestBody: "RequestBody",
-  });
-});
-
-export function updateContactRequestToJSON(
-  updateContactRequest: UpdateContactRequest,
-): string {
-  return JSON.stringify(
-    UpdateContactRequest$outboundSchema.parse(updateContactRequest),
-  );
-}
-
-/** @internal */
-export const UpdateContactResponseBody$inboundSchema: z.ZodType<
-  UpdateContactResponseBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  _id: z.string(),
-  external_id: z.string(),
-  display_name: z.nullable(z.string()).optional(),
-  email: z.nullable(z.string()).optional(),
-  avatar_url: z.nullable(z.string()).optional(),
-  tags: z.array(z.string()).optional(),
-  metadata: z.record(z.any()).optional(),
-  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  updated: z.string().datetime({ offset: true }).default(
-    "2026-01-23T09:49:01.865Z",
-  ).transform(v => new Date(v)),
-}).transform((v) => {
-  return remap$(v, {
-    "_id": "id",
-    "external_id": "externalId",
-    "display_name": "displayName",
-    "avatar_url": "avatarUrl",
-  });
-});
-
-export function updateContactResponseBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<UpdateContactResponseBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => UpdateContactResponseBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UpdateContactResponseBody' from JSON`,
-  );
-}

package/src/funcs/contactsDelete.ts

@@ -1,178 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-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 {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { OrqError } from "../models/errors/orqerror.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.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";
-
-/**
- * Delete a contact
- *
- * @remarks
- * Permanently deletes a contact from your workspace and cleans up associated budget configurations. This action cannot be undone.
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export function contactsDelete(
-  client: OrqCore,
-  request: operations.DeleteContactRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    void,
-    | errors.DeleteContactResponseBody
-    | OrqError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: OrqCore,
-  request: operations.DeleteContactRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      void,
-      | errors.DeleteContactResponseBody
-      | OrqError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) => operations.DeleteContactRequest$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: "DeleteContact",
-    oAuth2Scopes: null,
-
-    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: "DELETE",
-    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<
-    void,
-    | errors.DeleteContactResponseBody
-    | OrqError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.nil(204, z.void()),
-    M.jsonErr(404, errors.DeleteContactResponseBody$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-  )(response, req, { extraFields: responseFields });
-  if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
-  }
-
-  return [result, { status: "complete", request: req, response }];
-}

package/src/funcs/contactsList.ts

@@ -1,172 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { OrqCore } from "../core.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";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import { OrqError } from "../models/errors/orqerror.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.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";
-
-/**
- * List contacts
- *
- * @remarks
- * Retrieves a paginated list of contacts in your workspace. Use pagination parameters to navigate through large contact lists efficiently.
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export function contactsList(
-  client: OrqCore,
-  request?: operations.ListContactsRequest | undefined,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListContactsResponseBody,
-    | OrqError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: OrqCore,
-  request?: operations.ListContactsRequest | undefined,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      operations.ListContactsResponseBody,
-      | OrqError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.ListContactsRequest$outboundSchema.optional().parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const path = pathToFunc("/v2/contacts")();
-
-  const query = encodeFormQuery({
-    "ending_before": payload?.ending_before,
-    "filter_by": payload?.filter_by,
-    "include_metrics": payload?.include_metrics,
-    "limit": payload?.limit,
-    "search": payload?.search,
-    "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 = {
-    options: client._options,
-    baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "ListContacts",
-    oAuth2Scopes: null,
-
-    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,
-    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: ["4XX", "5XX"],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req }];
-  }
-  const response = doResult.value;
-
-  const [result] = await M.match<
-    operations.ListContactsResponseBody,
-    | OrqError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, operations.ListContactsResponseBody$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-  )(response, req);
-  if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
-  }
-
-  return [result, { status: "complete", request: req, response }];
-}

package/src/funcs/contactsRetrieve.ts

@@ -1,177 +0,0 @@
-/*
- * 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 {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { OrqError } from "../models/errors/orqerror.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.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.
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export function contactsRetrieve(
-  client: OrqCore,
-  request: operations.RetrieveContactRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.RetrieveContactResponseBody,
-    | errors.RetrieveContactResponseBody
-    | OrqError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: OrqCore,
-  request: operations.RetrieveContactRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      operations.RetrieveContactResponseBody,
-      | errors.RetrieveContactResponseBody
-      | OrqError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    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: null,
-
-    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
-    | OrqError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, operations.RetrieveContactResponseBody$inboundSchema),
-    M.jsonErr(404, errors.RetrieveContactResponseBody$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-  )(response, req, { extraFields: responseFields });
-  if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
-  }
-
-  return [result, { status: "complete", request: req, response }];
-}