@linqapp/sdk 0.1.0 → 0.1.3

package/src/client.ts

@@ -21,34 +21,54 @@ import {
   AttachmentCreateResponse,
   AttachmentRetrieveResponse,
   Attachments,
+  SupportedContentType,
 } from './resources/attachments';
 import {
+  Capability,
+  CapabilityCheckImessageParams,
+  CapabilityCheckImessageResponse,
+  CapabilityCheckRcsParams,
+  CapabilityCheckRcsResponse,
+} from './resources/capability';
+import {
+  ChatHandle,
+  MediaPart,
+  Message,
   MessageAddReactionParams,
-  MessageAddReactionResponse,
   MessageDeleteParams,
-  MessageRetrieveResponse,
+  MessageEffect,
   MessageRetrieveThreadParams,
   MessageRetrieveThreadResponse,
   Messages,
+  Reaction,
+  ReactionType,
+  ReplyTo,
+  TextPart,
 } from './resources/messages';
+import { PhoneNumberListResponse, PhoneNumbers } from './resources/phone-numbers';
+import { PhonenumberListResponse, Phonenumbers } from './resources/phonenumbers';
+import { WebhookEventListResponse, WebhookEventType, WebhookEvents } from './resources/webhook-events';
 import {
-  PhoneNumberListDeprecatedResponse,
-  PhoneNumberListResponse,
-  PhoneNumbers,
-} from './resources/phone-numbers';
+  WebhookSubscription,
+  WebhookSubscriptionCreateParams,
+  WebhookSubscriptionCreateResponse,
+  WebhookSubscriptionListResponse,
+  WebhookSubscriptionUpdateParams,
+  WebhookSubscriptions,
+} from './resources/webhook-subscriptions';
 import {
+  Chat,
   ChatCreateParams,
   ChatCreateResponse,
   ChatListParams,
   ChatListResponse,
-  ChatRetrieveResponse,
   ChatSendVoicememoParams,
   ChatSendVoicememoResponse,
   ChatUpdateParams,
-  ChatUpdateResponse,
   Chats,
+  MessageContent,
+  ServiceType,
 } from './resources/chats/chats';
-import { Webhooks } from './resources/webhooks/webhooks';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -64,14 +84,17 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['LINQ_API_KEY'].
+   * Bearer token authentication. Include your API token in the Authorization header.
+   *
+   * Format: `Authorization: Bearer <your-token>`
+   *
    */
   apiKey?: string | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
-   * Defaults to process.env['LINQ_BASE_URL'].
+   * Defaults to process.env['LINQ_API_V3_BASE_URL'].
    */
   baseURL?: string | null | undefined;
 
