Giter Club home page Giter Club logo

sendbird-platform-sdk-typescript's Introduction

Sendbird banner image

link to docs This is a Node.js package written in Typescript that makes talking to the Sendbird Platform API easier. With this library you can extend your Sendbird integration to include advanced features like message-, and channel automation, user management, create user authentication tokens, and create bots.

Differences from upstream Repo

  • Fixed TS errors, and remove node_modules committed in the repo.
  • Upgraded to TS v5 and support only versions above Node v18
  • Publish the dist/ directory for use instead of directly using the source file which caused TS errors in consuming applications.
  • Run build automatically when running npm run publish

To publish, make sure you update the version using the appropriate npm version command and then run npm publish.

๐Ÿ”ฅ Quick start

import * as sendbird from 'sendbird-platform-sdk-typescript';
const APP_ID = "YOUR_APP_ID_FROM_DASHBOARD";
const API_TOKEN = "YOUR_MASTER_API_TOKEN_FROM_DASHBOARD";
const serverConfig = new sendbird.ServerConfiguration("https://api-{app_id}.sendbird.com", { "app_id": APP_ID })
const configuration = sendbird.createConfiguration({ baseServer : serverConfig });
const userAPI = new sendbird.UserApi(configuration);
// List users, use the next token in the response to get the next page of users in subsequent requests
userAPI.listUsers(API_TOKEN, '', 10).then((users) => {
    console.log("Listing first 10 users:\n")
    console.log(users)
}).catch((error) => {
    console.log("Error listing users")
    console.log(error)
})
// How to create a user
const userData: sendbird.CreateUserData = {
    userId: "bob_smith",
    nickname: "Bob",
    profileUrl: "https://cataas.com/c"
}
userAPI.createUser(API_TOKEN, userData).then((user) => {
    console.log("User created:\n")
    console.log(user)
}).catch((error) => {
    console.log("Error creating user:")
    console.log(error)
})

โš ๏ธ Warnings

  1. This package is not currently in npm. Please see the Local development section for installation instructions.
  2. This library is intended for server to server requests. Do not use in a browser environment. This SDK uses the Master API Token, which should never be exposed to the outside world like in a webpage or app.

โš’๏ธ Prerequisite

In order to make requests with this SDK you will need you master API token. This can be found through the Sendbird dashboard. Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General. how to find you api token

๐Ÿ’ป Requirements

You will need Node.js installed. This has been developed and tested with NodeJS 17+.

โš™๏ธ Installation

๐Ÿšจ Package not yet in npm ๐Ÿšจ npm install sendbird-platform-sdk-typescript

๐Ÿค“ Local Development

  1. Clone the repository
  2. cd to the sendbird-platform-sdk-typescript directory
  3. run npm install
  4. cd to your project directory
  5. run npm install /path/to/sendbird-platform-sdk-typescript --save

๐Ÿ—ƒ๏ธ Documentation

All the documentation for this project lives in the /docs directory of this repo.

Helpful links
Documentation
Announcement docs/AnnouncementApi.md
Application docs/ApplicationApi.md
Bot docs/BotApi.md
GroupChannel docs/GroupChannelApi.md
Message docs/MessageApi.md
OpenChannel docs/OpenChannelApi.md
User docs/UserApi.md
Webhooks docs/WebhooksApi.md

sendbird-platform-sdk-typescript's People

Contributors

chrischabot avatar niksrc avatar james-a-rob avatar hungvu193 avatar luke-cha avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.