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

package/types/ObjectParamAPI.ts

@@ -15,7 +15,6 @@ import { ChooseAPushNotificationContentTemplateResponse } from '../models/Choose
 import { CreateABotRequest } from '../models/CreateABotRequest';
 import { CreateABotResponse } from '../models/CreateABotResponse';
 import { CreateABotResponseBot } from '../models/CreateABotResponseBot';
-import { CreateABotResponseBotStyle } from '../models/CreateABotResponseBotStyle';
 import { CreateAChannelMetadataRequest } from '../models/CreateAChannelMetadataRequest';
 import { CreateAChannelMetadataResponse } from '../models/CreateAChannelMetadataResponse';
 import { CreateAGroupChannelRequest } from '../models/CreateAGroupChannelRequest';
@@ -42,7 +41,6 @@ import { LeaveMyGroupChannelsRequest } from '../models/LeaveMyGroupChannelsReque
 import { ListBlockedUsersResponse } from '../models/ListBlockedUsersResponse';
 import { ListBotsResponse } from '../models/ListBotsResponse';
 import { ListBotsResponseBotsInner } from '../models/ListBotsResponseBotsInner';
-import { ListBotsResponseBotsInnerAi } from '../models/ListBotsResponseBotsInnerAi';
 import { ListBotsResponseBotsInnerBot } from '../models/ListBotsResponseBotsInnerBot';
 import { ListBotsResponseBotsInnerBotStyle } from '../models/ListBotsResponseBotsInnerBotStyle';
 import { ListBotsResponseBotsInnerBotStyleColor } from '../models/ListBotsResponseBotsInnerBotStyleColor';
@@ -74,12 +72,14 @@ import { ScheduleAnAnnouncementRequestMessage } from '../models/ScheduleAnAnnoun
 import { ScheduleAnAnnouncementResponse } from '../models/ScheduleAnAnnouncementResponse';
 import { ScheduleAnAnnouncementResponseMessage } from '../models/ScheduleAnAnnouncementResponseMessage';
 import { SendABotMessageRequest } from '../models/SendABotMessageRequest';
+import { SendABotMessageResponse } from '../models/SendABotMessageResponse';
 import { SendAMessageRequest } from '../models/SendAMessageRequest';
+import { SendAMessageRequestPushMessageTemplate } from '../models/SendAMessageRequestPushMessageTemplate';
+import { SendAMessageRequestPushMessageTemplateOneOf } from '../models/SendAMessageRequestPushMessageTemplateOneOf';
 import { SendAdminMessageRequestBody } from '../models/SendAdminMessageRequestBody';
 import { SendFileMessageRequestBody } from '../models/SendFileMessageRequestBody';
 import { SendTextMessageRequestBody } from '../models/SendTextMessageRequestBody';
 import { SendTextMessageRequestBodyPushMessageTemplate } from '../models/SendTextMessageRequestBodyPushMessageTemplate';
-import { SendTextMessageRequestBodyPushMessageTemplateOneOf } from '../models/SendTextMessageRequestBodyPushMessageTemplateOneOf';
 import { SendbirdBasicUserInfo } from '../models/SendbirdBasicUserInfo';
 import { SendbirdDisappearingMessage } from '../models/SendbirdDisappearingMessage';
 import { SendbirdExtendedMessagePayload } from '../models/SendbirdExtendedMessagePayload';
@@ -87,8 +87,10 @@ import { SendbirdFile } from '../models/SendbirdFile';
 import { SendbirdGroupChannel } from '../models/SendbirdGroupChannel';
 import { SendbirdGroupChannelDetail } from '../models/SendbirdGroupChannelDetail';
 import { SendbirdGroupChannelDetailChannel } from '../models/SendbirdGroupChannelDetailChannel';
+import { SendbirdGroupChannelLastMessage } from '../models/SendbirdGroupChannelLastMessage';
 import { SendbirdMember } from '../models/SendbirdMember';
 import { SendbirdMessageResponse } from '../models/SendbirdMessageResponse';
