@sendbird/sendbird-platform-sdk-typescript 2.1.5 → 2.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG +27 -0
- package/README.md +12 -12
- package/apis/AnnouncementApi.d.ts +11 -0
- package/apis/AnnouncementApi.js +59 -0
- package/apis/AnnouncementApi.js.map +1 -0
- package/apis/BotApi.d.ts +36 -0
- package/apis/BotApi.js +434 -0
- package/apis/BotApi.js.map +1 -0
- package/apis/GroupChannelApi.d.ts +63 -0
- package/apis/GroupChannelApi.js +902 -0
- package/apis/GroupChannelApi.js.map +1 -0
- package/apis/MessageApi.d.ts +40 -0
- package/apis/MessageApi.js +567 -0
- package/apis/MessageApi.js.map +1 -0
- package/apis/MetadataApi.d.ts +18 -0
- package/apis/MetadataApi.js +191 -0
- package/apis/MetadataApi.js.map +1 -0
- package/apis/ModerationApi.d.ts +24 -0
- package/apis/ModerationApi.js +229 -0
- package/apis/ModerationApi.js.map +1 -0
- package/apis/OpenChannelApi.d.ts +29 -0
- package/apis/OpenChannelApi.js +340 -0
- package/apis/OpenChannelApi.js.map +1 -0
- package/apis/StatisticsApi.d.ts +13 -0
- package/apis/StatisticsApi.js +88 -0
- package/apis/StatisticsApi.js.map +1 -0
- package/apis/UserApi.d.ts +107 -0
- package/apis/UserApi.js +1418 -0
- package/apis/UserApi.js.map +1 -0
- package/apis/baseapi.d.ts +18 -0
- package/apis/baseapi.js +27 -0
- package/apis/baseapi.js.map +1 -0
- package/apis/exception.d.ts +10 -0
- package/apis/exception.js +14 -0
- package/apis/exception.js.map +1 -0
- package/auth/auth.d.ts +26 -0
- package/auth/auth.js +13 -0
- package/auth/auth.js.map +1 -0
- package/configuration.d.ts +18 -0
- package/configuration.js +21 -0
- package/configuration.js.map +1 -0
- package/http/http.d.ts +83 -0
- package/http/http.js +170 -0
- package/http/http.js.map +1 -0
- package/http/isomorphic-fetch.d.ts +5 -0
- package/http/isomorphic-fetch.js +34 -0
- package/http/isomorphic-fetch.js.map +1 -0
- package/index.d.ts +10 -0
- package/index.js +37 -0
- package/index.js.map +1 -0
- package/middleware.d.ts +16 -0
- package/middleware.js +17 -0
- package/middleware.js.map +1 -0
- package/models/AcceptAnInvitationRequest.d.ts +18 -0
- package/models/AcceptAnInvitationRequest.js +27 -0
- package/models/AcceptAnInvitationRequest.js.map +1 -0
- package/models/AddARegistrationOrDeviceTokenRequest.d.ts +19 -0
- package/models/AddARegistrationOrDeviceTokenRequest.js +33 -0
- package/models/AddARegistrationOrDeviceTokenRequest.js.map +1 -0
- package/models/AddARegistrationOrDeviceTokenResponse.d.ts +20 -0
- package/models/AddARegistrationOrDeviceTokenResponse.js +33 -0
- package/models/AddARegistrationOrDeviceTokenResponse.js.map +1 -0
- package/models/AddExtraDataToAMessageRequest.d.ts +18 -0
- package/models/AddExtraDataToAMessageRequest.js +21 -0
- package/models/AddExtraDataToAMessageRequest.js.map +1 -0
- package/models/AddExtraDataToAMessageResponse.d.ts +18 -0
- package/models/AddExtraDataToAMessageResponse.js +21 -0
- package/models/AddExtraDataToAMessageResponse.js.map +1 -0
- package/models/BlockAUserRequest.d.ts +18 -0
- package/models/BlockAUserRequest.js +27 -0
- package/models/BlockAUserRequest.js.map +1 -0
- package/models/BlockAUserResponse.d.ts +19 -0
- package/models/BlockAUserResponse.js +27 -0
- package/models/BlockAUserResponse.js.map +1 -0
- package/models/CheckIfMemberResponse.d.ts +19 -0
- package/models/CheckIfMemberResponse.js +27 -0
- package/models/CheckIfMemberResponse.js.map +1 -0
- package/models/ChooseAPushNotificationContentTemplateRequest.d.ts +18 -0
- package/models/ChooseAPushNotificationContentTemplateRequest.js +21 -0
- package/models/ChooseAPushNotificationContentTemplateRequest.js.map +1 -0
- package/models/ChooseAPushNotificationContentTemplateResponse.d.ts +17 -0
- package/models/ChooseAPushNotificationContentTemplateResponse.js +21 -0
- package/models/ChooseAPushNotificationContentTemplateResponse.js.map +1 -0
- package/models/CreateABotRequest.d.ts +25 -0
- package/models/CreateABotRequest.js +69 -0
- package/models/CreateABotRequest.js.map +1 -0
- package/models/CreateABotResponse.d.ts +26 -0
- package/models/CreateABotResponse.js +63 -0
- package/models/CreateABotResponse.js.map +1 -0
- package/models/CreateABotResponseBot.d.ts +25 -0
- package/models/CreateABotResponseBot.js +69 -0
- package/models/CreateABotResponseBot.js.map +1 -0
- package/models/CreateABotResponseBotStyle.d.ts +21 -0
- package/models/CreateABotResponseBotStyle.js +39 -0
- package/models/CreateABotResponseBotStyle.js.map +1 -0
- package/models/CreateAChannelMetadataRequest.d.ts +18 -0
- package/models/CreateAChannelMetadataRequest.js +27 -0
- package/models/CreateAChannelMetadataRequest.js.map +1 -0
- package/models/CreateAChannelMetadataResponse.d.ts +18 -0
- package/models/CreateAChannelMetadataResponse.js +27 -0
- package/models/CreateAChannelMetadataResponse.js.map +1 -0
- package/models/CreateAGroupChannelRequest.d.ts +37 -0
- package/models/CreateAGroupChannelRequest.js +129 -0
- package/models/CreateAGroupChannelRequest.js.map +1 -0
- package/models/CreateAUserRequest.d.ts +25 -0
- package/models/CreateAUserRequest.js +63 -0
- package/models/CreateAUserRequest.js.map +1 -0
- package/models/CreateAnOpenChannelRequest.d.ts +26 -0
- package/models/CreateAnOpenChannelRequest.js +69 -0
- package/models/CreateAnOpenChannelRequest.js.map +1 -0
- package/models/CreateUserMetadataRequest.d.ts +17 -0
- package/models/CreateUserMetadataRequest.js +21 -0
- package/models/CreateUserMetadataRequest.js.map +1 -0
- package/models/CreateUserTokenRequest.d.ts +17 -0
- package/models/CreateUserTokenRequest.js +21 -0
- package/models/CreateUserTokenRequest.js.map +1 -0
- package/models/CreateUserTokenResponse.d.ts +18 -0
- package/models/CreateUserTokenResponse.js +27 -0
- package/models/CreateUserTokenResponse.js.map +1 -0
- package/models/FreezeAGroupChannelRequest.d.ts +17 -0
- package/models/FreezeAGroupChannelRequest.js +21 -0
- package/models/FreezeAGroupChannelRequest.js.map +1 -0
- package/models/FreezeAnOpenChannelRequest.d.ts +17 -0
- package/models/FreezeAnOpenChannelRequest.js +21 -0
- package/models/FreezeAnOpenChannelRequest.js.map +1 -0
- package/models/GetAGroupChannelResponse.d.ts +75 -0
- package/models/GetAGroupChannelResponse.js +291 -0
- package/models/GetAGroupChannelResponse.js.map +1 -0
- package/models/GetAGroupChannelResponseAllOf.d.ts +18 -0
- package/models/GetAGroupChannelResponseAllOf.js +21 -0
- package/models/GetAGroupChannelResponseAllOf.js.map +1 -0
- package/models/GetAGroupChannelResponseAllOfChannel.d.ts +24 -0
- package/models/GetAGroupChannelResponseAllOfChannel.js +63 -0
- package/models/GetAGroupChannelResponseAllOfChannel.js.map +1 -0
- package/models/GetChannelInvitationPreferenceResponse.d.ts +17 -0
- package/models/GetChannelInvitationPreferenceResponse.js +21 -0
- package/models/GetChannelInvitationPreferenceResponse.js.map +1 -0
- package/models/GetTotalNumberOfMessagesInAChannelResponse.d.ts +17 -0
- package/models/GetTotalNumberOfMessagesInAChannelResponse.js +21 -0
- package/models/GetTotalNumberOfMessagesInAChannelResponse.js.map +1 -0
- package/models/GroupChannelListMembersResponse.d.ts +19 -0
- package/models/GroupChannelListMembersResponse.js +27 -0
- package/models/GroupChannelListMembersResponse.js.map +1 -0
- package/models/GroupChatListChannelsResponse.d.ts +20 -0
- package/models/GroupChatListChannelsResponse.js +33 -0
- package/models/GroupChatListChannelsResponse.js.map +1 -0
- package/models/HideAChannelRequest.d.ts +20 -0
- package/models/HideAChannelRequest.js +39 -0
- package/models/HideAChannelRequest.js.map +1 -0
- package/models/InviteAsMembersRequest.d.ts +20 -0
- package/models/InviteAsMembersRequest.js +39 -0
- package/models/InviteAsMembersRequest.js.map +1 -0
- package/models/InviteAsMembersResponse.d.ts +75 -0
- package/models/InviteAsMembersResponse.js +291 -0
- package/models/InviteAsMembersResponse.js.map +1 -0
- package/models/InviteAsMembersResponseAllOf.d.ts +18 -0
- package/models/InviteAsMembersResponseAllOf.js +21 -0
- package/models/InviteAsMembersResponseAllOf.js.map +1 -0
- package/models/JoinAChannelRequest.d.ts +18 -0
- package/models/JoinAChannelRequest.js +27 -0
- package/models/JoinAChannelRequest.js.map +1 -0
- package/models/JoinChannelsRequest.d.ts +17 -0
- package/models/JoinChannelsRequest.js +21 -0
- package/models/JoinChannelsRequest.js.map +1 -0
- package/models/LeaveAChannelRequest.d.ts +21 -0
- package/models/LeaveAChannelRequest.js +39 -0
- package/models/LeaveAChannelRequest.js.map +1 -0
- package/models/LeaveMyGroupChannelsRequest.d.ts +17 -0
- package/models/LeaveMyGroupChannelsRequest.js +21 -0
- package/models/LeaveMyGroupChannelsRequest.js.map +1 -0
- package/models/ListBlockedUsersResponse.d.ts +19 -0
- package/models/ListBlockedUsersResponse.js +27 -0
- package/models/ListBlockedUsersResponse.js.map +1 -0
- package/models/ListBotsResponse.d.ts +19 -0
- package/models/ListBotsResponse.js +27 -0
- package/models/ListBotsResponse.js.map +1 -0
- package/models/ListBotsResponseBotsInner.d.ts +30 -0
- package/models/ListBotsResponseBotsInner.js +75 -0
- package/models/ListBotsResponseBotsInner.js.map +1 -0
- package/models/ListBotsResponseBotsInnerAi.d.ts +28 -0
- package/models/ListBotsResponseBotsInnerAi.js +87 -0
- package/models/ListBotsResponseBotsInnerAi.js.map +1 -0
- package/models/ListBotsResponseBotsInnerBot.d.ts +24 -0
- package/models/ListBotsResponseBotsInnerBot.js +63 -0
- package/models/ListBotsResponseBotsInnerBot.js.map +1 -0
- package/models/ListBotsResponseBotsInnerBotStyle.d.ts +21 -0
- package/models/ListBotsResponseBotsInnerBotStyle.js +39 -0
- package/models/ListBotsResponseBotsInnerBotStyle.js.map +1 -0
- package/models/ListBotsResponseBotsInnerBotStyleColor.d.ts +19 -0
- package/models/ListBotsResponseBotsInnerBotStyleColor.js +33 -0
- package/models/ListBotsResponseBotsInnerBotStyleColor.js.map +1 -0
- package/models/ListBotsResponseBotsInnerFirstMessagesInner.d.ts +19 -0
- package/models/ListBotsResponseBotsInnerFirstMessagesInner.js +27 -0
- package/models/ListBotsResponseBotsInnerFirstMessagesInner.js.map +1 -0
- package/models/ListBotsResponseBotsInnerFirstMessagesInnerData.d.ts +17 -0
- package/models/ListBotsResponseBotsInnerFirstMessagesInnerData.js +21 -0
- package/models/ListBotsResponseBotsInnerFirstMessagesInnerData.js.map +1 -0
- package/models/ListBotsResponseBotsInnerSafeguard.d.ts +20 -0
- package/models/ListBotsResponseBotsInnerSafeguard.js +39 -0
- package/models/ListBotsResponseBotsInnerSafeguard.js.map +1 -0
- package/models/ListMessagesResponse.d.ts +18 -0
- package/models/ListMessagesResponse.js +21 -0
- package/models/ListMessagesResponse.js.map +1 -0
- package/models/ListMyGroupChannelsResponse.d.ts +20 -0
- package/models/ListMyGroupChannelsResponse.js +33 -0
- package/models/ListMyGroupChannelsResponse.js.map +1 -0
- package/models/ListOpenChannelsResponse.d.ts +20 -0
- package/models/ListOpenChannelsResponse.js +33 -0
- package/models/ListOpenChannelsResponse.js.map +1 -0
- package/models/ListOperatorsResponse.d.ts +19 -0
- package/models/ListOperatorsResponse.js +27 -0
- package/models/ListOperatorsResponse.js.map +1 -0
- package/models/ListRegistrationOrDeviceTokensResponse.d.ts +21 -0
- package/models/ListRegistrationOrDeviceTokensResponse.js +39 -0
- package/models/ListRegistrationOrDeviceTokensResponse.js.map +1 -0
- package/models/ListUsersResponse.d.ts +19 -0
- package/models/ListUsersResponse.js +27 -0
- package/models/ListUsersResponse.js.map +1 -0
- package/models/MarkAllMessagesAsReadRequest.d.ts +17 -0
- package/models/MarkAllMessagesAsReadRequest.js +21 -0
- package/models/MarkAllMessagesAsReadRequest.js.map +1 -0
- package/models/MarkChannelMessagesAsReadRequest.d.ts +17 -0
- package/models/MarkChannelMessagesAsReadRequest.js +21 -0
- package/models/MarkChannelMessagesAsReadRequest.js.map +1 -0
- package/models/MigrateMessagesAdminMessageRequest.d.ts +26 -0
- package/models/MigrateMessagesAdminMessageRequest.js +69 -0
- package/models/MigrateMessagesAdminMessageRequest.js.map +1 -0
- package/models/MigrateMessagesFileMessageRequest.d.ts +32 -0
- package/models/MigrateMessagesFileMessageRequest.js +99 -0
- package/models/MigrateMessagesFileMessageRequest.js.map +1 -0
- package/models/MigrateMessagesFileMessageRequestThumbnailsInner.d.ts +16 -0
- package/models/MigrateMessagesFileMessageRequestThumbnailsInner.js +14 -0
- package/models/MigrateMessagesFileMessageRequestThumbnailsInner.js.map +1 -0
- package/models/MigrateMessagesRequest.d.ts +20 -0
- package/models/MigrateMessagesRequest.js +33 -0
- package/models/MigrateMessagesRequest.js.map +1 -0
- package/models/MigrateMessagesRequestMessagesInner.d.ts +35 -0
- package/models/MigrateMessagesRequestMessagesInner.js +117 -0
- package/models/MigrateMessagesRequestMessagesInner.js.map +1 -0
- package/models/MigrateMessagesTextMessageRequest.d.ts +26 -0
- package/models/MigrateMessagesTextMessageRequest.js +69 -0
- package/models/MigrateMessagesTextMessageRequest.js.map +1 -0
- package/models/ObjectSerializer.d.ts +139 -0
- package/models/ObjectSerializer.js +630 -0
- package/models/ObjectSerializer.js.map +1 -0
- package/models/RegisterOperatorsToAGroupChannelRequest.d.ts +17 -0
- package/models/RegisterOperatorsToAGroupChannelRequest.js +21 -0
- package/models/RegisterOperatorsToAGroupChannelRequest.js.map +1 -0
- package/models/RemoveARegistrationOrDeviceTokenResponse.d.ts +19 -0
- package/models/RemoveARegistrationOrDeviceTokenResponse.js +27 -0
- package/models/RemoveARegistrationOrDeviceTokenResponse.js.map +1 -0
- package/models/RemoveAllRegistrationOrDeviceTokenResponse.d.ts +19 -0
- package/models/RemoveAllRegistrationOrDeviceTokenResponse.js +27 -0
- package/models/RemoveAllRegistrationOrDeviceTokenResponse.js.map +1 -0
- package/models/ResetChatHistoryRequest.d.ts +18 -0
- package/models/ResetChatHistoryRequest.js +27 -0
- package/models/ResetChatHistoryRequest.js.map +1 -0
- package/models/ResetChatHistoryResponse.d.ts +17 -0
- package/models/ResetChatHistoryResponse.js +21 -0
- package/models/ResetChatHistoryResponse.js.map +1 -0
- package/models/ScheduleAnAnnouncementRequest.d.ts +36 -0
- package/models/ScheduleAnAnnouncementRequest.js +123 -0
- package/models/ScheduleAnAnnouncementRequest.js.map +1 -0
- package/models/ScheduleAnAnnouncementRequestCreateChannelOptions.d.ts +21 -0
- package/models/ScheduleAnAnnouncementRequestCreateChannelOptions.js +45 -0
- package/models/ScheduleAnAnnouncementRequestCreateChannelOptions.js.map +1 -0
- package/models/ScheduleAnAnnouncementRequestMessage.d.ts +21 -0
- package/models/ScheduleAnAnnouncementRequestMessage.js +45 -0
- package/models/ScheduleAnAnnouncementRequestMessage.js.map +1 -0
- package/models/ScheduleAnAnnouncementResponse.d.ts +42 -0
- package/models/ScheduleAnAnnouncementResponse.js +159 -0
- package/models/ScheduleAnAnnouncementResponse.js.map +1 -0
- package/models/ScheduleAnAnnouncementResponseMessage.d.ts +22 -0
- package/models/ScheduleAnAnnouncementResponseMessage.js +51 -0
- package/models/ScheduleAnAnnouncementResponseMessage.js.map +1 -0
- package/models/SendABotMessageRequest.d.ts +42 -0
- package/models/SendABotMessageRequest.js +141 -0
- package/models/SendABotMessageRequest.js.map +1 -0
- package/models/SendABotMessageResponse.d.ts +18 -0
- package/models/SendABotMessageResponse.js +21 -0
- package/models/SendABotMessageResponse.js.map +1 -0
- package/models/SendAMessageRequest.d.ts +47 -0
- package/models/SendAMessageRequest.js +171 -0
- package/models/SendAMessageRequest.js.map +1 -0
- package/models/SendAMessageRequestPushMessageTemplate.d.ts +18 -0
- package/models/SendAMessageRequestPushMessageTemplate.js +27 -0
- package/models/SendAMessageRequestPushMessageTemplate.js.map +1 -0
- package/models/SendAMessageRequestPushMessageTemplateOneOf.d.ts +18 -0
- package/models/SendAMessageRequestPushMessageTemplateOneOf.js +27 -0
- package/models/SendAMessageRequestPushMessageTemplateOneOf.js.map +1 -0
- package/models/SendAdminMessageRequestBody.d.ts +32 -0
- package/models/SendAdminMessageRequestBody.js +87 -0
- package/models/SendAdminMessageRequestBody.js.map +1 -0
- package/models/SendFileMessageRequestBody.d.ts +41 -0
- package/models/SendFileMessageRequestBody.js +141 -0
- package/models/SendFileMessageRequestBody.js.map +1 -0
- package/models/SendTextMessageRequestBody.d.ts +39 -0
- package/models/SendTextMessageRequestBody.js +129 -0
- package/models/SendTextMessageRequestBody.js.map +1 -0
- package/models/SendTextMessageRequestBodyPushMessageTemplate.d.ts +18 -0
- package/models/SendTextMessageRequestBodyPushMessageTemplate.js +27 -0
- package/models/SendTextMessageRequestBodyPushMessageTemplate.js.map +1 -0
- package/models/SendbirdBasicUserInfo.d.ts +25 -0
- package/models/SendbirdBasicUserInfo.js +63 -0
- package/models/SendbirdBasicUserInfo.js.map +1 -0
- package/models/SendbirdDisappearingMessage.d.ts +18 -0
- package/models/SendbirdDisappearingMessage.js +27 -0
- package/models/SendbirdDisappearingMessage.js.map +1 -0
- package/models/SendbirdExtendedMessagePayload.d.ts +18 -0
- package/models/SendbirdExtendedMessagePayload.js +27 -0
- package/models/SendbirdExtendedMessagePayload.js.map +1 -0
- package/models/SendbirdFile.d.ts +23 -0
- package/models/SendbirdFile.js +51 -0
- package/models/SendbirdFile.js.map +1 -0
- package/models/SendbirdGroupChannel.d.ts +73 -0
- package/models/SendbirdGroupChannel.js +285 -0
- package/models/SendbirdGroupChannel.js.map +1 -0
- package/models/SendbirdGroupChannelDetail.d.ts +60 -0
- package/models/SendbirdGroupChannelDetail.js +213 -0
- package/models/SendbirdGroupChannelDetail.js.map +1 -0
- package/models/SendbirdGroupChannelDetailChannel.d.ts +24 -0
- package/models/SendbirdGroupChannelDetailChannel.js +63 -0
- package/models/SendbirdGroupChannelDetailChannel.js.map +1 -0
- package/models/SendbirdGroupChannelLastMessage.d.ts +53 -0
- package/models/SendbirdGroupChannelLastMessage.js +195 -0
- package/models/SendbirdGroupChannelLastMessage.js.map +1 -0
- package/models/SendbirdMember.d.ts +41 -0
- package/models/SendbirdMember.js +147 -0
- package/models/SendbirdMember.js.map +1 -0
- package/models/SendbirdMessageResponse.d.ts +53 -0
- package/models/SendbirdMessageResponse.js +195 -0
- package/models/SendbirdMessageResponse.js.map +1 -0
- package/models/SendbirdMessageResponseExtendedMessagePayload.d.ts +18 -0
- package/models/SendbirdMessageResponseExtendedMessagePayload.js +27 -0
- package/models/SendbirdMessageResponseExtendedMessagePayload.js.map +1 -0
- package/models/SendbirdMessageResponseMessageEvents.d.ts +20 -0
- package/models/SendbirdMessageResponseMessageEvents.js +39 -0
- package/models/SendbirdMessageResponseMessageEvents.js.map +1 -0
- package/models/SendbirdOpenChannel.d.ts +30 -0
- package/models/SendbirdOpenChannel.js +93 -0
- package/models/SendbirdOpenChannel.js.map +1 -0
- package/models/SendbirdParentMessageInfo.d.ts +25 -0
- package/models/SendbirdParentMessageInfo.js +57 -0
- package/models/SendbirdParentMessageInfo.js.map +1 -0
- package/models/SendbirdPushTriggerOption.d.ts +1 -0
- package/models/SendbirdPushTriggerOption.js +3 -0
- package/models/SendbirdPushTriggerOption.js.map +1 -0
- package/models/SendbirdReaction.d.ts +19 -0
- package/models/SendbirdReaction.js +33 -0
- package/models/SendbirdReaction.js.map +1 -0
- package/models/SendbirdSmsFallback.d.ts +18 -0
- package/models/SendbirdSmsFallback.js +27 -0
- package/models/SendbirdSmsFallback.js.map +1 -0
- package/models/SendbirdSortedMetaarrayInner.d.ts +18 -0
- package/models/SendbirdSortedMetaarrayInner.js +27 -0
- package/models/SendbirdSortedMetaarrayInner.js.map +1 -0
- package/models/SendbirdThumbnail.d.ts +22 -0
- package/models/SendbirdThumbnail.js +51 -0
- package/models/SendbirdThumbnail.js.map +1 -0
- package/models/SendbirdUser.d.ts +38 -0
- package/models/SendbirdUser.js +141 -0
- package/models/SendbirdUser.js.map +1 -0
- package/models/StartTypingIndicatorsRequest.d.ts +17 -0
- package/models/StartTypingIndicatorsRequest.js +21 -0
- package/models/StartTypingIndicatorsRequest.js.map +1 -0
- package/models/UpdateAChannelMetadataRequest.d.ts +18 -0
- package/models/UpdateAChannelMetadataRequest.js +27 -0
- package/models/UpdateAChannelMetadataRequest.js.map +1 -0
- package/models/UpdateAGroupChannelRequest.d.ts +27 -0
- package/models/UpdateAGroupChannelRequest.js +75 -0
- package/models/UpdateAGroupChannelRequest.js.map +1 -0
- package/models/UpdateAMessageRequest.d.ts +24 -0
- package/models/UpdateAMessageRequest.js +57 -0
- package/models/UpdateAMessageRequest.js.map +1 -0
- package/models/UpdateAUserRequest.d.ts +26 -0
- package/models/UpdateAUserRequest.js +69 -0
- package/models/UpdateAUserRequest.js.map +1 -0
- package/models/UpdateAnOpenChannelRequest.d.ts +23 -0
- package/models/UpdateAnOpenChannelRequest.js +51 -0
- package/models/UpdateAnOpenChannelRequest.js.map +1 -0
- package/models/UpdateBotByIdData.d.ts +24 -0
- package/models/UpdateBotByIdData.js +63 -0
- package/models/UpdateBotByIdData.js.map +1 -0
- package/models/UpdateBotByIdResponse.d.ts +23 -0
- package/models/UpdateBotByIdResponse.js +51 -0
- package/models/UpdateBotByIdResponse.js.map +1 -0
- package/models/UpdateChannelInvitationPreferenceRequest.d.ts +17 -0
- package/models/UpdateChannelInvitationPreferenceRequest.js +21 -0
- package/models/UpdateChannelInvitationPreferenceRequest.js.map +1 -0
- package/models/UpdateChannelInvitationPreferenceResponse.d.ts +17 -0
- package/models/UpdateChannelInvitationPreferenceResponse.js +21 -0
- package/models/UpdateChannelInvitationPreferenceResponse.js.map +1 -0
- package/models/UpdateCountPreferenceOfAChannelRequest.d.ts +18 -0
- package/models/UpdateCountPreferenceOfAChannelRequest.js +21 -0
- package/models/UpdateCountPreferenceOfAChannelRequest.js.map +1 -0
- package/models/UpdateCountPreferenceOfChannelByUrlResponse.d.ts +18 -0
- package/models/UpdateCountPreferenceOfChannelByUrlResponse.js +21 -0
- package/models/UpdateCountPreferenceOfChannelByUrlResponse.js.map +1 -0
- package/models/UpdateExtraDataInAMessageRequest.d.ts +20 -0
- package/models/UpdateExtraDataInAMessageRequest.js +33 -0
- package/models/UpdateExtraDataInAMessageRequest.js.map +1 -0
- package/models/UpdateExtraDataInAMessageResponse.d.ts +18 -0
- package/models/UpdateExtraDataInAMessageResponse.js +21 -0
- package/models/UpdateExtraDataInAMessageResponse.js.map +1 -0
- package/models/UpdatePushPreferencesForAChannelRequest.d.ts +19 -0
- package/models/UpdatePushPreferencesForAChannelRequest.js +27 -0
- package/models/UpdatePushPreferencesForAChannelRequest.js.map +1 -0
- package/models/UpdatePushPreferencesForAChannelResponse.d.ts +20 -0
- package/models/UpdatePushPreferencesForAChannelResponse.js +33 -0
- package/models/UpdatePushPreferencesForAChannelResponse.js.map +1 -0
- package/models/UpdatePushPreferencesRequest.d.ts +33 -0
- package/models/UpdatePushPreferencesRequest.js +105 -0
- package/models/UpdatePushPreferencesRequest.js.map +1 -0
- package/models/UpdatePushPreferencesRequestDndSchedulesInner.d.ts +20 -0
- package/models/UpdatePushPreferencesRequestDndSchedulesInner.js +27 -0
- package/models/UpdatePushPreferencesRequestDndSchedulesInner.js.map +1 -0
- package/models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.d.ts +20 -0
- package/models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.js +39 -0
- package/models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.js.map +1 -0
- package/models/UpdatePushPreferencesResponse.d.ts +33 -0
- package/models/UpdatePushPreferencesResponse.js +105 -0
- package/models/UpdatePushPreferencesResponse.js.map +1 -0
- package/models/UpdateSpecificUserMetadataRequest.d.ts +17 -0
- package/models/UpdateSpecificUserMetadataRequest.js +21 -0
- package/models/UpdateSpecificUserMetadataRequest.js.map +1 -0
- package/models/UpdateUserMetadataRequest.d.ts +18 -0
- package/models/UpdateUserMetadataRequest.js +27 -0
- package/models/UpdateUserMetadataRequest.js.map +1 -0
- package/models/ViewBotByIdResponse.d.ts +23 -0
- package/models/ViewBotByIdResponse.js +51 -0
- package/models/ViewBotByIdResponse.js.map +1 -0
- package/models/ViewBotByIdResponseBot.d.ts +22 -0
- package/models/ViewBotByIdResponseBot.js +51 -0
- package/models/ViewBotByIdResponseBot.js.map +1 -0
- package/models/ViewCountPreferenceOfAChannelResponse.d.ts +18 -0
- package/models/ViewCountPreferenceOfAChannelResponse.js +21 -0
- package/models/ViewCountPreferenceOfAChannelResponse.js.map +1 -0
- package/models/ViewNumberOfChannelsWithUnreadMessagesResponse.d.ts +17 -0
- package/models/ViewNumberOfChannelsWithUnreadMessagesResponse.js +21 -0
- package/models/ViewNumberOfChannelsWithUnreadMessagesResponse.js.map +1 -0
- package/models/ViewNumberOfDailyActiveUsersResponse.d.ts +17 -0
- package/models/ViewNumberOfDailyActiveUsersResponse.js +21 -0
- package/models/ViewNumberOfDailyActiveUsersResponse.js.map +1 -0
- package/models/ViewNumberOfMonthlyActiveUsersResponse.d.ts +17 -0
- package/models/ViewNumberOfMonthlyActiveUsersResponse.js +21 -0
- package/models/ViewNumberOfMonthlyActiveUsersResponse.js.map +1 -0
- package/models/ViewNumberOfUnreadMessagesResponse.d.ts +17 -0
- package/models/ViewNumberOfUnreadMessagesResponse.js +21 -0
- package/models/ViewNumberOfUnreadMessagesResponse.js.map +1 -0
- package/models/ViewPushPreferencesForAChannelResponse.d.ts +20 -0
- package/models/ViewPushPreferencesForAChannelResponse.js +33 -0
- package/models/ViewPushPreferencesForAChannelResponse.js.map +1 -0
- package/models/ViewPushPreferencesResponse.d.ts +33 -0
- package/models/ViewPushPreferencesResponse.js +105 -0
- package/models/ViewPushPreferencesResponse.js.map +1 -0
- package/models/all.d.ts +130 -0
- package/models/all.js +147 -0
- package/models/all.js.map +1 -0
- package/package.json +28 -32
- package/rxjsStub.d.ts +10 -0
- package/rxjsStub.js +32 -0
- package/rxjsStub.js.map +1 -0
- package/servers.d.ts +21 -0
- package/servers.js +31 -0
- package/servers.js.map +1 -0
- package/types/ObjectParamAPI.d.ts +853 -0
- package/types/ObjectParamAPI.js +343 -0
- package/types/ObjectParamAPI.js.map +1 -0
- package/types/ObservableAPI.d.ts +246 -0
- package/types/ObservableAPI.js +1467 -0
- package/types/ObservableAPI.js.map +1 -0
- package/types/PromiseAPI.d.ts +227 -0
- package/types/PromiseAPI.js +435 -0
- package/types/PromiseAPI.js.map +1 -0
- package/util.d.ts +2 -0
- package/util.js +29 -0
- package/util.js.map +1 -0
- package/.gitattributes +0 -8
- package/.openapi-generator/FILES +0 -156
- package/.openapi-generator/VERSION +0 -1
- package/AnnouncementApi.md +0 -100
- package/BotApi.md +0 -459
- package/GroupChannelApi.md +0 -1429
- package/MessageApi.md +0 -880
- package/MetadataApi.md +0 -274
- package/ModerationApi.md +0 -338
- package/OpenChannelApi.md +0 -540
- package/StatisticsApi.md +0 -125
- package/UserApi.md +0 -1868
- package/apis/AnnouncementApi.ts +0 -96
- package/apis/BotApi.ts +0 -832
- package/apis/GroupChannelApi.ts +0 -1865
- package/apis/MessageApi.ts +0 -1150
- package/apis/MetadataApi.ts +0 -365
- package/apis/ModerationApi.ts +0 -449
- package/apis/OpenChannelApi.ts +0 -676
- package/apis/StatisticsApi.ts +0 -155
- package/apis/UserApi.ts +0 -2916
- package/apis/baseapi.ts +0 -37
- package/apis/exception.ts +0 -15
- package/auth/auth.ts +0 -54
- package/catalog-info.yaml +0 -12
- package/configuration.ts +0 -66
- package/git_push.sh +0 -51
- package/http/http.ts +0 -231
- package/http/isomorphic-fetch.ts +0 -32
- package/index.ts +0 -12
- package/jest.config.ts +0 -11
- package/jest.setup.ts +0 -5
- package/middleware.ts +0 -66
- package/models/AcceptAnInvitationRequest.ts +0 -42
- package/models/AddARegistrationOrDeviceTokenRequest.ts +0 -49
- package/models/AddARegistrationOrDeviceTokenResponse.ts +0 -50
- package/models/AddExtraDataToAMessageRequest.ts +0 -36
- package/models/AddExtraDataToAMessageResponse.ts +0 -36
- package/models/BlockAUserRequest.ts +0 -45
- package/models/BlockAUserResponse.ts +0 -43
- package/models/CheckIfMemberResponse.ts +0 -45
- package/models/ChooseAPushNotificationContentTemplateRequest.ts +0 -41
- package/models/ChooseAPushNotificationContentTemplateResponse.ts +0 -35
- package/models/CreateABotRequest.ts +0 -100
- package/models/CreateABotResponse.ts +0 -86
- package/models/CreateABotResponseBot.ts +0 -91
- package/models/CreateABotResponseBotStyle.ts +0 -57
- package/models/CreateAChannelMetadataRequest.ts +0 -42
- package/models/CreateAChannelMetadataResponse.ts +0 -42
- package/models/CreateAGroupChannelRequest.ts +0 -171
- package/models/CreateAUserRequest.ts +0 -80
- package/models/CreateAnOpenChannelRequest.ts +0 -91
- package/models/CreateUserMetadataRequest.ts +0 -35
- package/models/CreateUserTokenRequest.ts +0 -35
- package/models/CreateUserTokenResponse.ts +0 -42
- package/models/FreezeAGroupChannelRequest.ts +0 -35
- package/models/FreezeAnOpenChannelRequest.ts +0 -38
- package/models/GetAGroupChannelResponse.ts +0 -365
- package/models/GetAGroupChannelResponseAllOf.ts +0 -36
- package/models/GetAGroupChannelResponseAllOfChannel.ts +0 -84
- package/models/GetChannelInvitationPreferenceResponse.ts +0 -35
- package/models/GetTotalNumberOfMessagesInAChannelResponse.ts +0 -35
- package/models/GroupChannelListMembersResponse.ts +0 -43
- package/models/GroupChatListChannelsResponse.ts +0 -50
- package/models/HideAChannelRequest.ts +0 -68
- package/models/InviteAsMembersRequest.ts +0 -62
- package/models/InviteAsMembersResponse.ts +0 -365
- package/models/InviteAsMembersResponseAllOf.ts +0 -36
- package/models/JoinAChannelRequest.ts +0 -48
- package/models/JoinChannelsRequest.ts +0 -35
- package/models/LeaveAChannelRequest.ts +0 -71
- package/models/LeaveMyGroupChannelsRequest.ts +0 -35
- package/models/ListBlockedUsersResponse.ts +0 -43
- package/models/ListBotsResponse.ts +0 -43
- package/models/ListBotsResponseBotsInner.ts +0 -102
- package/models/ListBotsResponseBotsInnerAi.ts +0 -112
- package/models/ListBotsResponseBotsInnerBot.ts +0 -84
- package/models/ListBotsResponseBotsInnerBotStyle.ts +0 -57
- package/models/ListBotsResponseBotsInnerBotStyleColor.ts +0 -49
- package/models/ListBotsResponseBotsInnerFirstMessagesInner.ts +0 -43
- package/models/ListBotsResponseBotsInnerFirstMessagesInnerData.ts +0 -35
- package/models/ListBotsResponseBotsInnerSafeguard.ts +0 -56
- package/models/ListMessagesResponse.ts +0 -36
- package/models/ListMyGroupChannelsResponse.ts +0 -50
- package/models/ListOpenChannelsResponse.ts +0 -50
- package/models/ListOperatorsResponse.ts +0 -43
- package/models/ListRegistrationOrDeviceTokensResponse.ts +0 -57
- package/models/ListUsersResponse.ts +0 -43
- package/models/MarkAllMessagesAsReadRequest.ts +0 -38
- package/models/MarkChannelMessagesAsReadRequest.ts +0 -35
- package/models/MigrateMessagesAdminMessageRequest.ts +0 -94
- package/models/MigrateMessagesFileMessageRequest.ts +0 -130
- package/models/MigrateMessagesFileMessageRequestThumbnailsInner.ts +0 -29
- package/models/MigrateMessagesRequest.ts +0 -50
- package/models/MigrateMessagesRequestMessagesInner.ts +0 -154
- package/models/MigrateMessagesTextMessageRequest.ts +0 -94
- package/models/ObjectSerializer.ts +0 -647
- package/models/RegisterOperatorsToAGroupChannelRequest.ts +0 -35
- package/models/RemoveARegistrationOrDeviceTokenResponse.ts +0 -43
- package/models/RemoveAllRegistrationOrDeviceTokenResponse.ts +0 -43
- package/models/ResetChatHistoryRequest.ts +0 -42
- package/models/ResetChatHistoryResponse.ts +0 -38
- package/models/ScheduleAnAnnouncementRequest.ts +0 -156
- package/models/ScheduleAnAnnouncementRequestCreateChannelOptions.ts +0 -63
- package/models/ScheduleAnAnnouncementRequestMessage.ts +0 -63
- package/models/ScheduleAnAnnouncementResponse.ts +0 -198
- package/models/ScheduleAnAnnouncementResponseMessage.ts +0 -70
- package/models/SendABotMessageRequest.ts +0 -220
- package/models/SendABotMessageResponse.ts +0 -36
- package/models/SendAMessageRequest.ts +0 -238
- package/models/SendAMessageRequestPushMessageTemplate.ts +0 -52
- package/models/SendAMessageRequestPushMessageTemplateOneOf.ts +0 -48
- package/models/SendAdminMessageRequestBody.ts +0 -121
- package/models/SendBirdFile.ts +0 -71
- package/models/SendBirdGroupChannel.ts +0 -355
- package/models/SendBirdMember.ts +0 -187
- package/models/SendBirdMessageResponse.ts +0 -245
- package/models/SendBirdParentMessageInfo.ts +0 -79
- package/models/SendBirdUser.ts +0 -181
- package/models/SendFileMessageRequestBody.ts +0 -187
- package/models/SendTextMessageRequestBody.ts +0 -170
- package/models/SendTextMessageRequestBodyPushMessageTemplate.ts +0 -52
- package/models/SendbirdBasicUserInfo.ts +0 -87
- package/models/SendbirdDisappearingMessage.ts +0 -42
- package/models/SendbirdExtendedMessagePayload.ts +0 -51
- package/models/SendbirdGroupChannelDetail.ts +0 -266
- package/models/SendbirdGroupChannelDetailChannel.ts +0 -84
- package/models/SendbirdGroupChannelLastMessage.ts +0 -246
- package/models/SendbirdMessageResponseExtendedMessagePayload.ts +0 -49
- package/models/SendbirdMessageResponseMessageEvents.ts +0 -56
- package/models/SendbirdOpenChannel.ts +0 -120
- package/models/SendbirdPushTriggerOption.ts +0 -15
- package/models/SendbirdReaction.ts +0 -49
- package/models/SendbirdSmsFallback.ts +0 -42
- package/models/SendbirdSortedMetaarrayInner.ts +0 -42
- package/models/SendbirdThumbnail.ts +0 -70
- package/models/StartTypingIndicatorsRequest.ts +0 -35
- package/models/UpdateAChannelMetadataRequest.ts +0 -42
- package/models/UpdateAGroupChannelRequest.ts +0 -98
- package/models/UpdateAMessageRequest.ts +0 -80
- package/models/UpdateAUserRequest.ts +0 -91
- package/models/UpdateAnOpenChannelRequest.ts +0 -70
- package/models/UpdateBotByIdData.ts +0 -108
- package/models/UpdateBotByIdResponse.ts +0 -71
- package/models/UpdateChannelInvitationPreferenceRequest.ts +0 -35
- package/models/UpdateChannelInvitationPreferenceResponse.ts +0 -35
- package/models/UpdateCountPreferenceOfAChannelRequest.ts +0 -38
- package/models/UpdateCountPreferenceOfChannelByUrlResponse.ts +0 -38
- package/models/UpdateExtraDataInAMessageRequest.ts +0 -50
- package/models/UpdateExtraDataInAMessageResponse.ts +0 -36
- package/models/UpdatePushPreferencesForAChannelRequest.ts +0 -48
- package/models/UpdatePushPreferencesForAChannelResponse.ts +0 -50
- package/models/UpdatePushPreferencesRequest.ts +0 -135
- package/models/UpdatePushPreferencesRequestDndSchedulesInner.ts +0 -46
- package/models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.ts +0 -56
- package/models/UpdatePushPreferencesResponse.ts +0 -135
- package/models/UpdateSpecificUserMetadataRequest.ts +0 -35
- package/models/UpdateUserMetadataRequest.ts +0 -42
- package/models/ViewBotByIdResponse.ts +0 -71
- package/models/ViewBotByIdResponseBot.ts +0 -70
- package/models/ViewCountPreferenceOfAChannelResponse.ts +0 -38
- package/models/ViewNumberOfChannelsWithUnreadMessagesResponse.ts +0 -35
- package/models/ViewNumberOfDailyActiveUsersResponse.ts +0 -35
- package/models/ViewNumberOfMonthlyActiveUsersResponse.ts +0 -35
- package/models/ViewNumberOfUnreadMessagesResponse.ts +0 -35
- package/models/ViewPushPreferencesForAChannelResponse.ts +0 -50
- package/models/ViewPushPreferencesResponse.ts +0 -135
- package/models/all.ts +0 -130
- package/package.json-e +0 -40
- package/rxjsStub.ts +0 -27
- package/servers.ts +0 -53
- package/src/api/generated/.openapi-generator/FILES +0 -151
- package/src/api/generated/.openapi-generator/VERSION +0 -1
- package/src/api/generated/README.md +0 -30
- package/src/api/generated/apis/AnnouncementApi.ts +0 -96
- package/src/api/generated/apis/BotApi.ts +0 -471
- package/src/api/generated/apis/GroupChannelApi.ts +0 -1865
- package/src/api/generated/apis/MessageApi.ts +0 -1150
- package/src/api/generated/apis/MetadataApi.ts +0 -365
- package/src/api/generated/apis/ModerationApi.ts +0 -449
- package/src/api/generated/apis/OpenChannelApi.ts +0 -676
- package/src/api/generated/apis/StatisticsApi.ts +0 -155
- package/src/api/generated/apis/UserApi.ts +0 -2454
- package/src/api/generated/apis/baseapi.ts +0 -37
- package/src/api/generated/apis/exception.ts +0 -15
- package/src/api/generated/auth/auth.ts +0 -54
- package/src/api/generated/configuration.ts +0 -66
- package/src/api/generated/git_push.sh +0 -51
- package/src/api/generated/http/http.ts +0 -231
- package/src/api/generated/http/isomorphic-fetch.ts +0 -32
- package/src/api/generated/index.ts +0 -12
- package/src/api/generated/middleware.ts +0 -66
- package/src/api/generated/models/AcceptAnInvitationRequest.ts +0 -42
- package/src/api/generated/models/AddARegistrationOrDeviceTokenRequest.ts +0 -49
- package/src/api/generated/models/AddARegistrationOrDeviceTokenResponse.ts +0 -50
- package/src/api/generated/models/AddExtraDataToAMessageRequest.ts +0 -36
- package/src/api/generated/models/AddExtraDataToAMessageResponse.ts +0 -36
- package/src/api/generated/models/BlockAUserRequest.ts +0 -45
- package/src/api/generated/models/BlockAUserResponse.ts +0 -43
- package/src/api/generated/models/CheckIfMemberResponse.ts +0 -45
- package/src/api/generated/models/ChooseAPushNotificationContentTemplateRequest.ts +0 -41
- package/src/api/generated/models/ChooseAPushNotificationContentTemplateResponse.ts +0 -35
- package/src/api/generated/models/CreateABotRequest.ts +0 -100
- package/src/api/generated/models/CreateABotResponse.ts +0 -86
- package/src/api/generated/models/CreateABotResponseBot.ts +0 -91
- package/src/api/generated/models/CreateABotResponseBotStyle.ts +0 -57
- package/src/api/generated/models/CreateAChannelMetadataRequest.ts +0 -42
- package/src/api/generated/models/CreateAChannelMetadataResponse.ts +0 -42
- package/src/api/generated/models/CreateAGroupChannelRequest.ts +0 -171
- package/src/api/generated/models/CreateAUserRequest.ts +0 -80
- package/src/api/generated/models/CreateAnOpenChannelRequest.ts +0 -91
- package/src/api/generated/models/CreateUserTokenRequest.ts +0 -35
- package/src/api/generated/models/CreateUserTokenResponse.ts +0 -42
- package/src/api/generated/models/FreezeAGroupChannelRequest.ts +0 -35
- package/src/api/generated/models/FreezeAnOpenChannelRequest.ts +0 -38
- package/src/api/generated/models/GetAGroupChannelResponse.ts +0 -365
- package/src/api/generated/models/GetAGroupChannelResponseAllOf.ts +0 -36
- package/src/api/generated/models/GetAGroupChannelResponseAllOfChannel.ts +0 -84
- package/src/api/generated/models/GetChannelInvitationPreferenceResponse.ts +0 -35
- package/src/api/generated/models/GetTotalNumberOfMessagesInAChannelResponse.ts +0 -35
- package/src/api/generated/models/GroupChannelListMembersResponse.ts +0 -43
- package/src/api/generated/models/GroupChatListChannelsResponse.ts +0 -50
- package/src/api/generated/models/HideAChannelRequest.ts +0 -68
- package/src/api/generated/models/InviteAsMembersRequest.ts +0 -62
- package/src/api/generated/models/InviteAsMembersResponse.ts +0 -365
- package/src/api/generated/models/InviteAsMembersResponseAllOf.ts +0 -36
- package/src/api/generated/models/JoinAChannelRequest.ts +0 -48
- package/src/api/generated/models/JoinChannelsRequest.ts +0 -35
- package/src/api/generated/models/LeaveAChannelRequest.ts +0 -71
- package/src/api/generated/models/LeaveMyGroupChannelsRequest.ts +0 -35
- package/src/api/generated/models/ListBlockedUsersResponse.ts +0 -43
- package/src/api/generated/models/ListBotsResponse.ts +0 -43
- package/src/api/generated/models/ListBotsResponseBotsInner.ts +0 -110
- package/src/api/generated/models/ListBotsResponseBotsInnerAi.ts +0 -112
- package/src/api/generated/models/ListBotsResponseBotsInnerBot.ts +0 -84
- package/src/api/generated/models/ListBotsResponseBotsInnerBotStyle.ts +0 -57
- package/src/api/generated/models/ListBotsResponseBotsInnerBotStyleColor.ts +0 -49
- package/src/api/generated/models/ListBotsResponseBotsInnerFirstMessagesInner.ts +0 -43
- package/src/api/generated/models/ListBotsResponseBotsInnerFirstMessagesInnerData.ts +0 -35
- package/src/api/generated/models/ListBotsResponseBotsInnerSafeguard.ts +0 -56
- package/src/api/generated/models/ListMessagesResponse.ts +0 -36
- package/src/api/generated/models/ListMyGroupChannelsResponse.ts +0 -50
- package/src/api/generated/models/ListOpenChannelsResponse.ts +0 -50
- package/src/api/generated/models/ListOperatorsResponse.ts +0 -43
- package/src/api/generated/models/ListRegistrationOrDeviceTokensResponse.ts +0 -57
- package/src/api/generated/models/ListUsersResponse.ts +0 -43
- package/src/api/generated/models/MarkAllMessagesAsReadRequest.ts +0 -38
- package/src/api/generated/models/MarkChannelMessagesAsReadRequest.ts +0 -35
- package/src/api/generated/models/MigrateMessagesAdminMessageRequest.ts +0 -94
- package/src/api/generated/models/MigrateMessagesFileMessageRequest.ts +0 -130
- package/src/api/generated/models/MigrateMessagesFileMessageRequestThumbnailsInner.ts +0 -29
- package/src/api/generated/models/MigrateMessagesRequest.ts +0 -50
- package/src/api/generated/models/MigrateMessagesRequestMessagesInner.ts +0 -154
- package/src/api/generated/models/MigrateMessagesTextMessageRequest.ts +0 -94
- package/src/api/generated/models/ObjectSerializer.ts +0 -619
- package/src/api/generated/models/RegisterOperatorsToAGroupChannelRequest.ts +0 -35
- package/src/api/generated/models/RemoveARegistrationOrDeviceTokenResponse.ts +0 -43
- package/src/api/generated/models/RemoveAllRegistrationOrDeviceTokenResponse.ts +0 -43
- package/src/api/generated/models/ResetChatHistoryRequest.ts +0 -42
- package/src/api/generated/models/ResetChatHistoryResponse.ts +0 -38
- package/src/api/generated/models/ScheduleAnAnnouncementRequest.ts +0 -156
- package/src/api/generated/models/ScheduleAnAnnouncementRequestCreateChannelOptions.ts +0 -63
- package/src/api/generated/models/ScheduleAnAnnouncementRequestMessage.ts +0 -63
- package/src/api/generated/models/ScheduleAnAnnouncementResponse.ts +0 -198
- package/src/api/generated/models/ScheduleAnAnnouncementResponseMessage.ts +0 -70
- package/src/api/generated/models/SendABotMessageRequest.ts +0 -214
- package/src/api/generated/models/SendABotMessageResponse.ts +0 -36
- package/src/api/generated/models/SendAMessageRequest.ts +0 -238
- package/src/api/generated/models/SendAMessageRequestPushMessageTemplate.ts +0 -52
- package/src/api/generated/models/SendAMessageRequestPushMessageTemplateOneOf.ts +0 -48
- package/src/api/generated/models/SendAdminMessageRequestBody.ts +0 -121
- package/src/api/generated/models/SendFileMessageRequestBody.ts +0 -187
- package/src/api/generated/models/SendTextMessageRequestBody.ts +0 -170
- package/src/api/generated/models/SendTextMessageRequestBodyPushMessageTemplate.ts +0 -52
- package/src/api/generated/models/SendbirdBasicUserInfo.ts +0 -87
- package/src/api/generated/models/SendbirdDisappearingMessage.ts +0 -42
- package/src/api/generated/models/SendbirdExtendedMessagePayload.ts +0 -51
- package/src/api/generated/models/SendbirdFile.ts +0 -71
- package/src/api/generated/models/SendbirdGroupChannel.ts +0 -355
- package/src/api/generated/models/SendbirdGroupChannelDetail.ts +0 -266
- package/src/api/generated/models/SendbirdGroupChannelDetailChannel.ts +0 -84
- package/src/api/generated/models/SendbirdMember.ts +0 -187
- package/src/api/generated/models/SendbirdMessageResponse.ts +0 -245
- package/src/api/generated/models/SendbirdMessageResponseMessageEvents.ts +0 -56
- package/src/api/generated/models/SendbirdOpenChannel.ts +0 -120
- package/src/api/generated/models/SendbirdParentMessageInfo.ts +0 -79
- package/src/api/generated/models/SendbirdPushTriggerOption.ts +0 -15
- package/src/api/generated/models/SendbirdReaction.ts +0 -49
- package/src/api/generated/models/SendbirdSmsFallback.ts +0 -42
- package/src/api/generated/models/SendbirdSortedMetaarrayInner.ts +0 -42
- package/src/api/generated/models/SendbirdThumbnail.ts +0 -70
- package/src/api/generated/models/SendbirdUser.ts +0 -188
- package/src/api/generated/models/StartTypingIndicatorsRequest.ts +0 -35
- package/src/api/generated/models/UpdateAChannelMetadataRequest.ts +0 -42
- package/src/api/generated/models/UpdateAGroupChannelRequest.ts +0 -98
- package/src/api/generated/models/UpdateAMessageRequest.ts +0 -80
- package/src/api/generated/models/UpdateAUserRequest.ts +0 -91
- package/src/api/generated/models/UpdateAnOpenChannelRequest.ts +0 -70
- package/src/api/generated/models/UpdateChannelInvitationPreferenceRequest.ts +0 -35
- package/src/api/generated/models/UpdateChannelInvitationPreferenceResponse.ts +0 -35
- package/src/api/generated/models/UpdateCountPreferenceOfAChannelRequest.ts +0 -38
- package/src/api/generated/models/UpdateCountPreferenceOfChannelByUrlResponse.ts +0 -38
- package/src/api/generated/models/UpdateExtraDataInAMessageRequest.ts +0 -50
- package/src/api/generated/models/UpdateExtraDataInAMessageResponse.ts +0 -36
- package/src/api/generated/models/UpdatePushPreferencesForAChannelRequest.ts +0 -48
- package/src/api/generated/models/UpdatePushPreferencesForAChannelResponse.ts +0 -50
- package/src/api/generated/models/UpdatePushPreferencesRequest.ts +0 -127
- package/src/api/generated/models/UpdatePushPreferencesResponse.ts +0 -127
- package/src/api/generated/models/ViewCountPreferenceOfAChannelResponse.ts +0 -38
- package/src/api/generated/models/ViewNumberOfChannelsWithUnreadMessagesResponse.ts +0 -35
- package/src/api/generated/models/ViewNumberOfDailyActiveUsersResponse.ts +0 -35
- package/src/api/generated/models/ViewNumberOfMonthlyActiveUsersResponse.ts +0 -35
- package/src/api/generated/models/ViewNumberOfUnreadMessagesResponse.ts +0 -35
- package/src/api/generated/models/ViewPushPreferencesForAChannelResponse.ts +0 -50
- package/src/api/generated/models/ViewPushPreferencesResponse.ts +0 -127
- package/src/api/generated/models/all.ts +0 -121
- package/src/api/generated/package.json +0 -40
- package/src/api/generated/rxjsStub.ts +0 -27
- package/src/api/generated/servers.ts +0 -53
- package/src/api/generated/tsconfig.json +0 -28
- package/src/api/generated/types/ObjectParamAPI.ts +0 -3611
- package/src/api/generated/types/ObservableAPI.ts +0 -2594
- package/src/api/generated/types/PromiseAPI.ts +0 -1440
- package/src/api/generated/util.ts +0 -37
- package/src/types/FileCompat.ts +0 -7
- package/tests/asset/image/test_20kb.jpg +0 -0
- package/tests/asset/image/test_25mb.bmp +0 -0
- package/tests/asset/image/test_5mb.jpg +0 -0
- package/tests/asset/image/test_75kb.jpg +0 -0
- package/tests/integration/bot.test.ts +0 -548
- package/tests/integration/constants.ts +0 -10
- package/tests/integration/groupChannel.test.ts +0 -1624
- package/tests/integration/helper.ts +0 -8
- package/tests/integration/metadata.test.ts +0 -22
- package/tests/integration/moderation.test.ts +0 -172
- package/tests/integration/openChannel.test.ts +0 -239
- package/tests/integration/statistics.test.ts +0 -44
- package/tests/integration/user.test.ts +0 -957
- package/tests/utils/fileLoader.ts +0 -46
- package/tsconfig.json +0 -29
- package/types/ObjectParamAPI.ts +0 -3998
- package/types/ObservableAPI.ts +0 -2855
- package/types/PromiseAPI.ts +0 -1575
- package/util.ts +0 -37
|
@@ -1,1440 +0,0 @@
|
|
|
1
|
-
import { ResponseContext, RequestContext, HttpFile } from '../http/http';
|
|
2
|
-
import * as models from '../models/all';
|
|
3
|
-
import { Configuration} from '../configuration'
|
|
4
|
-
|
|
5
|
-
import { AcceptAnInvitationRequest } from '../models/AcceptAnInvitationRequest';
|
|
6
|
-
import { AddARegistrationOrDeviceTokenRequest } from '../models/AddARegistrationOrDeviceTokenRequest';
|
|
7
|
-
import { AddARegistrationOrDeviceTokenResponse } from '../models/AddARegistrationOrDeviceTokenResponse';
|
|
8
|
-
import { AddExtraDataToAMessageRequest } from '../models/AddExtraDataToAMessageRequest';
|
|
9
|
-
import { AddExtraDataToAMessageResponse } from '../models/AddExtraDataToAMessageResponse';
|
|
10
|
-
import { BlockAUserRequest } from '../models/BlockAUserRequest';
|
|
11
|
-
import { BlockAUserResponse } from '../models/BlockAUserResponse';
|
|
12
|
-
import { CheckIfMemberResponse } from '../models/CheckIfMemberResponse';
|
|
13
|
-
import { ChooseAPushNotificationContentTemplateRequest } from '../models/ChooseAPushNotificationContentTemplateRequest';
|
|
14
|
-
import { ChooseAPushNotificationContentTemplateResponse } from '../models/ChooseAPushNotificationContentTemplateResponse';
|
|
15
|
-
import { CreateABotRequest } from '../models/CreateABotRequest';
|
|
16
|
-
import { CreateABotResponse } from '../models/CreateABotResponse';
|
|
17
|
-
import { CreateABotResponseBot } from '../models/CreateABotResponseBot';
|
|
18
|
-
import { CreateABotResponseBotStyle } from '../models/CreateABotResponseBotStyle';
|
|
19
|
-
import { CreateAChannelMetadataRequest } from '../models/CreateAChannelMetadataRequest';
|
|
20
|
-
import { CreateAChannelMetadataResponse } from '../models/CreateAChannelMetadataResponse';
|
|
21
|
-
import { CreateAGroupChannelRequest } from '../models/CreateAGroupChannelRequest';
|
|
22
|
-
import { CreateAUserRequest } from '../models/CreateAUserRequest';
|
|
23
|
-
import { CreateAnOpenChannelRequest } from '../models/CreateAnOpenChannelRequest';
|
|
24
|
-
import { CreateUserTokenRequest } from '../models/CreateUserTokenRequest';
|
|
25
|
-
import { CreateUserTokenResponse } from '../models/CreateUserTokenResponse';
|
|
26
|
-
import { FreezeAGroupChannelRequest } from '../models/FreezeAGroupChannelRequest';
|
|
27
|
-
import { FreezeAnOpenChannelRequest } from '../models/FreezeAnOpenChannelRequest';
|
|
28
|
-
import { GetAGroupChannelResponse } from '../models/GetAGroupChannelResponse';
|
|
29
|
-
import { GetAGroupChannelResponseAllOf } from '../models/GetAGroupChannelResponseAllOf';
|
|
30
|
-
import { GetChannelInvitationPreferenceResponse } from '../models/GetChannelInvitationPreferenceResponse';
|
|
31
|
-
import { GetTotalNumberOfMessagesInAChannelResponse } from '../models/GetTotalNumberOfMessagesInAChannelResponse';
|
|
32
|
-
import { GroupChannelListMembersResponse } from '../models/GroupChannelListMembersResponse';
|
|
33
|
-
import { GroupChatListChannelsResponse } from '../models/GroupChatListChannelsResponse';
|
|
34
|
-
import { HideAChannelRequest } from '../models/HideAChannelRequest';
|
|
35
|
-
import { InviteAsMembersRequest } from '../models/InviteAsMembersRequest';
|
|
36
|
-
import { InviteAsMembersResponse } from '../models/InviteAsMembersResponse';
|
|
37
|
-
import { InviteAsMembersResponseAllOf } from '../models/InviteAsMembersResponseAllOf';
|
|
38
|
-
import { JoinAChannelRequest } from '../models/JoinAChannelRequest';
|
|
39
|
-
import { JoinChannelsRequest } from '../models/JoinChannelsRequest';
|
|
40
|
-
import { LeaveAChannelRequest } from '../models/LeaveAChannelRequest';
|
|
41
|
-
import { LeaveMyGroupChannelsRequest } from '../models/LeaveMyGroupChannelsRequest';
|
|
42
|
-
import { ListBlockedUsersResponse } from '../models/ListBlockedUsersResponse';
|
|
43
|
-
import { ListBotsResponse } from '../models/ListBotsResponse';
|
|
44
|
-
import { ListBotsResponseBotsInner } from '../models/ListBotsResponseBotsInner';
|
|
45
|
-
import { ListBotsResponseBotsInnerAi } from '../models/ListBotsResponseBotsInnerAi';
|
|
46
|
-
import { ListBotsResponseBotsInnerBot } from '../models/ListBotsResponseBotsInnerBot';
|
|
47
|
-
import { ListBotsResponseBotsInnerBotStyle } from '../models/ListBotsResponseBotsInnerBotStyle';
|
|
48
|
-
import { ListBotsResponseBotsInnerBotStyleColor } from '../models/ListBotsResponseBotsInnerBotStyleColor';
|
|
49
|
-
import { ListBotsResponseBotsInnerFirstMessagesInner } from '../models/ListBotsResponseBotsInnerFirstMessagesInner';
|
|
50
|
-
import { ListBotsResponseBotsInnerFirstMessagesInnerData } from '../models/ListBotsResponseBotsInnerFirstMessagesInnerData';
|
|
51
|
-
import { ListBotsResponseBotsInnerSafeguard } from '../models/ListBotsResponseBotsInnerSafeguard';
|
|
52
|
-
import { ListMessagesResponse } from '../models/ListMessagesResponse';
|
|
53
|
-
import { ListMyGroupChannelsResponse } from '../models/ListMyGroupChannelsResponse';
|
|
54
|
-
import { ListOpenChannelsResponse } from '../models/ListOpenChannelsResponse';
|
|
55
|
-
import { ListOperatorsResponse } from '../models/ListOperatorsResponse';
|
|
56
|
-
import { ListRegistrationOrDeviceTokensResponse } from '../models/ListRegistrationOrDeviceTokensResponse';
|
|
57
|
-
import { ListUsersResponse } from '../models/ListUsersResponse';
|
|
58
|
-
import { MarkAllMessagesAsReadRequest } from '../models/MarkAllMessagesAsReadRequest';
|
|
59
|
-
import { MarkChannelMessagesAsReadRequest } from '../models/MarkChannelMessagesAsReadRequest';
|
|
60
|
-
import { MigrateMessagesAdminMessageRequest } from '../models/MigrateMessagesAdminMessageRequest';
|
|
61
|
-
import { MigrateMessagesFileMessageRequest } from '../models/MigrateMessagesFileMessageRequest';
|
|
62
|
-
import { MigrateMessagesFileMessageRequestThumbnailsInner } from '../models/MigrateMessagesFileMessageRequestThumbnailsInner';
|
|
63
|
-
import { MigrateMessagesRequest } from '../models/MigrateMessagesRequest';
|
|
64
|
-
import { MigrateMessagesRequestMessagesInner } from '../models/MigrateMessagesRequestMessagesInner';
|
|
65
|
-
import { MigrateMessagesTextMessageRequest } from '../models/MigrateMessagesTextMessageRequest';
|
|
66
|
-
import { RegisterOperatorsToAGroupChannelRequest } from '../models/RegisterOperatorsToAGroupChannelRequest';
|
|
67
|
-
import { RemoveARegistrationOrDeviceTokenResponse } from '../models/RemoveARegistrationOrDeviceTokenResponse';
|
|
68
|
-
import { RemoveAllRegistrationOrDeviceTokenResponse } from '../models/RemoveAllRegistrationOrDeviceTokenResponse';
|
|
69
|
-
import { ResetChatHistoryRequest } from '../models/ResetChatHistoryRequest';
|
|
70
|
-
import { ResetChatHistoryResponse } from '../models/ResetChatHistoryResponse';
|
|
71
|
-
import { ScheduleAnAnnouncementRequest } from '../models/ScheduleAnAnnouncementRequest';
|
|
72
|
-
import { ScheduleAnAnnouncementRequestCreateChannelOptions } from '../models/ScheduleAnAnnouncementRequestCreateChannelOptions';
|
|
73
|
-
import { ScheduleAnAnnouncementRequestMessage } from '../models/ScheduleAnAnnouncementRequestMessage';
|
|
74
|
-
import { ScheduleAnAnnouncementResponse } from '../models/ScheduleAnAnnouncementResponse';
|
|
75
|
-
import { ScheduleAnAnnouncementResponseMessage } from '../models/ScheduleAnAnnouncementResponseMessage';
|
|
76
|
-
import { SendABotMessageRequest } from '../models/SendABotMessageRequest';
|
|
77
|
-
import { SendABotMessageResponse } from '../models/SendABotMessageResponse';
|
|
78
|
-
import { SendAMessageRequest } from '../models/SendAMessageRequest';
|
|
79
|
-
import { SendAMessageRequestPushMessageTemplate } from '../models/SendAMessageRequestPushMessageTemplate';
|
|
80
|
-
import { SendAMessageRequestPushMessageTemplateOneOf } from '../models/SendAMessageRequestPushMessageTemplateOneOf';
|
|
81
|
-
import { SendAdminMessageRequestBody } from '../models/SendAdminMessageRequestBody';
|
|
82
|
-
import { SendFileMessageRequestBody } from '../models/SendFileMessageRequestBody';
|
|
83
|
-
import { SendTextMessageRequestBody } from '../models/SendTextMessageRequestBody';
|
|
84
|
-
import { SendTextMessageRequestBodyPushMessageTemplate } from '../models/SendTextMessageRequestBodyPushMessageTemplate';
|
|
85
|
-
import { SendbirdBasicUserInfo } from '../models/SendbirdBasicUserInfo';
|
|
86
|
-
import { SendbirdDisappearingMessage } from '../models/SendbirdDisappearingMessage';
|
|
87
|
-
import { SendbirdExtendedMessagePayload } from '../models/SendbirdExtendedMessagePayload';
|
|
88
|
-
import { SendbirdFile } from '../models/SendbirdFile';
|
|
89
|
-
import { SendbirdGroupChannel } from '../models/SendbirdGroupChannel';
|
|
90
|
-
import { SendbirdGroupChannelDetail } from '../models/SendbirdGroupChannelDetail';
|
|
91
|
-
import { SendbirdGroupChannelDetailChannel } from '../models/SendbirdGroupChannelDetailChannel';
|
|
92
|
-
import { SendbirdMember } from '../models/SendbirdMember';
|
|
93
|
-
import { SendbirdMessageResponse } from '../models/SendbirdMessageResponse';
|
|
94
|
-
import { SendbirdMessageResponseMessageEvents } from '../models/SendbirdMessageResponseMessageEvents';
|
|
95
|
-
import { SendbirdOpenChannel } from '../models/SendbirdOpenChannel';
|
|
96
|
-
import { SendbirdParentMessageInfo } from '../models/SendbirdParentMessageInfo';
|
|
97
|
-
import { SendbirdPushTriggerOption } from '../models/SendbirdPushTriggerOption';
|
|
98
|
-
import { SendbirdReaction } from '../models/SendbirdReaction';
|
|
99
|
-
import { SendbirdSmsFallback } from '../models/SendbirdSmsFallback';
|
|
100
|
-
import { SendbirdSortedMetaarrayInner } from '../models/SendbirdSortedMetaarrayInner';
|
|
101
|
-
import { SendbirdThumbnail } from '../models/SendbirdThumbnail';
|
|
102
|
-
import { SendbirdUser } from '../models/SendbirdUser';
|
|
103
|
-
import { StartTypingIndicatorsRequest } from '../models/StartTypingIndicatorsRequest';
|
|
104
|
-
import { UpdateAChannelMetadataRequest } from '../models/UpdateAChannelMetadataRequest';
|
|
105
|
-
import { UpdateAGroupChannelRequest } from '../models/UpdateAGroupChannelRequest';
|
|
106
|
-
import { UpdateAMessageRequest } from '../models/UpdateAMessageRequest';
|
|
107
|
-
import { UpdateAUserRequest } from '../models/UpdateAUserRequest';
|
|
108
|
-
import { UpdateAnOpenChannelRequest } from '../models/UpdateAnOpenChannelRequest';
|
|
109
|
-
import { UpdateChannelInvitationPreferenceRequest } from '../models/UpdateChannelInvitationPreferenceRequest';
|
|
110
|
-
import { UpdateChannelInvitationPreferenceResponse } from '../models/UpdateChannelInvitationPreferenceResponse';
|
|
111
|
-
import { UpdateCountPreferenceOfAChannelRequest } from '../models/UpdateCountPreferenceOfAChannelRequest';
|
|
112
|
-
import { UpdateCountPreferenceOfChannelByUrlResponse } from '../models/UpdateCountPreferenceOfChannelByUrlResponse';
|
|
113
|
-
import { UpdateExtraDataInAMessageRequest } from '../models/UpdateExtraDataInAMessageRequest';
|
|
114
|
-
import { UpdateExtraDataInAMessageResponse } from '../models/UpdateExtraDataInAMessageResponse';
|
|
115
|
-
import { UpdatePushPreferencesForAChannelRequest } from '../models/UpdatePushPreferencesForAChannelRequest';
|
|
116
|
-
import { UpdatePushPreferencesForAChannelResponse } from '../models/UpdatePushPreferencesForAChannelResponse';
|
|
117
|
-
import { UpdatePushPreferencesRequest } from '../models/UpdatePushPreferencesRequest';
|
|
118
|
-
import { UpdatePushPreferencesResponse } from '../models/UpdatePushPreferencesResponse';
|
|
119
|
-
import { ViewCountPreferenceOfAChannelResponse } from '../models/ViewCountPreferenceOfAChannelResponse';
|
|
120
|
-
import { ViewNumberOfChannelsWithUnreadMessagesResponse } from '../models/ViewNumberOfChannelsWithUnreadMessagesResponse';
|
|
121
|
-
import { ViewNumberOfDailyActiveUsersResponse } from '../models/ViewNumberOfDailyActiveUsersResponse';
|
|
122
|
-
import { ViewNumberOfMonthlyActiveUsersResponse } from '../models/ViewNumberOfMonthlyActiveUsersResponse';
|
|
123
|
-
import { ViewNumberOfUnreadMessagesResponse } from '../models/ViewNumberOfUnreadMessagesResponse';
|
|
124
|
-
import { ViewPushPreferencesForAChannelResponse } from '../models/ViewPushPreferencesForAChannelResponse';
|
|
125
|
-
import { ViewPushPreferencesResponse } from '../models/ViewPushPreferencesResponse';
|
|
126
|
-
import { ObservableAnnouncementApi } from './ObservableAPI';
|
|
127
|
-
|
|
128
|
-
import { AnnouncementApiRequestFactory, AnnouncementApiResponseProcessor} from "../apis/AnnouncementApi";
|
|
129
|
-
export class PromiseAnnouncementApi {
|
|
130
|
-
private api: ObservableAnnouncementApi
|
|
131
|
-
|
|
132
|
-
public constructor(
|
|
133
|
-
configuration: Configuration,
|
|
134
|
-
requestFactory?: AnnouncementApiRequestFactory,
|
|
135
|
-
responseProcessor?: AnnouncementApiResponseProcessor
|
|
136
|
-
) {
|
|
137
|
-
this.api = new ObservableAnnouncementApi(configuration, requestFactory, responseProcessor);
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* ## Schedule an announcement Creates an announcement. You can also schedule an announcement in the [Sendbird Dashboard](https://dashboard.sendbird.com). [https://sendbird.com/docs/chat/platform-api/v3/message/announcements/create-an-announcement#1-create-an-announcement](https://sendbird.com/docs/chat/platform-api/v3/message/announcements/create-an-announcement#1-create-an-announcement)
|
|
142
|
-
* Schedule an announcement
|
|
143
|
-
* @param apiToken
|
|
144
|
-
* @param scheduleAnAnnouncementRequest
|
|
145
|
-
*/
|
|
146
|
-
public scheduleAnAnnouncement(apiToken?: string, scheduleAnAnnouncementRequest?: ScheduleAnAnnouncementRequest, _options?: Configuration): Promise<ScheduleAnAnnouncementResponse> {
|
|
147
|
-
const result = this.api.scheduleAnAnnouncement(apiToken, scheduleAnAnnouncementRequest, _options);
|
|
148
|
-
return result.toPromise();
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
import { ObservableBotApi } from './ObservableAPI';
|
|
157
|
-
|
|
158
|
-
import { BotApiRequestFactory, BotApiResponseProcessor} from "../apis/BotApi";
|
|
159
|
-
export class PromiseBotApi {
|
|
160
|
-
private api: ObservableBotApi
|
|
161
|
-
|
|
162
|
-
public constructor(
|
|
163
|
-
configuration: Configuration,
|
|
164
|
-
requestFactory?: BotApiRequestFactory,
|
|
165
|
-
responseProcessor?: BotApiResponseProcessor
|
|
166
|
-
) {
|
|
167
|
-
this.api = new ObservableBotApi(configuration, requestFactory, responseProcessor);
|
|
168
|
-
}
|
|
169
|
-
|
|
170
|
-
/**
|
|
171
|
-
* ## Create a bot Creates a new bot within an application. Creating a bot is similar to creating a normal user, except a callback URL should be specified for a bot to receive events. > **Note**: The bot must first [join a group channel](https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/join-channels) to interact with users. In group channels, you can also invite a bot through the [invite as members](https://sendbird.com/docs/chat/platform-api/v3/channel/inviting-a-user/invite-as-members-channel) action. [https://sendbird.com/docs/chat/platform-api/v3/bot/creating-a-bot/create-a-bot#1-create-a-bot](https://sendbird.com/docs/chat/platform-api/v3/bot/creating-a-bot/create-a-bot#1-create-a-bot)
|
|
172
|
-
* Create a bot
|
|
173
|
-
* @param apiToken
|
|
174
|
-
* @param createABotRequest
|
|
175
|
-
*/
|
|
176
|
-
public createABot(apiToken?: string, createABotRequest?: CreateABotRequest, _options?: Configuration): Promise<CreateABotResponse> {
|
|
177
|
-
const result = this.api.createABot(apiToken, createABotRequest, _options);
|
|
178
|
-
return result.toPromise();
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
* ## 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)
|
|
183
|
-
* Join channels
|
|
184
|
-
* @param botUserid (Required)
|
|
185
|
-
* @param apiToken
|
|
186
|
-
* @param joinChannelsRequest
|
|
187
|
-
*/
|
|
188
|
-
public joinChannels(botUserid: string, apiToken?: string, joinChannelsRequest?: JoinChannelsRequest, _options?: Configuration): Promise<SendbirdGroupChannelDetail> {
|
|
189
|
-
const result = this.api.joinChannels(botUserid, apiToken, joinChannelsRequest, _options);
|
|
190
|
-
return result.toPromise();
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
/**
|
|
194
|
-
* ## Leave channels Makes a bot leave a specific channel [https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/leave-channels#1-leave-channels](https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/leave-channels#1-leave-channels)
|
|
195
|
-
* Leave channels - When leaving a specific channel
|
|
196
|
-
* @param channelUrl
|
|
197
|
-
* @param botUserid (Required)
|
|
198
|
-
* @param apiToken
|
|
199
|
-
*/
|
|
200
|
-
public leaveAGroupChannel(channelUrl: string, botUserid: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
201
|
-
const result = this.api.leaveAGroupChannel(channelUrl, botUserid, apiToken, _options);
|
|
202
|
-
return result.toPromise();
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
/**
|
|
206
|
-
* ## Leave channels Makes a bot leave all group channels. [https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/leave-channels#1-leave-channels](https://sendbird.com/docs/chat/platform-api/v3/bot/managing-a-bot/leave-channels#1-leave-channels)
|
|
207
|
-
* Leave channels - When leaving all channels
|
|
208
|
-
* @param botUserid (Required)
|
|
209
|
-
* @param apiToken
|
|
210
|
-
*/
|
|
211
|
-
public leaveGroupChannels(botUserid: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
212
|
-
const result = this.api.leaveGroupChannels(botUserid, apiToken, _options);
|
|
213
|
-
return result.toPromise();
|
|
214
|
-
}
|
|
215
|
-
|
|
216
|
-
/**
|
|
217
|
-
* ## List bots Retrieves a list of all bots within an application. https://sendbird.com/docs/chat/platform-api/v3/bot/listing-bots/list-bots#1-list-bots
|
|
218
|
-
* List bots
|
|
219
|
-
* @param token
|
|
220
|
-
* @param limit
|
|
221
|
-
* @param apiToken
|
|
222
|
-
*/
|
|
223
|
-
public listBots(token?: string, limit?: number, apiToken?: string, _options?: Configuration): Promise<ListBotsResponse> {
|
|
224
|
-
const result = this.api.listBots(token, limit, apiToken, _options);
|
|
225
|
-
return result.toPromise();
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
/**
|
|
229
|
-
* ## 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.
|
|
230
|
-
* Send a bot's message
|
|
231
|
-
* @param botUserid (Required)
|
|
232
|
-
* @param apiToken
|
|
233
|
-
* @param sendABotMessageRequest
|
|
234
|
-
*/
|
|
235
|
-
public sendABotMessage(botUserid: string, apiToken?: string, sendABotMessageRequest?: SendABotMessageRequest, _options?: Configuration): Promise<SendABotMessageResponse> {
|
|
236
|
-
const result = this.api.sendABotMessage(botUserid, apiToken, sendABotMessageRequest, _options);
|
|
237
|
-
return result.toPromise();
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
import { ObservableGroupChannelApi } from './ObservableAPI';
|
|
246
|
-
|
|
247
|
-
import { GroupChannelApiRequestFactory, GroupChannelApiResponseProcessor} from "../apis/GroupChannelApi";
|
|
248
|
-
export class PromiseGroupChannelApi {
|
|
249
|
-
private api: ObservableGroupChannelApi
|
|
250
|
-
|
|
251
|
-
public constructor(
|
|
252
|
-
configuration: Configuration,
|
|
253
|
-
requestFactory?: GroupChannelApiRequestFactory,
|
|
254
|
-
responseProcessor?: GroupChannelApiResponseProcessor
|
|
255
|
-
) {
|
|
256
|
-
this.api = new ObservableGroupChannelApi(configuration, requestFactory, responseProcessor);
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* ## Accept an invitation Accepts an invitation from a group channel for a user to join. A single user may join up to 2,000 group channels, and any invitation to a user who is at capacity will be automatically canceled. See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. > **Note**: This action is only available when the `auto_accept` property of an application is set to **false**. You can change the value of the property using the [update default channel invitation preference](https://sendbird.com/docs/chat/platform-api/v3/channel/setting-up-channels/update-default-invitation-preference) action, or the [update channel invitation preference](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/update-channel-invitation-preference) action. [https://sendbird.com/docs/chat/platform-api/v3/channel/inviting-a-user/accept-an-invitation-channel#1-accept-an-invitation](https://sendbird.com/docs/chat/platform-api/v3/channel/inviting-a-user/accept-an-invitation-channel#1-accept-an-invitation)
|
|
261
|
-
* Accept an invitation
|
|
262
|
-
* @param channelUrl (Required)
|
|
263
|
-
* @param apiToken
|
|
264
|
-
* @param acceptAnInvitationRequest
|
|
265
|
-
*/
|
|
266
|
-
public acceptAnInvitation(channelUrl: string, apiToken?: string, acceptAnInvitationRequest?: AcceptAnInvitationRequest, _options?: Configuration): Promise<SendbirdGroupChannelDetail> {
|
|
267
|
-
const result = this.api.acceptAnInvitation(channelUrl, apiToken, acceptAnInvitationRequest, _options);
|
|
268
|
-
return result.toPromise();
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
* ## Unregister operators from a group channel You can unregister operators in a group channel but keep them in the channel as members using this API. https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/unregister-operators-from-a-group-channel#1-unregister-operators-from-a-group-channel `channel_url` Type: string Description: Specifies the URL of the channel to cancel the registration of operators.
|
|
273
|
-
* Cancel the registration of operators
|
|
274
|
-
* @param channelUrl (Required)
|
|
275
|
-
* @param operatorIds Specifies an array of one or more operator IDs to unregister from the channel. The operators in this array remain as participants of the channel after losing their operational roles. Urlencoding each operator ID is recommended. An example of a Urlencoded array would be ?operator_ids=urlencoded_id_1,urlencoded_id_2.
|
|
276
|
-
* @param deleteAll
|
|
277
|
-
* @param apiToken
|
|
278
|
-
*/
|
|
279
|
-
public cancelTheRegistrationOfOperators(channelUrl: string, operatorIds: string, deleteAll?: boolean, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
280
|
-
const result = this.api.cancelTheRegistrationOfOperators(channelUrl, operatorIds, deleteAll, apiToken, _options);
|
|
281
|
-
return result.toPromise();
|
|
282
|
-
}
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* ## Check if user is a member Checks if a user is a member of a group channel. > **Note**: See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. [https://sendbird.com/docs/chat/platform-api/v3/channel/listing-users/check-if-user-is-a-member#1-check-if-user-is-a-member](https://sendbird.com/docs/chat/platform-api/v3/channel/listing-users/check-if-user-is-a-member#1-check-if-user-is-a-member)
|
|
286
|
-
* Check if member
|
|
287
|
-
* @param channelUrl (Required)
|
|
288
|
-
* @param userId (Required)
|
|
289
|
-
* @param apiToken
|
|
290
|
-
*/
|
|
291
|
-
public checkIfMember(channelUrl: string, userId: string, apiToken?: string, _options?: Configuration): Promise<CheckIfMemberResponse> {
|
|
292
|
-
const result = this.api.checkIfMember(channelUrl, userId, apiToken, _options);
|
|
293
|
-
return result.toPromise();
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* ## Create a group channel You can create a group channel for 1-to-1 and 1-to-N conversations. By default, group channels are used for conversations between up to 100 members. This number can stretch up to tens of thousands in Supergroup channels. Group channels can either be private and invite only, or public. They support typing indicators, unread count and read receipts, allowing for an interactive chat experience. A user can join up to 2000 group channels, and higher numbers would negatively impact the performance for the end user. The Chat history is turned off by default and its settings can be changed on Sendbird Dashboard by going to Settings > Chat > Channels > Group channels > Chat history. To learn more about group channels, see Channel Overview. > If you are seeing the error message Maximum \"channel join\" count reached., then consider deleting channels that are no longer used. For situations where an agent connects with many customers such as support, delivery logistics or sales, we recommend using Sendbird Desk. https://sendbird.com/docs/chat/platform-api/v3/channel/creating-a-channel/create-a-group-channel#1-create-a-group-channel
|
|
298
|
-
* Create a group channel
|
|
299
|
-
* @param apiToken
|
|
300
|
-
* @param createAGroupChannelRequest
|
|
301
|
-
*/
|
|
302
|
-
public createAGroupChannel(apiToken?: string, createAGroupChannelRequest?: CreateAGroupChannelRequest, _options?: Configuration): Promise<SendbirdGroupChannelDetail> {
|
|
303
|
-
const result = this.api.createAGroupChannel(apiToken, createAGroupChannelRequest, _options);
|
|
304
|
-
return result.toPromise();
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
/**
|
|
308
|
-
* ## Delete a group channel You can delete a group channel or a Supergroup channel using this API. See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. [https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/delete-a-group-channel#1-delete-a-group-channel](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/delete-a-group-channel#1-delete-a-group-channel)
|
|
309
|
-
* Delete a group channel
|
|
310
|
-
* @param channelUrl
|
|
311
|
-
* @param apiToken
|
|
312
|
-
*/
|
|
313
|
-
public deleteAGroupChannel(channelUrl: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
314
|
-
const result = this.api.deleteAGroupChannel(channelUrl, apiToken, _options);
|
|
315
|
-
return result.toPromise();
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
/**
|
|
319
|
-
* ## Get a group channel This action retrieves information about a specific [group channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel). You can use the optional query parameters to determine whether to include delivery receipt, read receipt, or member information in the response. https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/get-a-group-channel#1-get-a-group-channel `channel_url` Type: string Description: Specifies the URL of the channel to retrieve.
|
|
320
|
-
* Get a group channel
|
|
321
|
-
* @param channelUrl
|
|
322
|
-
* @param showDeliveryReceipt
|
|
323
|
-
* @param showReadReceipt
|
|
324
|
-
* @param showMember
|
|
325
|
-
* @param memberActiveMode Restricts the member list to members who are activated or deactivated in the channel. This parameter is only effective if the parameter show_member is true. Acceptable values are all, activated, and deactivated. (default: all)
|
|
326
|
-
* @param userId
|
|
327
|
-
* @param apiToken
|
|
328
|
-
*/
|
|
329
|
-
public getAGroupChannel(channelUrl: string, showDeliveryReceipt?: boolean, showReadReceipt?: boolean, showMember?: boolean, memberActiveMode?: 'all' | 'activated' | 'deactivated', userId?: string, apiToken?: string, _options?: Configuration): Promise<GetAGroupChannelResponse> {
|
|
330
|
-
const result = this.api.getAGroupChannel(channelUrl, showDeliveryReceipt, showReadReceipt, showMember, memberActiveMode, userId, apiToken, _options);
|
|
331
|
-
return result.toPromise();
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
* ## Hide a channel This action allows you to hide a [group channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel) from a user's channel list. Hiding a channel gives users the ability to archive channels so that they can focus on channels that need the most attention. With this API, you can allow users to hide a channel from themselves or from all channel members. You can also determine whether to have the channel remain hidden when a new message is sent to the channel. Note that only group channels can be hidden. [https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/hide-a-channel#1-hide-a-channel](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/hide-a-channel#1-hide-a-channel)
|
|
336
|
-
* Hide a channel
|
|
337
|
-
* @param channelUrl (Required)
|
|
338
|
-
* @param apiToken
|
|
339
|
-
* @param hideAChannelRequest
|
|
340
|
-
*/
|
|
341
|
-
public hideAChannel(channelUrl: string, apiToken?: string, hideAChannelRequest?: HideAChannelRequest, _options?: Configuration): Promise<any> {
|
|
342
|
-
const result = this.api.hideAChannel(channelUrl, apiToken, hideAChannelRequest, _options);
|
|
343
|
-
return result.toPromise();
|
|
344
|
-
}
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* ## Invite as members Invites one or more users as members to a group channel. Users can join a group channel immediately after receiving an invitation, without having to accept it. To give users an option to accept or decline an invitation, see [update default channel invitation preference](https://sendbird.com/docs/chat/platform-api/v3/channel/setting-up-channels/update-default-invitation-preference) or [update channel invitation preference](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/update-channel-invitation-preference). See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. > **Note**: By default, [blocked users](https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/block-users) are included when sending invitations. If you wish to exclude blocked users, [contact our sales team](https://get.sendbird.com/talk-to-sales.html). [https://sendbird.com/docs/chat/platform-api/v3/channel/inviting-a-user/invite-as-members-channel#1-invite-as-members](https://sendbird.com/docs/chat/platform-api/v3/channel/inviting-a-user/invite-as-members-channel#1-invite-as-members)
|
|
348
|
-
* Invite as members
|
|
349
|
-
* @param channelUrl (Required)
|
|
350
|
-
* @param apiToken
|
|
351
|
-
* @param inviteAsMembersRequest
|
|
352
|
-
*/
|
|
353
|
-
public inviteAsMembers(channelUrl: string, apiToken?: string, inviteAsMembersRequest?: InviteAsMembersRequest, _options?: Configuration): Promise<InviteAsMembersResponse> {
|
|
354
|
-
const result = this.api.inviteAsMembers(channelUrl, apiToken, inviteAsMembersRequest, _options);
|
|
355
|
-
return result.toPromise();
|
|
356
|
-
}
|
|
357
|
-
|
|
358
|
-
/**
|
|
359
|
-
* ## Join a channel This API allows a user to join a [public](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#4-group-channel-types) group channel. Users can only join public group channels where the `is_public` property is set to `true` using this API. A single user can join up to 2,000 group channels, and a user who reaches the capacity can’t join a new channel. See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. [https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/join-a-channel#1-join-a-channel](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/join-a-channel#1-join-a-channel)
|
|
360
|
-
* Join a channel
|
|
361
|
-
* @param channelUrl (Required)
|
|
362
|
-
* @param apiToken
|
|
363
|
-
* @param joinAChannelRequest
|
|
364
|
-
*/
|
|
365
|
-
public joinAChannel(channelUrl: string, apiToken?: string, joinAChannelRequest?: JoinAChannelRequest, _options?: Configuration): Promise<SendbirdGroupChannelDetail> {
|
|
366
|
-
const result = this.api.joinAChannel(channelUrl, apiToken, joinAChannelRequest, _options);
|
|
367
|
-
return result.toPromise();
|
|
368
|
-
}
|
|
369
|
-
|
|
370
|
-
/**
|
|
371
|
-
* ## Leave a channel Makes one or more members leave a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-leave-a-channel ----------------------------
|
|
372
|
-
* Leave a channel
|
|
373
|
-
* @param channelUrl
|
|
374
|
-
* @param apiToken
|
|
375
|
-
* @param leaveAChannelRequest
|
|
376
|
-
*/
|
|
377
|
-
public leaveAChannel(channelUrl: string, apiToken?: string, leaveAChannelRequest?: LeaveAChannelRequest, _options?: Configuration): Promise<any> {
|
|
378
|
-
const result = this.api.leaveAChannel(channelUrl, apiToken, leaveAChannelRequest, _options);
|
|
379
|
-
return result.toPromise();
|
|
380
|
-
}
|
|
381
|
-
|
|
382
|
-
/**
|
|
383
|
-
* ## List group channels This action retrieves a list of [group channels](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel). You can use various query parameters to determine the search scope and select what kind of information you want to receive about the queried channels. If you want to retrieve a list of group channels that a specific user has joined, use the [list group channels by user](https://sendbird.com/docs/chat/platform-api/v3/user/managing-joined-group-channels/list-group-channels-by-user) action under the User section. https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-group-channels#1-list-group-channels
|
|
384
|
-
* List channels
|
|
385
|
-
* @param apiToken
|
|
386
|
-
* @param token Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
|
|
387
|
-
* @param limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
|
|
388
|
-
* @param distinctMode
|
|
389
|
-
* @param publicMode
|
|
390
|
-
* @param superMode
|
|
391
|
-
* @param createdAfter Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
|
|
392
|
-
* @param createdBefore Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
|
|
393
|
-
* @param showEmpty
|
|
394
|
-
* @param showMember
|
|
395
|
-
* @param showDeliveryReceipt
|
|
396
|
-
* @param showReadReceipt
|
|
397
|
-
* @param showMetadata
|
|
398
|
-
* @param showFrozen
|
|
399
|
-
* @param order
|
|
400
|
-
* @param metadataOrderKey Specifies the key of an item in metadata. When a value of the order parameter is set to metadata_value_alphabetical, the results are alphabetically sorted by the value of the item specified by the key.
|
|
401
|
-
* @param customTypes Specifies a comma-separated string of one or more custom types to filter group channels. URL encoding each type is recommended. If not specified, all channels are returned, regardless of their custom type.
|
|
402
|
-
* @param customTypeStartswith Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
|
|
403
|
-
* @param channelUrls Specifies a comma-separated string of one or more group channel URLs to restrict the search scope. URL encoding each channel URL is recommended.
|
|
404
|
-
* @param name Specifies one or more group channel names.
|
|
405
|
-
* @param nameContains Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
|
|
406
|
-
* @param nameStartswith Searches for group channels whose names start with the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
|
|
407
|
-
* @param membersExactlyIn Searches for group channels with all the specified users as members. The parameter value should consist of user IDs separated by commas. Only user IDs that match those of existing users are used for channel search. URL encoding each ID is recommended.
|
|
408
|
-
* @param membersIncludeIn Searches for group channels that include one or more users as members among the specified users. The value should consist of user IDs separated by commas or %2C. You can specify up to 60 user IDs. Only user IDs that match those of existing users are used for channel search. URL encoding each ID is recommended.
|
|
409
|
-
* @param queryType Specifies a logical condition applied to the members_include_in parameter. Acceptable values are either AND or OR. For example, if you specify three members, A, B, and C, in members_include_in, the value of AND returns all channels that include every one of {A. B, C} as members. The value of OR returns channels that include {A}, plus those that include {B}, plus those that include {C}. (Default: AND)
|
|
410
|
-
* @param membersNickname Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
|
|
411
|
-
* @param membersNicknameContains Searches for group channels with members whose nicknames contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended. * We recommend using at least three characters for the parameter value for better search efficiency when you design and implement related features. If you would like to allow one or two characters for searching, use members_nickname instead to prevent performance issues.
|
|
412
|
-
* @param metadataKey Searches for group channels with metadata containing an item with the specified value as its key. To use this parameter, either the metadata_values parameter or the metadata_value_startswith parameter should be specified.
|
|
413
|
-
* @param metadataValues Searches for group channels with metadata containing an item with the key specified by the metadata_key parameter, and the value of that item matches one or more values specified by this parameter. The string should be specified with multiple values separated by commas. URL encoding each value is recommended. To use this parameter, the metadata_key parameter should be specified.
|
|
414
|
-
* @param metadataValueStartswith Searches for group channels with metadata containing an item with the key specified by the metadata_key parameter, and the values of that item that start with the specified value of this parameter. URL encoding the value is recommended. To use this parameter, the metadata_key parameter should be specified.
|
|
415
|
-
* @param metacounterKey Searches for group channels with metacounter containing an item with the specified value as its key. To use this parameter, either the metacounter_values parameter or one of the metacounter_value_gt, metacounter_value_gte, metacounter_value_lt, and metacounter_value_lte parameters should be specified.
|
|
416
|
-
* @param metacounterValues Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is equal to one or more values specified by this parameter. The string should be specified with multiple values separated by commas. To use this parameter, the metacounter_key parameter should be specified.
|
|
417
|
-
* @param metacounterValueGt Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is greater than the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
418
|
-
* @param metacounterValueGte Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is greater than or equal to the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
419
|
-
* @param metacounterValueLt Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is lower than the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
420
|
-
* @param metacounterValueLte Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is lower than or equal to the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
421
|
-
* @param includeSortedMetaarrayInLastMessage Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
|
|
422
|
-
*/
|
|
423
|
-
public listChannels(apiToken: string, token?: string, limit?: number, distinctMode?: 'all' | 'distinct' | 'nondistinct', publicMode?: 'all' | 'private' | 'public', superMode?: 'all' | 'super' | 'nonsuper', createdAfter?: number, createdBefore?: number, showEmpty?: boolean, showMember?: boolean, showDeliveryReceipt?: boolean, showReadReceipt?: boolean, showMetadata?: boolean, showFrozen?: boolean, order?: 'chronological' | 'latest_last_message' | 'channel_name_alphabetical' | 'metadata_value_alphabetical', metadataOrderKey?: string, customTypes?: string, customTypeStartswith?: string, channelUrls?: string, name?: string, nameContains?: string, nameStartswith?: string, membersExactlyIn?: string, membersIncludeIn?: string, queryType?: string, membersNickname?: string, membersNicknameContains?: string, metadataKey?: string, metadataValues?: string, metadataValueStartswith?: string, metacounterKey?: string, metacounterValues?: string, metacounterValueGt?: string, metacounterValueGte?: string, metacounterValueLt?: string, metacounterValueLte?: string, includeSortedMetaarrayInLastMessage?: boolean, _options?: Configuration): Promise<GroupChatListChannelsResponse> {
|
|
424
|
-
const result = this.api.listChannels(apiToken, token, limit, distinctMode, publicMode, superMode, createdAfter, createdBefore, showEmpty, showMember, showDeliveryReceipt, showReadReceipt, showMetadata, showFrozen, order, metadataOrderKey, customTypes, customTypeStartswith, channelUrls, name, nameContains, nameStartswith, membersExactlyIn, membersIncludeIn, queryType, membersNickname, membersNicknameContains, metadataKey, metadataValues, metadataValueStartswith, metacounterKey, metacounterValues, metacounterValueGt, metacounterValueGte, metacounterValueLt, metacounterValueLte, includeSortedMetaarrayInLastMessage, _options);
|
|
425
|
-
return result.toPromise();
|
|
426
|
-
}
|
|
427
|
-
|
|
428
|
-
/**
|
|
429
|
-
* ## List members Retrieves a list of members of a group channel. > **Note**: See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. [https://sendbird.com/docs/chat/platform-api/v3/channel/listing-users/list-members-of-a-group-channel#1-list-members-of-a-group-channel](https://sendbird.com/docs/chat/platform-api/v3/channel/listing-users/list-members-of-a-group-channel#1-list-members-of-a-group-channel) `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of members of.
|
|
430
|
-
* List members
|
|
431
|
-
* @param channelUrl (Required)
|
|
432
|
-
* @param token
|
|
433
|
-
* @param limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
|
|
434
|
-
* @param userId Specifies the unique ID of a user. If `user_id` is provided, the response will include two additional boolean properties about each user in the members list. - `is_blocking_me`: Indicates whether the listed user is blocking the user specified in the user_id parameter. - `is_blocked_by_me`: Indicates whether the listed user is blocked by the user specified in the user_id parameter.
|
|
435
|
-
* @param showDeliveryReceipt
|
|
436
|
-
* @param showReadReceipt
|
|
437
|
-
* @param showMemberIsMuted
|
|
438
|
-
* @param order Specifies the method to sort a list of results. Acceptable values are the following: - `member_nickname_alphabetical` (default): sorts by the member nicknames in alphabetical order. - `operator_then_member_alphabetical`: sorts by the operational role and member nickname in alphabetical order where channel operators are listed before channel members.
|
|
439
|
-
* @param operatorFilter Restricts the search scope to only retrieve operators or non-operator members of the channel. Acceptable values are the following: - `all` (default): no filter is applied to the list. - `operator`: only channel operators are retrieved. - `nonoperator`: all channel members, except channel operators, are retrieved.
|
|
440
|
-
* @param memberStateFilter Restricts the search scope to retrieve members based on if they have accepted an invitation or if they were invited by a friend. Acceptable values are `invited_only`, `joined_only`, `invited_by_friend`, `invited_by_non_friend`, and `all`. (Default: `all`)
|
|
441
|
-
* @param mutedMemberFilter Restricts the search scope to retrieve members who are muted or unmuted in the channel. Acceptable values are `all`, `muted`, and `unmuted`. (Default: `all`)
|
|
442
|
-
* @param memberActiveModeFilter Restricts the search scope to retrieve members who are activated or deactivated in the channel. Acceptable values are `all`, `activated`, and `deactivated`. (default: `activated`)
|
|
443
|
-
* @param nicknameStartswith Searches for members whose nicknames start with the specified value. Urlencoding the value is recommended.
|
|
444
|
-
* @param includePushPreference Determines whether to include information about the push preference of each member, such as `push_enabled`, `push_trigger_option`, and `do_not_disturb`. (Default: `false`)
|
|
445
|
-
* @param apiToken
|
|
446
|
-
*/
|
|
447
|
-
public listMembers(channelUrl: string, token?: string, limit?: number, userId?: string, showDeliveryReceipt?: boolean, showReadReceipt?: boolean, showMemberIsMuted?: boolean, order?: 'member_nickname_alphabetical' | 'operator_then_member_alphabetical', operatorFilter?: 'all' | 'operator' | 'nonoperator', memberStateFilter?: 'all' | 'invited_only' | 'joined_only' | 'invited_by_friend' | 'invited_by_non_friend', mutedMemberFilter?: 'all' | 'muted' | 'unmuted', memberActiveModeFilter?: 'activated' | 'deactivated', nicknameStartswith?: string, includePushPreference?: boolean, apiToken?: string, _options?: Configuration): Promise<GroupChannelListMembersResponse> {
|
|
448
|
-
const result = this.api.listMembers(channelUrl, token, limit, userId, showDeliveryReceipt, showReadReceipt, showMemberIsMuted, order, operatorFilter, memberStateFilter, mutedMemberFilter, memberActiveModeFilter, nicknameStartswith, includePushPreference, apiToken, _options);
|
|
449
|
-
return result.toPromise();
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
/**
|
|
453
|
-
* ## List operators You can retrieve a list of operators of a group channel using this API. https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/list-operators-of-a-group-channel#1-list-operators-of-a-group-channel `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of operators.
|
|
454
|
-
* List operators
|
|
455
|
-
* @param channelUrl (Required)
|
|
456
|
-
* @param token
|
|
457
|
-
* @param limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
|
|
458
|
-
* @param apiToken
|
|
459
|
-
*/
|
|
460
|
-
public listOperators(channelUrl: string, token?: string, limit?: number, apiToken?: string, _options?: Configuration): Promise<ListOperatorsResponse> {
|
|
461
|
-
const result = this.api.listOperators(channelUrl, token, limit, apiToken, _options);
|
|
462
|
-
return result.toPromise();
|
|
463
|
-
}
|
|
464
|
-
|
|
465
|
-
/**
|
|
466
|
-
* ## Register operators to a group channel You can register one or more operators to a group channel using this API. https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/register-operators-to-a-group-channel#1-register-operators-to-a-group-channel
|
|
467
|
-
* Register operators to a group channel
|
|
468
|
-
* @param channelUrl (Required)
|
|
469
|
-
* @param apiToken
|
|
470
|
-
* @param registerOperatorsToAGroupChannelRequest
|
|
471
|
-
*/
|
|
472
|
-
public registerOperatorsToAGroupChannel(channelUrl: string, apiToken?: string, registerOperatorsToAGroupChannelRequest?: RegisterOperatorsToAGroupChannelRequest, _options?: Configuration): Promise<any> {
|
|
473
|
-
const result = this.api.registerOperatorsToAGroupChannel(channelUrl, apiToken, registerOperatorsToAGroupChannelRequest, _options);
|
|
474
|
-
return result.toPromise();
|
|
475
|
-
}
|
|
476
|
-
|
|
477
|
-
/**
|
|
478
|
-
* ## Reset chat history This action resets the properties related to a specific user's chat history in a [group channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel), clearing existing messages in a channel from only the specified user's end. Because this action doesn't delete messages from the Sendbird database, other members in the channel can still retrieve and see the messages. This action clears the messages for the specified user by updating the `last_message` and `read_receipt` properties of the [group channel resource](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#4-list-of-properties-for-group-channels) in addition to other internally managed data such as the count of a user's unread messages. Using the `reset_all` property, you can also reset the properties related to the chat history of all members in a group channel. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/reset-chat-history#1-reset-chat-history
|
|
479
|
-
* Reset chat history
|
|
480
|
-
* @param channelUrl (Required)
|
|
481
|
-
* @param apiToken
|
|
482
|
-
* @param resetChatHistoryRequest
|
|
483
|
-
*/
|
|
484
|
-
public resetChatHistory(channelUrl: string, apiToken?: string, resetChatHistoryRequest?: ResetChatHistoryRequest, _options?: Configuration): Promise<ResetChatHistoryResponse> {
|
|
485
|
-
const result = this.api.resetChatHistory(channelUrl, apiToken, resetChatHistoryRequest, _options);
|
|
486
|
-
return result.toPromise();
|
|
487
|
-
}
|
|
488
|
-
|
|
489
|
-
/**
|
|
490
|
-
* ## Start typing indicators You can start showing a typing indicator using this API. Seeing whether other users are typing can help a more interactive conversation environment by showing real-time engagement of other users. If you're looking for an easy way to show typing indicators on your app, check out Sendbird UIKit for a ready-to-use UI feature that can be customized to fit your needs. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-typing-indicators/start-typing-indicators#1-start-typing-indicators `channel_url` Type: string Description: Specifies the URL of the channel to set typing indicators.
|
|
491
|
-
* Start typing indicators
|
|
492
|
-
* @param channelUrl (Required)
|
|
493
|
-
* @param apiToken
|
|
494
|
-
* @param startTypingIndicatorsRequest
|
|
495
|
-
*/
|
|
496
|
-
public startTypingIndicators(channelUrl: string, apiToken?: string, startTypingIndicatorsRequest?: StartTypingIndicatorsRequest, _options?: Configuration): Promise<any> {
|
|
497
|
-
const result = this.api.startTypingIndicators(channelUrl, apiToken, startTypingIndicatorsRequest, _options);
|
|
498
|
-
return result.toPromise();
|
|
499
|
-
}
|
|
500
|
-
|
|
501
|
-
/**
|
|
502
|
-
* ## Stop typing indicators You can stop showing a typing indicator using this API. To signal that a user is no longer typing, you can let the indicator disappear when the user sends a message or completely deletes the message text. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-typing-indicators/stop-typing-indicators#1-stop-typing-indicators `channel_url` Type: string Description: Specifies the URL of the channel to set typing indicators.
|
|
503
|
-
* Stop typing indicators
|
|
504
|
-
* @param channelUrl (Required)
|
|
505
|
-
* @param apiToken
|
|
506
|
-
* @param startTypingIndicatorsRequest
|
|
507
|
-
*/
|
|
508
|
-
public stopTypingIndicators(channelUrl: string, apiToken?: string, startTypingIndicatorsRequest?: StartTypingIndicatorsRequest, _options?: Configuration): Promise<any> {
|
|
509
|
-
const result = this.api.stopTypingIndicators(channelUrl, apiToken, startTypingIndicatorsRequest, _options);
|
|
510
|
-
return result.toPromise();
|
|
511
|
-
}
|
|
512
|
-
|
|
513
|
-
/**
|
|
514
|
-
* ## Unhide a channel This action lets a hidden [group channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel) reappear on the channel list of a specific user or every member in the group channel. Hiding or unhiding a channel lets users organize their channel list based on those that require the most attention. Note that only group channels can be hidden or unhidden. [https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/unhide-a-channel#1-unhide-a-channel](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/unhide-a-channel#1-unhide-a-channel) `channel_url` Type: string Description: Specifies the URL of the channel to unhide or unarchive.
|
|
515
|
-
* Unhide a channel
|
|
516
|
-
* @param channelUrl (Required)
|
|
517
|
-
* @param userId (Required)
|
|
518
|
-
* @param shouldUnhideAll
|
|
519
|
-
* @param apiToken
|
|
520
|
-
*/
|
|
521
|
-
public unhideAChannel(channelUrl: string, userId: string, shouldUnhideAll?: boolean, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
522
|
-
const result = this.api.unhideAChannel(channelUrl, userId, shouldUnhideAll, apiToken, _options);
|
|
523
|
-
return result.toPromise();
|
|
524
|
-
}
|
|
525
|
-
|
|
526
|
-
/**
|
|
527
|
-
* ## Update a group channel You can update information about a group channel or a Supergroup channel using this API. You can't make any changes to the members of a channel with this API. To change members, see [invite as members](https://sendbird.com/docs/chat/platform-api/v3/channel/inviting-a-user/invite-as-members-channel) instead. See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/update-a-group-channel#1-update-a-group-channel
|
|
528
|
-
* Update a group channel
|
|
529
|
-
* @param channelUrl
|
|
530
|
-
* @param apiToken
|
|
531
|
-
* @param updateAGroupChannelRequest
|
|
532
|
-
*/
|
|
533
|
-
public updateAGroupChannel(channelUrl: string, apiToken?: string, updateAGroupChannelRequest?: UpdateAGroupChannelRequest, _options?: Configuration): Promise<SendbirdGroupChannelDetail> {
|
|
534
|
-
const result = this.api.updateAGroupChannel(channelUrl, apiToken, updateAGroupChannelRequest, _options);
|
|
535
|
-
return result.toPromise();
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
}
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
import { ObservableMessageApi } from './ObservableAPI';
|
|
544
|
-
|
|
545
|
-
import { MessageApiRequestFactory, MessageApiResponseProcessor} from "../apis/MessageApi";
|
|
546
|
-
export class PromiseMessageApi {
|
|
547
|
-
private api: ObservableMessageApi
|
|
548
|
-
|
|
549
|
-
public constructor(
|
|
550
|
-
configuration: Configuration,
|
|
551
|
-
requestFactory?: MessageApiRequestFactory,
|
|
552
|
-
responseProcessor?: MessageApiResponseProcessor
|
|
553
|
-
) {
|
|
554
|
-
this.api = new ObservableMessageApi(configuration, requestFactory, responseProcessor);
|
|
555
|
-
}
|
|
556
|
-
|
|
557
|
-
/**
|
|
558
|
-
* ## Add extra data to a message Adds one or more key-values items which store additional information for a message. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/message-add-metadata#1-add-metadata ----------------------------
|
|
559
|
-
* Add extra data to a message
|
|
560
|
-
* @param channelType (Required)
|
|
561
|
-
* @param channelUrl (Required)
|
|
562
|
-
* @param messageId (Required)
|
|
563
|
-
* @param apiToken
|
|
564
|
-
* @param addExtraDataToAMessageRequest
|
|
565
|
-
*/
|
|
566
|
-
public addExtraDataToAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageId: string, apiToken?: string, addExtraDataToAMessageRequest?: AddExtraDataToAMessageRequest, _options?: Configuration): Promise<AddExtraDataToAMessageResponse> {
|
|
567
|
-
const result = this.api.addExtraDataToAMessage(channelType, channelUrl, messageId, apiToken, addExtraDataToAMessageRequest, _options);
|
|
568
|
-
return result.toPromise();
|
|
569
|
-
}
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
* ## Delete a message Deletes a message from a channel. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/delete-a-message#1-delete-a-message ----------------------------
|
|
573
|
-
* Delete a message
|
|
574
|
-
* @param channelType (Required)
|
|
575
|
-
* @param channelUrl (Required)
|
|
576
|
-
* @param messageId (Required)
|
|
577
|
-
* @param apiToken
|
|
578
|
-
*/
|
|
579
|
-
public deleteAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageId: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
580
|
-
const result = this.api.deleteAMessage(channelType, channelUrl, messageId, apiToken, _options);
|
|
581
|
-
return result.toPromise();
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
/**
|
|
585
|
-
* ## Get a message Retrieves information on a specific message. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/get-a-message#1-get-a-message ---------------------------- `channel_type` Type: string Description: Specifies the type of the channel. Either open_channels or group_channels. `channel_url` Type: string Description: Specifies the URL of the target channel. `message_id` Type: long Description: Specifies the unique ID of the message to retrieve.
|
|
586
|
-
* Get a message
|
|
587
|
-
* @param channelType (Required)
|
|
588
|
-
* @param channelUrl (Required)
|
|
589
|
-
* @param messageId (Required)
|
|
590
|
-
* @param includeReactions
|
|
591
|
-
* @param includeThreadInfo
|
|
592
|
-
* @param includeParentMessageInfo
|
|
593
|
-
* @param includePollDetails Determines whether to include all properties of a poll resource with a full list of options in the results. If set to false, a selection of poll resource properties consisting of id, title, close_at, created_at, updated_at, status, and message_id are returned. (Default: false) * To use this property, the polls feature should be turned on in Settings > Chat > Features on Sendbird Dashboard.
|
|
594
|
-
* @param withSortedMetaArray
|
|
595
|
-
* @param apiToken
|
|
596
|
-
*/
|
|
597
|
-
public getAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageId: string, includeReactions?: boolean, includeThreadInfo?: boolean, includeParentMessageInfo?: boolean, includePollDetails?: boolean, withSortedMetaArray?: boolean, apiToken?: string, _options?: Configuration): Promise<SendbirdMessageResponse> {
|
|
598
|
-
const result = this.api.getAMessage(channelType, channelUrl, messageId, includeReactions, includeThreadInfo, includeParentMessageInfo, includePollDetails, withSortedMetaArray, apiToken, _options);
|
|
599
|
-
return result.toPromise();
|
|
600
|
-
}
|
|
601
|
-
|
|
602
|
-
/**
|
|
603
|
-
* ## Get total number of messages in a channel Retrieves the total number of messages in a specific channel. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/get-total-number-of-messages-in-a-channel#1-get-total-number-of-messages-in-a-channel ----------------------------
|
|
604
|
-
* Get total number of messages in a channel
|
|
605
|
-
* @param channelType (Required)
|
|
606
|
-
* @param channelUrl (Required)
|
|
607
|
-
* @param apiToken
|
|
608
|
-
*/
|
|
609
|
-
public getTotalNumberOfMessagesInAChannel(channelType: 'open_channels' | 'group_channels', channelUrl: string, apiToken?: string, _options?: Configuration): Promise<GetTotalNumberOfMessagesInAChannelResponse> {
|
|
610
|
-
const result = this.api.getTotalNumberOfMessagesInAChannel(channelType, channelUrl, apiToken, _options);
|
|
611
|
-
return result.toPromise();
|
|
612
|
-
}
|
|
613
|
-
|
|
614
|
-
/**
|
|
615
|
-
* ## List messages You can retrieve a list of past messages of a specific channel with this API. By default, this action returns a list of messages in the order they were created. Replies in threaded messages are also listed in the chronological order of their creation like other messages, not grouped with their parent messages. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/list-messages#1-list-messages `channel_type` Type: string Description: Specifies the type of the channel. Either open_channels or group_channels. `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of past messages.
|
|
616
|
-
* List messages
|
|
617
|
-
* @param channelType (Required)
|
|
618
|
-
* @param channelUrl (Required)
|
|
619
|
-
* @param messageTs Specifies the timestamp to be the reference point of the query in Unix milliseconds. Either this or the message_id parameter below should be specified in your query URL to retrieve a list. It fetches messages that were sent prior to and after the specified message_ts and the default value for both prev_limit and next_limit is 15.
|
|
620
|
-
* @param messageId Specifies the unique ID of the message to be the reference point of the query. Either this or the message_ts parameter above should be specified in your query URL to retrieve a list. It fetches messages that were sent prior to and after the specified message_id and the default value for both prev_limit and next_limit is 15.
|
|
621
|
-
* @param prevLimit Specifies the number of previously sent messages to retrieve before message_ts. For example, if message_ts=1484202848298, then prev_limit=50 returns 50 messages sent by 1484202848297 (message_ts - 1). Acceptable values range from 0 to 200. (Default: 15)
|
|
622
|
-
* @param nextLimit Specifies the number of sent messages to retrieve after message_ts. For example, if message_ts=1484202848298, then next_limit=50 returns 50 messages sent from 1484202848299 (message_ts + 1). Acceptable values range from 0 to 200. (Default: 15)
|
|
623
|
-
* @param include Determines whether to include messages sent exactly on the specified message_ts in the results. (Default: true)
|
|
624
|
-
* @param reverse Determines whether to sort the results in reverse chronological order. If set to true, messages appear in reverse chronological order where the newest comes first and the oldest last. (Default: false)
|
|
625
|
-
* @param senderId Restricts the search scope to only retrieve messages sent by the user with the specified ID.
|
|
626
|
-
* @param senderIds Restricts the search scope to only retrieve messages sent by one or more users with the specified IDs listed in a comma-separated string.
|
|
627
|
-
* @param operatorFilter
|
|
628
|
-
* @param customTypes Specifies a comma-separated string of one or more custom message types to retrieve. The value set to this parameter can serve as a filter as follows: - A string of specific custom types: Messages with the corresponding custom types are returned. - Empty like &custom_types=&...: Messages whose custom_type property is empty or has a value of null are returned. - An asterisk (\\*) (default): All messages are returned regardless of their custom_type.
|
|
629
|
-
* @param messageType
|
|
630
|
-
* @param includingRemoved
|
|
631
|
-
* @param includeReactions
|
|
632
|
-
* @param includeReplyType One of following values: NONE, ALL, ONLY_REPLY_TO_CHANNEL
|
|
633
|
-
* @param includeParentMessageInfo
|
|
634
|
-
* @param includeThreadInfo
|
|
635
|
-
* @param includePollDetails Determines whether to include all properties of a poll resource with a full list of options in the results. If set to false, a selection of poll resource properties consisting of id, title, close_at, created_at, updated_at, status, and message_id are returned. (Default: false) * To use this property, the polls feature should be turned on in Settings > Chat > Features on Sendbird Dashboard.
|
|
636
|
-
* @param withSortedMetaArray Determines whether to include the sorted_metaarray property in the response. (Default: false)
|
|
637
|
-
* @param showSubchannelMessagesOnly
|
|
638
|
-
* @param userId
|
|
639
|
-
* @param apiToken
|
|
640
|
-
*/
|
|
641
|
-
public listMessages(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageTs: number, messageId: number, prevLimit?: number, nextLimit?: number, include?: boolean, reverse?: boolean, senderId?: string, senderIds?: string, operatorFilter?: 'all' | 'operator' | 'nonoperator', customTypes?: string, messageType?: 'MESG' | 'FILE' | 'ADMM', includingRemoved?: boolean, includeReactions?: boolean, includeReplyType?: 'NONE' | 'ALL' | 'ONLY_REPLY_TO_CHANNEL', includeParentMessageInfo?: boolean, includeThreadInfo?: boolean, includePollDetails?: boolean, withSortedMetaArray?: boolean, showSubchannelMessagesOnly?: boolean, userId?: string, apiToken?: string, _options?: Configuration): Promise<ListMessagesResponse> {
|
|
642
|
-
const result = this.api.listMessages(channelType, channelUrl, messageTs, messageId, prevLimit, nextLimit, include, reverse, senderId, senderIds, operatorFilter, customTypes, messageType, includingRemoved, includeReactions, includeReplyType, includeParentMessageInfo, includeThreadInfo, includePollDetails, withSortedMetaArray, showSubchannelMessagesOnly, userId, apiToken, _options);
|
|
643
|
-
return result.toPromise();
|
|
644
|
-
}
|
|
645
|
-
|
|
646
|
-
/**
|
|
647
|
-
* ## Mark all messages as read Marks all messages in a group channel as read for a specific user. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/platform-api/v3/message/read-receipts/mark-all-messages-as-read-message#1-mark-all-messages-as-read
|
|
648
|
-
* Mark all messages as read
|
|
649
|
-
* @param channelUrl (Required)
|
|
650
|
-
* @param apiToken
|
|
651
|
-
* @param markChannelMessagesAsReadRequest
|
|
652
|
-
*/
|
|
653
|
-
public markChannelMessagesAsRead(channelUrl: string, apiToken?: string, markChannelMessagesAsReadRequest?: MarkChannelMessagesAsReadRequest, _options?: Configuration): Promise<any> {
|
|
654
|
-
const result = this.api.markChannelMessagesAsRead(channelUrl, apiToken, markChannelMessagesAsReadRequest, _options);
|
|
655
|
-
return result.toPromise();
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
/**
|
|
659
|
-
* ## Migrate messages Using our migration API, you can migrate the messages from another system into a Sendbird system's [channel](https://sendbird.com/docs/chat/v3/platform-api/guides/channel-types) which consists of users, messages, and other chat-related data. > To turn on this feature, [contact our support team](https://dashboard.sendbird.com/settings/contact_us). There are three things to do in advance before the migration. Follow the instructions below: 1. Register the users of your current chat solution to your Sendbird application. You can migrate the users into the Sendbird system using the [user creation API](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-create-a-user). 2. Create either an [open](https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-create-a-channel) or a [group](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-create-a-channel) channel to migrate the messages of your chat solution. The Sendbird system doesn't create a channel for your migration automatically. 3. The maximum number of migrated messages per call is 100. To avoid the failure during your migration, you must adjust the number of messages to process at once via the API. https://sendbird.com/docs/chat/platform-api/v3/message/migration/migrate-messages#1-migrate-messages
|
|
660
|
-
* Migrate messages
|
|
661
|
-
* @param targetChannelUrl (Required)
|
|
662
|
-
* @param apiToken
|
|
663
|
-
* @param migrateMessagesRequest
|
|
664
|
-
*/
|
|
665
|
-
public migrateMessages(targetChannelUrl: string, apiToken?: string, migrateMessagesRequest?: MigrateMessagesRequest, _options?: Configuration): Promise<any> {
|
|
666
|
-
const result = this.api.migrateMessages(targetChannelUrl, apiToken, migrateMessagesRequest, _options);
|
|
667
|
-
return result.toPromise();
|
|
668
|
-
}
|
|
669
|
-
|
|
670
|
-
/**
|
|
671
|
-
* ## Remove extra data from a message Removes specific items from a message by their keys. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/message-remove-metadata#1-remove-metadata ----------------------------
|
|
672
|
-
* Remove extra data from a message
|
|
673
|
-
* @param channelType (Required)
|
|
674
|
-
* @param channelUrl (Required)
|
|
675
|
-
* @param messageId (Required)
|
|
676
|
-
* @param keys
|
|
677
|
-
* @param apiToken
|
|
678
|
-
*/
|
|
679
|
-
public removeExtraDataFromAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageId: string, keys?: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
680
|
-
const result = this.api.removeExtraDataFromAMessage(channelType, channelUrl, messageId, keys, apiToken, _options);
|
|
681
|
-
return result.toPromise();
|
|
682
|
-
}
|
|
683
|
-
|
|
684
|
-
/**
|
|
685
|
-
* ## Send a message You can use this action to send a text message, a file message, or an admin message to a specific channel. Sendbird Chat SDKs and the platform API allows you to upload any type of files in messages to the Sendbird server. See [Message Overview](https://sendbird.com/docs/chat/platform-api/v3/message/message-overview) for more information on each message type. Messages are sent between client devices running the Sendbird Chat SDK or UIKit as well as programmatically from businesses to their customers. For instance, a delivery app can automatically send a message like \"Arriving in one minute!\" on behalf of a delivery driver. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/send-a-message#1-send-a-message ----------------------------
|
|
686
|
-
* Send a message
|
|
687
|
-
* @param channelType (Required)
|
|
688
|
-
* @param channelUrl (Required)
|
|
689
|
-
* @param apiToken
|
|
690
|
-
* @param sendAMessageRequest
|
|
691
|
-
*/
|
|
692
|
-
public sendAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, apiToken?: string, sendAMessageRequest?: SendAMessageRequest, _options?: Configuration): Promise<SendbirdMessageResponse> {
|
|
693
|
-
const result = this.api.sendAMessage(channelType, channelUrl, apiToken, sendAMessageRequest, _options);
|
|
694
|
-
return result.toPromise();
|
|
695
|
-
}
|
|
696
|
-
|
|
697
|
-
/**
|
|
698
|
-
* ## Update a message Updates specific information on a message. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/update-a-message#1-update-a-message ----------------------------
|
|
699
|
-
* Update a message
|
|
700
|
-
* @param channelType (Required)
|
|
701
|
-
* @param channelUrl (Required)
|
|
702
|
-
* @param messageId (Required)
|
|
703
|
-
* @param apiToken
|
|
704
|
-
* @param updateAMessageRequest
|
|
705
|
-
*/
|
|
706
|
-
public updateAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageId: string, apiToken?: string, updateAMessageRequest?: UpdateAMessageRequest, _options?: Configuration): Promise<SendbirdMessageResponse> {
|
|
707
|
-
const result = this.api.updateAMessage(channelType, channelUrl, messageId, apiToken, updateAMessageRequest, _options);
|
|
708
|
-
return result.toPromise();
|
|
709
|
-
}
|
|
710
|
-
|
|
711
|
-
/**
|
|
712
|
-
* ## Update extra data in a message Updates the values of specific items by their keys. https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/message-update-metadata#1-update-metadata ----------------------------
|
|
713
|
-
* Update extra data in a message
|
|
714
|
-
* @param channelType (Required)
|
|
715
|
-
* @param channelUrl (Required)
|
|
716
|
-
* @param messageId (Required)
|
|
717
|
-
* @param apiToken
|
|
718
|
-
* @param updateExtraDataInAMessageRequest
|
|
719
|
-
*/
|
|
720
|
-
public updateExtraDataInAMessage(channelType: 'open_channels' | 'group_channels', channelUrl: string, messageId: string, apiToken?: string, updateExtraDataInAMessageRequest?: UpdateExtraDataInAMessageRequest, _options?: Configuration): Promise<UpdateExtraDataInAMessageResponse> {
|
|
721
|
-
const result = this.api.updateExtraDataInAMessage(channelType, channelUrl, messageId, apiToken, updateExtraDataInAMessageRequest, _options);
|
|
722
|
-
return result.toPromise();
|
|
723
|
-
}
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
}
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
import { ObservableMetadataApi } from './ObservableAPI';
|
|
731
|
-
|
|
732
|
-
import { MetadataApiRequestFactory, MetadataApiResponseProcessor} from "../apis/MetadataApi";
|
|
733
|
-
export class PromiseMetadataApi {
|
|
734
|
-
private api: ObservableMetadataApi
|
|
735
|
-
|
|
736
|
-
public constructor(
|
|
737
|
-
configuration: Configuration,
|
|
738
|
-
requestFactory?: MetadataApiRequestFactory,
|
|
739
|
-
responseProcessor?: MetadataApiResponseProcessor
|
|
740
|
-
) {
|
|
741
|
-
this.api = new ObservableMetadataApi(configuration, requestFactory, responseProcessor);
|
|
742
|
-
}
|
|
743
|
-
|
|
744
|
-
/**
|
|
745
|
-
* ## Create a channel metadata Creates a channel metadata's items to store in a channel. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-metadata/channel-create-metadata#1-create-metadata ----------------------------
|
|
746
|
-
* Create a channel metadata
|
|
747
|
-
* @param channelType (Required)
|
|
748
|
-
* @param channelUrl (Required)
|
|
749
|
-
* @param apiToken
|
|
750
|
-
* @param createAChannelMetadataRequest
|
|
751
|
-
*/
|
|
752
|
-
public createAChannelMetadata(channelType: 'open_channels' | 'group_channels', channelUrl: string, apiToken?: string, createAChannelMetadataRequest?: CreateAChannelMetadataRequest, _options?: Configuration): Promise<CreateAChannelMetadataResponse> {
|
|
753
|
-
const result = this.api.createAChannelMetadata(channelType, channelUrl, apiToken, createAChannelMetadataRequest, _options);
|
|
754
|
-
return result.toPromise();
|
|
755
|
-
}
|
|
756
|
-
|
|
757
|
-
/**
|
|
758
|
-
* ## Delete a channel metadata Deletes a channel metadata's one or all items that are stored in a channel. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-metadata/channel-delete-metadata#1-delete-metadata ---------------------------- `channel_type` Type: string Description: Specifies the type of the channel. Either open_channels or group_channels. `channel_url` Type: string Description: Specifies the URL of the channel which has the metadata to delete.
|
|
759
|
-
* Delete a channel metadata - When deleting all items of a channel metadata
|
|
760
|
-
* @param channelType (Required)
|
|
761
|
-
* @param channelUrl (Required)
|
|
762
|
-
* @param key
|
|
763
|
-
* @param apiToken
|
|
764
|
-
*/
|
|
765
|
-
public deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata(channelType: 'open_channels' | 'group_channels', channelUrl: string, key?: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
766
|
-
const result = this.api.deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata(channelType, channelUrl, key, apiToken, _options);
|
|
767
|
-
return result.toPromise();
|
|
768
|
-
}
|
|
769
|
-
|
|
770
|
-
/**
|
|
771
|
-
* ## Update a channel metadata Updates existing items of a channel metadata by their keys, or adds new items to the metadata. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-metadata/channel-update-metadata#1-update-metadata ---------------------------- `channel_type` Type: string Description: Specifies the type of the channel. Either open_channels or group_channels. `channel_url` Type: string Description: Specifies the URL of the target channel.
|
|
772
|
-
* Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata
|
|
773
|
-
* @param channelType (Required)
|
|
774
|
-
* @param channelUrl (Required)
|
|
775
|
-
* @param apiToken
|
|
776
|
-
* @param updateAChannelMetadataRequest
|
|
777
|
-
*/
|
|
778
|
-
public updateAChannelMetadata(channelType: 'open_channels' | 'group_channels', channelUrl: string, apiToken?: string, updateAChannelMetadataRequest?: UpdateAChannelMetadataRequest, _options?: Configuration): Promise<any> {
|
|
779
|
-
const result = this.api.updateAChannelMetadata(channelType, channelUrl, apiToken, updateAChannelMetadataRequest, _options);
|
|
780
|
-
return result.toPromise();
|
|
781
|
-
}
|
|
782
|
-
|
|
783
|
-
/**
|
|
784
|
-
* ## View a channel metadata Retrieves a channel metadata's one or more items that are stored in a channel. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-metadata/channel-get-metadata#1-get-metadata ---------------------------- `channel_type` Type: string Description: Specifies the type of the channel. Either open_channels or group_channels. `channel_url` Type: string Description: Specifies the URL of the target channel.
|
|
785
|
-
* View a channel metadata - When retrieving all items of a channel metadata
|
|
786
|
-
* @param channelType (Required)
|
|
787
|
-
* @param channelUrl (Required)
|
|
788
|
-
* @param key
|
|
789
|
-
* @param keys In a query string, specifies an array of one or more keys of the metadata items. If not specified, all items of the metadata are returned. If specified, only the items that match the parameter values are returned. URL encoding each key is recommended.
|
|
790
|
-
* @param apiToken
|
|
791
|
-
*/
|
|
792
|
-
public viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata(channelType: 'open_channels' | 'group_channels', channelUrl: string, key?: string, keys?: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
793
|
-
const result = this.api.viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata(channelType, channelUrl, key, keys, apiToken, _options);
|
|
794
|
-
return result.toPromise();
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
}
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
import { ObservableModerationApi } from './ObservableAPI';
|
|
803
|
-
|
|
804
|
-
import { ModerationApiRequestFactory, ModerationApiResponseProcessor} from "../apis/ModerationApi";
|
|
805
|
-
export class PromiseModerationApi {
|
|
806
|
-
private api: ObservableModerationApi
|
|
807
|
-
|
|
808
|
-
public constructor(
|
|
809
|
-
configuration: Configuration,
|
|
810
|
-
requestFactory?: ModerationApiRequestFactory,
|
|
811
|
-
responseProcessor?: ModerationApiResponseProcessor
|
|
812
|
-
) {
|
|
813
|
-
this.api = new ObservableModerationApi(configuration, requestFactory, responseProcessor);
|
|
814
|
-
}
|
|
815
|
-
|
|
816
|
-
/**
|
|
817
|
-
* ## 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)
|
|
818
|
-
* Block a user
|
|
819
|
-
* @param userId (Required)
|
|
820
|
-
* @param apiToken
|
|
821
|
-
* @param blockAUserRequest
|
|
822
|
-
*/
|
|
823
|
-
public blockAUser(userId: string, apiToken?: string, blockAUserRequest?: BlockAUserRequest, _options?: Configuration): Promise<BlockAUserResponse> {
|
|
824
|
-
const result = this.api.blockAUser(userId, apiToken, blockAUserRequest, _options);
|
|
825
|
-
return result.toPromise();
|
|
826
|
-
}
|
|
827
|
-
|
|
828
|
-
/**
|
|
829
|
-
* ## Freeze a group channel Freezes or unfreezes a group channel. > **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). [https://sendbird.com/docs/chat/platform-api/v3/moderation/freezing-a-channel/freeze-a-group-channel#1-freeze-a-group-channel](https://sendbird.com/docs/chat/platform-api/v3/moderation/freezing-a-channel/freeze-a-group-channel#1-freeze-a-group-channel)
|
|
830
|
-
* Freeze a group channel
|
|
831
|
-
* @param channelUrl (Required)
|
|
832
|
-
* @param apiToken
|
|
833
|
-
* @param freezeAGroupChannelRequest
|
|
834
|
-
*/
|
|
835
|
-
public freezeAGroupChannel(channelUrl: string, apiToken?: string, freezeAGroupChannelRequest?: FreezeAGroupChannelRequest, _options?: Configuration): Promise<SendbirdGroupChannelDetail> {
|
|
836
|
-
const result = this.api.freezeAGroupChannel(channelUrl, apiToken, freezeAGroupChannelRequest, _options);
|
|
837
|
-
return result.toPromise();
|
|
838
|
-
}
|
|
839
|
-
|
|
840
|
-
/**
|
|
841
|
-
* ## Freeze an open channel Freezes or unfreezes an open channel. > **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). [https://sendbird.com/docs/chat/platform-api/v3/moderation/freezing-a-channel/freeze-an-open-channel#1-freeze-an-open-channel](https://sendbird.com/docs/chat/platform-api/v3/moderation/freezing-a-channel/freeze-an-open-channel#1-freeze-an-open-channel)
|
|
842
|
-
* Freeze an open channel
|
|
843
|
-
* @param channelUrl (Required)
|
|
844
|
-
* @param apiToken
|
|
845
|
-
* @param freezeAnOpenChannelRequest
|
|
846
|
-
*/
|
|
847
|
-
public freezeAnOpenChannel(channelUrl: string, apiToken?: string, freezeAnOpenChannelRequest?: FreezeAnOpenChannelRequest, _options?: Configuration): Promise<SendbirdOpenChannel> {
|
|
848
|
-
const result = this.api.freezeAnOpenChannel(channelUrl, apiToken, freezeAnOpenChannelRequest, _options);
|
|
849
|
-
return result.toPromise();
|
|
850
|
-
}
|
|
851
|
-
|
|
852
|
-
/**
|
|
853
|
-
* ## List blocked by and blocking users This action retrieves a list of users who are either blocked by a specific user or a list of users who are blocking a specific user. [https://sendbird.com/docs/chat/platform-api/v3/moderation/listing-blocked-and-blocking-users/list-blocked-and-blocking-users#1-list-blocked-by-and-blocking-users](https://sendbird.com/docs/chat/platform-api/v3/moderation/listing-blocked-and-blocking-users/list-blocked-and-blocking-users#1-list-blocked-by-and-blocking-users) `user_id` Type: string Description: Specifies the unique ID of the target user.
|
|
854
|
-
* List blocked users
|
|
855
|
-
* @param userId (Required)
|
|
856
|
-
* @param list Specifies whether to retrieve a list of users who are blocked by the specified user or a list of users who are blocking the specified user. Acceptable values are blocked_by_me and blocking_me. The `me` in the values refers to the user specified in the parameter. (Default: blocked_by_me)
|
|
857
|
-
* @param token
|
|
858
|
-
* @param limit
|
|
859
|
-
* @param userIds Specifies the user IDs of the blocked or blocking users to search for. The value should be a comma-separated string that consists of multiple URL encoded user IDs.
|
|
860
|
-
* @param metadatakey
|
|
861
|
-
* @param metadatavaluesIn
|
|
862
|
-
* @param apiToken
|
|
863
|
-
*/
|
|
864
|
-
public listBlockedUsers(userId: string, list?: 'blocked_by_me' | 'blocking_me', token?: string, limit?: number, userIds?: string, metadatakey?: string, metadatavaluesIn?: string, apiToken?: string, _options?: Configuration): Promise<ListBlockedUsersResponse> {
|
|
865
|
-
const result = this.api.listBlockedUsers(userId, list, token, limit, userIds, metadatakey, metadatavaluesIn, apiToken, _options);
|
|
866
|
-
return result.toPromise();
|
|
867
|
-
}
|
|
868
|
-
|
|
869
|
-
/**
|
|
870
|
-
* ## Unblock a user Unblocks the user. https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/unblock-a-user#1-unblock-a-user
|
|
871
|
-
* Unblock a user
|
|
872
|
-
* @param userId (Required)
|
|
873
|
-
* @param targetId (Required)
|
|
874
|
-
* @param apiToken
|
|
875
|
-
*/
|
|
876
|
-
public unblockAUser(userId: string, targetId: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
877
|
-
const result = this.api.unblockAUser(userId, targetId, apiToken, _options);
|
|
878
|
-
return result.toPromise();
|
|
879
|
-
}
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
}
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
import { ObservableOpenChannelApi } from './ObservableAPI';
|
|
887
|
-
|
|
888
|
-
import { OpenChannelApiRequestFactory, OpenChannelApiResponseProcessor} from "../apis/OpenChannelApi";
|
|
889
|
-
export class PromiseOpenChannelApi {
|
|
890
|
-
private api: ObservableOpenChannelApi
|
|
891
|
-
|
|
892
|
-
public constructor(
|
|
893
|
-
configuration: Configuration,
|
|
894
|
-
requestFactory?: OpenChannelApiRequestFactory,
|
|
895
|
-
responseProcessor?: OpenChannelApiResponseProcessor
|
|
896
|
-
) {
|
|
897
|
-
this.api = new ObservableOpenChannelApi(configuration, requestFactory, responseProcessor);
|
|
898
|
-
}
|
|
899
|
-
|
|
900
|
-
/**
|
|
901
|
-
* ## Create an open channel You can create an [open channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel) that facilitates conversations for millions of users. Open channels allow a seamless chat experience possible for all participants by using [dynamic partitioning](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#4-how-dynamic-partitioning-works) which creates subchannels that each handle up to tens of thousands of participants. Because users don't need invitations to join open channels, short-lived live events like concerts or live streams that don't require a sustained membership are good use cases for open channels. [https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-create-a-channel](https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-create-a-channel)
|
|
902
|
-
* Create an open channel
|
|
903
|
-
* @param apiToken
|
|
904
|
-
* @param createAnOpenChannelRequest
|
|
905
|
-
*/
|
|
906
|
-
public createAnOpenChannel(apiToken?: string, createAnOpenChannelRequest?: CreateAnOpenChannelRequest, _options?: Configuration): Promise<SendbirdOpenChannel> {
|
|
907
|
-
const result = this.api.createAnOpenChannel(apiToken, createAnOpenChannelRequest, _options);
|
|
908
|
-
return result.toPromise();
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
/**
|
|
912
|
-
* ## Delete an open channel You can delete an open channel using this API. See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/delete-an-open-channel#1-delete-an-open-channel
|
|
913
|
-
* Delete an open channel
|
|
914
|
-
* @param channelUrl (Required)
|
|
915
|
-
* @param apiToken
|
|
916
|
-
*/
|
|
917
|
-
public deleteAnOpenChannel(channelUrl: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
918
|
-
const result = this.api.deleteAnOpenChannel(channelUrl, apiToken, _options);
|
|
919
|
-
return result.toPromise();
|
|
920
|
-
}
|
|
921
|
-
|
|
922
|
-
/**
|
|
923
|
-
* ## Get an open channel This action retrieves information about a specific [open channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel). [https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/get-an-open-channel#1-get-an-open-channel](https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/get-an-open-channel#1-get-an-open-channel)
|
|
924
|
-
* Get an open channel
|
|
925
|
-
* @param channelUrl (Required)
|
|
926
|
-
* @param apiToken
|
|
927
|
-
* @param includeOperators Determines whether to include a list of operators in the response. (Default: false)
|
|
928
|
-
*/
|
|
929
|
-
public getAnOpenChannel(channelUrl: string, apiToken?: string, includeOperators?: boolean, _options?: Configuration): Promise<SendbirdOpenChannel> {
|
|
930
|
-
const result = this.api.getAnOpenChannel(channelUrl, apiToken, includeOperators, _options);
|
|
931
|
-
return result.toPromise();
|
|
932
|
-
}
|
|
933
|
-
|
|
934
|
-
/**
|
|
935
|
-
* ## List operators of an open channel You can retrieve a list of operators of an open channel using this API. https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/list-operators-of-an-open-channel#1-list-operators-of-an-open-channel `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of operators.
|
|
936
|
-
* List operators of an open channel
|
|
937
|
-
* @param channelUrl (Required)
|
|
938
|
-
* @param token
|
|
939
|
-
* @param limit
|
|
940
|
-
* @param apiToken
|
|
941
|
-
*/
|
|
942
|
-
public listChannelOperators(channelUrl: string, token?: string, limit?: number, apiToken?: string, _options?: Configuration): Promise<ListOperatorsResponse> {
|
|
943
|
-
const result = this.api.listChannelOperators(channelUrl, token, limit, apiToken, _options);
|
|
944
|
-
return result.toPromise();
|
|
945
|
-
}
|
|
946
|
-
|
|
947
|
-
/**
|
|
948
|
-
* ## List open channels This action retrieves a list of [open channels](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel). You can use various query parameters to determine the search scope and select what kind of information you want to receive about the queried channels. [https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-open-channels#1-list-open-channels](https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-open-channels#1-list-open-channels)
|
|
949
|
-
* List open channels
|
|
950
|
-
* @param token
|
|
951
|
-
* @param channelUrls Specifies a comma-separated string of one or more open channel URLs to restrict the search scope. URL encoding each channel URL is recommended.
|
|
952
|
-
* @param limit
|
|
953
|
-
* @param customTypes Specifies a comma-separated string of one or more custom types to filter open channels. Urlencoding each type is recommended (for example, ?custom_types=urlencoded_type_1,urlencoded_type_2). If not specified, all channels are returned, regardless of their custom type.
|
|
954
|
-
* @param nameContains
|
|
955
|
-
* @param urlContains
|
|
956
|
-
* @param showFrozen Determines whether to include frozen channels in the response. Frozen channels are channels where only channel operators are allowed to send messages. (Default: true)
|
|
957
|
-
* @param showMetadata Determines whether to include channel metadata in the response. (Default: false)
|
|
958
|
-
* @param apiToken
|
|
959
|
-
*/
|
|
960
|
-
public listOpenChannels(token?: string, channelUrls?: string, limit?: number, customTypes?: string, nameContains?: string, urlContains?: string, showFrozen?: boolean, showMetadata?: boolean, apiToken?: string, _options?: Configuration): Promise<ListOpenChannelsResponse> {
|
|
961
|
-
const result = this.api.listOpenChannels(token, channelUrls, limit, customTypes, nameContains, urlContains, showFrozen, showMetadata, apiToken, _options);
|
|
962
|
-
return result.toPromise();
|
|
963
|
-
}
|
|
964
|
-
|
|
965
|
-
/**
|
|
966
|
-
* ## Register operators to an open channel You can register one or more operators to an open channel using this API. https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/register-operators-to-an-open-channel#1-register-operators-to-an-open-channel
|
|
967
|
-
* Register operators to an open channel
|
|
968
|
-
* @param channelUrl (Required)
|
|
969
|
-
* @param apiToken
|
|
970
|
-
* @param registerOperatorsToAGroupChannelRequest
|
|
971
|
-
*/
|
|
972
|
-
public registerOperators(channelUrl: string, apiToken?: string, registerOperatorsToAGroupChannelRequest?: RegisterOperatorsToAGroupChannelRequest, _options?: Configuration): Promise<any> {
|
|
973
|
-
const result = this.api.registerOperators(channelUrl, apiToken, registerOperatorsToAGroupChannelRequest, _options);
|
|
974
|
-
return result.toPromise();
|
|
975
|
-
}
|
|
976
|
-
|
|
977
|
-
/**
|
|
978
|
-
* ## Unregister operators from an open channel You can unregister operators in an open channel but keep them in the channel as participants using this API. https://sendbird.com/docs/chat/platform-api/v3/user/assigning-a-user-role/unregister-operators-from-an-open-channel#1-unregister-operators-from-an-open-channel `channel_url` Type: string Description: Specifies the URL of the channel to cancel the registration of operators.
|
|
979
|
-
* Unregister operators from an open channel
|
|
980
|
-
* @param channelUrl (Required)
|
|
981
|
-
* @param operatorIds Specifies an array of one or more operator IDs to unregister from the channel. The operators in this array remain as participants of the channel after losing their operational roles. Urlencoding each operator ID is recommended. An example of a Urlencoded array would be ?operator_ids=urlencoded_id_1,urlencoded_id_2.
|
|
982
|
-
* @param deleteAll Determines whether to unregister all operators and leave them as the participants of the channel. When this is set to true, the operator_ids property isn't effective and doesn't need to be specified in the request. (Default: false)
|
|
983
|
-
* @param apiToken
|
|
984
|
-
*/
|
|
985
|
-
public unregisterOperators(channelUrl: string, operatorIds: string, deleteAll?: boolean, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
986
|
-
const result = this.api.unregisterOperators(channelUrl, operatorIds, deleteAll, apiToken, _options);
|
|
987
|
-
return result.toPromise();
|
|
988
|
-
}
|
|
989
|
-
|
|
990
|
-
/**
|
|
991
|
-
* ## Update an open channel You can update information about an open channel using this API. You can add a cover image to a channel to better identify the channel or specify a custom channel type for grouping channels by custom type. See [this page](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-open-channel-vs-group-channel-vs-supergroup-channel) to learn more about channel types. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/update-an-open-channel#1-update-an-open-channel
|
|
992
|
-
* Update an open channel
|
|
993
|
-
* @param channelUrl (Required)
|
|
994
|
-
* @param apiToken
|
|
995
|
-
* @param updateAnOpenChannelRequest
|
|
996
|
-
*/
|
|
997
|
-
public updateAnOpenChannel(channelUrl: string, apiToken?: string, updateAnOpenChannelRequest?: UpdateAnOpenChannelRequest, _options?: Configuration): Promise<SendbirdOpenChannel> {
|
|
998
|
-
const result = this.api.updateAnOpenChannel(channelUrl, apiToken, updateAnOpenChannelRequest, _options);
|
|
999
|
-
return result.toPromise();
|
|
1000
|
-
}
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
}
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
import { ObservableStatisticsApi } from './ObservableAPI';
|
|
1008
|
-
|
|
1009
|
-
import { StatisticsApiRequestFactory, StatisticsApiResponseProcessor} from "../apis/StatisticsApi";
|
|
1010
|
-
export class PromiseStatisticsApi {
|
|
1011
|
-
private api: ObservableStatisticsApi
|
|
1012
|
-
|
|
1013
|
-
public constructor(
|
|
1014
|
-
configuration: Configuration,
|
|
1015
|
-
requestFactory?: StatisticsApiRequestFactory,
|
|
1016
|
-
responseProcessor?: StatisticsApiResponseProcessor
|
|
1017
|
-
) {
|
|
1018
|
-
this.api = new ObservableStatisticsApi(configuration, requestFactory, responseProcessor);
|
|
1019
|
-
}
|
|
1020
|
-
|
|
1021
|
-
/**
|
|
1022
|
-
* ## View number of daily active users Retrieves the number of daily active users of an application. > **Note**: This metric is scheduled to be calculated every 30 minutes, starting at 00:00 UTC, with the first update at 00:30 UTC. [https://sendbird.com/docs/chat/platform-api/v3/statistics/daus-and-maus/get-number-of-daily-active-users#1-get-number-of-daily-active-users](https://sendbird.com/docs/chat/platform-api/v3/statistics/daus-and-maus/get-number-of-daily-active-users#1-get-number-of-daily-active-users)
|
|
1023
|
-
* View number of daily active users
|
|
1024
|
-
* @param date YYYY-MM-DD
|
|
1025
|
-
* @param apiToken
|
|
1026
|
-
*/
|
|
1027
|
-
public viewNumberOfDailyActiveUsers(date?: string, apiToken?: string, _options?: Configuration): Promise<ViewNumberOfDailyActiveUsersResponse> {
|
|
1028
|
-
const result = this.api.viewNumberOfDailyActiveUsers(date, apiToken, _options);
|
|
1029
|
-
return result.toPromise();
|
|
1030
|
-
}
|
|
1031
|
-
|
|
1032
|
-
/**
|
|
1033
|
-
* ## View number of monthly active users Retrieves the number of monthly active users of an application. > **Note**: This metric is scheduled to be calculated every 30 minutes, starting at 00:00 UTC, with the first update at 00:30 UTC. [https://sendbird.com/docs/chat/platform-api/v3/statistics/daus-and-maus/get-number-of-monthly-active-users#1-get-number-of-monthly-active-users](https://sendbird.com/docs/chat/platform-api/v3/statistics/daus-and-maus/get-number-of-monthly-active-users#1-get-number-of-monthly-active-users)
|
|
1034
|
-
* View number of monthly active users
|
|
1035
|
-
* @param date YYYY-MM-DD
|
|
1036
|
-
* @param apiToken
|
|
1037
|
-
*/
|
|
1038
|
-
public viewNumberOfMonthlyActiveUsers(date?: string, apiToken?: string, _options?: Configuration): Promise<ViewNumberOfMonthlyActiveUsersResponse> {
|
|
1039
|
-
const result = this.api.viewNumberOfMonthlyActiveUsers(date, apiToken, _options);
|
|
1040
|
-
return result.toPromise();
|
|
1041
|
-
}
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
}
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
import { ObservableUserApi } from './ObservableAPI';
|
|
1049
|
-
|
|
1050
|
-
import { UserApiRequestFactory, UserApiResponseProcessor} from "../apis/UserApi";
|
|
1051
|
-
export class PromiseUserApi {
|
|
1052
|
-
private api: ObservableUserApi
|
|
1053
|
-
|
|
1054
|
-
public constructor(
|
|
1055
|
-
configuration: Configuration,
|
|
1056
|
-
requestFactory?: UserApiRequestFactory,
|
|
1057
|
-
responseProcessor?: UserApiResponseProcessor
|
|
1058
|
-
) {
|
|
1059
|
-
this.api = new ObservableUserApi(configuration, requestFactory, responseProcessor);
|
|
1060
|
-
}
|
|
1061
|
-
|
|
1062
|
-
/**
|
|
1063
|
-
* ## Add a registration or device token > __Note__: A user can have up to 20 FCM registration tokens, 20 HMS device tokens, and 20 APNs device tokens each. The oldest token will be deleted before a new token is added for a user who already has 20 registration or device tokens. Only the 20 newest tokens will be maintained for users who already have more than 20 of each token type. To send notification requests to push notification services on behalf of your server, adds a specific user's FCM registration token, HMS device token, or APNs device token to Sendbird server. Depending on which push service you are using, you can pass one of two values in `token_type`: `gcm`, `huawei`, or `apns`. A FCM registration token and an APNs device token allow identification of each client app instance on each device, and are generated and registered by Android and iOS apps through the corresponding SDKs. Use this method if you need to register a token via your own server. > __Note__: For more information on the registration token and device token, visit the Google's [FCM](https://firebase.google.com/docs/auth/admin/verify-id-tokens) page, Huawei's [Push kit](https://developer.huawei.com/consumer/en/doc/development/HMSCore-Guides/service-introduction-0000001050040060) and Apple's [APNs](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html) page. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-add-a-registration-or-device-token ----------------------------
|
|
1064
|
-
* Add a registration or device token
|
|
1065
|
-
* @param userId (Required)
|
|
1066
|
-
* @param tokenType (Required)
|
|
1067
|
-
* @param apiToken
|
|
1068
|
-
* @param addARegistrationOrDeviceTokenRequest
|
|
1069
|
-
*/
|
|
1070
|
-
public addARegistrationOrDeviceToken(userId: string, tokenType: 'gcm' | 'huawei' | 'apns', apiToken?: string, addARegistrationOrDeviceTokenRequest?: AddARegistrationOrDeviceTokenRequest, _options?: Configuration): Promise<AddARegistrationOrDeviceTokenResponse> {
|
|
1071
|
-
const result = this.api.addARegistrationOrDeviceToken(userId, tokenType, apiToken, addARegistrationOrDeviceTokenRequest, _options);
|
|
1072
|
-
return result.toPromise();
|
|
1073
|
-
}
|
|
1074
|
-
|
|
1075
|
-
/**
|
|
1076
|
-
* ## Choose a push notification content template Users can choose a template to determine how push notifications appear to them. Push notification content templates are pre-formatted forms that can be customized to display your own push notification messages on a user's device. Sendbird provides two types: `default` and `alternative`. Go to **Settings** > **Chat** > **Push notifications** > **Push notification content templates** on [Sendbird Dashboard](https://dashboard.sendbird.com/auth/signin) to customize the templates. If the `push_message_template` property is specified when [sending a message](https://sendbird.com/docs/chat/platform-api/v3/message/messaging-basics/send-a-message), the content template customized for the message takes precedence over the user's choice. > **Note**: Push notifications are only available for group channels. https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/choose-a-push-notification-content-template#1-choose-a-push-notification-content-template
|
|
1077
|
-
* Choose a push notification content template
|
|
1078
|
-
* @param userId (Required)
|
|
1079
|
-
* @param apiToken
|
|
1080
|
-
* @param chooseAPushNotificationContentTemplateRequest
|
|
1081
|
-
*/
|
|
1082
|
-
public chooseAPushNotificationContentTemplate(userId: string, apiToken?: string, chooseAPushNotificationContentTemplateRequest?: ChooseAPushNotificationContentTemplateRequest, _options?: Configuration): Promise<ChooseAPushNotificationContentTemplateResponse> {
|
|
1083
|
-
const result = this.api.chooseAPushNotificationContentTemplate(userId, apiToken, chooseAPushNotificationContentTemplateRequest, _options);
|
|
1084
|
-
return result.toPromise();
|
|
1085
|
-
}
|
|
1086
|
-
|
|
1087
|
-
/**
|
|
1088
|
-
* ## Create a user You should create a user in your Sendbird application to initiate conversations in channels. A user is identified by its unique user ID, and additionally have a changeable nickname, profile image, and so on. Users are at the core of all conversations. Sendbird applications are made up of users who chat in either Open Channels or Group Channels. Using this API, it is possible to have fine grained control over your users and what those users can do. To learn more about users, see [User overview](https://sendbird.com/docs/chat/platform-api/v3/user/user-overview#2-resource-representation). https://sendbird.com/docs/chat/platform-api/v3/user/creating-users/create-a-user#1-create-a-user
|
|
1089
|
-
* Create a user
|
|
1090
|
-
* @param apiToken
|
|
1091
|
-
* @param createAUserRequest
|
|
1092
|
-
*/
|
|
1093
|
-
public createAUser(apiToken?: string, createAUserRequest?: CreateAUserRequest, _options?: Configuration): Promise<SendbirdUser> {
|
|
1094
|
-
const result = this.api.createAUser(apiToken, createAUserRequest, _options);
|
|
1095
|
-
return result.toPromise();
|
|
1096
|
-
}
|
|
1097
|
-
|
|
1098
|
-
/**
|
|
1099
|
-
* ## Create user token This action issues a session token for user authentication. Session tokens provide an efficient stateless authentication method by not storing the tokens in the Sendbird database, and thus improving the server's performance. See [access token vs. session token](https://sendbird.com/docs/chat/platform-api/v3/user/creating-users/create-a-user#2-access-token-vs-session-token) to learn more about authenticating users. > **Note**: The endpoint `/users/{user_id}` is deprecated. Use `/users/{user_id}/token` for greater efficiency. https://sendbird.com/docs/chat/platform-api/v3/user/managing-session-tokens/issue-a-session-token#1-issue-a-session-token
|
|
1100
|
-
* Create user token
|
|
1101
|
-
* @param userId (Required)
|
|
1102
|
-
* @param apiToken
|
|
1103
|
-
* @param createUserTokenRequest
|
|
1104
|
-
*/
|
|
1105
|
-
public createUserToken(userId: string, apiToken?: string, createUserTokenRequest?: CreateUserTokenRequest, _options?: Configuration): Promise<CreateUserTokenResponse> {
|
|
1106
|
-
const result = this.api.createUserToken(userId, apiToken, createUserTokenRequest, _options);
|
|
1107
|
-
return result.toPromise();
|
|
1108
|
-
}
|
|
1109
|
-
|
|
1110
|
-
/**
|
|
1111
|
-
* ## Delete a user You can delete a user from your Sendbird application using this API. > **Note**: This API deletes user data and metadata, except for their messages. If you wish to delete user data including their messages, use the [GDPR request](https://sendbird.com/docs/chat/platform-api/v3/privacy/privacy-overview). [https://sendbird.com/docs/chat/platform-api/v3/user/managing-users/delete-a-user#1-delete-a-user](https://sendbird.com/docs/chat/platform-api/v3/user/managing-users/delete-a-user#1-delete-a-user)
|
|
1112
|
-
* Delete a user
|
|
1113
|
-
* @param userId (Required)
|
|
1114
|
-
* @param apiToken
|
|
1115
|
-
*/
|
|
1116
|
-
public deleteAUser(userId: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
1117
|
-
const result = this.api.deleteAUser(userId, apiToken, _options);
|
|
1118
|
-
return result.toPromise();
|
|
1119
|
-
}
|
|
1120
|
-
|
|
1121
|
-
/**
|
|
1122
|
-
* ## Get channel invitation preference This action retrieves a user's [group channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel) invitation preference. Users are subject to both user-specific and application-wide invitation preferences. Of the two, the invitation preference set for a specific user takes precedence over [the default channel invitation preference](https://sendbird.com/docs/chat/platform-api/v3/channel/setting-up-channels/get-default-invitation-preference). [https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/get-channel-invitation-preference#1-get-channel-invitation-preference](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/get-channel-invitation-preference#1-get-channel-invitation-preference)
|
|
1123
|
-
* Get channel invitation preference
|
|
1124
|
-
* @param userId (Required)
|
|
1125
|
-
* @param apiToken
|
|
1126
|
-
*/
|
|
1127
|
-
public getChannelInvitationPreference(userId: string, apiToken?: string, _options?: Configuration): Promise<GetChannelInvitationPreferenceResponse> {
|
|
1128
|
-
const result = this.api.getChannelInvitationPreference(userId, apiToken, _options);
|
|
1129
|
-
return result.toPromise();
|
|
1130
|
-
}
|
|
1131
|
-
|
|
1132
|
-
/**
|
|
1133
|
-
* ## Leave my group channels This action allows a user to leave all group channels or channels with a specific custom type. This API is useful if you want to let a user leave a set of channels at once. To let a user leave only one of their group channels, use the [leave a channel API](https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/leave-a-channel) instead. Since this API can't be called for a deactivated user, ensure that the [<code>leave_all_when_deactivated</code>](https://sendbird.com/docs/chat/platform-api/v3/user/managing-users/update-a-user#2-request-body) property of the user is set to its default value of `true` to let the user leave all joined group channels upon deactivation. https://sendbird.com/docs/chat/platform-api/v3/user/managing-joined-group-channels/leave-group-channels#1-leave-group-channels `user_id` Type: string Description: Specifies the unique ID of the user to leave all joined group channels.
|
|
1134
|
-
* Leave my group channels
|
|
1135
|
-
* @param userId (Required)
|
|
1136
|
-
* @param apiToken
|
|
1137
|
-
* @param leaveMyGroupChannelsRequest
|
|
1138
|
-
*/
|
|
1139
|
-
public leaveMyGroupChannels(userId: string, apiToken?: string, leaveMyGroupChannelsRequest?: LeaveMyGroupChannelsRequest, _options?: Configuration): Promise<any> {
|
|
1140
|
-
const result = this.api.leaveMyGroupChannels(userId, apiToken, leaveMyGroupChannelsRequest, _options);
|
|
1141
|
-
return result.toPromise();
|
|
1142
|
-
}
|
|
1143
|
-
|
|
1144
|
-
/**
|
|
1145
|
-
* ## List my group channels This action retrieves a list of [group channels](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel) that a specific user has joined. You can use various query parameters to determine the search scope and select what kind of information you want to receive about the queried channels. If you're looking to retrieve a list of group channels in a specific application, visit the [list group channels](https://sendbird.com/docs/chat/platform-api/v3/channel/listing-channels-in-an-application/list-group-channels) page under the Channel section. https://sendbird.com/docs/chat/platform-api/v3/user/managing-joined-group-channels/list-group-channels-by-user#1-list-group-channels-by-user `user_id` Type: string Description: Specifies the unique ID of the target user.
|
|
1146
|
-
* List my group channels
|
|
1147
|
-
* @param userId (Required)
|
|
1148
|
-
* @param apiToken
|
|
1149
|
-
* @param token Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
|
|
1150
|
-
* @param limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
|
|
1151
|
-
* @param distinctMode
|
|
1152
|
-
* @param publicMode
|
|
1153
|
-
* @param superMode
|
|
1154
|
-
* @param createdAfter Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
|
|
1155
|
-
* @param createdBefore Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
|
|
1156
|
-
* @param showEmpty
|
|
1157
|
-
* @param showMember
|
|
1158
|
-
* @param showDeliveryReceipt
|
|
1159
|
-
* @param showReadReceipt
|
|
1160
|
-
* @param showMetadata
|
|
1161
|
-
* @param showFrozen
|
|
1162
|
-
* @param order
|
|
1163
|
-
* @param metadataOrderKey Specifies the key of an item in metadata. When a value of the order parameter is set to metadata_value_alphabetical, the results are alphabetically sorted by the value of the item specified by the key.
|
|
1164
|
-
* @param customTypes Specifies a comma-separated string of one or more custom types to filter group channels. URL encoding each type is recommended. If not specified, all channels are returned, regardless of their custom type.
|
|
1165
|
-
* @param customTypeStartswith Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
|
|
1166
|
-
* @param channelUrls Specifies a comma-separated string of one or more group channel URLs to restrict the search scope. URL encoding each channel URL is recommended.
|
|
1167
|
-
* @param name Specifies one or more group channel names.
|
|
1168
|
-
* @param nameContains Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
|
|
1169
|
-
* @param nameStartswith Searches for group channels whose names start with the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
|
|
1170
|
-
* @param membersExactlyIn Searches for group channels with all the specified users as members. The parameter value should consist of user IDs separated by commas. Only user IDs that match those of existing users are used for channel search. URL encoding each ID is recommended.
|
|
1171
|
-
* @param membersIncludeIn Searches for group channels that include one or more users as members among the specified users. The value should consist of user IDs separated by commas or %2C. You can specify up to 60 user IDs. Only user IDs that match those of existing users are used for channel search. URL encoding each ID is recommended.
|
|
1172
|
-
* @param queryType Specifies a logical condition applied to the members_include_in parameter. Acceptable values are either AND or OR. For example, if you specify three members, A, B, and C, in members_include_in, the value of AND returns all channels that include every one of {A. B, C} as members. The value of OR returns channels that include {A}, plus those that include {B}, plus those that include {C}. (Default: AND)
|
|
1173
|
-
* @param membersNickname Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
|
|
1174
|
-
* @param membersNicknameContains Searches for group channels with members whose nicknames contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended. * We recommend using at least three characters for the parameter value for better search efficiency when you design and implement related features. If you would like to allow one or two characters for searching, use members_nickname instead to prevent performance issues.
|
|
1175
|
-
* @param membersNicknameStartswith Searches for group channels with members whose nicknames begin with the specified value. This parameter isn't case-sensitive. URL encoding the value is recommended.
|
|
1176
|
-
* @param searchQuery Searches for group channels where the specified query string matches the channel name or the nickname of the member. This parameter isn't case-sensitive and should be specified in conjunction with the search_fields parameter below. URL encoding the value is recommended.
|
|
1177
|
-
* @param searchFields Specifies a comma-separated string of one or more search fields to apply to the query, which restricts the results within the specified fields (OR search condition). Acceptable values are channel_name and member_nickname. This is effective only when the search_query parameter above is specified. (Default: channel_name, member_nickname together)
|
|
1178
|
-
* @param metadataKey Searches for group channels with metadata containing an item with the specified value as its key. To use this parameter, either the metadata_values parameter or the metadata_value_startswith parameter should be specified.
|
|
1179
|
-
* @param metadataValues Searches for group channels with metadata containing an item with the key specified by the metadata_key parameter, and the value of that item matches one or more values specified by this parameter. The string should be specified with multiple values separated by commas. URL encoding each value is recommended. To use this parameter, the metadata_key parameter should be specified.
|
|
1180
|
-
* @param metadataValueStartswith Searches for group channels with metadata containing an item with the key specified by the metadata_key parameter, and the values of that item that start with the specified value of this parameter. URL encoding the value is recommended. To use this parameter, the metadata_key parameter should be specified.
|
|
1181
|
-
* @param metacounterKey Searches for group channels with metacounter containing an item with the specified value as its key. To use this parameter, either the metacounter_values parameter or one of the metacounter_value_gt, metacounter_value_gte, metacounter_value_lt, and metacounter_value_lte parameters should be specified.
|
|
1182
|
-
* @param metacounterValues Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is equal to one or more values specified by this parameter. The string should be specified with multiple values separated by commas. To use this parameter, the metacounter_key parameter should be specified.
|
|
1183
|
-
* @param metacounterValueGt Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is greater than the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
1184
|
-
* @param metacounterValueGte Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is greater than or equal to the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
1185
|
-
* @param metacounterValueLt Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is lower than the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
1186
|
-
* @param metacounterValueLte Searches for group channels with metacounter containing an item with the key specified by the metadata_key parameter, where the value of that item is lower than or equal to the value specified by this parameter. To use this parameter, the metacounter_key parameter should be specified.
|
|
1187
|
-
* @param includeSortedMetaarrayInLastMessage Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
|
|
1188
|
-
* @param hiddenMode Restricts the search scope to group channels that match a specific hidden_status and operating behavior
|
|
1189
|
-
* @param unreadFilter Restricts the search scope to only retrieve group channels with one or more unread messages. This filter doesn't support Supergroup channels. Acceptable values are all and unread_message. (Default: all)
|
|
1190
|
-
* @param memberStateFilter
|
|
1191
|
-
*/
|
|
1192
|
-
public listMyGroupChannels(userId: string, apiToken: string, token?: string, limit?: number, distinctMode?: 'all' | 'distinct' | 'nondistinct', publicMode?: 'all' | 'private' | 'public', superMode?: 'all' | 'super' | 'nonsuper', createdAfter?: number, createdBefore?: number, showEmpty?: boolean, showMember?: boolean, showDeliveryReceipt?: boolean, showReadReceipt?: boolean, showMetadata?: boolean, showFrozen?: boolean, order?: 'chronological' | 'latest_last_message' | 'channel_name_alphabetical' | 'metadata_value_alphabetical', metadataOrderKey?: string, customTypes?: string, customTypeStartswith?: string, channelUrls?: string, name?: string, nameContains?: string, nameStartswith?: string, membersExactlyIn?: string, membersIncludeIn?: string, queryType?: string, membersNickname?: string, membersNicknameContains?: string, membersNicknameStartswith?: string, searchQuery?: string, searchFields?: string, metadataKey?: string, metadataValues?: string, metadataValueStartswith?: string, metacounterKey?: string, metacounterValues?: string, metacounterValueGt?: string, metacounterValueGte?: string, metacounterValueLt?: string, metacounterValueLte?: string, includeSortedMetaarrayInLastMessage?: boolean, hiddenMode?: 'unhidden_only' | 'hidden_only' | 'hidden_allow_auto_unhide' | 'hidden_prevent_auto_unhide' | 'all', unreadFilter?: 'all' | 'unread_message', memberStateFilter?: 'all' | 'invited_only' | 'joined_only' | 'invited_by_friend' | 'invited_by_non_friend', _options?: Configuration): Promise<ListMyGroupChannelsResponse> {
|
|
1193
|
-
const result = this.api.listMyGroupChannels(userId, apiToken, token, limit, distinctMode, publicMode, superMode, createdAfter, createdBefore, showEmpty, showMember, showDeliveryReceipt, showReadReceipt, showMetadata, showFrozen, order, metadataOrderKey, customTypes, customTypeStartswith, channelUrls, name, nameContains, nameStartswith, membersExactlyIn, membersIncludeIn, queryType, membersNickname, membersNicknameContains, membersNicknameStartswith, searchQuery, searchFields, metadataKey, metadataValues, metadataValueStartswith, metacounterKey, metacounterValues, metacounterValueGt, metacounterValueGte, metacounterValueLt, metacounterValueLte, includeSortedMetaarrayInLastMessage, hiddenMode, unreadFilter, memberStateFilter, _options);
|
|
1194
|
-
return result.toPromise();
|
|
1195
|
-
}
|
|
1196
|
-
|
|
1197
|
-
/**
|
|
1198
|
-
* ## List registration or device tokens Retrieves a list of a user's registration or device tokens. You can pass `gcm`, `huawei`, or `apns` for FCM registration token, HMS device token, or APNs device token, respectively, in the `token_type` parameter for the push notification service you are using. https://sendbird.com/docs/chat/platform-api/v3/user/managing-device-tokens/list-registration-or-device-tokens#1-list-registration-or-device-tokens
|
|
1199
|
-
* List registration or device tokens
|
|
1200
|
-
* @param userId (Required)
|
|
1201
|
-
* @param tokenType (Required)
|
|
1202
|
-
* @param apiToken
|
|
1203
|
-
*/
|
|
1204
|
-
public listRegistrationOrDeviceTokens(userId: string, tokenType: 'gcm' | 'huawei' | 'apns', apiToken?: string, _options?: Configuration): Promise<ListRegistrationOrDeviceTokensResponse> {
|
|
1205
|
-
const result = this.api.listRegistrationOrDeviceTokens(userId, tokenType, apiToken, _options);
|
|
1206
|
-
return result.toPromise();
|
|
1207
|
-
}
|
|
1208
|
-
|
|
1209
|
-
/**
|
|
1210
|
-
* ## List users You can retrieve a list of users in your Sendbird application using this API. You can generate a customized list using various parameter combinations. https://sendbird.com/docs/chat/platform-api/v3/user/listing-users/list-users#1-list-users
|
|
1211
|
-
* List users
|
|
1212
|
-
* @param token
|
|
1213
|
-
* @param limit
|
|
1214
|
-
* @param activeMode Specifies the activation status of the users in the list. Acceptable values are `activated`, `deactivated`, and `all`. (Default: `activated`)
|
|
1215
|
-
* @param showBot Determines whether to include bots in the list. (Default: true)
|
|
1216
|
-
* @param userIds Specifies the user IDs. The value should be a comma-separated string that consists of multiple urlencoded user IDs. An example of a urlencoded string is ?user_ids=urlencoded_id_1,urlencoded_id_2. * The maximum number of user IDs in this parameter is 250. If you exceed the maximum number, your request may receive an HTTP 414 error indicating that the request URL is longer than what Sendbird server can interpret.
|
|
1217
|
-
* @param nickname
|
|
1218
|
-
* @param nicknameStartswith
|
|
1219
|
-
* @param metadatakey
|
|
1220
|
-
* @param metadatavaluesIn Searches for blocked users with metadata containing an item with the key specified by the metadatakey parameter above, and the value of that item matches one or more values specified by this parameter. The string should be specified with multiple urlencoded metadata values separated by commas (for example, `?metadatavalues_in=urlencoded_value_1, urlencoded_value_2`). This parameter should be specified in conjunction with the `metadatakey` above.
|
|
1221
|
-
* @param apiToken
|
|
1222
|
-
*/
|
|
1223
|
-
public listUsers(token?: string, limit?: number, activeMode?: 'activated' | 'deactivated' | 'all', showBot?: boolean, userIds?: string, nickname?: string, nicknameStartswith?: string, metadatakey?: string, metadatavaluesIn?: string, apiToken?: string, _options?: Configuration): Promise<ListUsersResponse> {
|
|
1224
|
-
const result = this.api.listUsers(token, limit, activeMode, showBot, userIds, nickname, nicknameStartswith, metadatakey, metadatavaluesIn, apiToken, _options);
|
|
1225
|
-
return result.toPromise();
|
|
1226
|
-
}
|
|
1227
|
-
|
|
1228
|
-
/**
|
|
1229
|
-
* ## Mark all messages as read This action marks all of a user's unread messages as read in certain group channels. If channels aren't specified, the user's unread messages in all group channels are marked as read. https://sendbird.com/docs/chat/platform-api/v3/user/marking-messages-as-read/mark-all-of-a-users-messages-as-read#1-mark-all-of-a-user-s-messages-as-read
|
|
1230
|
-
* Mark all messages as read
|
|
1231
|
-
* @param userId (Required)
|
|
1232
|
-
* @param apiToken
|
|
1233
|
-
* @param markAllMessagesAsReadRequest
|
|
1234
|
-
*/
|
|
1235
|
-
public markAllMessagesAsRead(userId: string, apiToken?: string, markAllMessagesAsReadRequest?: MarkAllMessagesAsReadRequest, _options?: Configuration): Promise<any> {
|
|
1236
|
-
const result = this.api.markAllMessagesAsRead(userId, apiToken, markAllMessagesAsReadRequest, _options);
|
|
1237
|
-
return result.toPromise();
|
|
1238
|
-
}
|
|
1239
|
-
|
|
1240
|
-
/**
|
|
1241
|
-
* ## Remove a registration or device token Removes a user's specific registration or device token or all tokens. You can pass `gcm`, `huawei`, or `apns` for FCM registration token, HMS device token, or APNs device token, respectively, in the `token_type` parameter for the push notification service you are using. https://sendbird.com/docs/chat/platform-api/v3/user/managing-device-tokens/remove-a-registration-or-device-token#1-remove-a-registration-or-device-token
|
|
1242
|
-
* Remove a registration or device token - When unregistering a specific token
|
|
1243
|
-
* @param userId (Required)
|
|
1244
|
-
* @param tokenType (Required)
|
|
1245
|
-
* @param token (Required)
|
|
1246
|
-
* @param apiToken
|
|
1247
|
-
*/
|
|
1248
|
-
public removeARegistrationOrDeviceToken(userId: string, tokenType: 'gcm' | 'huawei' | 'apns', token: string, apiToken?: string, _options?: Configuration): Promise<RemoveARegistrationOrDeviceTokenResponse> {
|
|
1249
|
-
const result = this.api.removeARegistrationOrDeviceToken(userId, tokenType, token, apiToken, _options);
|
|
1250
|
-
return result.toPromise();
|
|
1251
|
-
}
|
|
1252
|
-
|
|
1253
|
-
/**
|
|
1254
|
-
* ## Remove a registration or device token from an owner Removes a registration or device token from a user who is the owner of the token. You can pass `gcm`, `huawei`, or `apns` for FCM registration token, HMS device token, or APNs device token, respectively, in the `token_type` parameter for the push notification service you are using. https://sendbird.com/docs/chat/platform-api/v3/user/managing-device-tokens/remove-a-registration-or-device-token-from-an-owner#1-remove-a-registration-or-device-token-from-an-owner
|
|
1255
|
-
* Remove a registration or device token from an owner
|
|
1256
|
-
* @param tokenType (Required)
|
|
1257
|
-
* @param token (Required)
|
|
1258
|
-
* @param apiToken
|
|
1259
|
-
*/
|
|
1260
|
-
public removeARegistrationOrDeviceTokenFromAnOwner(tokenType: string, token: string, apiToken?: string, _options?: Configuration): Promise<Array<MarkChannelMessagesAsReadRequest>> {
|
|
1261
|
-
const result = this.api.removeARegistrationOrDeviceTokenFromAnOwner(tokenType, token, apiToken, _options);
|
|
1262
|
-
return result.toPromise();
|
|
1263
|
-
}
|
|
1264
|
-
|
|
1265
|
-
/**
|
|
1266
|
-
* ## Remove a registration or device token Removes a user's specific registration or device token or all tokens. You can pass `gcm`, `huawei`, or `apns` for FCM registration token, HMS device token, or APNs device token, respectively, in the `token_type` parameter for the push notification service you are using. https://sendbird.com/docs/chat/platform-api/v3/user/managing-device-tokens/remove-a-registration-or-device-token#1-remove-a-registration-or-device-token
|
|
1267
|
-
* Remove a registration or device token - When unregistering all device tokens
|
|
1268
|
-
* @param userId (Required)
|
|
1269
|
-
* @param apiToken
|
|
1270
|
-
*/
|
|
1271
|
-
public removeAllRegistrationOrDeviceToken(userId: string, apiToken?: string, _options?: Configuration): Promise<RemoveAllRegistrationOrDeviceTokenResponse> {
|
|
1272
|
-
const result = this.api.removeAllRegistrationOrDeviceToken(userId, apiToken, _options);
|
|
1273
|
-
return result.toPromise();
|
|
1274
|
-
}
|
|
1275
|
-
|
|
1276
|
-
/**
|
|
1277
|
-
* ## Reset push preferences You can reset a user's notifications preferences. The values are reset to the default as the following. - The values for the `do_not_disturb` and `snooze_enabled` properties are set to `false`. - The values of the parameters associated with the time frame are all set to `0`. - The value for the `timezone` property is set to `UTC`. - The value for the `push_sound` property is set to `default`. > **Note**: Push notifications are only available for group channels. [https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/reset-push-notification-preferences#1-reset-push-notification-preferences](https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/reset-push-notification-preferences#1-reset-push-notification-preferences)
|
|
1278
|
-
* Reset push preferences
|
|
1279
|
-
* @param userId (Required)
|
|
1280
|
-
* @param apiToken
|
|
1281
|
-
*/
|
|
1282
|
-
public resetPushPreferences(userId: string, apiToken?: string, _options?: Configuration): Promise<any> {
|
|
1283
|
-
const result = this.api.resetPushPreferences(userId, apiToken, _options);
|
|
1284
|
-
return result.toPromise();
|
|
1285
|
-
}
|
|
1286
|
-
|
|
1287
|
-
/**
|
|
1288
|
-
* ## Update a user You can update information about a user using this API. In addition to changing a user's nickname or profile image, you can issue a new access token for the user. The new access token replaces the previous one as the necessary token for authentication. You can also deactivate or reactivate a user using this API request. If the `leave_all_when_deactivated` is set to `true`, a user leaves all joined group channels and becomes deactivated. > **Note**: Issuing session tokens through the `/users/{user_id}` endpoint is now deprecated and it's replaced with [<code>/users/{user_id}/token</code>](https://sendbird.com/docs/chat/platform-api/v3/user/managing-session-tokens/issue-a-session-token) endpoint for greater efficiency. For those who are currently using the old endpoint, you can start issuing tokens using the new endpoint. [https://sendbird.com/docs/chat/platform-api/v3/user/managing-users/update-a-user#1-update-a-user](https://sendbird.com/docs/chat/platform-api/v3/user/managing-users/update-a-user#1-update-a-user)
|
|
1289
|
-
* Update a user
|
|
1290
|
-
* @param userId (Required)
|
|
1291
|
-
* @param apiToken
|
|
1292
|
-
* @param updateAUserRequest
|
|
1293
|
-
*/
|
|
1294
|
-
public updateAUser(userId: string, apiToken?: string, updateAUserRequest?: UpdateAUserRequest, _options?: Configuration): Promise<SendbirdUser> {
|
|
1295
|
-
const result = this.api.updateAUser(userId, apiToken, updateAUserRequest, _options);
|
|
1296
|
-
return result.toPromise();
|
|
1297
|
-
}
|
|
1298
|
-
|
|
1299
|
-
/**
|
|
1300
|
-
* ## Update channel invitation preference This action updates a user's [group channel](https://sendbird.com/docs/chat/platform-api/v3/channel/channel-overview#2-channel-types-3-group-channel) invitation preference. Updating the [application's default channel invitation preference](https://sendbird.com/docs/chat/platform-api/v3/channel/setting-up-channels/update-default-invitation-preference) won't override existing users' individual channel invitation preferences. The changed preference only affects the users created after the update. https://sendbird.com/docs/chat/platform-api/v3/channel/managing-a-channel/update-channel-invitation-preference#1-update-channel-invitation-preference
|
|
1301
|
-
* Update channel invitation preference
|
|
1302
|
-
* @param userId (Required)
|
|
1303
|
-
* @param apiToken
|
|
1304
|
-
* @param updateChannelInvitationPreferenceRequest
|
|
1305
|
-
*/
|
|
1306
|
-
public updateChannelInvitationPreference(userId: string, apiToken?: string, updateChannelInvitationPreferenceRequest?: UpdateChannelInvitationPreferenceRequest, _options?: Configuration): Promise<UpdateChannelInvitationPreferenceResponse> {
|
|
1307
|
-
const result = this.api.updateChannelInvitationPreference(userId, apiToken, updateChannelInvitationPreferenceRequest, _options);
|
|
1308
|
-
return result.toPromise();
|
|
1309
|
-
}
|
|
1310
|
-
|
|
1311
|
-
/**
|
|
1312
|
-
* ## Update count preference of a channel This action updates a user's count preference of a specific group channel. The count preference allows a user to either update the number of unread messages or the number of unread mentioned messages, or both in a specific group channel. If you want to retrieve the total number count of a specific group channel, go to the [get count preference of a channel](https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-count-preference-of-a-channel) page. https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/update-count-preference-of-a-channel#1-update-count-preference-of-a-channel
|
|
1313
|
-
* Update count preference of a channel
|
|
1314
|
-
* @param userId (Required)
|
|
1315
|
-
* @param channelUrl (Required)
|
|
1316
|
-
* @param apiToken
|
|
1317
|
-
* @param updateCountPreferenceOfAChannelRequest
|
|
1318
|
-
*/
|
|
1319
|
-
public updateCountPreferenceOfAChannel(userId: string, channelUrl: string, apiToken?: string, updateCountPreferenceOfAChannelRequest?: UpdateCountPreferenceOfAChannelRequest, _options?: Configuration): Promise<UpdateCountPreferenceOfChannelByUrlResponse> {
|
|
1320
|
-
const result = this.api.updateCountPreferenceOfAChannel(userId, channelUrl, apiToken, updateCountPreferenceOfAChannelRequest, _options);
|
|
1321
|
-
return result.toPromise();
|
|
1322
|
-
}
|
|
1323
|
-
|
|
1324
|
-
/**
|
|
1325
|
-
* ## Update push preferences You can update a user's notifications preferences. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background. > **Note**: Push notifications are only available for group channels. [https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/update-push-notification-preferences#1-update-push-notification-preferences](https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/update-push-notification-preferences#1-update-push-notification-preferences)
|
|
1326
|
-
* Update push preferences
|
|
1327
|
-
* @param userId (Required)
|
|
1328
|
-
* @param apiToken
|
|
1329
|
-
* @param updatePushPreferencesRequest
|
|
1330
|
-
*/
|
|
1331
|
-
public updatePushPreferences(userId: string, apiToken?: string, updatePushPreferencesRequest?: UpdatePushPreferencesRequest, _options?: Configuration): Promise<UpdatePushPreferencesResponse> {
|
|
1332
|
-
const result = this.api.updatePushPreferences(userId, apiToken, updatePushPreferencesRequest, _options);
|
|
1333
|
-
return result.toPromise();
|
|
1334
|
-
}
|
|
1335
|
-
|
|
1336
|
-
/**
|
|
1337
|
-
* ## Update push preferences for a channel You can update a user's notifications preferences for a specific channel. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background. > **Note**: Push notifications are only available for group channels. [https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/update-push-notification-preferences-for-a-channel#1-update-push-notification-preferences-for-a-channel](https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/update-push-notification-preferences-for-a-channel#1-update-push-notification-preferences-for-a-channel)
|
|
1338
|
-
* Update push preferences for a channel
|
|
1339
|
-
* @param userId (Required)
|
|
1340
|
-
* @param channelUrl (Required)
|
|
1341
|
-
* @param apiToken
|
|
1342
|
-
* @param updatePushPreferencesForAChannelRequest
|
|
1343
|
-
*/
|
|
1344
|
-
public updatePushPreferencesForAChannel(userId: string, channelUrl: string, apiToken?: string, updatePushPreferencesForAChannelRequest?: UpdatePushPreferencesForAChannelRequest, _options?: Configuration): Promise<UpdatePushPreferencesForAChannelResponse> {
|
|
1345
|
-
const result = this.api.updatePushPreferencesForAChannel(userId, channelUrl, apiToken, updatePushPreferencesForAChannelRequest, _options);
|
|
1346
|
-
return result.toPromise();
|
|
1347
|
-
}
|
|
1348
|
-
|
|
1349
|
-
/**
|
|
1350
|
-
* ## View a user You can retrieve information about a user using this API. https://sendbird.com/docs/chat/platform-api/v3/user/listing-users/get-a-user#1-get-a-user `user_id` Type: string Description: Specifies the unique ID of the user to retrieve.
|
|
1351
|
-
* View a user
|
|
1352
|
-
* @param userId (Required)
|
|
1353
|
-
* @param includeUnreadCount
|
|
1354
|
-
* @param customTypes
|
|
1355
|
-
* @param superMode Restricts the search scope to retrieve only Supergroup or non-Supergroup channels. Acceptable values are `all`, `super`, and `nonsuper`. This parameter should be specified in conjunction with `include_unread_count` above. (Default: `all`)
|
|
1356
|
-
* @param apiToken
|
|
1357
|
-
*/
|
|
1358
|
-
public viewAUser(userId: string, includeUnreadCount?: boolean, customTypes?: string, superMode?: 'all' | 'super' | 'nonsuper', apiToken?: string, _options?: Configuration): Promise<SendbirdUser> {
|
|
1359
|
-
const result = this.api.viewAUser(userId, includeUnreadCount, customTypes, superMode, apiToken, _options);
|
|
1360
|
-
return result.toPromise();
|
|
1361
|
-
}
|
|
1362
|
-
|
|
1363
|
-
/**
|
|
1364
|
-
* ## View count preference of a channel This action retrieves a user's count preference of a specific group channel. The count preference allows a user to either retrieve the number of unread messages or unread mentioned messages, or both in a specific group channel. If you want to update the total number count of a specific group channel, visit the [update count preference of a channel](https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/update-count-preference-of-a-channel). https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-count-preference-of-a-channel#1-get-count-preference-of-a-channel
|
|
1365
|
-
* View count preference of a channel
|
|
1366
|
-
* @param userId (Required)
|
|
1367
|
-
* @param channelUrl (Required)
|
|
1368
|
-
* @param apiToken
|
|
1369
|
-
*/
|
|
1370
|
-
public viewCountPreferenceOfAChannel(userId: string, channelUrl: string, apiToken?: string, _options?: Configuration): Promise<ViewCountPreferenceOfAChannelResponse> {
|
|
1371
|
-
const result = this.api.viewCountPreferenceOfAChannel(userId, channelUrl, apiToken, _options);
|
|
1372
|
-
return result.toPromise();
|
|
1373
|
-
}
|
|
1374
|
-
|
|
1375
|
-
/**
|
|
1376
|
-
* ## View number of channels with unread messages This action retrieves the total number of group channels in which a user has unread messages. You can use various query parameters to determine the search scope of group channels. https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-number-of-channels-with-unread-messages#1-get-number-of-channels-with-unread-messages
|
|
1377
|
-
* View number of channels with unread messages
|
|
1378
|
-
* @param userId (Required)
|
|
1379
|
-
* @param customTypes
|
|
1380
|
-
* @param superMode Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are all, super, and nonsuper. (Default: all)
|
|
1381
|
-
* @param apiToken
|
|
1382
|
-
*/
|
|
1383
|
-
public viewNumberOfChannelsWithUnreadMessages(userId: string, customTypes?: string, superMode?: 'all' | 'super' | 'nonsuper', apiToken?: string, _options?: Configuration): Promise<ViewNumberOfChannelsWithUnreadMessagesResponse> {
|
|
1384
|
-
const result = this.api.viewNumberOfChannelsWithUnreadMessages(userId, customTypes, superMode, apiToken, _options);
|
|
1385
|
-
return result.toPromise();
|
|
1386
|
-
}
|
|
1387
|
-
|
|
1388
|
-
/**
|
|
1389
|
-
* ## View number of unread messages This action retrieves a user's total number of unread messages in group channels. > **Note**: The unread count feature is only available for group channels. [https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-number-of-unread-messages#1-get-number-of-unread-messages](https://sendbird.com/docs/chat/platform-api/v3/user/managing-unread-count/get-number-of-unread-messages#1-get-number-of-unread-messages) `user_id` Type: string Description: Specifies the unique ID of a user.
|
|
1390
|
-
* View number of unread messages
|
|
1391
|
-
* @param userId (Required)
|
|
1392
|
-
* @param customTypes Specifies a comma-separated string of one or more custom types to filter group channels. URL encoding each type is recommended. If not specified, all channels are returned, regardless of their custom type.
|
|
1393
|
-
* @param superMode Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are `all`, `super`, and `nonsuper`. (Default: `all`)
|
|
1394
|
-
* @param apiToken
|
|
1395
|
-
*/
|
|
1396
|
-
public viewNumberOfUnreadMessages(userId: string, customTypes?: string, superMode?: string, apiToken?: string, _options?: Configuration): Promise<ViewNumberOfUnreadMessagesResponse> {
|
|
1397
|
-
const result = this.api.viewNumberOfUnreadMessages(userId, customTypes, superMode, apiToken, _options);
|
|
1398
|
-
return result.toPromise();
|
|
1399
|
-
}
|
|
1400
|
-
|
|
1401
|
-
/**
|
|
1402
|
-
* ## View push preferences You can retrieves a user's notifications preferences. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background. > **Note**: Push notifications are only available for group channels. [https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/get-push-notification-preferences#1-get-push-notification-preferences](https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/get-push-notification-preferences#1-get-push-notification-preferences)
|
|
1403
|
-
* View push preferences
|
|
1404
|
-
* @param userId (Required)
|
|
1405
|
-
* @param apiToken
|
|
1406
|
-
*/
|
|
1407
|
-
public viewPushPreferences(userId: string, apiToken?: string, _options?: Configuration): Promise<ViewPushPreferencesResponse> {
|
|
1408
|
-
const result = this.api.viewPushPreferences(userId, apiToken, _options);
|
|
1409
|
-
return result.toPromise();
|
|
1410
|
-
}
|
|
1411
|
-
|
|
1412
|
-
/**
|
|
1413
|
-
* ## View push preferences for a channel You can retrieve a user's notifications preferences for a specific channel. A push notification is a message that is immediately delivered to a user's device when the device is either idle or running the client app in the background. These notifications preferences can be configured. > **Note**: Push notifications are only available for group channels. [https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/get-push-notification-preferences-for-a-channel#1-get-push-notification-preferences-for-a-channel](https://sendbird.com/docs/chat/platform-api/v3/user/configuring-notification-preferences/get-push-notification-preferences-for-a-channel#1-get-push-notification-preferences-for-a-channel)
|
|
1414
|
-
* View push preferences for a channel
|
|
1415
|
-
* @param userId (Required)
|
|
1416
|
-
* @param channelUrl (Required)
|
|
1417
|
-
* @param apiToken
|
|
1418
|
-
*/
|
|
1419
|
-
public viewPushPreferencesForAChannel(userId: string, channelUrl: string, apiToken?: string, _options?: Configuration): Promise<ViewPushPreferencesForAChannelResponse> {
|
|
1420
|
-
const result = this.api.viewPushPreferencesForAChannel(userId, channelUrl, apiToken, _options);
|
|
1421
|
-
return result.toPromise();
|
|
1422
|
-
}
|
|
1423
|
-
|
|
1424
|
-
/**
|
|
1425
|
-
* ## View who owns a registration or device token Retrieves a user who owns a FCM registration token, HMS device token, or APNs device token. You can pass one of two values in `token_type`: `gcm`, `huawei`, or `apns`, depending on which push service you are using. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-who-owns-a-registration-or-device-token ----------------------------
|
|
1426
|
-
* View who owns a registration or device token
|
|
1427
|
-
* @param tokenType (Required)
|
|
1428
|
-
* @param token (Required)
|
|
1429
|
-
* @param apiToken
|
|
1430
|
-
*/
|
|
1431
|
-
public viewWhoOwnsARegistrationOrDeviceToken(tokenType: string, token: string, apiToken?: string, _options?: Configuration): Promise<Array<MarkChannelMessagesAsReadRequest>> {
|
|
1432
|
-
const result = this.api.viewWhoOwnsARegistrationOrDeviceToken(tokenType, token, apiToken, _options);
|
|
1433
|
-
return result.toPromise();
|
|
1434
|
-
}
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
}
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|