@sendbird/sendbird-platform-sdk-typescript 2.0.0

package/PrivacyApi.md

@@ -0,0 +1,251 @@
+# Sendbird.PrivacyApi
+
+All URIs are relative to *https://api-APP_ID.sendbird.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancelTheRegistrationOfGdprRequestById**](PrivacyApi.md#cancelTheRegistrationOfGdprRequestById) | **DELETE** /v3/privacy/gdpr/{request_id} | Cancel the registration of a GDPR request
+[**listGdprRequests**](PrivacyApi.md#listGdprRequests) | **GET** /v3/privacy/gdpr | List GDPR requests
+[**registerGdprRequest**](PrivacyApi.md#registerGdprRequest) | **POST** /v3/privacy/gdpr | Register a GDPR request
+[**viewGdprRequestById**](PrivacyApi.md#viewGdprRequestById) | **GET** /v3/privacy/gdpr/{request_id} | View a GDPR request
+
+
+# **cancelTheRegistrationOfGdprRequestById**
+> void cancelTheRegistrationOfGdprRequestById()
+
+## Cancel the registration of a GDPR request  Cancels the registration of a specific GDPR request.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-cancel-the-registration-of-a-gdpr-request ----------------------------
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.PrivacyApi(configuration);
+
+let body:Sendbird.PrivacyApiCancelTheRegistrationOfGdprRequestByIdRequest = {
+  // string
+  requestId: "request_id_example",
+  // string (optional)
+  apiToken: "{{API_TOKEN}}",
+};
+
+apiInstance.cancelTheRegistrationOfGdprRequestById(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **requestId** | [**string**] |  | defaults to undefined
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**void**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
+# **listGdprRequests**
+> ListGdprRequestsResponse listGdprRequests()
+
+## List GDPR requests  Retrieves a list of GDPR requests of all types.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-list-gdpr-requests ----------------------------
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.PrivacyApi(configuration);
+
+let body:Sendbird.PrivacyApiListGdprRequestsRequest = {
+  // string (optional)
+  apiToken: "{{API_TOKEN}}",
+  // string (optional)
+  token: "token_example",
+  // number (optional)
+  limit: 1,
+};
+
+apiInstance.listGdprRequests(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+ **token** | [**string**] |  | (optional) defaults to undefined
+ **limit** | [**number**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**ListGdprRequestsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
+# **registerGdprRequest**
+> RegisterGdprRequestResponse registerGdprRequest()
+
+## Register a GDPR request  Registers a specific type of GDPR request to meet the GDPR's requirements.  > __Note__: Currently, only delete and access of the user data are supported. The features for the [right to restriction of processing](https://gdpr-info.eu/art-18-gdpr/) and [right to object](https://gdpr-info.eu/art-21-gdpr/) will be available soon.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-register-a-gdpr-request
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.PrivacyApi(configuration);
+
+let body:Sendbird.PrivacyApiRegisterGdprRequestRequest = {
+  // string (optional)
+  apiToken: "{{API_TOKEN}}",
+  // RegisterGdprRequestData (optional)
+  registerGdprRequestData: {
+    action: "action_example",
+    userIds: [
+      "userIds_example",
+    ],
+    channelDeleteOption: "channelDeleteOption_example",
+    userId: "userId_example",
+  },
+};
+
+apiInstance.registerGdprRequest(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registerGdprRequestData** | **RegisterGdprRequestData**|  |
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**RegisterGdprRequestResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
+# **viewGdprRequestById**
+> ViewGdprRequestByIdResponse viewGdprRequestById()
+
+## View a GDPR request  Retrieves a specific GDPR request.  https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-view-a-gdpr-request ----------------------------
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.PrivacyApi(configuration);
+
+let body:Sendbird.PrivacyApiViewGdprRequestByIdRequest = {
+  // string
+  requestId: "request_id_example",
+  // string (optional)
+  apiToken: "{{API_TOKEN}}",
+};
+
+apiInstance.viewGdprRequestById(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **requestId** | [**string**] |  | defaults to undefined
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**ViewGdprRequestByIdResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
+

package/PushNotificationsApi.md

@@ -0,0 +1,124 @@
+# Sendbird.PushNotificationsApi
+
+All URIs are relative to *https://api-APP_ID.sendbird.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**v3ApplicationsPushSettingsGet**](PushNotificationsApi.md#v3ApplicationsPushSettingsGet) | **GET** /v3/applications/push/settings | Check push notifications
+[**v3ApplicationsPushSettingsPut**](PushNotificationsApi.md#v3ApplicationsPushSettingsPut) | **PUT** /v3/applications/push/settings | Turn on push notifications
+
+
+# **v3ApplicationsPushSettingsGet**
+> V3ApplicationsPushSettingsGet200Response v3ApplicationsPushSettingsGet()
+
+## Check push notifications Shows whether the push notifications feature is turned on for an application. https://sendbird.com/docs/chat/v3/platform-api/application/managing-notifications/check-push-notifications -----------------------------  
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.PushNotificationsApi(configuration);
+
+let body:Sendbird.PushNotificationsApiV3ApplicationsPushSettingsGetRequest = {
+  // string (optional)
+  apiToken: "Api-Token_example",
+};
+
+apiInstance.v3ApplicationsPushSettingsGet(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**V3ApplicationsPushSettingsGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
+# **v3ApplicationsPushSettingsPut**
+> ListPushConfigurationsResponse v3ApplicationsPushSettingsPut()
+
+## Turn on push notifications Determines whether to turn on the push notifications feature for an application. https://sendbird.com/docs/chat/v3/platform-api/application/managing-notifications/turn-on-push-notifications -----------------------------  
+
+### Example
+
+
+```typescript
+import { Sendbird } from 'sendbird-platform-sdk';
+import * as fs from 'fs';
+
+const configuration = Sendbird.createConfiguration();
+const apiInstance = new Sendbird.PushNotificationsApi(configuration);
+
+let body:Sendbird.PushNotificationsApiV3ApplicationsPushSettingsPutRequest = {
+  // string (optional)
+  apiToken: "Api-Token_example",
+  // V3ApplicationsPushSettingsGetRequest (optional)
+  v3ApplicationsPushSettingsGetRequest: {
+    pushEnabled: true,
+  },
+};
+
+apiInstance.v3ApplicationsPushSettingsPut(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **v3ApplicationsPushSettingsGetRequest** | **V3ApplicationsPushSettingsGetRequest**|  |
+ **apiToken** | [**string**] |  | (optional) defaults to undefined
+
+
+### Return type
+
+**ListPushConfigurationsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
+

package/README.md

@@ -0,0 +1,104 @@
+![Sendbird banner image](http://ww1.prweb.com/prfiles/2021/09/14/18371217/Sendbird_Logo_RGB_lg.png)
+
+# [Sendbird Typescript Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
+
+[![link to docs](https://img.shields.io/badge/SDK-docs-green)](/docs)
+[![NPM](https://img.shields.io/npm/v/sendbird-platform-sdk-typescript.svg)](https://www.npmjs.com/package/sendbird-platform-sdk-typescript)
+
+This is a Node.js package written in Typescript  that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-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.
+
+>__Note__: Platform API SDK v2 includes only the APIs that were actively used in v1. If you need help getting started with the new SDK, [contact us](https://dashboard.sendbird.com/settings/contact_us).
+
+# 🔥 Quick start
+
+```typescript
+import {
+  createConfiguration,
+  ServerConfiguration,
+  UserApi,
+  UserApiCreateAUserRequest,
+  UserApiListUsersRequest,
+} from "@sendbird/sendbird-platform-sdk-typescript";
+
+const APP_ID = "YOUR_APP_ID_FROM_DASHBOARD";
+const API_TOKEN = "YOUR_MASTER_API_TOKEN_FROM_DASHBOARD";
+
+const serverConfig = new ServerConfiguration(
+  `https://api-${APP_ID}.sendbird.com`,
+  { app_id: APP_ID }
+);
+const configuration = createConfiguration({
+  baseServer: serverConfig,
+});
+const userApi = new UserApi(configuration);
+
+const listUsersParams: UserApiListUsersRequest = {
+  limit: 10,
+  apiToken: API_TOKEN,
+};
+
+const users = await userApi.listUsers(listUsersParams);
+console.log("Listing first 10 users:\n", users);
+
+const createUserParams: UserApiCreateAUserRequest = {
+  createAUserRequest: {
+    userId: "bob_smith",
+    nickname: "Bob",
+    profileUrl: "https://cataas.com/c",
+  },
+  apiToken: API_TOKEN,
+};
+
+const user = await userApi.createAUser(createUserParams);
+console.log("User created:\n", user);
+```
+
+# ⚠️ Warnings
+
+ 1. This library is intended for server to server requests. **Do not use in a browser environment**. This SDK uses the Master API Token, which must never be exposed in public environments such as web pages or apps.
+
+# ⚒️ Prerequisite
+
+In order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/).  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](https://i.imgur.com/0YMKtpX.png)
+
+# 💻 Requirements
+
+You will need [Node.js](https://nodejs.org/en/download/) installed. This has been developed and tested with NodeJS 17+.
+
+# 📦 Installation
+
+You can install the SDK directly from npm:
+```
+# Using npm
+npm install @sendbird/sendbird-platform-sdk-typescript
+
+# Using yarn
+yarn add @sendbird/sendbird-platform-sdk-typescript
+```
+> ⚠️ This SDK is intended for the server-side environment only. Do not use this in browsers or frontend applications.
+
+# 🤓 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 root directory of this repo. 
+
+##### Helpful links
+
+|       | Documentation |
+| ----------- | ----------- |
+| Announcement   | [AnnouncementApi.md](AnnouncementApi.md)|
+| Bot | [BotApi.md](BotApi.md)  |
+| GroupChannel | [GroupChannelApi.md](GroupChannelApi.md)  |
+| Message | [MessageApi.md](MessageApi.md)  |
+| OpenChannel | [OpenChannelApi.md ](OpenChannelApi.md)  |
+| User | [UserApi.md](UserApi.md)  |
+