@@ -125,7 +148,7 @@ export interface ClientOptions {
   /**
    * Set the log level.
    *
-   * Defaults to process.env['LINQ_LOG'] or 'warn' if it isn't set.
+   * Defaults to process.env['LINQ_API_V3_LOG'] or 'warn' if it isn't set.
    */
   logLevel?: LogLevel | undefined;
 
@@ -138,9 +161,9 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Linq API.
+ * API Client for interfacing with the Linq API V3 API.
  */
-export class Linq {
+export class LinqAPIV3 {
   apiKey: string;
 
   baseURL: string;
@@ -156,10 +179,10 @@ export class Linq {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Linq API.
+   * API Client for interfacing with the Linq API V3 API.
    *
-   * @param {string | undefined} [opts.apiKey=process.env['LINQ_API_KEY'] ?? undefined]
-   * @param {string} [opts.baseURL=process.env['LINQ_BASE_URL'] ?? https://api.linqapp.com/api/partner] - Override the default base URL for the API.
+   * @param {string | undefined} [opts.apiKey=process.env['LINQ_API_V3_API_KEY'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['LINQ_API_V3_BASE_URL'] ?? https://api.linqapp.com/api/partner] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -168,13 +191,13 @@ export class Linq {
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
   constructor({
-    baseURL = readEnv('LINQ_BASE_URL'),
-    apiKey = readEnv('LINQ_API_KEY'),
+    baseURL = readEnv('LINQ_API_V3_BASE_URL'),
+    apiKey = readEnv('LINQ_API_V3_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Errors.LinqError(
-        "The LINQ_API_KEY environment variable is missing or empty; either provide it, or instantiate the Linq client with an apiKey option, like new Linq({ apiKey: 'My API Key' }).",
+      throw new Errors.LinqAPIV3Error(
+        "The LINQ_API_V3_API_KEY environment variable is missing or empty; either provide it, or instantiate the LinqAPIV3 client with an apiKey option, like new LinqAPIV3({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -185,14 +208,14 @@ export class Linq {
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? Linq.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? LinqAPIV3.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
     // Set default logLevel early so that we can log a warning in parseLogLevel.
     this.logLevel = defaultLogLevel;
     this.logLevel =
       parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
-      parseLogLevel(readEnv('LINQ_LOG'), "process.env['LINQ_LOG']", this) ??
+      parseLogLevel(readEnv('LINQ_API_V3_LOG'), "process.env['LINQ_API_V3_LOG']", this) ??
       defaultLogLevel;
     this.fetchOptions = options.fetchOptions;
     this.maxRetries = options.maxRetries ?? 2;
@@ -255,7 +278,7 @@ export class Linq {
         if (value === null) {
           return `${encodeURIComponent(key)}=`;
         }
-        throw new Errors.LinqError(
+        throw new Errors.LinqAPIV3Error(
           `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
         );
       })
@@ -742,10 +765,10 @@ export class Linq {
     }
   }
 
-  static Linq = this;
+  static LinqAPIV3 = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static LinqError = Errors.LinqError;
+  static LinqAPIV3Error = Errors.LinqAPIV3Error;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -764,24 +787,31 @@ export class Linq {
   chats: API.Chats = new API.Chats(this);
   messages: API.Messages = new API.Messages(this);
   attachments: API.Attachments = new API.Attachments(this);
+  phonenumbers: API.Phonenumbers = new API.Phonenumbers(this);
   phoneNumbers: API.PhoneNumbers = new API.PhoneNumbers(this);
-  webhooks: API.Webhooks = new API.Webhooks(this);
+  webhookEvents: API.WebhookEvents = new API.WebhookEvents(this);
+  webhookSubscriptions: API.WebhookSubscriptions = new API.WebhookSubscriptions(this);
+  capability: API.Capability = new API.Capability(this);
 }
 
-Linq.Chats = Chats;
-Linq.Messages = Messages;
-Linq.Attachments = Attachments;
-Linq.PhoneNumbers = PhoneNumbers;
-Linq.Webhooks = Webhooks;
+LinqAPIV3.Chats = Chats;
+LinqAPIV3.Messages = Messages;
+LinqAPIV3.Attachments = Attachments;
+LinqAPIV3.Phonenumbers = Phonenumbers;
+LinqAPIV3.PhoneNumbers = PhoneNumbers;
+LinqAPIV3.WebhookEvents = WebhookEvents;
+LinqAPIV3.WebhookSubscriptions = WebhookSubscriptions;
+LinqAPIV3.Capability = Capability;
 
-export declare namespace Linq {
+export declare namespace LinqAPIV3 {
   export type RequestOptions = Opts.RequestOptions;
 
   export {
     Chats as Chats,
+    type Chat as Chat,
+    type MessageContent as MessageContent,
+    type ServiceType as ServiceType,
     type ChatCreateResponse as ChatCreateResponse,
-    type ChatRetrieveResponse as ChatRetrieveResponse,
-    type ChatUpdateResponse as ChatUpdateResponse,
     type ChatListResponse as ChatListResponse,
     type ChatSendVoicememoResponse as ChatSendVoicememoResponse,
     type ChatCreateParams as ChatCreateParams,
@@ -792,8 +822,14 @@ export declare namespace Linq {
 
   export {
     Messages as Messages,
-    type MessageRetrieveResponse as MessageRetrieveResponse,
-    type MessageAddReactionResponse as MessageAddReactionResponse,
+    type ChatHandle as ChatHandle,
+    type MediaPart as MediaPart,
+    type Message as Message,
+    type MessageEffect as MessageEffect,
+    type Reaction as Reaction,
+    type ReactionType as ReactionType,
+    type ReplyTo as ReplyTo,
+    type TextPart as TextPart,
     type MessageRetrieveThreadResponse as MessageRetrieveThreadResponse,
     type MessageDeleteParams as MessageDeleteParams,
     type MessageAddReactionParams as MessageAddReactionParams,
@@ -802,16 +838,36 @@ export declare namespace Linq {
 
   export {
     Attachments as Attachments,
+    type SupportedContentType as SupportedContentType,
     type AttachmentCreateResponse as AttachmentCreateResponse,
     type AttachmentRetrieveResponse as AttachmentRetrieveResponse,
     type AttachmentCreateParams as AttachmentCreateParams,
   };
 
+  export { Phonenumbers as Phonenumbers, type PhonenumberListResponse as PhonenumberListResponse };
+
+  export { PhoneNumbers as PhoneNumbers, type PhoneNumberListResponse as PhoneNumberListResponse };
+
+  export {
+    WebhookEvents as WebhookEvents,
+    type WebhookEventType as WebhookEventType,
+    type WebhookEventListResponse as WebhookEventListResponse,
+  };
+
   export {
-    PhoneNumbers as PhoneNumbers,
-    type PhoneNumberListResponse as PhoneNumberListResponse,
-    type PhoneNumberListDeprecatedResponse as PhoneNumberListDeprecatedResponse,
+    WebhookSubscriptions as WebhookSubscriptions,
+    type WebhookSubscription as WebhookSubscription,
+    type WebhookSubscriptionCreateResponse as WebhookSubscriptionCreateResponse,
+    type WebhookSubscriptionListResponse as WebhookSubscriptionListResponse,
+    type WebhookSubscriptionCreateParams as WebhookSubscriptionCreateParams,
+    type WebhookSubscriptionUpdateParams as WebhookSubscriptionUpdateParams,
   };
 
-  export { Webhooks as Webhooks };
+  export {
+    Capability as Capability,
+    type CapabilityCheckImessageResponse as CapabilityCheckImessageResponse,
+    type CapabilityCheckRcsResponse as CapabilityCheckRcsResponse,
+    type CapabilityCheckImessageParams as CapabilityCheckImessageParams,
+    type CapabilityCheckRcsParams as CapabilityCheckRcsParams,
+  };
 }

package/src/core/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type Linq } from '../client';
+import { type LinqAPIV3 } from '../client';
 
 import { type PromiseOrValue } from '../internal/types';
 import { APIResponseProps, defaultParseResponse } from '../internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from '../internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: Linq;
+  #client: LinqAPIV3;
 
   constructor(
-    client: Linq,
+    client: LinqAPIV3,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: Linq,
+      client: LinqAPIV3,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

package/src/core/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from '../internal/errors';
 
-export class LinqError extends Error {}
+export class LinqAPIV3Error extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends LinqError {
+> extends LinqAPIV3Error {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

package/src/core/resource.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import type { Linq } from '../client';
+import type { LinqAPIV3 } from '../client';
 
 export abstract class APIResource {
-  protected _client: Linq;
+  protected _client: LinqAPIV3;
 
-  constructor(client: Linq) {
+  constructor(client: LinqAPIV3) {
     this._client = client;
   }
 }

package/src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Linq as default } from './client';
+export { LinqAPIV3 as default } from './client';
 
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
-export { Linq, type ClientOptions } from './client';
+export { LinqAPIV3, type ClientOptions } from './client';
 export {
-  LinqError,
+  LinqAPIV3Error,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type Linq } from '../client';
+import { type LinqAPIV3 } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
 export type APIResponseProps = {
@@ -13,7 +13,7 @@ export type APIResponseProps = {
   startTime: number;
 };
 
-export async function defaultParseResponse<T>(client: Linq, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: LinqAPIV3, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
     // fetch refuses to read the body when the status code is 204.

package/src/internal/shims.ts

@@ -16,7 +16,7 @@ export function getDefaultFetch(): Fetch {
   }
 
   throw new Error(
-    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new Linq({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
+    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new LinqAPIV3({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
   );
 }
 

package/src/internal/uploads.ts

@@ -1,6 +1,6 @@
 import { type RequestOptions } from './request-options';
 import type { FilePropertyBag, Fetch } from './builtin-types';
-import type { Linq } from '../client';
+import type { LinqAPIV3 } from '../client';
 import { ReadableStreamFrom } from './shims';
 
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
@@ -74,7 +74,7 @@ export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
  */
 export const maybeMultipartFormRequestOptions = async (
   opts: RequestOptions,
-  fetch: Linq | Fetch,
+  fetch: LinqAPIV3 | Fetch,
 ): Promise<RequestOptions> => {
   if (!hasUploadableValue(opts.body)) return opts;
 
@@ -85,7 +85,7 @@ type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknow
 
 export const multipartFormRequestOptions = async (
   opts: MultipartFormRequestOptions,
-  fetch: Linq | Fetch,
+  fetch: LinqAPIV3 | Fetch,
 ): Promise<RequestOptions> => {
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
@@ -98,7 +98,7 @@ const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>
  * This function detects if the fetch function provided supports the global FormData object to avoid
  * confusing error messages later on.
  */
-function supportsFormData(fetchObject: Linq | Fetch): Promise<boolean> {
+function supportsFormData(fetchObject: LinqAPIV3 | Fetch): Promise<boolean> {
   const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
   const cached = supportsFormDataMap.get(fetch);
   if (cached) return cached;
@@ -124,7 +124,7 @@ function supportsFormData(fetchObject: Linq | Fetch): Promise<boolean> {
 
 export const createForm = async <T = Record<string, unknown>>(
   body: T | undefined,
-  fetch: Linq | Fetch,
+  fetch: LinqAPIV3 | Fetch,
 ): Promise<FormData> => {
   if (!(await supportsFormData(fetch))) {
     throw new TypeError(

package/src/internal/utils/base64.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { LinqError } from '../../core/error';
+import { LinqAPIV3Error } from '../../core/error';
 import { encodeUTF8 } from './bytes';
 
 export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
@@ -18,7 +18,7 @@ export const toBase64 = (data: string | Uint8Array | null | undefined): string =
     return btoa(String.fromCharCode.apply(null, data as any));
   }
 
-  throw new LinqError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
+  throw new LinqAPIV3Error('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
 };
 
 export const fromBase64 = (str: string): Uint8Array => {
@@ -36,5 +36,5 @@ export const fromBase64 = (str: string): Uint8Array => {
     return buf;
   }
 
-  throw new LinqError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
+  throw new LinqAPIV3Error('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
 };

package/src/internal/utils/log.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { hasOwn } from './values';
-import { type Linq } from '../../client';
+import { type LinqAPIV3 } from '../../client';
 import { RequestOptions } from '../request-options';
 
 type LogFn = (message: string, ...rest: unknown[]) => void;
@@ -24,7 +24,7 @@ const levelNumbers = {
 export const parseLogLevel = (
   maybeLevel: string | undefined,
   sourceName: string,
-  client: Linq,
+  client: LinqAPIV3,
 ): LogLevel | undefined => {
   if (!maybeLevel) {
     return undefined;
@@ -60,7 +60,7 @@ const noopLogger = {
 
 let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
-export function loggerFor(client: Linq): Logger {
+export function loggerFor(client: LinqAPIV3): Logger {
   const logger = client.logger;
   const logLevel = client.logLevel ?? 'off';
   if (!logger) {

package/src/internal/utils/path.ts

@@ -1,4 +1,4 @@
-import { LinqError } from '../../core/error';
+import { LinqAPIV3Error } from '../../core/error';
 
 /**
  * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
@@ -72,7 +72,7 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new LinqError(
+      throw new LinqAPIV3Error(
         `Path parameters result in path with invalid segments:\n${invalidSegments
           .map((e) => e.error)
           .join('\n')}\n${path}\n${underline}`,

package/src/internal/utils/values.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { LinqError } from '../../core/error';
+import { LinqAPIV3Error } from '../../core/error';
 
 // https://url.spec.whatwg.org/#url-scheme-string
 const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
@@ -39,7 +39,7 @@ export function isObj(obj: unknown): obj is Record<string, unknown> {
 
 export const ensurePresent = <T>(value: T | null | undefined): T => {
   if (value == null) {
-    throw new LinqError(`Expected a value to be given but received ${value} instead.`);
+    throw new LinqAPIV3Error(`Expected a value to be given but received ${value} instead.`);
   }
 
   return value;
@@ -47,10 +47,10 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 
 export const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new LinqError(`${name} must be an integer`);
+    throw new LinqAPIV3Error(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new LinqError(`${name} must be a positive integer`);
+    throw new LinqAPIV3Error(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -59,14 +59,14 @@ export const coerceInteger = (value: unknown): number => {
   if (typeof value === 'number') return Math.round(value);
   if (typeof value === 'string') return parseInt(value, 10);
 
-  throw new LinqError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new LinqAPIV3Error(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceFloat = (value: unknown): number => {
   if (typeof value === 'number') return value;
   if (typeof value === 'string') return parseFloat(value);
 
-  throw new LinqError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new LinqAPIV3Error(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {