Skip to content

Repository files navigation

@pontx/sendbird-chat-platform

Pontx Hub SDK guide

Type-safe Sendbird Chat Platform API v3 SDK and CLI generated from the exact PontxSpec in the Sendbird candidate metadata (83 endpoints / 173 schemas, reconstructed from the official generated SDK at pinned revision fccf6fa, v2.1.8).

Install

pnpm add @pontx/sendbird-chat-platform

SDK

import { createSendbirdChatPlatformClient } from "@pontx/sendbird-chat-platform";

const client = createSendbirdChatPlatformClient({
  appId: process.env.SENDBIRD_APP_ID,
  apiToken: process.env.SENDBIRD_API_TOKEN,
});
const user = await client.users.viewAUser({ userId: "user_id_123" });

The client builds the base URL https://api-{app_id}.sendbird.com from appId (or the SENDBIRD_APP_ID environment variable) and attaches the api-token header only when apiToken or the SENDBIRD_API_TOKEN environment variable is provided. baseUrl overrides the host for proxies and tests.

CLI

pnpm add --global @pontx/sendbird-chat-platform
pontx-sendbird-chat-platform list apis
pontx-sendbird-chat-platform call users viewAUser --user_id user_id_123 --dry-run

Set SENDBIRD_APP_ID and SENDBIRD_API_TOKEN in your environment; the CLI never prints credentials and mutations require explicit confirmation after a --dry-run preview.

Terms and data boundary

This package makes caller-directed requests only with the caller's own application credentials. Sendbird server-side data (users, channels, messages, push tokens) is private application content; Pontx Hub neither proxies, caches, nor aggregates it. Callers must confirm their own Sendbird terms and data-compliance posture before use. This package does not redistribute Sendbird SDK source, an OpenAPI document, or documentation prose (see source.provenance.json).

About

Type-safe Sendbird Chat Platform API v3 SDK and CLI generated from the product-owned PontxSpec

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages