Registry / communication / sendbird-platform-sdk-typescript

sendbird-platform-sdk-typescript

library0.0.18jsnpmunverified

OpenAPI-generated TypeScript client for the Sendbird Platform API. Current stable version is 2.1.6, released as a minor/patch cadence. Supports all platform endpoints (users, channels, messages, bots, metadata, push preferences) with full TypeScript types and fetch-based HTTP. Key differentiators: auto-generated from official OpenAPI spec, object-form function calls since v2.0.0 (breaking change from v1), nullable type support, and weekly DND schedules in push preferences.

communication http-networking serialization

npm install sendbird-platform-sdk-typescript

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SENDBIRD-PLATFORM-

sendbird-platform-sdk-typescript

communicationjavascriptv0.0.18

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SendbirdPlatformSDK

✓ import { SendbirdPlatformSDK } from 'sendbird-platform-sdk-typescript'

✗ const SendbirdPlatformSDK = require('sendbird-platform-sdk-typescript')

SDK is ESM-only, default export is not available. Use named import.

createUser

✓ import { createUser } from 'sendbird-platform-sdk-typescript'

✗ import createUser from 'sendbird-platform-sdk-typescript'

All functions are named exports from the package root.

SendbirdPlatformSDKType

✓ import type { SendbirdPlatformSDKType } from 'sendbird-platform-sdk-typescript'

✗ import { SendbirdPlatformSDKType } from 'sendbird-platform-sdk-typescript'

Type imports should use `import type` to avoid runtime overhead.

Initializes the SDK with appId and apiToken from environment variables, then lists users.

import { SendbirdPlatformSDK } from 'sendbird-platform-sdk-typescript'; const sdk = new SendbirdPlatformSDK({ appId: process.env.SENDBIRD_APP_ID ?? '', apiToken: process.env.SENDBIRD_API_TOKEN ?? '', }); async function main() { const { users } = await sdk.user.listUsers(); console.log(users); } main().catch(console.error);

Debug

Known issues

breakingv2.0.0 changed function calls to require object form for all parameters.

fix

Update all function calls to pass an options object instead of positional arguments.

affects: >=2.0.0

gotchaSDK uses fetch which may not be available in older Node.js versions (<18).

fix

Use Node.js >=18 or provide a fetch polyfill.

affects: all

gotchaType definitions may not match actual API response shape for nullable fields.

fix

Upgrade to >=2.1.1 which improved nullable type handling.

affects: <2.1.1

Errors

Common errors & fixes

Cannot find module 'sendbird-platform-sdk-typescript'

Package not installed or import path incorrect.

fix

Run 'npm install sendbird-platform-sdk-typescript' and ensure import is correct: 'import { SendbirdPlatformSDK } from "sendbird-platform-sdk-typescript"'.

TypeError: sdk.user.listUsers is not a function

Using v1 syntax (positional arguments) on v2.

fix

Update to object form: sdk.user.listUsers({}) or check version-specific docs.

Upgrade

Version history

0.0.18latest on npm

Audit

Dependencies

fetchoptionaluses browser/Node fetch for HTTP requests

Agent activity

16 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/sendbird/sendbird-platform-sdk-typescript ↗

packagehttps://www.npmjs.com/package/sendbird-platform-sdk-typescript ↗

homepagehttps://sendbird.com ↗