@relaymessenger/sdk 0.2.0 → 0.3.0-staging.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Companion Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSES/Apache-2.0.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Linq API V3
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+@relaymessenger/sdk preserves selected resource organization and method names from
+@linqapp/sdk 0.49.1, developed by Linq and distributed under the Apache License
+2.0. The Apache license text is included in LICENSES/Apache-2.0.txt.
+
+Relay's implementation, API host, v1 paths, types, and supported product
+surface are independent. Linq does not sponsor or endorse this package.

package/README.md

@@ -1,28 +1,200 @@
 # `@relaymessenger/sdk`
 
-Shared Relay transport for native plugins and runnable examples.
+TypeScript client for Relay v1.
 
-Raw HTTPS against `https://api.relayapp.im` remains the public contract. This
-package is a thin TypeScript binding used by host plugins: Agent Token auth,
-Standard Webhooks verification, durable long-poll cursors, event dedupe, and
-idempotent `POST /v1/messages`.
+```ts
+import Relay from "@relaymessenger/sdk";
+
+const relay = new Relay({ apiKey: process.env.RELAY_AGENT_TOKEN! });
+
+const chats = await relay.chats.listChats();
+console.log(chats.chats);
+console.log(chats.hasNextPage());
+for await (const chat of chats) {
+  console.log(chat.id);
+}
+```
+
+Chat pages expose `.chats`, message pages expose `.messages`, and both expose `.hasNextPage()` and
+`.getNextPage()`. `.data` remains an alias for generic consumers.
+
+## Send
+
+```ts
+await relay.chats.messages.send(chatId, {
+  message: {
+    parts: [{ type: "text", value: "Hello" }],
+    idempotency_key: crypto.randomUUID(),
+  },
+});
+```
+
+## Share your Contact Card
+
+```ts
+await relay.chats.shareContactCard(chatId);
+```
+
+This shares the authenticated agent's configured Contact Card in an existing
+Chat.
+
+## Request a Contact
+
+An agent with a Premium Handle can send an Add request to a user who has not
+added it:
+
+```ts
+const request = await relay.contactRequests.create({
+  handle: "advait",
+  "Idempotency-Key": crypto.randomUUID(),
+});
+
+console.log(request.state); // "pending"
+```
+
+An agent without a Premium Handle receives `RelayAPIError` with
+`status === 402`. Sending Messages to users who already added the agent
+remains ordinary messaging.
+
+Available resource methods:
+
+- `chats.create`, `retrieve`, `update`, `listChats`, `leaveChat`, `markAsRead`,
+  `shareContactCard`, `startTyping`, `stopTyping`
+- `chats.messages.list`, `chats.messages.send`
+- `chats.participants.add`, `chats.participants.remove`
+- `chats.sendVoicememo`
+- `messages.create`, `retrieve`, `addReaction`, `listMessagesThread`
+- `attachments.create`, `retrieve`, `delete`
+- `webhookEvents.list`
+- `webhookSubscriptions.create`, `retrieve`, `update`, `list`, `delete`
+- `contactCard.create`, `retrieve`, `update`
+- `contactRequests.create`
+- `blockedHandles.list`, `block`, `unblock`
+- `websocket.run`
+
+Every retrieved `Message` may include `deliveries`, one entry per recipient:
+
+```ts
+for (const delivery of message.deliveries ?? []) {
+  console.log(
+    delivery.contact.handle,
+    delivery.delivered_at,
+    delivery.read_at,
+  );
+}
+```
+
+Relay records this per-recipient truth for direct and group Chats.
+
+## Typing
 
 ```ts
-import { createRelayClient, runPollLoop, MemoryDedupe } from "@relaymessenger/sdk";
+await relay.chats.startTyping(chatId);
+await relay.chats.stopTyping(chatId);
+```
+
+Calling `startTyping` again refreshes the indicator.
+
+## Raw attachment upload
+
+```ts
+const allocation = await relay.attachments.create({
+  filename: "photo.png",
+  content_type: "image/png",
+  size_bytes: bytes.byteLength,
+});
+
+await relay.attachments.upload(allocation, bytes);
+```
+
+The upload helper sends the bytes as a raw `PUT` body with the exact returned
+headers.
+
+## Webhooks
+
+```ts
+const relay = new Relay({
+  apiKey: process.env.RELAY_AGENT_TOKEN!,
+  webhookSecret: process.env.RELAY_WEBHOOK_SECRET!,
+});
+
+const event = relay.webhooks.unwrap(rawBody, {
+  headers: {
+    "webhook-id": request.headers.get("webhook-id")!,
+    "webhook-timestamp": request.headers.get("webhook-timestamp")!,
+    "webhook-signature": request.headers.get("webhook-signature")!,
+  },
+});
 
-const client = createRelayClient({ token: process.env.RELAY_AGENT_TOKEN! });
-const me = await client.getMe();
-const dedupe = new MemoryDedupe();
+if (event.event_type === "contact.added") {
+  console.log(event.data.contact.handle, event.data.chat_id);
+}
 
-await runPollLoop({
-  client,
-  getCursor: () => 0,
-  setCursor: async () => {},
-  dedupe,
-  onMessage: async ({ event, message, reply }) => {
-    await reply.text(`hi from ${me.handle}`);
+if (event.event_type === "contact.removed") {
+  console.log(event.data.contact.handle);
+}
+```
+
+Verification follows Standard Webhooks and must use the unmodified raw body.
+Commit the complete event to a durable inbox, then return `2xx` before running
+the handler or model. Relay uses that response as the agent's Delivered ACK.
+
+## WebSocket
+
+```ts
+await relay.websocket.run({
+  onEvent: async (event, { sequence }) => {
+    // This promise must resolve only after a durable inbox commit.
+    await inbox.insertOnce(event.event_id, event);
+    console.log("accepted", sequence);
+  },
+  onFullSync: async ({ throughSequence, reason }) => {
+    // Fetch the complete REST state and atomically replace the local snapshot.
+    const snapshot = await loadCompleteRelayState(relay);
+    await inbox.replaceWithSnapshot(snapshot, { throughSequence, reason });
   },
 });
 ```
 
-Docs: https://docs.relayapp.im
+With one or more saved Webhook subscriptions, Relay delivers through those
+Webhooks. With an empty subscription list, connect by WebSocket. A WebSocket
+upgrade with saved subscriptions returns HTTP `409` as
+`RelayWebhookConfiguredError`.
+
+Creating the first Webhook subscription while sockets are connected closes
+those sockets and moves undelivered events to Webhook delivery. Deleting the
+last subscription makes the WebSocket path available again. Relay retains
+undelivered events across either change.
+
+The SDK derives `wss://<Relay host>/v1/websocket` from `baseURL` and sends the
+Agent Token in the WebSocket upgrade `Authorization` header.
+
+The SDK validates the ready checkpoint, rejects sequence gaps, and routes
+replayed sequences through your durable deduplication handler. It sends a
+cumulative ACK after `onEvent` resolves:
+
+```json
+{ "type": "ack", "through_sequence": "42" }
+```
+
+Unacknowledged events replay after reconnect, so the inbox deduplicates by
+`event_id`. Resolve `onEvent` after durable acceptance, then run model work and
+send replies through the idempotent REST Message API.
+
+The WebSocket and each signed Webhook carry the same
+`RelayWebhookEnvelope`, so one durable event handler can serve either path.
+Webhook retries remain at-least-once and can repeat an `event_id`.
+
+If Relay reports that the stored checkpoint is older than retained event
+history, it sends a `full_sync` frame. `onFullSync` must fetch and durably apply
+a complete REST snapshot. The SDK sends `full_sync_complete` after that promise
+resolves, then resumes event ACKs.
+
+Relay sends a JSON ping every 30 seconds. The SDK answers with a JSON pong and
+also uses the Node WebSocket heartbeat to detect a dead connection.
+
+The runner uses capped, jittered exponential reconnect after
+`heartbeat_timeout`, `restart`, close codes `1011`, `1012`, or `4408`, send
+failures, and retryable `ack_failed` or `delivery_failed` errors. Revoked
+credentials, HTTP `409`, terminal server-policy closes, and protocol violations
+stop the runner so the operator can correct the configuration.

package/dist/client.d.ts

