@sendbird/sendbird-platform-sdk-typescript 2.0.0 → 2.1.2

package/.gitattributes

@@ -0,0 +1,8 @@
+**/* linguist-generated
+*.md linguist-documentation
+
+.gitattributes text
+.gitattributes export-ignore
+
+.gitignore text
+.gitignore export-ignore

package/.openapi-generator/FILES

@@ -1,14 +1,3 @@
-.gitignore
-AnnouncementApi.md
-BotApi.md
-GroupChannelApi.md
-MessageApi.md
-MetadataApi.md
-ModerationApi.md
-OpenChannelApi.md
-README.md
-StatisticsApi.md
-UserApi.md
 apis/AnnouncementApi.ts
 apis/BotApi.ts
 apis/GroupChannelApi.ts
@@ -40,12 +29,12 @@ models/ChooseAPushNotificationContentTemplateResponse.ts
 models/CreateABotRequest.ts
 models/CreateABotResponse.ts
 models/CreateABotResponseBot.ts
-models/CreateABotResponseBotStyle.ts
 models/CreateAChannelMetadataRequest.ts
 models/CreateAChannelMetadataResponse.ts
 models/CreateAGroupChannelRequest.ts
 models/CreateAUserRequest.ts
 models/CreateAnOpenChannelRequest.ts
+models/CreateUserMetadataRequest.ts
 models/CreateUserTokenRequest.ts
 models/CreateUserTokenResponse.ts
 models/FreezeAGroupChannelRequest.ts
@@ -67,7 +56,6 @@ models/LeaveMyGroupChannelsRequest.ts
 models/ListBlockedUsersResponse.ts
 models/ListBotsResponse.ts
 models/ListBotsResponseBotsInner.ts
-models/ListBotsResponseBotsInnerAi.ts
 models/ListBotsResponseBotsInnerBot.ts
 models/ListBotsResponseBotsInnerBotStyle.ts
 models/ListBotsResponseBotsInnerBotStyleColor.ts
@@ -100,12 +88,14 @@ models/ScheduleAnAnnouncementRequestMessage.ts
 models/ScheduleAnAnnouncementResponse.ts
 models/ScheduleAnAnnouncementResponseMessage.ts
 models/SendABotMessageRequest.ts
+models/SendABotMessageResponse.ts
 models/SendAMessageRequest.ts
+models/SendAMessageRequestPushMessageTemplate.ts
+models/SendAMessageRequestPushMessageTemplateOneOf.ts
 models/SendAdminMessageRequestBody.ts
 models/SendFileMessageRequestBody.ts
 models/SendTextMessageRequestBody.ts
 models/SendTextMessageRequestBodyPushMessageTemplate.ts
-models/SendTextMessageRequestBodyPushMessageTemplateOneOf.ts
 models/SendbirdBasicUserInfo.ts
 models/SendbirdDisappearingMessage.ts
 models/SendbirdExtendedMessagePayload.ts
@@ -113,8 +103,10 @@ models/SendbirdFile.ts
 models/SendbirdGroupChannel.ts
 models/SendbirdGroupChannelDetail.ts
 models/SendbirdGroupChannelDetailChannel.ts
+models/SendbirdGroupChannelLastMessage.ts
 models/SendbirdMember.ts
 models/SendbirdMessageResponse.ts
+models/SendbirdMessageResponseExtendedMessagePayload.ts
 models/SendbirdMessageResponseMessageEvents.ts
 models/SendbirdOpenChannel.ts
 models/SendbirdParentMessageInfo.ts
@@ -130,6 +122,8 @@ models/UpdateAGroupChannelRequest.ts
 models/UpdateAMessageRequest.ts
 models/UpdateAUserRequest.ts
 models/UpdateAnOpenChannelRequest.ts
+models/UpdateBotByIdData.ts
+models/UpdateBotByIdResponse.ts
 models/UpdateChannelInvitationPreferenceRequest.ts
 models/UpdateChannelInvitationPreferenceResponse.ts
 models/UpdateCountPreferenceOfAChannelRequest.ts
@@ -140,6 +134,10 @@ models/UpdatePushPreferencesForAChannelRequest.ts
 models/UpdatePushPreferencesForAChannelResponse.ts
 models/UpdatePushPreferencesRequest.ts
 models/UpdatePushPreferencesResponse.ts
+models/UpdateSpecificUserMetadataRequest.ts
+models/UpdateUserMetadataRequest.ts
+models/ViewBotByIdResponse.ts
+models/ViewBotByIdResponseBot.ts
 models/ViewCountPreferenceOfAChannelResponse.ts
 models/ViewNumberOfChannelsWithUnreadMessagesResponse.ts
 models/ViewNumberOfDailyActiveUsersResponse.ts
@@ -148,10 +146,8 @@ models/ViewNumberOfUnreadMessagesResponse.ts
 models/ViewPushPreferencesForAChannelResponse.ts
 models/ViewPushPreferencesResponse.ts
 models/all.ts
-package.json
 rxjsStub.ts
 servers.ts
-tsconfig.json
 types/ObjectParamAPI.ts
 types/ObservableAPI.ts
 types/PromiseAPI.ts

package/BotApi.md

@@ -321,7 +321,7 @@ No authorization required
 [[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)
 
 # **sendABotMessage**
-> SendbirdMessageResponse sendABotMessage()
+> SendABotMessageResponse sendABotMessage()
 
 ## Send a bot message  Sends a bot message to a group channel.  [https://sendbird.com/docs/chat/platform-api/v3/bot/sending-a-bot-message/send-a-bot-message#1-send-a-bot-message](https://sendbird.com/docs/chat/platform-api/v3/bot/sending-a-bot-message/send-a-bot-message#1-send-a-bot-message)  `bot_userid`   Type: string   Description: Specifies the ID of the bot to send a message.
 
@@ -338,28 +338,66 @@ const apiInstance = new Sendbird.BotApi(configuration);
 let body:Sendbird.BotApiSendABotMessageRequest = {
   // string | (Required) 
   botUserid: "bot_userid_example",
+  // string | Specifies the type of message to send. MESG for text message, FILE for file message.
+  messageType: "MESG",
+  // string | Specifies the URL of the channel to send the message to.
+  channelUrl: "channelUrl_example",
   // string (optional)
   apiToken: "{{API_TOKEN}}",
-  // SendABotMessageRequest (optional)
-  sendABotMessageRequest: {
-    channelUrl: "channelUrl_example",
-    createdAt: 1,
-    customType: "customType_example",
-    data: "data_example",
-    dedupId: "dedupId_example",
-    extendedMessagePayload: {
-      customView: {},
-      suggestedReplies: [
-        "suggestedReplies_example",
-      ],
-    },
-    markAsRead: true,
-    mentioned: [
-      "mentioned_example",
+  // string | Specifies the content of the message. * This property is required when message_type is MESG. (optional)
+  message: "message_example",
+  // Array<string> | * This property is available when message_type is MESG. (optional)
+  mentioned: [
+    "mentioned_example",
+  ],
+  // SendbirdExtendedMessagePayload (optional)
+  extendedMessagePayload: {
+    customView: {},
+    suggestedReplies: [
+      "suggestedReplies_example",
     ],
-    message: "message_example",
-    sendPush: true,
   },
+  // HttpFile | When sending a single file with a message, specifies the data of the file to upload to the Sendbird server in raw binary format. When sending a request containing a file, change the value of the content-type header to multipart/form-data;boundary={your_unique_boundary_string} in the request. * This property is required when message_type is FILE. * This doesn't allow a converted base64-encoded string from a file as its value. (optional)
+  file: { data: Buffer.from(fs.readFileSync('/path/to/file', 'utf-8')), name: '/path/to/file' },
+  // boolean | Determines whether to require an authentication key to verify if the file is being properly accessed. Only the user who uploaded the file or users who are in the channel where the file was uploaded should have access. The authentication key managed internally by the Sendbird system is generated every time a user logs in to the Sendbird server and is valid for three days starting from the last login. If set to false, Sendbird tries to access a file without any key. To access encrypted files, such as the files in the Sendbird server which are by default encrypted, the property must be set to true. (Default: false) The require_auth parameter only works if the file or URL is managed by Sendbird, which means that when you upload files using multipart format or provide URLs that point to the files hosted on the Sendbird server. However, if the file is hosted on a server or service that is not managed by Sendbird, access control and authentication for the file should be handled by the respective server or service hosting the file. * This property is available when message_type is FILE. (optional)
+  requireAuth: true,
+  // string | * This property is available when message_type is FILE. (optional)
+  mentionType: "users",
+  // Array<string> | * This property is available when message_type is FILE. (optional)
+  mentionedUserIds: [
+    "mentionedUserIds_example",
+  ],
+  // boolean | * This property is available when message_type is FILE. (optional)
+  isSilent: true,
+  // Array<SendbirdSortedMetaarrayInner> (optional)
+  sortedMetaarray: [
+    {
+      key: "key_example",
+      value: [
+        "value_example",
+      ],
+    },
+  ],
+  // string | * This property is available when message_type is FILE. (optional)
+  apnsBundleId: "apnsBundleId_example",
+  // any | * This property is available when message_type is FILE. (optional)
+  appleCriticalAlertOptions: {},
+  // string | * This property is available when message_type is FILE. (optional)
+  sound: "sound_example",
+  // number | * This property is available when message_type is FILE. (optional)
+  volume: 3.14,
+  // number (optional)
+  createdAt: 1,
+  // string (optional)
+  customType: "customType_example",
+  // string (optional)
+  data: "data_example",
+  // string (optional)
+  dedupId: "dedupId_example",
+  // boolean (optional)
+  markAsRead: true,
+  // boolean (optional)
+  sendPush: true,
 };
 
 apiInstance.sendABotMessage(body).then((data:any) => {
@@ -372,14 +410,34 @@ apiInstance.sendABotMessage(body).then((data:any) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sendABotMessageRequest** | **SendABotMessageRequest**|  |
  **botUserid** | [**string**] | (Required)  | defaults to undefined
+ **messageType** | [**string**]**Array<&#39;MESG&#39; &#124; &#39;FILE&#39;>** | Specifies the type of message to send. MESG for text message, FILE for file message. | defaults to undefined
+ **channelUrl** | [**string**] | Specifies the URL of the channel to send the message to. | defaults to undefined
  **apiToken** | [**string**] |  | (optional) defaults to undefined
+ **message** | [**string**] | Specifies the content of the message. * This property is required when message_type is MESG. | (optional) defaults to undefined
+ **mentioned** | **Array&lt;string&gt;** | * This property is available when message_type is MESG. | (optional) defaults to undefined
+ **extendedMessagePayload** | **SendbirdExtendedMessagePayload** |  | (optional) defaults to undefined
+ **file** | [**HttpFile**] | When sending a single file with a message, specifies the data of the file to upload to the Sendbird server in raw binary format. When sending a request containing a file, change the value of the content-type header to multipart/form-data;boundary&#x3D;{your_unique_boundary_string} in the request. * This property is required when message_type is FILE. * This doesn&#39;t allow a converted base64-encoded string from a file as its value. | (optional) defaults to undefined
+ **requireAuth** | [**boolean**] | Determines whether to require an authentication key to verify if the file is being properly accessed. Only the user who uploaded the file or users who are in the channel where the file was uploaded should have access. The authentication key managed internally by the Sendbird system is generated every time a user logs in to the Sendbird server and is valid for three days starting from the last login. If set to false, Sendbird tries to access a file without any key. To access encrypted files, such as the files in the Sendbird server which are by default encrypted, the property must be set to true. (Default: false) The require_auth parameter only works if the file or URL is managed by Sendbird, which means that when you upload files using multipart format or provide URLs that point to the files hosted on the Sendbird server. However, if the file is hosted on a server or service that is not managed by Sendbird, access control and authentication for the file should be handled by the respective server or service hosting the file. * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **mentionType** | [**string**]**Array<&#39;users&#39; &#124; &#39;channel&#39;>** | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **mentionedUserIds** | **Array&lt;string&gt;** | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **isSilent** | [**boolean**] | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **sortedMetaarray** | **Array&lt;SendbirdSortedMetaarrayInner&gt;** |  | (optional) defaults to undefined
+ **apnsBundleId** | [**string**] | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **appleCriticalAlertOptions** | **any** | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **sound** | [**string**] | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **volume** | [**number**] | * This property is available when message_type is FILE. | (optional) defaults to undefined
+ **createdAt** | [**number**] |  | (optional) defaults to undefined
+ **customType** | [**string**] |  | (optional) defaults to undefined
+ **data** | [**string**] |  | (optional) defaults to undefined
+ **dedupId** | [**string**] |  | (optional) defaults to undefined
+ **markAsRead** | [**boolean**] |  | (optional) defaults to undefined
+ **sendPush** | [**boolean**] |  | (optional) defaults to undefined
 
 
 ### Return type
 
-**SendbirdMessageResponse**
+**SendABotMessageResponse**
 
 ### Authorization
 
@@ -387,7 +445,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: multipart/form-data
  - **Accept**: application/json
 
 

package/MessageApi.md

@@ -630,7 +630,61 @@ let body:Sendbird.MessageApiSendAMessageRequest = {
   // string (optional)
   apiToken: "{{API_TOKEN}}",
   // SendAMessageRequest (optional)
-  sendAMessageRequest: null,
+  sendAMessageRequest: {
+    messageType: "MESG",
+    userId: "userId_example",
+    message: "message_example",
+    pushMessageTemplate: "pushMessageTemplate_example",
+    pollId: 1,
+    files: {
+      url: "url_example",
+      fileName: "fileName_example",
+      fileSize: 1,
+      fileType: "fileType_example",
+      thumbnails: [
+        {
+          height: 1,
+          plainUrl: "plainUrl_example",
+          realHeight: 1,
+          realWidth: 1,
+          url: "url_example",
+          width: 1,
+        },
+      ],
+      requireAuth: true,
+    },
+    requireAuth: true,
+    thumbnail1: "thumbnail1_example",
+    thumbnail2: "thumbnail2_example",
+    thumbnail3: "thumbnail3_example",
+    thumbnails: [
+      "thumbnails_example",
+    ],
+    apnsBundleId: "apnsBundleId_example",
+    appleCriticalAlertOptions: {},
+    createdAt: 1,
+    customType: "customType_example",
+    data: "data_example",
+    dedupId: "dedupId_example",
+    includePollDetails: true,
+    isSilent: true,
+    markAsRead: true,
+    mentionType: "users",
+    mentionedUserIds: [
+      "mentionedUserIds_example",
+    ],
+    sendPush: true,
+    sortedMetaarray: [
+      {
+        key: "key_example",
+        value: [
+          "value_example",
+        ],
+      },
+    ],
+    sound: "sound_example",
+    volume: 3.14,
+  },
 };
 
 apiInstance.sendAMessage(body).then((data:any) => {

package/README.md

@@ -3,60 +3,45 @@
 # [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";
-
+```javascript  
+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 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: {
+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",
-  },
-  apiToken: API_TOKEN,
-};
-
-const user = await userApi.createAUser(createUserParams);
-console.log("User created:\n", user);
+    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 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.
+ 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
 
@@ -67,17 +52,10 @@ In order to make requests with this SDK you will need you master API token. This
 
 You will need [Node.js](https://nodejs.org/en/download/) installed. This has been developed and tested with NodeJS 17+.
 
-# 📦 Installation
+# ⚙️ 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.
+🚨 Package not yet in npm 🚨
+```npm install sendbird-platform-sdk-typescript```
 
 # 🤓 Local Development
 
@@ -89,7 +67,7 @@ yarn add @sendbird/sendbird-platform-sdk-typescript
 
 
 # 🗃️ Documentation 
-All the documentation for this project lives in the root directory of this repo. 
+All the documentation for this project lives in the /docs directory of this repo. 
 
 ##### Helpful links
 
@@ -101,4 +79,4 @@ All the documentation for this project lives in the root directory of this repo.
 | Message | [MessageApi.md](MessageApi.md)  |
 | OpenChannel | [OpenChannelApi.md ](OpenChannelApi.md)  |
 | User | [UserApi.md](UserApi.md)  |
-
+| Moderation | [ModerationApi.md](ModerationApi.md)  |