+import { SendbirdMessageResponseExtendedMessagePayload } from '../models/SendbirdMessageResponseExtendedMessagePayload';
 import { SendbirdMessageResponseMessageEvents } from '../models/SendbirdMessageResponseMessageEvents';
 import { SendbirdOpenChannel } from '../models/SendbirdOpenChannel';
 import { SendbirdParentMessageInfo } from '../models/SendbirdParentMessageInfo';
@@ -104,6 +106,8 @@ import { UpdateAGroupChannelRequest } from '../models/UpdateAGroupChannelRequest
 import { UpdateAMessageRequest } from '../models/UpdateAMessageRequest';
 import { UpdateAUserRequest } from '../models/UpdateAUserRequest';
 import { UpdateAnOpenChannelRequest } from '../models/UpdateAnOpenChannelRequest';
+import { UpdateBotByIdData } from '../models/UpdateBotByIdData';
+import { UpdateBotByIdResponse } from '../models/UpdateBotByIdResponse';
 import { UpdateChannelInvitationPreferenceRequest } from '../models/UpdateChannelInvitationPreferenceRequest';
 import { UpdateChannelInvitationPreferenceResponse } from '../models/UpdateChannelInvitationPreferenceResponse';
 import { UpdateCountPreferenceOfAChannelRequest } from '../models/UpdateCountPreferenceOfAChannelRequest';
@@ -114,6 +118,8 @@ import { UpdatePushPreferencesForAChannelRequest } from '../models/UpdatePushPre
 import { UpdatePushPreferencesForAChannelResponse } from '../models/UpdatePushPreferencesForAChannelResponse';
 import { UpdatePushPreferencesRequest } from '../models/UpdatePushPreferencesRequest';
 import { UpdatePushPreferencesResponse } from '../models/UpdatePushPreferencesResponse';
+import { ViewBotByIdResponse } from '../models/ViewBotByIdResponse';
+import { ViewBotByIdResponseBot } from '../models/ViewBotByIdResponseBot';
 import { ViewCountPreferenceOfAChannelResponse } from '../models/ViewCountPreferenceOfAChannelResponse';
 import { ViewNumberOfChannelsWithUnreadMessagesResponse } from '../models/ViewNumberOfChannelsWithUnreadMessagesResponse';
 import { ViewNumberOfDailyActiveUsersResponse } from '../models/ViewNumberOfDailyActiveUsersResponse';
@@ -176,6 +182,21 @@ export interface BotApiCreateABotRequest {
     createABotRequest?: CreateABotRequest
 }
 