@@ -1,57 +1,135 @@
-import type { RelayAgentProfile, RelayEventsPage, RelayOutgoingPart, RelayReplyRef, RelaySendResult } from "./types.js";
-type FetchLike = (input: string, init?: RequestInit) => Promise<Response>;
-export type RelayClientOptions = {
-    token: string;
-    baseUrl?: string;
-    fetchImpl?: FetchLike;
-    requestTimeoutMs?: number;
-};
-export type RelayClient = {
-    readonly baseUrl: string;
-    getMe: (params?: {
-        signal?: AbortSignal;
-    }) => Promise<RelayAgentProfile>;
-    pollEvents: (params: {
-        cursor: number;
-        timeoutSeconds?: number;
-        limit?: number;
-        signal?: AbortSignal;
-    }) => Promise<RelayEventsPage>;
-    sendMessage: (params: {
-        conversationId: string;
-        parts: RelayOutgoingPart[];
-        replyTo?: RelayReplyRef;
-        invocationId?: string;
-        idempotencyKey: string;
-        signal?: AbortSignal;
-    }) => Promise<RelaySendResult>;
-    sendText: (params: {
-        conversationId: string;
-        text: string;
-        replyTo?: RelayReplyRef;
-        invocationId?: string;
-        idempotencyKey: string;
-        signal?: AbortSignal;
-    }) => Promise<RelaySendResult>;
-    setTyping: (params: {
-        conversationId: string;
-        started: boolean;
-        label?: string;
-        invocationId?: string;
-        signal?: AbortSignal;
-    }) => Promise<void>;
-    setResponding: (params: {
-        conversationId: string;
-        messageId: string;
-        label?: string;
-        invocationId?: string;
-        signal?: AbortSignal;
-    }) => Promise<void>;
-    markRead: (params: {
-        conversationId: string;
-        messageId: string;
-        signal?: AbortSignal;
-    }) => Promise<void>;
-};
-export declare function createRelayClient(options: RelayClientOptions): RelayClient;
-export {};
+import { ChatsPage, MessagesPage } from "./pagination.js";
+import type { AcceptedResponse, Attachment, AttachmentCreateParams, AttachmentCreateResponse, BlockedHandleListResponse, BlockHandleParams, BlockHandleResponse, Chat, ChatCreateParams, ChatCreateResponse, ChatListChatsParams, ChatSendVoicememoParams, ChatSendVoicememoResponse, ChatUpdateParams, ChatUpdateResponse, ContactCardItem, ContactCardCreateParams, ContactCardRetrieveParams, ContactCardRetrieveResponse, ContactCardUpdateParams, ContactRequestCreateParams, ContactRequestCreateResponse, Message, MessageAddReactionParams, MessageAddReactionResponse, MessageCreateParams, MessageCreateResponse, MessageListParams, MessageSendParams, MessageSendResponse, MessageThreadParams, ParticipantAddParams, ParticipantRemoveParams, RequestOptions, UnblockHandleParams, WebhookEventListResponse, WebhookSubscription, WebhookSubscriptionCreateParams, WebhookSubscriptionCreateResponse, WebhookSubscriptionListResponse, WebhookSubscriptionUpdateParams } from "./types.js";
+import { Webhooks } from "./webhooks.js";
+import { type WebSocketRunOptions } from "./websocket.js";
+type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+export interface RelayOptions {
+    apiKey: string;
+    baseURL?: string;
+    webhookSecret?: string | null;
+    maxRetries?: number;
+    timeout?: number;
+    retryBaseDelayMs?: number;
+    fetch?: FetchLike;
+}
+interface InternalRequest {
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    path: string;
+    query?: object;
+    body?: unknown;
+    options?: RequestOptions | undefined;
+    idempotencyKey?: string;
+    retryable?: boolean;
+}
+declare class Transport {
+    #private;
+    readonly baseURL: string;
+    constructor(options: RelayOptions);
+    request<T>(request: InternalRequest): Promise<T>;
+    upload(allocation: AttachmentCreateResponse, data: BodyInit, options?: RequestOptions): Promise<void>;
+    runWebSocket(options: WebSocketRunOptions): Promise<void>;
+}
+declare class ChatMessages {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(chatID: string, query?: MessageListParams, options?: RequestOptions): Promise<MessagesPage<Message>>;
+    send(chatID: string, body: MessageSendParams, options?: RequestOptions): Promise<MessageSendResponse>;
+}
+declare class ChatParticipants {
+    private readonly transport;
+    constructor(transport: Transport);
+    add(chatID: string, body: ParticipantAddParams, options?: RequestOptions): Promise<AcceptedResponse>;
+    remove(chatID: string, body: ParticipantRemoveParams, options?: RequestOptions): Promise<AcceptedResponse>;
+}
+export declare class Chats {
+    private readonly transport;
+    readonly messages: ChatMessages;
+    readonly participants: ChatParticipants;
+    constructor(transport: Transport);
+    create(body: ChatCreateParams, options?: RequestOptions): Promise<ChatCreateResponse>;
+    retrieve(chatID: string, options?: RequestOptions): Promise<Chat>;
+    update(chatID: string, body: ChatUpdateParams, options?: RequestOptions): Promise<ChatUpdateResponse>;
+    listChats(query?: ChatListChatsParams, options?: RequestOptions): Promise<ChatsPage<Chat>>;
+    leaveChat(chatID: string, options?: RequestOptions): Promise<AcceptedResponse>;
+    startTyping(chatID: string, options?: RequestOptions): Promise<void>;
+    stopTyping(chatID: string, options?: RequestOptions): Promise<void>;
+    markAsRead(chatID: string, options?: RequestOptions): Promise<void>;
+    shareContactCard(chatID: string, options?: RequestOptions): Promise<void>;
+    sendVoicememo(chatID: string, body: ChatSendVoicememoParams, options?: RequestOptions): Promise<ChatSendVoicememoResponse>;
+}
+export declare class Messages {
+    private readonly transport;
+    constructor(transport: Transport);
+    create(params: MessageCreateParams, options?: RequestOptions): Promise<MessageCreateResponse>;
+    retrieve(messageID: string, options?: RequestOptions): Promise<Message>;
+    addReaction(messageID: string, body: MessageAddReactionParams, options?: RequestOptions): Promise<MessageAddReactionResponse>;
+    listMessagesThread(messageID: string, query?: MessageThreadParams, options?: RequestOptions): Promise<MessagesPage<Message>>;
+}
+export declare class Attachments {
+    private readonly transport;
+    constructor(transport: Transport);
+    create(body: AttachmentCreateParams, options?: RequestOptions): Promise<AttachmentCreateResponse>;
+    retrieve(attachmentID: string, options?: RequestOptions): Promise<Attachment>;
+    delete(attachmentID: string, options?: RequestOptions): Promise<void>;
+    upload(allocation: AttachmentCreateResponse, data: BodyInit, options?: RequestOptions): Promise<void>;
+}
+export declare class WebhookEvents {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(options?: RequestOptions): Promise<WebhookEventListResponse>;
+}
+export declare class WebhookSubscriptions {
+    private readonly transport;
+    constructor(transport: Transport);
+    create(body: WebhookSubscriptionCreateParams, options?: RequestOptions): Promise<WebhookSubscriptionCreateResponse>;
+    retrieve(subscriptionID: string, options?: RequestOptions): Promise<WebhookSubscription>;
+    update(subscriptionID: string, body: WebhookSubscriptionUpdateParams, options?: RequestOptions): Promise<WebhookSubscription>;
+    list(options?: RequestOptions): Promise<WebhookSubscriptionListResponse>;
+    delete(subscriptionID: string, options?: RequestOptions): Promise<void>;
+}
+export declare class ContactCard {
+    private readonly transport;
+    constructor(transport: Transport);
+    create(body: ContactCardCreateParams, options?: RequestOptions): Promise<ContactCardItem>;
+    retrieve(query?: ContactCardRetrieveParams, options?: RequestOptions): Promise<ContactCardRetrieveResponse>;
+    update(params: ContactCardUpdateParams, options?: RequestOptions): Promise<ContactCardItem>;
+}
+export declare class ContactRequests {
+    private readonly transport;
+    constructor(transport: Transport);
+    create(params: ContactRequestCreateParams, options?: RequestOptions): Promise<ContactRequestCreateResponse>;
+}
+export declare class BlockedHandles {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(options?: RequestOptions): Promise<BlockedHandleListResponse>;
+    block(body: BlockHandleParams, options?: RequestOptions): Promise<BlockHandleResponse>;
+    unblock(body: UnblockHandleParams, options?: RequestOptions): Promise<void>;
+}
+export declare class WebSocket {
+    private readonly transport;
+    constructor(transport: Transport);
+    /**
+     * Keeps one outbound WebSocket connection alive. `onEvent` must return
+     * only after the event is committed to a durable inbox; the SDK sends the
+     * cumulative ACK after that promise resolves. `onFullSync` must return only
+     * after a complete REST snapshot is durably applied.
+     */
+    run(options: WebSocketRunOptions): Promise<void>;
+}
+export declare class Relay {
+    readonly baseURL: string;
+    readonly chats: Chats;
+    readonly messages: Messages;
+    readonly attachments: Attachments;
+    readonly webhookEvents: WebhookEvents;
+    readonly webhookSubscriptions: WebhookSubscriptions;
+    readonly contactCard: ContactCard;
+    readonly contactRequests: ContactRequests;
+    readonly blockedHandles: BlockedHandles;
+    readonly websocket: WebSocket;
+    readonly webhooks: Webhooks;
+    constructor(options: RelayOptions);
+}
+export default Relay;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EACV,gBAAgB,EAChB,UAAU,EACV,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,mBAAmB,EACnB,IAAI,EACJ,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,EACvB,yBAAyB,EACzB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,uBAAuB,EACvB,yBAAyB,EACzB,2BAA2B,EAC3B,uBAAuB,EACvB,0BAA0B,EAC1B,4BAA4B,EAC5B,OAAO,EACP,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,uBAAuB,EACvB,cAAc,EACd,mBAAmB,EACnB,wBAAwB,EACxB,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,+BAA+B,EAC/B,+BAA+B,EAChC,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,gBAAgB,CAAC;AAExB,KAAK,SAAS,GAAG,CACf,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO,EAC7B,IAAI,CAAC,EAAE,WAAW,KACf,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,UAAU,eAAe;IACvB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AA0BD,cAAM,SAAS;;IACb,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAOb,OAAO,EAAE,YAAY;IAU3B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC;IAwFhD,MAAM,CACV,UAAU,EAAE,wBAAwB,EACpC,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAwBhB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1D;AAED,cAAM,YAAY;IACJ,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAE3C,IAAI,CACR,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,iBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAgBjC,IAAI,CACF,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;CAWhC;AAED,cAAM,gBAAgB;IACR,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,GAAG,CACD,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IAS5B,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;CAQ7B;AAED,qBAAa,KAAK;IAIJ,OAAO,CAAC,QAAQ,CAAC,SAAS;IAHtC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,YAAY,EAAE,gBAAgB,CAAC;gBAEX,SAAS,EAAE,SAAS;IAKjD,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAYrF,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjE,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kBAAkB,CAAC;IASxB,SAAS,CACb,KAAK,GAAE,mBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAgB3B,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQ9E,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASpE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASnE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASnE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzE,aAAa,CACX,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,yBAAyB,CAAC;CAQtC;AAED,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,MAAM,CACJ,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,qBAAqB,CAAC;IAYjC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvE,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAShC,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,mBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;CAoBlC;AAED,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,MAAM,CACJ,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,wBAAwB,CAAC;IASpC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAQ7E,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAQrE,MAAM,CACJ,UAAU,EAAE,wBAAwB,EACpC,IAAI,EAAE,QAAQ,EACd,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;CAGjB;AAED,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAOlE;AAED,qBAAa,oBAAoB;IACnB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,MAAM,CACJ,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iCAAiC,CAAC;IAS7C,QAAQ,CACN,cAAc,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAQ/B,MAAM,CACJ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAS/B,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAQxE,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAOxE;AAED,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAS3B,QAAQ,CACN,KAAK,GAAE,yBAA8B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,2BAA2B,CAAC;IASvC,MAAM,CACJ,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;CAU5B;AAED,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,MAAM,CACJ,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,4BAA4B,CAAC;CAUzC;AAED,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAQlE,KAAK,CACH,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAS/B,OAAO,CACL,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;CAQjB;AAED,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,SAAS;IAEjD;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjD;AAED,qBAAa,KAAK;IAChB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IACpD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAC1C,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;gBAEhB,OAAO,EAAE,YAAY;CAclC;AAED,eAAe,KAAK,CAAC"}