+export interface BotApiDeleteBotByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof BotApideleteBotById
+     */
+    botUserid: string
+    /**
+     * 
+     * @type string
+     * @memberof BotApideleteBotById
+     */
+    apiToken?: string
+}
+
 export interface BotApiJoinChannelsRequest {
     /**
      * (Required) 
@@ -261,18 +282,174 @@ export interface BotApiSendABotMessageRequest {
      * @memberof BotApisendABotMessage
      */
     botUserid: string
+    /**
+     * Specifies the type of message to send. MESG for text message, FILE for file message.
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    messageType: string
+    /**
+     * Specifies the URL of the channel to send the message to.
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    channelUrl: string
     /**
      * 
      * @type string
      * @memberof BotApisendABotMessage
      */
     apiToken?: string
+    /**
+     * Specifies the content of the message. * This property is required when message_type is MESG.
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    message?: string
+    /**
+     * * This property is available when message_type is MESG.
+     * @type Array<string>
+     * @memberof BotApisendABotMessage
+     */
+    mentioned?: Array<string>
+    /**
+     * 
+     * @type SendbirdExtendedMessagePayload
+     * @memberof BotApisendABotMessage
+     */
+    extendedMessagePayload?: SendbirdExtendedMessagePayload
+    /**
+     * 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.
+     * @type HttpFile
+     * @memberof BotApisendABotMessage
+     */
+    file?: HttpFile
+    /**
+     * 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.
+     * @type boolean
+     * @memberof BotApisendABotMessage
+     */
+    requireAuth?: boolean
+    /**
+     * * This property is available when message_type is FILE.
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    mentionType?: string
+    /**
+     * * This property is available when message_type is FILE.
+     * @type Array&lt;string&gt;
+     * @memberof BotApisendABotMessage
+     */
+    mentionedUserIds?: Array<string>
+    /**
+     * * This property is available when message_type is FILE.
+     * @type boolean
+     * @memberof BotApisendABotMessage
+     */
+    isSilent?: boolean
     /**
      * 
-     * @type SendABotMessageRequest
+     * @type Array&lt;SendbirdSortedMetaarrayInner&gt;
+     * @memberof BotApisendABotMessage
+     */
+    sortedMetaarray?: Array<SendbirdSortedMetaarrayInner>
+    /**
+     * * This property is available when message_type is FILE.
+     * @type string
      * @memberof BotApisendABotMessage
      */
-    sendABotMessageRequest?: SendABotMessageRequest
+    apnsBundleId?: string
+    /**
+     * * This property is available when message_type is FILE.
+     * @type any
+     * @memberof BotApisendABotMessage
+     */
+    appleCriticalAlertOptions?: any
+    /**
+     * * This property is available when message_type is FILE.
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    sound?: string
+    /**
+     * * This property is available when message_type is FILE.
+     * @type number
+     * @memberof BotApisendABotMessage
+     */
+    volume?: number
+    /**
+     * 
+     * @type number
+     * @memberof BotApisendABotMessage
+     */
+    createdAt?: number
+    /**
+     * 
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    customType?: string
+    /**
+     * 
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    data?: string
+    /**
+     * 
+     * @type string
+     * @memberof BotApisendABotMessage
+     */
+    dedupId?: string
+    /**
+     * 
+     * @type boolean
+     * @memberof BotApisendABotMessage
+     */
+    markAsRead?: boolean
+    /**
+     * 
+     * @type boolean
+     * @memberof BotApisendABotMessage
+     */
+    sendPush?: boolean
+}
+
+export interface BotApiUpdateBotByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof BotApiupdateBotById
+     */
+    botUserid: string
+    /**
+     * 
+     * @type string
+     * @memberof BotApiupdateBotById
+     */
+    apiToken?: string
+    /**
+     * 
+     * @type UpdateBotByIdData
+     * @memberof BotApiupdateBotById
+     */
+    updateBotByIdData?: UpdateBotByIdData
+}
+
+export interface BotApiViewBotByIdRequest {
+    /**
+     * 
+     * @type string
+     * @memberof BotApiviewBotById
+     */
+    botUserid: string
+    /**
+     * 
+     * @type string
+     * @memberof BotApiviewBotById
+     */
+    apiToken?: string
 }
 
 export class ObjectBotApi {
@@ -291,6 +468,15 @@ export class ObjectBotApi {
         return this.api.createABot(param.apiToken, param.createABotRequest,  options).toPromise();
     }
 
+    /**
+     * ## Delete a bot  Deletes a bot from an application.  https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-delete-a-bot ----------------------------
+     * Delete a bot
+     * @param param the request object
+     */
+    public deleteBotById(param: BotApiDeleteBotByIdRequest, options?: Configuration): Promise<any> {
+        return this.api.deleteBotById(param.botUserid, param.apiToken,  options).toPromise();
+    }
+
     /**
      * ## Join channels  Makes a bot join one or more group channels.  [https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/join-channels#1-join-channels](https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/join-channels#1-join-channels)
      * Join channels
@@ -332,8 +518,26 @@ export class ObjectBotApi {
      * Send a bot's message
      * @param param the request object
      */
-    public sendABotMessage(param: BotApiSendABotMessageRequest, options?: Configuration): Promise<SendbirdMessageResponse> {
-        return this.api.sendABotMessage(param.botUserid, param.apiToken, param.sendABotMessageRequest,  options).toPromise();
+    public sendABotMessage(param: BotApiSendABotMessageRequest, options?: Configuration): Promise<SendABotMessageResponse> {
+        return this.api.sendABotMessage(param.botUserid, param.messageType, param.channelUrl, param.apiToken, param.message, param.mentioned, param.extendedMessagePayload, param.file, param.requireAuth, param.mentionType, param.mentionedUserIds, param.isSilent, param.sortedMetaarray, param.apnsBundleId, param.appleCriticalAlertOptions, param.sound, param.volume, param.createdAt, param.customType, param.data, param.dedupId, param.markAsRead, param.sendPush,  options).toPromise();
+    }
+
+    /**
+     * ## Update a bot  Updates information on a bot.  https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-update-a-bot ----------------------------
+     * Update a bot
+     * @param param the request object
+     */
+    public updateBotById(param: BotApiUpdateBotByIdRequest, options?: Configuration): Promise<UpdateBotByIdResponse> {
+        return this.api.updateBotById(param.botUserid, param.apiToken, param.updateBotByIdData,  options).toPromise();
+    }
+
+    /**
+     * ## View a bot  Retrieves information on a bot.  https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-view-a-bot ----------------------------
+     * View a bot
+     * @param param the request object
+     */
+    public viewBotById(param: BotApiViewBotByIdRequest, options?: Configuration): Promise<ViewBotByIdResponse> {
+        return this.api.viewBotById(param.botUserid, param.apiToken,  options).toPromise();
     }
 
 }
@@ -1244,10 +1448,10 @@ export interface MessageApiAddExtraDataToAMessageRequest {
     channelUrl: string
     /**
      * (Required) 
-     * @type string
+     * @type number
      * @memberof MessageApiaddExtraDataToAMessage
      */
-    messageId: string
+    messageId: number
     /**
      * 
      * @type string
@@ -1277,10 +1481,10 @@ export interface MessageApiDeleteAMessageRequest {
     channelUrl: string
     /**
      * (Required) 
-     * @type string
+     * @type number
      * @memberof MessageApideleteAMessage
      */
-    messageId: string
+    messageId: number
     /**
      * 
      * @type string
@@ -1304,10 +1508,10 @@ export interface MessageApiGetAMessageRequest {
     channelUrl: string
     /**
      * (Required) 
-     * @type string
+     * @type number
      * @memberof MessageApigetAMessage
      */
-    messageId: string
+    messageId: number
     /**
      * 
      * @type boolean
@@ -1565,10 +1769,10 @@ export interface MessageApiRemoveExtraDataFromAMessageRequest {
     channelUrl: string
     /**
      * (Required) 
-     * @type string
+     * @type number
      * @memberof MessageApiremoveExtraDataFromAMessage
      */
-    messageId: string
+    messageId: number
     /**
      * 
      * @type string
@@ -1625,10 +1829,10 @@ export interface MessageApiUpdateAMessageRequest {
     channelUrl: string
     /**
      * (Required) 
-     * @type string
+     * @type number
      * @memberof MessageApiupdateAMessage
      */
-    messageId: string
+    messageId: number
     /**
      * 
      * @type string
@@ -1658,10 +1862,10 @@ export interface MessageApiUpdateExtraDataInAMessageRequest {
     channelUrl: string
     /**
      * (Required) 
-     * @type string
+     * @type number
      * @memberof MessageApiupdateExtraDataInAMessage
      */
-    messageId: string
+    messageId: number
     /**
      * 
      * @type string
@@ -2092,7 +2296,7 @@ export class ObjectModerationApi {
     }
 
     /**
-     * ## Block a user  A user can block another user if the user doesn't wish to receive any messages or notifications from the blocked user in a 1-to-1 group channel. In a 1-to-N group channel, the user can still receive messages from the blocked user, but this depends on the UI settings of the chat view. In any case, notifications from the blocked user won't be delivered to the 1-to-N group channel. You can choose whether or not the user can view [which users are blocked](https://sendbird.com/docs/chat/platform-api/v3/moderation/listing-blocked-and-blocking-users/list-blocked-and-blocking-users) in the channel UI.  Sendbird application provides two blocking options: include or exclude blocked users when sending invitations, and turn on or off notifications from blocked users. [Explicit and classic block modes](https://sendbird.com/docs/chat/platform-api/v3/deprecated#2-explicit-and-classic-block-modes) have been deprecated and are only supported for customers who started using them before they were deprecated.  - **Include or exclude blocked users when sending invitations**: Determines whether or not to automatically filter out blocked users when a user invites a group of users to a new group channel. By default, blocked users are included when sending invitations. The value of this option can be changed by Sendbird if your Sendbird application isn't integrated to the client app. If you want to change the value, [contact our sales team](https://get.sendbird.com/talk-to-sales.html).      - **Turn on or off notifications from blocked users**: Determines whether or not to receive message notifications from the blocked user in a specific 1-to-N group channel where they are both members. By default, a user doesn't receive notifications from blocked users. The value of this option can be set individually per channel. If you want to use this option, [contact our sales team](https://get.sendbird.com/talk-to-sales.html).       > **Note**: To learn more about other available moderation tools, see [Moderation Overview](https://sendbird.com/docs/chat/platform-api/v3/moderation/moderation-overview#2-actions).      The following tables explain what happens to a user's chat experience when the user blocks another user in a 1-to-1 or 1-to-N group channel. In the case of a 1-to-1 group channel, the block mode is only maintained with the original members. If other than the original members are added, the rules for 1-to-N group channel begin to apply.  [https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users#1-block-users](https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users#1-block-users)
+     * ## Block a user  A user can block another user if the user doesn't wish to receive any messages or notifications from the blocked user in a 1-to-1 group channel. In a 1-to-N group channel, the user can still receive messages from the blocked user, but this depends on the UI settings of the chat view. In any case, notifications from the blocked user won't be delivered to the 1-to-N group channel. You can choose whether or not the user can view [which users are blocked](https://sendbird.com/docs/chat/platform-api/v3/moderation/listing-blocked-and-blocking-users/list-blocked-and-blocking-users) in the channel UI.  Sendbird application provides two blocking options: include or exclude blocked users when sending invitations, and turn on or off notifications from blocked users. [Explicit and classic block modes](https://sendbird.com/docs/chat/platform-api/v3/deprecated#2-explicit-and-classic-block-modes) have been deprecated and are only supported for customers who started using them before they were deprecated.  - **Include or exclude blocked users when sending invitations**: Determines whether or not to automatically filter out blocked users when a user invites a group of users to a new group channel. By default, blocked users are included when sending invitations. The value of this option can be changed by Sendbird if your Sendbird application isn't integrated with the client app. If you want to change the value, [contact our sales team](https://get.sendbird.com/talk-to-sales.html).      - **Turn on or off notifications from blocked users**: Determines whether or not to receive message notifications from the blocked user in a specific 1-to-N group channel where they are both members. By default, a user doesn't receive notifications from blocked users. The value of this option can be set individually per channel. If you want to use this option, [contact our sales team](https://get.sendbird.com/talk-to-sales.html).  > **Note**: To learn more about other available moderation tools, see [Moderation Overview](https://sendbird.com/docs/chat/platform-api/v3/moderation/moderation-overview#2-actions).  The following tables explain what happens to a user's chat experience when the user blocks another user in a 1-to-1 or 1-to-N group channel. In the case of a 1-to-1 group channel, the block mode is only maintained with the original members. If other than the original members are added, the rules for 1-to-N group channel begin to apply.  [https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users#1-block-users](https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users#1-block-users)
      * Block a user
      * @param param the request object
      */