diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
index 52d8493..d4d07dd 100644
--- a/.openapi-generator/FILES
+++ b/.openapi-generator/FILES
@@ -2,622 +2,374 @@
.gitignore
.travis.yml
README.md
-docs/AddApnsPushConfigurationData.md
-docs/AddApnsPushConfigurationResponse.md
-docs/AddApnsPushConfigurationResponsePushConfigurationsInner.md
-docs/AddEmojiCategoriesResponse.md
-docs/AddEmojiCategoriesResponseEmojiCategoriesInner.md
-docs/AddEmojisData.md
-docs/AddEmojisResponse.md
-docs/AddExtraDataToMessageData.md
-docs/AddExtraDataToMessageResponse.md
-docs/AddFcmPushConfigurationData.md
-docs/AddFcmPushConfigurationResponse.md
-docs/AddFcmPushConfigurationResponsePushConfigurationsInner.md
-docs/AddHmsPushConfigurationData.md
-docs/AddHmsPushConfigurationResponse.md
-docs/AddHmsPushConfigurationResponsePushConfigurationsInner.md
-docs/AddIpToWhitelistData.md
-docs/AddIpToWhitelistResponse.md
-docs/AddReactionToAMessageData.md
-docs/AddReactionToAMessageResponse.md
-docs/AddRegistrationOrDeviceTokenData.md
-docs/AddRegistrationOrDeviceTokenResponse.md
+docs/AcceptAnInvitationRequest.md
+docs/AddARegistrationOrDeviceTokenRequest.md
+docs/AddARegistrationOrDeviceTokenResponse.md
+docs/AddExtraDataToAMessageRequest.md
+docs/AddExtraDataToAMessageResponse.md
docs/AnnouncementApi.md
-docs/ApplicationApi.md
-docs/BanFromChannelsWithCustomChannelTypesData.md
-docs/BanUsersInChannelsWithCustomChannelTypeData.md
-docs/BanUsersInChannelsWithCustomChannelTypeDataBannedListInner.md
-docs/Blob.md
-docs/BlockUserData.md
-docs/BlockUserResponse.md
+docs/BlockAUserRequest.md
+docs/BlockAUserResponse.md
docs/BotApi.md
-docs/ChoosePushNotificationContentTemplateResponse.md
-docs/ChooseWhichEventsToSubscribeToData.md
-docs/ChooseWhichEventsToSubscribeToResponse.md
-docs/ChooseWhichEventsToSubscribeToResponseWebhook.md
-docs/ConfigureAutoEventData.md
-docs/ConfigureAutoEventDataAutoEventMessage.md
-docs/CreateBotData.md
-docs/CreateBotResponse.md
-docs/CreateBotResponseBot.md
-docs/CreateChannelMetacounterData.md
-docs/CreateChannelMetadataData.md
-docs/CreateChannelMetadataResponse.md
-docs/CreateUserData.md
-docs/CreateUserMetadataData.md
-docs/CreateUserMetadataResponse.md
-docs/CreateUserTokenData.md
+docs/CheckIfMemberResponse.md
+docs/ChooseAPushNotificationContentTemplateRequest.md
+docs/ChooseAPushNotificationContentTemplateResponse.md
+docs/CreateABotRequest.md
+docs/CreateABotResponse.md
+docs/CreateABotResponseBot.md
+docs/CreateABotResponseBotStyle.md
+docs/CreateAChannelMetadataRequest.md
+docs/CreateAChannelMetadataResponse.md
+docs/CreateAGroupChannelRequest.md
+docs/CreateAUserRequest.md
+docs/CreateAnOpenChannelRequest.md
+docs/CreateUserTokenRequest.md
docs/CreateUserTokenResponse.md
-docs/CustomTypeListBannedUsersResponse.md
-docs/DataExportApi.md
-docs/DeleteAllowedIpsFromWhitelistResponse.md
-docs/DeleteApnsCertificateByIdResponse.md
-docs/EnableReactionsData.md
-docs/EnableReactionsResponse.md
-docs/File.md
-docs/Function.md
-docs/GcAcceptInvitationData.md
-docs/GcBanUserData.md
-docs/GcBanUserResponse.md
-docs/GcCheckIfMemberByIdResponse.md
-docs/GcCreateChannelData.md
-docs/GcDeclineInvitationData.md
-docs/GcFreezeChannelData.md
-docs/GcHideOrArchiveChannelData.md
-docs/GcInviteAsMembersData.md
-docs/GcJoinChannelData.md
-docs/GcLeaveChannelData.md
-docs/GcListBannedUsersResponse.md
-docs/GcListChannelsResponse.md
-docs/GcListMembersResponse.md
-docs/GcListMutedUsersResponse.md
-docs/GcListOperatorsResponse.md
-docs/GcMarkAllMessagesAsDeliveredData.md
-docs/GcMarkAllMessagesAsDeliveredResponse.md
-docs/GcMarkAllMessagesAsReadData.md
-docs/GcMuteUserData.md
-docs/GcRegisterOperatorsData.md
-docs/GcRegisterOperatorsResponse.md
-docs/GcResetChatHistoryData.md
-docs/GcResetChatHistoryResponse.md
-docs/GcUpdateBanByIdData.md
-docs/GcUpdateBanByIdResponse.md
-docs/GcUpdateChannelByUrlData.md
-docs/GcViewBanByIdResponse.md
-docs/GcViewMuteByIdResponse.md
-docs/GcViewNumberOfEachMembersUnreadMessagesResponse.md
-docs/GenerateSecondaryApiTokenData.md
-docs/GenerateSecondaryApiTokenResponse.md
-docs/GetDetailedOpenRateOfAnnouncementByIdResponse.md
-docs/GetDetailedOpenRateOfAnnouncementGroupResponse.md
-docs/GetDetailedOpenStatusOfAnnouncementByIdResponse.md
-docs/GetDetailedOpenStatusOfAnnouncementByIdResponseOpenStatusInner.md
-docs/GetStatisticsDailyResponse.md
-docs/GetStatisticsDailyResponseStatisticsInner.md
-docs/GetStatisticsMonthlyResponse.md
-docs/GetStatisticsResponse.md
+docs/FreezeAGroupChannelRequest.md
+docs/FreezeAnOpenChannelRequest.md
+docs/GetAGroupChannelResponse.md
+docs/GetAGroupChannelResponseAllOf.md
+docs/GetChannelInvitationPreferenceResponse.md
+docs/GetTotalNumberOfMessagesInAChannelResponse.md
docs/GroupChannelApi.md
-docs/JoinChannelsData.md
-docs/JoinChannelsResponse.md
-docs/LeaveMyGroupChannelsData.md
-docs/ListAllEmojisAndEmojiCategoriesResponse.md
-docs/ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInner.md
-docs/ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner.md
-docs/ListAnnouncementGroupsResponse.md
-docs/ListAnnouncementsResponse.md
-docs/ListAnnouncementsResponseAnnouncementsInner.md
-docs/ListBannedChannelsResponse.md
-docs/ListBannedChannelsResponseBannedChannelsInner.md
+docs/GroupChannelListMembersResponse.md
+docs/GroupChatListChannelsResponse.md
+docs/HideAChannelRequest.md
+docs/InviteAsMembersRequest.md
+docs/InviteAsMembersResponse.md
+docs/InviteAsMembersResponseAllOf.md
+docs/JoinAChannelRequest.md
+docs/JoinChannelsRequest.md
+docs/LeaveAChannelRequest.md
+docs/LeaveMyGroupChannelsRequest.md
docs/ListBlockedUsersResponse.md
docs/ListBotsResponse.md
docs/ListBotsResponseBotsInner.md
-docs/ListDataExportsByMessageChannelOrUserResponse.md
-docs/ListDataExportsByMessageChannelOrUserResponseExportedDataInner.md
-docs/ListDataExportsByMessageChannelOrUserResponseExportedDataInnerFile.md
-docs/ListEmojisResponse.md
-docs/ListGdprRequestsResponse.md
-docs/ListGdprRequestsResponseRequestsInner.md
+docs/ListBotsResponseBotsInnerAi.md
+docs/ListBotsResponseBotsInnerBot.md
+docs/ListBotsResponseBotsInnerBotStyle.md
+docs/ListBotsResponseBotsInnerBotStyleColor.md
+docs/ListBotsResponseBotsInnerFirstMessagesInner.md
+docs/ListBotsResponseBotsInnerFirstMessagesInnerData.md
+docs/ListBotsResponseBotsInnerSafeguard.md
docs/ListMessagesResponse.md
-docs/ListMessagesResponseMessagesInner.md
-docs/ListMessagesResponseMessagesInnerOgTag.md
-docs/ListMessagesResponseMessagesInnerOgTagOgImage.md
-docs/ListMessagesResponseMessagesInnerSortedMetaarrayInner.md
-docs/ListMutedChannelsResponse.md
-docs/ListMutedUsersInChannelsWithCustomChannelType200Response.md
docs/ListMyGroupChannelsResponse.md
-docs/ListPushConfigurationsResponse.md
-docs/ListPushConfigurationsResponsePushConfigurationsInner.md
-docs/ListPushNotificationContentTemplatesResponse.md
-docs/ListPushNotificationContentTemplatesResponsePushMessageTemplatesInner.md
-docs/ListPushNotificationContentTemplatesResponsePushMessageTemplatesInnerTemplate.md
-docs/ListReactionsOfMessageResponse.md
+docs/ListOpenChannelsResponse.md
+docs/ListOperatorsResponse.md
docs/ListRegistrationOrDeviceTokensResponse.md
-docs/ListReportsOnChannelByUrlResponse.md
-docs/ListReportsOnMessageByIdResponse.md
-docs/ListReportsOnMessageByIdResponseReportLogsInner.md
-docs/ListReportsOnUserByIdResponse.md
-docs/ListReportsResponse.md
-docs/ListReportsResponseReportLogsInner.md
-docs/ListSecondaryApiTokensResponse.md
-docs/ListSecondaryApiTokensResponseApiTokensInner.md
docs/ListUsersResponse.md
-docs/MarkAllMessagesAsReadData.md
+docs/MarkAllMessagesAsReadRequest.md
+docs/MarkChannelMessagesAsReadRequest.md
docs/MessageApi.md
docs/MetadataApi.md
docs/ModerationApi.md
-docs/MuteInChannelsWithCustomChannelTypesData.md
-docs/MuteUsersInChannelsWithCustomChannelTypeData.md
-docs/OcBanUserData.md
-docs/OcBanUserResponse.md
-docs/OcCreateChannelData.md
-docs/OcDeleteChannelByUrl200Response.md
-docs/OcFreezeChannelData.md
-docs/OcListBannedUsersResponse.md
-docs/OcListBannedUsersResponseBannedListInner.md
-docs/OcListChannelsResponse.md
-docs/OcListMutedUsersResponse.md
-docs/OcListOperatorsResponse.md
-docs/OcListParticipantsResponse.md
-docs/OcMuteUserData.md
-docs/OcRegisterOperatorsData.md
-docs/OcUpdateBanByIdData.md
-docs/OcUpdateBanByIdResponse.md
-docs/OcUpdateChannelByUrlData.md
-docs/OcViewBanByIdResponse.md
-docs/OcViewMuteByIdResponse.md
docs/OpenChannelApi.md
-docs/PrivacyApi.md
-docs/RegisterAndScheduleDataExportData.md
-docs/RegisterAndScheduleDataExportResponse.md
-docs/RegisterAsOperatorToChannelsWithCustomChannelTypesData.md
-docs/RegisterGdprRequestData.md
-docs/RegisterGdprRequestResponse.md
-docs/RemovePushConfigurationByIdResponse.md
-docs/RemoveReactionFromAMessageResponse.md
-docs/RemoveRegistrationOrDeviceTokenByTokenResponse.md
-docs/RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse.md
-docs/RemoveRegistrationOrDeviceTokenResponse.md
-docs/ReportApi.md
-docs/ReportChannelByUrlData.md
-docs/ReportChannelByUrlResponse.md
-docs/ReportMessageByIdData.md
-docs/ReportMessageByIdResponse.md
-docs/ReportUserByIdData.md
-docs/ReportUserByIdResponse.md
-docs/ResetPushPreferencesResponse.md
-docs/RetrieveAdvancedAnalyticsMetricsResponse.md
-docs/RetrieveIpWhitelistResponse.md
-docs/RetrieveListOfSubscribedEventsResponse.md
-docs/RetrieveListOfSubscribedEventsResponseWebhook.md
-docs/RevokeSecondaryApiTokenByTokenResponse.md
-docs/SBObject.md
-docs/ScheduleAnnouncementData.md
-docs/ScheduleAnnouncementDataMessage.md
-docs/ScheduleAnnouncementResponse.md
-docs/ScheduleAnnouncementResponseCreateChannelOptions.md
-docs/ScheduleAnnouncementResponseMessage.md
-docs/SendBirdAdminMessage.md
-docs/SendBirdAppleCriticalAlertOptions.md
-docs/SendBirdAutoEventMessageSettings.md
-docs/SendBirdBaseChannel.md
-docs/SendBirdBaseMessageInstance.md
-docs/SendBirdChannelResponse.md
-docs/SendBirdEmoji.md
-docs/SendBirdEmojiCategory.md
-docs/SendBirdFileMessageParams.md
-docs/SendBirdGroupChannel.md
-docs/SendBirdGroupChannelChannel.md
-docs/SendBirdGroupChannelCollection.md
-docs/SendBirdGroupChannelCreatedBy.md
-docs/SendBirdGroupChannelDisappearingMessage.md
-docs/SendBirdGroupChannelInviter.md
-docs/SendBirdGroupChannelLastMessage.md
-docs/SendBirdGroupChannelSmsFallback.md
-docs/SendBirdMember.md
-docs/SendBirdMessageMetaArray.md
-docs/SendBirdMessageResponse.md
-docs/SendBirdMessageResponseMentionedUsersInner.md
-docs/SendBirdMessageResponseUser.md
-docs/SendBirdOGImage.md
-docs/SendBirdOGMetaData.md
-docs/SendBirdOpenChannel.md
-docs/SendBirdPlugin.md
-docs/SendBirdPoll.md
-docs/SendBirdPollDetails.md
-docs/SendBirdPollOption.md
-docs/SendBirdPollUpdatedVoteCount.md
-docs/SendBirdReaction.md
-docs/SendBirdRestrictionInfo.md
-docs/SendBirdSender.md
-docs/SendBirdThreadInfo.md
-docs/SendBirdThumbnailSBObject.md
-docs/SendBirdThumbnailSize.md
-docs/SendBirdUser.md
-docs/SendBirdUserMessageParams.md
-docs/SendBotSMessageData.md
-docs/SendMessageData.md
-docs/SetDomainFilterData.md
-docs/SetDomainFilterDataDomainFilter.md
-docs/SetDomainFilterDataImageModeration.md
-docs/SetDomainFilterDataImageModerationLimits.md
-docs/SetDomainFilterDataProfanityFilter.md
-docs/SetDomainFilterDataProfanityFilterRegexFiltersInner.md
-docs/SetDomainFilterDataProfanityTriggeredModeration.md
+docs/RegisterOperatorsToAGroupChannelRequest.md
+docs/RemoveARegistrationOrDeviceTokenResponse.md
+docs/RemoveAllRegistrationOrDeviceTokenResponse.md
+docs/ResetChatHistoryRequest.md
+docs/ResetChatHistoryResponse.md
+docs/ScheduleAnAnnouncementRequest.md
+docs/ScheduleAnAnnouncementRequestCreateChannelOptions.md
+docs/ScheduleAnAnnouncementRequestMessage.md
+docs/ScheduleAnAnnouncementResponse.md
+docs/ScheduleAnAnnouncementResponseMessage.md
+docs/SendABotMessageRequest.md
+docs/SendAMessageRequest.md
+docs/SendAdminMessageRequestBody.md
+docs/SendFileMessageRequestBody.md
+docs/SendTextMessageRequestBody.md
+docs/SendTextMessageRequestBodyPushMessageTemplate.md
+docs/SendTextMessageRequestBodyPushMessageTemplateOneOf.md
+docs/SendbirdBasicUserInfo.md
+docs/SendbirdDisappearingMessage.md
+docs/SendbirdExtendedMessagePayload.md
+docs/SendbirdFile.md
+docs/SendbirdGroupChannel.md
+docs/SendbirdGroupChannelDetail.md
+docs/SendbirdGroupChannelDetailChannel.md
+docs/SendbirdMember.md
+docs/SendbirdMessageResponse.md
+docs/SendbirdMessageResponseMessageEvents.md
+docs/SendbirdOpenChannel.md
+docs/SendbirdParentMessageInfo.md
+docs/SendbirdPushTriggerOption.md
+docs/SendbirdReaction.md
+docs/SendbirdSmsFallback.md
+docs/SendbirdSortedMetaarrayInner.md
+docs/SendbirdThumbnail.md
+docs/SendbirdUser.md
+docs/StartTypingIndicatorsRequest.md
docs/StatisticsApi.md
-docs/TranslateMessageIntoOtherLanguagesData.md
-docs/UpdateAnnouncementByIdData.md
-docs/UpdateAnnouncementByIdResponse.md
-docs/UpdateAnnouncementByIdResponseMessage.md
-docs/UpdateApnsPushConfigurationByIdData.md
-docs/UpdateApnsPushConfigurationByIdResponse.md
-docs/UpdateBotByIdData.md
-docs/UpdateBotByIdResponse.md
-docs/UpdateChannelInvitationPreferenceData.md
+docs/UpdateAChannelMetadataRequest.md
+docs/UpdateAGroupChannelRequest.md
+docs/UpdateAMessageRequest.md
+docs/UpdateAUserRequest.md
+docs/UpdateAnOpenChannelRequest.md
+docs/UpdateChannelInvitationPreferenceRequest.md
docs/UpdateChannelInvitationPreferenceResponse.md
-docs/UpdateChannelMetacounterData.md
-docs/UpdateChannelMetadataData.md
-docs/UpdateCountPreferenceOfChannelByUrlData.md
+docs/UpdateCountPreferenceOfAChannelRequest.md
docs/UpdateCountPreferenceOfChannelByUrlResponse.md
-docs/UpdateDefaultChannelInvitationPreferenceData.md
-docs/UpdateDefaultChannelInvitationPreferenceResponse.md
-docs/UpdateEmojiCategoryUrlByIdData.md
-docs/UpdateEmojiUrlByKeyData.md
-docs/UpdateExtraDataInMessageData.md
-docs/UpdateExtraDataInMessageResponse.md
-docs/UpdateExtraDataInMessageResponseSortedMetaarrayInner.md
-docs/UpdateFcmPushConfigurationByIdData.md
-docs/UpdateFcmPushConfigurationByIdResponse.md
-docs/UpdateHmsPushConfigurationByIdData.md
-docs/UpdateHmsPushConfigurationByIdResponse.md
-docs/UpdateMessageByIdData.md
-docs/UpdatePushNotificationContentTemplateData.md
-docs/UpdatePushNotificationContentTemplateResponse.md
-docs/UpdatePushPreferencesData.md
-docs/UpdatePushPreferencesForChannelByUrlData.md
-docs/UpdatePushPreferencesForChannelByUrlResponse.md
+docs/UpdateExtraDataInAMessageRequest.md
+docs/UpdateExtraDataInAMessageResponse.md
+docs/UpdatePushPreferencesForAChannelRequest.md
+docs/UpdatePushPreferencesForAChannelResponse.md
+docs/UpdatePushPreferencesRequest.md
docs/UpdatePushPreferencesResponse.md
-docs/UpdateUserByIdData.md
-docs/UpdateUserMetadataData.md
-docs/UpdateUserMetadataResponse.md
-docs/UseDefaultEmojisData.md
-docs/UseDefaultEmojisResponse.md
docs/UserApi.md
-docs/ViewAnnouncementByIdResponse.md
-docs/ViewBotByIdResponse.md
-docs/ViewChannelInvitationPreferenceResponse.md
-docs/ViewCountPreferenceOfChannelByUrlResponse.md
-docs/ViewDataExportByIdResponse.md
-docs/ViewDefaultChannelInvitationPreferenceResponse.md
-docs/ViewGdprRequestByIdResponse.md
-docs/ViewNumberOfChannelsByJoinStatusResponse.md
+docs/ViewCountPreferenceOfAChannelResponse.md
docs/ViewNumberOfChannelsWithUnreadMessagesResponse.md
-docs/ViewNumberOfConcurrentConnectionsResponse.md
docs/ViewNumberOfDailyActiveUsersResponse.md
docs/ViewNumberOfMonthlyActiveUsersResponse.md
-docs/ViewNumberOfPeakConnectionsResponse.md
-docs/ViewNumberOfPeakConnectionsResponsePeakConnectionsInner.md
-docs/ViewNumberOfUnreadItemsResponse.md
docs/ViewNumberOfUnreadMessagesResponse.md
-docs/ViewPushConfigurationByIdResponse.md
-docs/ViewPushNotificationContentTemplateResponse.md
-docs/ViewPushNotificationContentTemplateResponsePushMessageTemplatesInner.md
-docs/ViewPushPreferencesForChannelByUrlResponse.md
+docs/ViewPushPreferencesForAChannelResponse.md
docs/ViewPushPreferencesResponse.md
-docs/ViewSecondaryApiTokenByTokenResponse.md
-docs/ViewTotalNumberOfMessagesInChannelResponse.md
-docs/ViewUserMetadataResponse.md
-docs/ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner.md
-docs/WebhookApi.md
git_push.sh
mocha.opts
package.json
src/ApiClient.js
src/api/AnnouncementApi.js
-src/api/ApplicationApi.js
src/api/BotApi.js
-src/api/DataExportApi.js
src/api/GroupChannelApi.js
src/api/MessageApi.js
src/api/MetadataApi.js
src/api/ModerationApi.js
src/api/OpenChannelApi.js
-src/api/PrivacyApi.js
-src/api/ReportApi.js
src/api/StatisticsApi.js
src/api/UserApi.js
-src/api/WebhookApi.js
src/index.js
-src/model/AddApnsPushConfigurationData.js
-src/model/AddApnsPushConfigurationResponse.js
-src/model/AddApnsPushConfigurationResponsePushConfigurationsInner.js
-src/model/AddEmojiCategoriesResponse.js
-src/model/AddEmojiCategoriesResponseEmojiCategoriesInner.js
-src/model/AddEmojisData.js
-src/model/AddEmojisResponse.js
-src/model/AddExtraDataToMessageData.js
-src/model/AddExtraDataToMessageResponse.js
-src/model/AddFcmPushConfigurationData.js
-src/model/AddFcmPushConfigurationResponse.js
-src/model/AddFcmPushConfigurationResponsePushConfigurationsInner.js
-src/model/AddHmsPushConfigurationData.js
-src/model/AddHmsPushConfigurationResponse.js
-src/model/AddHmsPushConfigurationResponsePushConfigurationsInner.js
-src/model/AddIpToWhitelistData.js
-src/model/AddIpToWhitelistResponse.js
-src/model/AddReactionToAMessageData.js
-src/model/AddReactionToAMessageResponse.js
-src/model/AddRegistrationOrDeviceTokenData.js
-src/model/AddRegistrationOrDeviceTokenResponse.js
-src/model/BanFromChannelsWithCustomChannelTypesData.js
-src/model/BanUsersInChannelsWithCustomChannelTypeData.js
-src/model/BanUsersInChannelsWithCustomChannelTypeDataBannedListInner.js
-src/model/Blob.js
-src/model/BlockUserData.js
-src/model/BlockUserResponse.js
-src/model/ChoosePushNotificationContentTemplateResponse.js
-src/model/ChooseWhichEventsToSubscribeToData.js
-src/model/ChooseWhichEventsToSubscribeToResponse.js
-src/model/ChooseWhichEventsToSubscribeToResponseWebhook.js
-src/model/ConfigureAutoEventData.js
-src/model/ConfigureAutoEventDataAutoEventMessage.js
-src/model/CreateBotData.js
-src/model/CreateBotResponse.js
-src/model/CreateBotResponseBot.js
-src/model/CreateChannelMetacounterData.js
-src/model/CreateChannelMetadataData.js
-src/model/CreateChannelMetadataResponse.js
-src/model/CreateUserData.js
-src/model/CreateUserMetadataData.js
-src/model/CreateUserMetadataResponse.js
-src/model/CreateUserTokenData.js
+src/model/AcceptAnInvitationRequest.js
+src/model/AddARegistrationOrDeviceTokenRequest.js
+src/model/AddARegistrationOrDeviceTokenResponse.js
+src/model/AddExtraDataToAMessageRequest.js
+src/model/AddExtraDataToAMessageResponse.js
+src/model/BlockAUserRequest.js
+src/model/BlockAUserResponse.js
+src/model/CheckIfMemberResponse.js
+src/model/ChooseAPushNotificationContentTemplateRequest.js
+src/model/ChooseAPushNotificationContentTemplateResponse.js
+src/model/CreateABotRequest.js
+src/model/CreateABotResponse.js
+src/model/CreateABotResponseBot.js
+src/model/CreateABotResponseBotStyle.js
+src/model/CreateAChannelMetadataRequest.js
+src/model/CreateAChannelMetadataResponse.js
+src/model/CreateAGroupChannelRequest.js
+src/model/CreateAUserRequest.js
+src/model/CreateAnOpenChannelRequest.js
+src/model/CreateUserTokenRequest.js
src/model/CreateUserTokenResponse.js
-src/model/CustomTypeListBannedUsersResponse.js
-src/model/DeleteAllowedIpsFromWhitelistResponse.js
-src/model/DeleteApnsCertificateByIdResponse.js
-src/model/EnableReactionsData.js
-src/model/EnableReactionsResponse.js
-src/model/File.js
-src/model/Function.js
-src/model/GcAcceptInvitationData.js
-src/model/GcBanUserData.js
-src/model/GcBanUserResponse.js
-src/model/GcCheckIfMemberByIdResponse.js
-src/model/GcCreateChannelData.js
-src/model/GcDeclineInvitationData.js
-src/model/GcFreezeChannelData.js
-src/model/GcHideOrArchiveChannelData.js
-src/model/GcInviteAsMembersData.js
-src/model/GcJoinChannelData.js
-src/model/GcLeaveChannelData.js
-src/model/GcListBannedUsersResponse.js
-src/model/GcListChannelsResponse.js
-src/model/GcListMembersResponse.js
-src/model/GcListMutedUsersResponse.js
-src/model/GcListOperatorsResponse.js
-src/model/GcMarkAllMessagesAsDeliveredData.js
-src/model/GcMarkAllMessagesAsDeliveredResponse.js
-src/model/GcMarkAllMessagesAsReadData.js
-src/model/GcMuteUserData.js
-src/model/GcRegisterOperatorsData.js
-src/model/GcRegisterOperatorsResponse.js
-src/model/GcResetChatHistoryData.js
-src/model/GcResetChatHistoryResponse.js
-src/model/GcUpdateBanByIdData.js
-src/model/GcUpdateBanByIdResponse.js
-src/model/GcUpdateChannelByUrlData.js
-src/model/GcViewBanByIdResponse.js
-src/model/GcViewMuteByIdResponse.js
-src/model/GcViewNumberOfEachMembersUnreadMessagesResponse.js
-src/model/GenerateSecondaryApiTokenData.js
-src/model/GenerateSecondaryApiTokenResponse.js
-src/model/GetDetailedOpenRateOfAnnouncementByIdResponse.js
-src/model/GetDetailedOpenRateOfAnnouncementGroupResponse.js
-src/model/GetDetailedOpenStatusOfAnnouncementByIdResponse.js
-src/model/GetDetailedOpenStatusOfAnnouncementByIdResponseOpenStatusInner.js
-src/model/GetStatisticsDailyResponse.js
-src/model/GetStatisticsDailyResponseStatisticsInner.js
-src/model/GetStatisticsMonthlyResponse.js
-src/model/GetStatisticsResponse.js
-src/model/JoinChannelsData.js
-src/model/JoinChannelsResponse.js
-src/model/LeaveMyGroupChannelsData.js
-src/model/ListAllEmojisAndEmojiCategoriesResponse.js
-src/model/ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInner.js
-src/model/ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner.js
-src/model/ListAnnouncementGroupsResponse.js
-src/model/ListAnnouncementsResponse.js
-src/model/ListAnnouncementsResponseAnnouncementsInner.js
-src/model/ListBannedChannelsResponse.js
-src/model/ListBannedChannelsResponseBannedChannelsInner.js
+src/model/FreezeAGroupChannelRequest.js
+src/model/FreezeAnOpenChannelRequest.js
+src/model/GetAGroupChannelResponse.js
+src/model/GetAGroupChannelResponseAllOf.js
+src/model/GetChannelInvitationPreferenceResponse.js
+src/model/GetTotalNumberOfMessagesInAChannelResponse.js
+src/model/GroupChannelListMembersResponse.js
+src/model/GroupChatListChannelsResponse.js
+src/model/HideAChannelRequest.js
+src/model/InviteAsMembersRequest.js
+src/model/InviteAsMembersResponse.js
+src/model/InviteAsMembersResponseAllOf.js
+src/model/JoinAChannelRequest.js
+src/model/JoinChannelsRequest.js
+src/model/LeaveAChannelRequest.js
+src/model/LeaveMyGroupChannelsRequest.js
src/model/ListBlockedUsersResponse.js
src/model/ListBotsResponse.js
src/model/ListBotsResponseBotsInner.js
-src/model/ListDataExportsByMessageChannelOrUserResponse.js
-src/model/ListDataExportsByMessageChannelOrUserResponseExportedDataInner.js
-src/model/ListDataExportsByMessageChannelOrUserResponseExportedDataInnerFile.js
-src/model/ListEmojisResponse.js
-src/model/ListGdprRequestsResponse.js
-src/model/ListGdprRequestsResponseRequestsInner.js
+src/model/ListBotsResponseBotsInnerAi.js
+src/model/ListBotsResponseBotsInnerBot.js
+src/model/ListBotsResponseBotsInnerBotStyle.js
+src/model/ListBotsResponseBotsInnerBotStyleColor.js
+src/model/ListBotsResponseBotsInnerFirstMessagesInner.js
+src/model/ListBotsResponseBotsInnerFirstMessagesInnerData.js
+src/model/ListBotsResponseBotsInnerSafeguard.js
src/model/ListMessagesResponse.js
-src/model/ListMessagesResponseMessagesInner.js
-src/model/ListMessagesResponseMessagesInnerOgTag.js
-src/model/ListMessagesResponseMessagesInnerOgTagOgImage.js
-src/model/ListMessagesResponseMessagesInnerSortedMetaarrayInner.js
-src/model/ListMutedChannelsResponse.js
-src/model/ListMutedUsersInChannelsWithCustomChannelType200Response.js
src/model/ListMyGroupChannelsResponse.js
-src/model/ListPushConfigurationsResponse.js
-src/model/ListPushConfigurationsResponsePushConfigurationsInner.js
-src/model/ListPushNotificationContentTemplatesResponse.js
-src/model/ListPushNotificationContentTemplatesResponsePushMessageTemplatesInner.js
-src/model/ListPushNotificationContentTemplatesResponsePushMessageTemplatesInnerTemplate.js
-src/model/ListReactionsOfMessageResponse.js
+src/model/ListOpenChannelsResponse.js
+src/model/ListOperatorsResponse.js
src/model/ListRegistrationOrDeviceTokensResponse.js
-src/model/ListReportsOnChannelByUrlResponse.js
-src/model/ListReportsOnMessageByIdResponse.js
-src/model/ListReportsOnMessageByIdResponseReportLogsInner.js
-src/model/ListReportsOnUserByIdResponse.js
-src/model/ListReportsResponse.js
-src/model/ListReportsResponseReportLogsInner.js
-src/model/ListSecondaryApiTokensResponse.js
-src/model/ListSecondaryApiTokensResponseApiTokensInner.js
src/model/ListUsersResponse.js
-src/model/MarkAllMessagesAsReadData.js
-src/model/MuteInChannelsWithCustomChannelTypesData.js
-src/model/MuteUsersInChannelsWithCustomChannelTypeData.js
-src/model/OcBanUserData.js
-src/model/OcBanUserResponse.js
-src/model/OcCreateChannelData.js
-src/model/OcDeleteChannelByUrl200Response.js
-src/model/OcFreezeChannelData.js
-src/model/OcListBannedUsersResponse.js
-src/model/OcListBannedUsersResponseBannedListInner.js
-src/model/OcListChannelsResponse.js
-src/model/OcListMutedUsersResponse.js
-src/model/OcListOperatorsResponse.js
-src/model/OcListParticipantsResponse.js
-src/model/OcMuteUserData.js
-src/model/OcRegisterOperatorsData.js
-src/model/OcUpdateBanByIdData.js
-src/model/OcUpdateBanByIdResponse.js
-src/model/OcUpdateChannelByUrlData.js
-src/model/OcViewBanByIdResponse.js
-src/model/OcViewMuteByIdResponse.js
-src/model/RegisterAndScheduleDataExportData.js
-src/model/RegisterAndScheduleDataExportResponse.js
-src/model/RegisterAsOperatorToChannelsWithCustomChannelTypesData.js
-src/model/RegisterGdprRequestData.js
-src/model/RegisterGdprRequestResponse.js
-src/model/RemovePushConfigurationByIdResponse.js
-src/model/RemoveReactionFromAMessageResponse.js
-src/model/RemoveRegistrationOrDeviceTokenByTokenResponse.js
-src/model/RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse.js
-src/model/RemoveRegistrationOrDeviceTokenResponse.js
-src/model/ReportChannelByUrlData.js
-src/model/ReportChannelByUrlResponse.js
-src/model/ReportMessageByIdData.js
-src/model/ReportMessageByIdResponse.js
-src/model/ReportUserByIdData.js
-src/model/ReportUserByIdResponse.js
-src/model/ResetPushPreferencesResponse.js
-src/model/RetrieveAdvancedAnalyticsMetricsResponse.js
-src/model/RetrieveIpWhitelistResponse.js
-src/model/RetrieveListOfSubscribedEventsResponse.js
-src/model/RetrieveListOfSubscribedEventsResponseWebhook.js
-src/model/RevokeSecondaryApiTokenByTokenResponse.js
-src/model/SBObject.js
-src/model/ScheduleAnnouncementData.js
-src/model/ScheduleAnnouncementDataMessage.js
-src/model/ScheduleAnnouncementResponse.js
-src/model/ScheduleAnnouncementResponseCreateChannelOptions.js
-src/model/ScheduleAnnouncementResponseMessage.js
-src/model/SendBirdAdminMessage.js
-src/model/SendBirdAppleCriticalAlertOptions.js
-src/model/SendBirdAutoEventMessageSettings.js
-src/model/SendBirdBaseChannel.js
-src/model/SendBirdBaseMessageInstance.js
-src/model/SendBirdChannelResponse.js
-src/model/SendBirdEmoji.js
-src/model/SendBirdEmojiCategory.js
-src/model/SendBirdFileMessageParams.js
-src/model/SendBirdGroupChannel.js
-src/model/SendBirdGroupChannelChannel.js
-src/model/SendBirdGroupChannelCollection.js
-src/model/SendBirdGroupChannelCreatedBy.js
-src/model/SendBirdGroupChannelDisappearingMessage.js
-src/model/SendBirdGroupChannelInviter.js
-src/model/SendBirdGroupChannelLastMessage.js
-src/model/SendBirdGroupChannelSmsFallback.js
-src/model/SendBirdMember.js
-src/model/SendBirdMessageMetaArray.js
-src/model/SendBirdMessageResponse.js
-src/model/SendBirdMessageResponseMentionedUsersInner.js
-src/model/SendBirdMessageResponseUser.js
-src/model/SendBirdOGImage.js
-src/model/SendBirdOGMetaData.js
-src/model/SendBirdOpenChannel.js
-src/model/SendBirdPlugin.js
-src/model/SendBirdPoll.js
-src/model/SendBirdPollDetails.js
-src/model/SendBirdPollOption.js
-src/model/SendBirdPollUpdatedVoteCount.js
-src/model/SendBirdReaction.js
-src/model/SendBirdRestrictionInfo.js
-src/model/SendBirdSender.js
-src/model/SendBirdThreadInfo.js
-src/model/SendBirdThumbnailSBObject.js
-src/model/SendBirdThumbnailSize.js
-src/model/SendBirdUser.js
-src/model/SendBirdUserMessageParams.js
-src/model/SendBotSMessageData.js
-src/model/SendMessageData.js
-src/model/SetDomainFilterData.js
-src/model/SetDomainFilterDataDomainFilter.js
-src/model/SetDomainFilterDataImageModeration.js
-src/model/SetDomainFilterDataImageModerationLimits.js
-src/model/SetDomainFilterDataProfanityFilter.js
-src/model/SetDomainFilterDataProfanityFilterRegexFiltersInner.js
-src/model/SetDomainFilterDataProfanityTriggeredModeration.js
-src/model/TranslateMessageIntoOtherLanguagesData.js
-src/model/UpdateAnnouncementByIdData.js
-src/model/UpdateAnnouncementByIdResponse.js
-src/model/UpdateAnnouncementByIdResponseMessage.js
-src/model/UpdateApnsPushConfigurationByIdData.js
-src/model/UpdateApnsPushConfigurationByIdResponse.js
-src/model/UpdateBotByIdData.js
-src/model/UpdateBotByIdResponse.js
-src/model/UpdateChannelInvitationPreferenceData.js
+src/model/MarkAllMessagesAsReadRequest.js
+src/model/MarkChannelMessagesAsReadRequest.js
+src/model/RegisterOperatorsToAGroupChannelRequest.js
+src/model/RemoveARegistrationOrDeviceTokenResponse.js
+src/model/RemoveAllRegistrationOrDeviceTokenResponse.js
+src/model/ResetChatHistoryRequest.js
+src/model/ResetChatHistoryResponse.js
+src/model/ScheduleAnAnnouncementRequest.js
+src/model/ScheduleAnAnnouncementRequestCreateChannelOptions.js
+src/model/ScheduleAnAnnouncementRequestMessage.js
+src/model/ScheduleAnAnnouncementResponse.js
+src/model/ScheduleAnAnnouncementResponseMessage.js
+src/model/SendABotMessageRequest.js
+src/model/SendAMessageRequest.js
+src/model/SendAdminMessageRequestBody.js
+src/model/SendFileMessageRequestBody.js
+src/model/SendTextMessageRequestBody.js
+src/model/SendTextMessageRequestBodyPushMessageTemplate.js
+src/model/SendTextMessageRequestBodyPushMessageTemplateOneOf.js
+src/model/SendbirdBasicUserInfo.js
+src/model/SendbirdDisappearingMessage.js
+src/model/SendbirdExtendedMessagePayload.js
+src/model/SendbirdFile.js
+src/model/SendbirdGroupChannel.js
+src/model/SendbirdGroupChannelDetail.js
+src/model/SendbirdGroupChannelDetailChannel.js
+src/model/SendbirdMember.js
+src/model/SendbirdMessageResponse.js
+src/model/SendbirdMessageResponseMessageEvents.js
+src/model/SendbirdOpenChannel.js
+src/model/SendbirdParentMessageInfo.js
+src/model/SendbirdPushTriggerOption.js
+src/model/SendbirdReaction.js
+src/model/SendbirdSmsFallback.js
+src/model/SendbirdSortedMetaarrayInner.js
+src/model/SendbirdThumbnail.js
+src/model/SendbirdUser.js
+src/model/StartTypingIndicatorsRequest.js
+src/model/UpdateAChannelMetadataRequest.js
+src/model/UpdateAGroupChannelRequest.js
+src/model/UpdateAMessageRequest.js
+src/model/UpdateAUserRequest.js
+src/model/UpdateAnOpenChannelRequest.js
+src/model/UpdateChannelInvitationPreferenceRequest.js
src/model/UpdateChannelInvitationPreferenceResponse.js
-src/model/UpdateChannelMetacounterData.js
-src/model/UpdateChannelMetadataData.js
-src/model/UpdateCountPreferenceOfChannelByUrlData.js
+src/model/UpdateCountPreferenceOfAChannelRequest.js
src/model/UpdateCountPreferenceOfChannelByUrlResponse.js
-src/model/UpdateDefaultChannelInvitationPreferenceData.js
-src/model/UpdateDefaultChannelInvitationPreferenceResponse.js
-src/model/UpdateEmojiCategoryUrlByIdData.js
-src/model/UpdateEmojiUrlByKeyData.js
-src/model/UpdateExtraDataInMessageData.js
-src/model/UpdateExtraDataInMessageResponse.js
-src/model/UpdateExtraDataInMessageResponseSortedMetaarrayInner.js
-src/model/UpdateFcmPushConfigurationByIdData.js
-src/model/UpdateFcmPushConfigurationByIdResponse.js
-src/model/UpdateHmsPushConfigurationByIdData.js
-src/model/UpdateHmsPushConfigurationByIdResponse.js
-src/model/UpdateMessageByIdData.js
-src/model/UpdatePushNotificationContentTemplateData.js
-src/model/UpdatePushNotificationContentTemplateResponse.js
-src/model/UpdatePushPreferencesData.js
-src/model/UpdatePushPreferencesForChannelByUrlData.js
-src/model/UpdatePushPreferencesForChannelByUrlResponse.js
+src/model/UpdateExtraDataInAMessageRequest.js
+src/model/UpdateExtraDataInAMessageResponse.js
+src/model/UpdatePushPreferencesForAChannelRequest.js
+src/model/UpdatePushPreferencesForAChannelResponse.js
+src/model/UpdatePushPreferencesRequest.js
src/model/UpdatePushPreferencesResponse.js
-src/model/UpdateUserByIdData.js
-src/model/UpdateUserMetadataData.js
-src/model/UpdateUserMetadataResponse.js
-src/model/UseDefaultEmojisData.js
-src/model/UseDefaultEmojisResponse.js
-src/model/ViewAnnouncementByIdResponse.js
-src/model/ViewBotByIdResponse.js
-src/model/ViewChannelInvitationPreferenceResponse.js
-src/model/ViewCountPreferenceOfChannelByUrlResponse.js
-src/model/ViewDataExportByIdResponse.js
-src/model/ViewDefaultChannelInvitationPreferenceResponse.js
-src/model/ViewGdprRequestByIdResponse.js
-src/model/ViewNumberOfChannelsByJoinStatusResponse.js
+src/model/ViewCountPreferenceOfAChannelResponse.js
src/model/ViewNumberOfChannelsWithUnreadMessagesResponse.js
-src/model/ViewNumberOfConcurrentConnectionsResponse.js
src/model/ViewNumberOfDailyActiveUsersResponse.js
src/model/ViewNumberOfMonthlyActiveUsersResponse.js
-src/model/ViewNumberOfPeakConnectionsResponse.js
-src/model/ViewNumberOfPeakConnectionsResponsePeakConnectionsInner.js
-src/model/ViewNumberOfUnreadItemsResponse.js
src/model/ViewNumberOfUnreadMessagesResponse.js
-src/model/ViewPushConfigurationByIdResponse.js
-src/model/ViewPushNotificationContentTemplateResponse.js
-src/model/ViewPushNotificationContentTemplateResponsePushMessageTemplatesInner.js
-src/model/ViewPushPreferencesForChannelByUrlResponse.js
+src/model/ViewPushPreferencesForAChannelResponse.js
src/model/ViewPushPreferencesResponse.js
-src/model/ViewSecondaryApiTokenByTokenResponse.js
-src/model/ViewTotalNumberOfMessagesInChannelResponse.js
-src/model/ViewUserMetadataResponse.js
-src/model/ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner.js
+test/api/AnnouncementApi.spec.js
+test/api/BotApi.spec.js
+test/api/GroupChannelApi.spec.js
+test/api/MessageApi.spec.js
+test/api/MetadataApi.spec.js
+test/api/ModerationApi.spec.js
+test/api/OpenChannelApi.spec.js
+test/api/StatisticsApi.spec.js
+test/api/UserApi.spec.js
+test/model/AcceptAnInvitationRequest.spec.js
+test/model/AddARegistrationOrDeviceTokenRequest.spec.js
+test/model/AddARegistrationOrDeviceTokenResponse.spec.js
+test/model/AddExtraDataToAMessageRequest.spec.js
+test/model/AddExtraDataToAMessageResponse.spec.js
+test/model/BlockAUserRequest.spec.js
+test/model/BlockAUserResponse.spec.js
+test/model/CheckIfMemberResponse.spec.js
+test/model/ChooseAPushNotificationContentTemplateRequest.spec.js
+test/model/ChooseAPushNotificationContentTemplateResponse.spec.js
+test/model/CreateABotRequest.spec.js
+test/model/CreateABotResponse.spec.js
+test/model/CreateABotResponseBot.spec.js
+test/model/CreateABotResponseBotStyle.spec.js
+test/model/CreateAChannelMetadataRequest.spec.js
+test/model/CreateAChannelMetadataResponse.spec.js
+test/model/CreateAGroupChannelRequest.spec.js
+test/model/CreateAUserRequest.spec.js
+test/model/CreateAnOpenChannelRequest.spec.js
+test/model/CreateUserTokenRequest.spec.js
+test/model/CreateUserTokenResponse.spec.js
+test/model/FreezeAGroupChannelRequest.spec.js
+test/model/FreezeAnOpenChannelRequest.spec.js
+test/model/GetAGroupChannelResponse.spec.js
+test/model/GetAGroupChannelResponseAllOf.spec.js
+test/model/GetChannelInvitationPreferenceResponse.spec.js
+test/model/GetTotalNumberOfMessagesInAChannelResponse.spec.js
+test/model/GroupChannelListMembersResponse.spec.js
+test/model/GroupChatListChannelsResponse.spec.js
+test/model/HideAChannelRequest.spec.js
+test/model/InviteAsMembersRequest.spec.js
+test/model/InviteAsMembersResponse.spec.js
+test/model/InviteAsMembersResponseAllOf.spec.js
+test/model/JoinAChannelRequest.spec.js
+test/model/JoinChannelsRequest.spec.js
+test/model/LeaveAChannelRequest.spec.js
+test/model/LeaveMyGroupChannelsRequest.spec.js
+test/model/ListBlockedUsersResponse.spec.js
+test/model/ListBotsResponse.spec.js
+test/model/ListBotsResponseBotsInner.spec.js
+test/model/ListBotsResponseBotsInnerAi.spec.js
+test/model/ListBotsResponseBotsInnerBot.spec.js
+test/model/ListBotsResponseBotsInnerBotStyle.spec.js
+test/model/ListBotsResponseBotsInnerBotStyleColor.spec.js
+test/model/ListBotsResponseBotsInnerFirstMessagesInner.spec.js
+test/model/ListBotsResponseBotsInnerFirstMessagesInnerData.spec.js
+test/model/ListBotsResponseBotsInnerSafeguard.spec.js
+test/model/ListMessagesResponse.spec.js
+test/model/ListMyGroupChannelsResponse.spec.js
+test/model/ListOpenChannelsResponse.spec.js
+test/model/ListOperatorsResponse.spec.js
+test/model/ListRegistrationOrDeviceTokensResponse.spec.js
+test/model/ListUsersResponse.spec.js
+test/model/MarkAllMessagesAsReadRequest.spec.js
+test/model/MarkChannelMessagesAsReadRequest.spec.js
+test/model/RegisterOperatorsToAGroupChannelRequest.spec.js
+test/model/RemoveARegistrationOrDeviceTokenResponse.spec.js
+test/model/RemoveAllRegistrationOrDeviceTokenResponse.spec.js
+test/model/ResetChatHistoryRequest.spec.js
+test/model/ResetChatHistoryResponse.spec.js
+test/model/ScheduleAnAnnouncementRequest.spec.js
+test/model/ScheduleAnAnnouncementRequestCreateChannelOptions.spec.js
+test/model/ScheduleAnAnnouncementRequestMessage.spec.js
+test/model/ScheduleAnAnnouncementResponse.spec.js
+test/model/ScheduleAnAnnouncementResponseMessage.spec.js
+test/model/SendABotMessageRequest.spec.js
+test/model/SendAMessageRequest.spec.js
+test/model/SendAdminMessageRequestBody.spec.js
+test/model/SendFileMessageRequestBody.spec.js
+test/model/SendTextMessageRequestBody.spec.js
+test/model/SendTextMessageRequestBodyPushMessageTemplate.spec.js
+test/model/SendTextMessageRequestBodyPushMessageTemplateOneOf.spec.js
+test/model/SendbirdBasicUserInfo.spec.js
+test/model/SendbirdDisappearingMessage.spec.js
+test/model/SendbirdExtendedMessagePayload.spec.js
+test/model/SendbirdFile.spec.js
+test/model/SendbirdGroupChannel.spec.js
+test/model/SendbirdGroupChannelDetail.spec.js
+test/model/SendbirdGroupChannelDetailChannel.spec.js
+test/model/SendbirdMember.spec.js
+test/model/SendbirdMessageResponse.spec.js
+test/model/SendbirdMessageResponseMessageEvents.spec.js
+test/model/SendbirdOpenChannel.spec.js
+test/model/SendbirdParentMessageInfo.spec.js
+test/model/SendbirdPushTriggerOption.spec.js
+test/model/SendbirdReaction.spec.js
+test/model/SendbirdSmsFallback.spec.js
+test/model/SendbirdSortedMetaarrayInner.spec.js
+test/model/SendbirdThumbnail.spec.js
+test/model/SendbirdUser.spec.js
+test/model/StartTypingIndicatorsRequest.spec.js
+test/model/UpdateAChannelMetadataRequest.spec.js
+test/model/UpdateAGroupChannelRequest.spec.js
+test/model/UpdateAMessageRequest.spec.js
+test/model/UpdateAUserRequest.spec.js
+test/model/UpdateAnOpenChannelRequest.spec.js
+test/model/UpdateChannelInvitationPreferenceRequest.spec.js
+test/model/UpdateChannelInvitationPreferenceResponse.spec.js
+test/model/UpdateCountPreferenceOfAChannelRequest.spec.js
+test/model/UpdateCountPreferenceOfChannelByUrlResponse.spec.js
+test/model/UpdateExtraDataInAMessageRequest.spec.js
+test/model/UpdateExtraDataInAMessageResponse.spec.js
+test/model/UpdatePushPreferencesForAChannelRequest.spec.js
+test/model/UpdatePushPreferencesForAChannelResponse.spec.js
+test/model/UpdatePushPreferencesRequest.spec.js
+test/model/UpdatePushPreferencesResponse.spec.js
+test/model/ViewCountPreferenceOfAChannelResponse.spec.js
+test/model/ViewNumberOfChannelsWithUnreadMessagesResponse.spec.js
+test/model/ViewNumberOfDailyActiveUsersResponse.spec.js
+test/model/ViewNumberOfMonthlyActiveUsersResponse.spec.js
+test/model/ViewNumberOfUnreadMessagesResponse.spec.js
+test/model/ViewPushPreferencesForAChannelResponse.spec.js
+test/model/ViewPushPreferencesResponse.spec.js
diff --git a/README.md-e b/README.md-e
new file mode 100644
index 0000000..3a021c1
--- /dev/null
+++ b/README.md-e
@@ -0,0 +1,90 @@
+
+
+# [Sendbird JavaScript Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
+
+[](/docs)
+
+This is a Node.js package that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier. With this library you can extend your Sendbird integration to include advanced features like channel automation and user management.
+# Install
+```npm install sendbird-platform-sdk```
+
+# 🔥 Quick start
+
+```javascript
+import SendbirdPlatformSdk from 'sendbird-platform-sdk';
+
+const userId = "1234";
+const name = "bob";
+const profileUrl = "https://picsum.photos/200";
+const apiToken = "YOUR_API_TOKEN";
+const appId = "YOUR_APP_ID";
+
+const opts = {
+ 'createUserData': new SendbirdPlatformSdk.CreateUserData(userId, name, profileUrl),
+};
+
+async function createUser() {
+ const userApiInstance = new SendbirdPlatformSdk.UserApi();
+ userApiInstance.apiClient.basePath = `https://api-${appId}.sendbird.com`;
+ try {
+ const data = await userApiInstance.createUser(apiToken, opts);
+ console.log(data);
+ } catch (e) {
+ console.log(e);
+ }
+}
+
+createUser();
+
+```
+
+# ⚒️ Prerequisite
+
+In order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/). Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.
+
+
+
+# 💻 Requirements
+
+You will need [Node.js](https://nodejs.org/en/download/) installed. This has been developed and tested with NodeJS 17+.
+
+# 🤓 Local Development
+
+To run locally we need to make use of the [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link) command. You will require two terminal tabs.
+
+Please follow these steps:
+
+##### Terminal 1
+
+1. Clone this repo to your machine ```git clone git@github.com:sendbird/sendbird-platform-sdk-javascript```
+2. Move into the newly cloned repo ```cd sendbird-platform-sdk-javascript```
+3. Install node modules ```npm install```
+4. Build the bundled JS ```npm run build```
+5. Link the package ```npm link```
+
+##### Terminal 2
+
+1. Create a new npm package or move into and existing one ```mkdir app-using-sendbird-chat```
+```npm init -y```
+2. Link package to sendbird-platform-sdk ```npm link path/to/sdk/sendbird-platform-sdk-javascript```
+
+The linking step is demonstrated visually here.
+
+
+
+
+# 🗃️ Documentation
+All the documentation for this project lives in the /docs directory of this repo.
+
+##### Helpful links
+
+| | Documentation |
+| ----------- | ----------- |
+| Announcement | [docs/AnnouncementApi.md](docs/AnnouncementApi.md)|
+| Application | [docs/ApplicationApi.md](docs/ApplicationApi.md) |
+| Bot | [docs/BotApi.md](docs/BotApi.md) |
+| GroupChannel | [docs/GroupChannelApi.md](docs/GroupChannelApi.md) |
+| Message | [docs/MessageApi.md](docs/MessageApi.md) |
+| OpenChannel | [docs/OpenChannelApi.md ](docs/OpenChannelApi.md) |
+| User | [docs/UserApi.md](docs/UserApi.md) |
+| Webhooks | [docs/WebhooksApi.md](docs/WebhooksApi.md) |
diff --git a/dist/ApiClient.js b/dist/ApiClient.js
index c307405..e2c8e9c 100644
--- a/dist/ApiClient.js
+++ b/dist/ApiClient.js
@@ -6,14 +6,27 @@ Object.defineProperty(exports, "__esModule", {
exports["default"] = void 0;
var _superagent = _interopRequireDefault(require("superagent"));
var _querystring = _interopRequireDefault(require("querystring"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* @module ApiClient
-* @version 0.0.16
+* @version 2.0.0
*/
/**
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
@@ -50,7 +63,7 @@ var ApiClient = /*#__PURE__*/function () {
* @default {}
*/
this.defaultHeaders = {
- 'User-Agent': 'OpenAPI-Generator/0.0.16/Javascript'
+ 'User-Agent': 'OpenAPI-Generator/2.0.0/Javascript'
};
/**
@@ -99,7 +112,7 @@ var ApiClient = /*#__PURE__*/function () {
* @param param The actual parameter.
* @returns {String} The string representation of param.
*/
- _createClass(ApiClient, [{
+ return _createClass(ApiClient, [{
key: "paramToString",
value: function paramToString(param) {
if (param == undefined || param == null) {
@@ -648,7 +661,6 @@ var ApiClient = /*#__PURE__*/function () {
}
}
}]);
- return ApiClient;
}();
/**
* Enumeration of collection format separator strategies.
@@ -688,5 +700,4 @@ ApiClient.CollectionFormatEnum = {
* @type {module:ApiClient}
*/
ApiClient.instance = new ApiClient();
-var _default = ApiClient;
-exports["default"] = _default;
\ No newline at end of file
+var _default = exports["default"] = ApiClient;
\ No newline at end of file
diff --git a/dist/api/AnnouncementApi.js b/dist/api/AnnouncementApi.js
index d2a1e88..c910f13 100644
--- a/dist/api/AnnouncementApi.js
+++ b/dist/api/AnnouncementApi.js
@@ -5,26 +5,32 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _GetDetailedOpenRateOfAnnouncementGroupResponse = _interopRequireDefault(require("../model/GetDetailedOpenRateOfAnnouncementGroupResponse"));
-var _GetStatisticsDailyResponse = _interopRequireDefault(require("../model/GetStatisticsDailyResponse"));
-var _GetStatisticsMonthlyResponse = _interopRequireDefault(require("../model/GetStatisticsMonthlyResponse"));
-var _GetStatisticsResponse = _interopRequireDefault(require("../model/GetStatisticsResponse"));
-var _ListAnnouncementGroupsResponse = _interopRequireDefault(require("../model/ListAnnouncementGroupsResponse"));
-var _ScheduleAnnouncementData = _interopRequireDefault(require("../model/ScheduleAnnouncementData"));
-var _ScheduleAnnouncementResponse = _interopRequireDefault(require("../model/ScheduleAnnouncementResponse"));
-var _UpdateAnnouncementByIdData = _interopRequireDefault(require("../model/UpdateAnnouncementByIdData"));
-var _UpdateAnnouncementByIdResponse = _interopRequireDefault(require("../model/UpdateAnnouncementByIdResponse"));
-var _ViewAnnouncementByIdResponse = _interopRequireDefault(require("../model/ViewAnnouncementByIdResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _ScheduleAnAnnouncementRequest = _interopRequireDefault(require("../model/ScheduleAnAnnouncementRequest"));
+var _ScheduleAnAnnouncementResponse = _interopRequireDefault(require("../model/ScheduleAnAnnouncementResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* Announcement service.
* @module api/AnnouncementApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var AnnouncementApi = /*#__PURE__*/function () {
+var AnnouncementApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new AnnouncementApi.
* @alias module:api/AnnouncementApi
@@ -38,426 +44,45 @@ var AnnouncementApi = /*#__PURE__*/function () {
}
/**
- * Get detailed open rate of an announcement group
- * ## Get detailed open rate of an announcement group Retrieves the detailed open rate information of an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-rate-of-an-announcement-group ----------------------------
- * @param {String} apiToken
- * @param {String} announcementGroup
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDetailedOpenRateOfAnnouncementGroupResponse} and HTTP response
+ * Schedule an announcement
+ * ## 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)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/ScheduleAnAnnouncementRequest} opts.scheduleAnAnnouncementRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ScheduleAnAnnouncementResponse} and HTTP response
*/
- _createClass(AnnouncementApi, [{
- key: "getDetailedOpenRateOfAnnouncementGroupWithHttpInfo",
- value: function getDetailedOpenRateOfAnnouncementGroupWithHttpInfo(apiToken, announcementGroup) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getDetailedOpenRateOfAnnouncementGroup");
- }
- // verify the required parameter 'announcementGroup' is set
- if (announcementGroup === undefined || announcementGroup === null) {
- throw new Error("Missing the required parameter 'announcementGroup' when calling getDetailedOpenRateOfAnnouncementGroup");
- }
- var pathParams = {
- 'announcement_group': announcementGroup
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GetDetailedOpenRateOfAnnouncementGroupResponse["default"];
- return this.apiClient.callApi('/v3/announcement_open_rate_by_group/{announcement_group}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get detailed open rate of an announcement group
- * ## Get detailed open rate of an announcement group Retrieves the detailed open rate information of an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-rate-of-an-announcement-group ----------------------------
- * @param {String} apiToken
- * @param {String} announcementGroup
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDetailedOpenRateOfAnnouncementGroupResponse}
- */
- }, {
- key: "getDetailedOpenRateOfAnnouncementGroup",
- value: function getDetailedOpenRateOfAnnouncementGroup(apiToken, announcementGroup) {
- return this.getDetailedOpenRateOfAnnouncementGroupWithHttpInfo(apiToken, announcementGroup).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Get statistics - weekly
- * ## Get statistics Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-statistics ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStatisticsResponse} and HTTP response
- */
- }, {
- key: "getStatisticsWithHttpInfo",
- value: function getStatisticsWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getStatistics");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GetStatisticsResponse["default"];
- return this.apiClient.callApi('/v3/announcement_stats/weekly', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get statistics - weekly
- * ## Get statistics Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-statistics ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStatisticsResponse}
- */
- }, {
- key: "getStatistics",
- value: function getStatistics(apiToken) {
- return this.getStatisticsWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Get statistics - daily
- * ## Get statistics Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-statistics ----------------------------
- * @param {String} apiToken
- * @param {String} startDate
- * @param {String} endDate
- * @param {String} startWeek
- * @param {String} endWeek
- * @param {String} startMonth
- * @param {String} endMonth
- * @param {Object} opts Optional parameters
- * @param {String} opts.announcementGroup
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStatisticsDailyResponse} and HTTP response
- */
- }, {
- key: "getStatisticsDailyWithHttpInfo",
- value: function getStatisticsDailyWithHttpInfo(apiToken, startDate, endDate, startWeek, endWeek, startMonth, endMonth, opts) {
+ return _createClass(AnnouncementApi, [{
+ key: "scheduleAnAnnouncementWithHttpInfo",
+ value: function scheduleAnAnnouncementWithHttpInfo(opts) {
opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getStatisticsDaily");
- }
- // verify the required parameter 'startDate' is set
- if (startDate === undefined || startDate === null) {
- throw new Error("Missing the required parameter 'startDate' when calling getStatisticsDaily");
- }
- // verify the required parameter 'endDate' is set
- if (endDate === undefined || endDate === null) {
- throw new Error("Missing the required parameter 'endDate' when calling getStatisticsDaily");
- }
- // verify the required parameter 'startWeek' is set
- if (startWeek === undefined || startWeek === null) {
- throw new Error("Missing the required parameter 'startWeek' when calling getStatisticsDaily");
- }
- // verify the required parameter 'endWeek' is set
- if (endWeek === undefined || endWeek === null) {
- throw new Error("Missing the required parameter 'endWeek' when calling getStatisticsDaily");
- }
- // verify the required parameter 'startMonth' is set
- if (startMonth === undefined || startMonth === null) {
- throw new Error("Missing the required parameter 'startMonth' when calling getStatisticsDaily");
- }
- // verify the required parameter 'endMonth' is set
- if (endMonth === undefined || endMonth === null) {
- throw new Error("Missing the required parameter 'endMonth' when calling getStatisticsDaily");
- }
- var pathParams = {};
- var queryParams = {
- 'start_date': startDate,
- 'end_date': endDate,
- 'start_week': startWeek,
- 'end_week': endWeek,
- 'start_month': startMonth,
- 'end_month': endMonth,
- 'announcement_group': opts['announcementGroup']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GetStatisticsDailyResponse["default"];
- return this.apiClient.callApi('/v3/announcement_stats/daily', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get statistics - daily
- * ## Get statistics Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-statistics ----------------------------
- * @param {String} apiToken
- * @param {String} startDate
- * @param {String} endDate
- * @param {String} startWeek
- * @param {String} endWeek
- * @param {String} startMonth
- * @param {String} endMonth
- * @param {Object} opts Optional parameters
- * @param {String} opts.announcementGroup
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStatisticsDailyResponse}
- */
- }, {
- key: "getStatisticsDaily",
- value: function getStatisticsDaily(apiToken, startDate, endDate, startWeek, endWeek, startMonth, endMonth, opts) {
- return this.getStatisticsDailyWithHttpInfo(apiToken, startDate, endDate, startWeek, endWeek, startMonth, endMonth, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Get statistics - monthly
- * ## Get statistics Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-statistics ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStatisticsMonthlyResponse} and HTTP response
- */
- }, {
- key: "getStatisticsMonthlyWithHttpInfo",
- value: function getStatisticsMonthlyWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getStatisticsMonthly");
- }
+ var postBody = opts['scheduleAnAnnouncementRequest'];
var pathParams = {};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GetStatisticsMonthlyResponse["default"];
- return this.apiClient.callApi('/v3/announcement_stats/monthly', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get statistics - monthly
- * ## Get statistics Retrieves the daily, weekly or monthly statistics of an announcement or an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-statistics ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStatisticsMonthlyResponse}
- */
- }, {
- key: "getStatisticsMonthly",
- value: function getStatisticsMonthly(apiToken) {
- return this.getStatisticsMonthlyWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List announcement groups
- * ## List announcement groups Retrieves a list of announcement groups. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-list-announcement-groups ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAnnouncementGroupsResponse} and HTTP response
- */
- }, {
- key: "listAnnouncementGroupsWithHttpInfo",
- value: function listAnnouncementGroupsWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listAnnouncementGroups");
- }
- var pathParams = {};
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListAnnouncementGroupsResponse["default"];
- return this.apiClient.callApi('/v3/announcement_group', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List announcement groups
- * ## List announcement groups Retrieves a list of announcement groups. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-list-announcement-groups ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListAnnouncementGroupsResponse}
- */
- }, {
- key: "listAnnouncementGroups",
- value: function listAnnouncementGroups(apiToken, opts) {
- return this.listAnnouncementGroupsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Schedule an announcement
- * ## Schedule an announcement Schedules a new announcement. You can also schedule an announcement in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-schedule-an-announcement
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/ScheduleAnnouncementData} opts.scheduleAnnouncementData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ScheduleAnnouncementResponse} and HTTP response
- */
- }, {
- key: "scheduleAnnouncementWithHttpInfo",
- value: function scheduleAnnouncementWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['scheduleAnnouncementData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling scheduleAnnouncement");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _ScheduleAnnouncementResponse["default"];
+ var returnType = _ScheduleAnAnnouncementResponse["default"];
return this.apiClient.callApi('/v3/announcements', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Schedule an announcement
- * ## Schedule an announcement Schedules a new announcement. You can also schedule an announcement in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-schedule-an-announcement
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/ScheduleAnnouncementData} opts.scheduleAnnouncementData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ScheduleAnnouncementResponse}
- */
- }, {
- key: "scheduleAnnouncement",
- value: function scheduleAnnouncement(apiToken, opts) {
- return this.scheduleAnnouncementWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update an announcement
- * ## Update an announcement Updates information of a specific announcement before it starts or changes the status of a specific announcement after it starts. For the 2 different applications, refer to the request body below. >__Note__: Updating information of an announcement is possible only when the announcement status is scheduled, indicating it hasn't started yet. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-update-an-announcement ----------------------------
- * @param {String} apiToken
- * @param {String} uniqueId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateAnnouncementByIdData} opts.updateAnnouncementByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateAnnouncementByIdResponse} and HTTP response
- */
- }, {
- key: "updateAnnouncementByIdWithHttpInfo",
- value: function updateAnnouncementByIdWithHttpInfo(apiToken, uniqueId, opts) {
- opts = opts || {};
- var postBody = opts['updateAnnouncementByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateAnnouncementById");
- }
- // verify the required parameter 'uniqueId' is set
- if (uniqueId === undefined || uniqueId === null) {
- throw new Error("Missing the required parameter 'uniqueId' when calling updateAnnouncementById");
- }
- var pathParams = {
- 'unique_id': uniqueId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateAnnouncementByIdResponse["default"];
- return this.apiClient.callApi('/v3/announcements/{unique_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update an announcement
- * ## Update an announcement Updates information of a specific announcement before it starts or changes the status of a specific announcement after it starts. For the 2 different applications, refer to the request body below. >__Note__: Updating information of an announcement is possible only when the announcement status is scheduled, indicating it hasn't started yet. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-update-an-announcement ----------------------------
- * @param {String} apiToken
- * @param {String} uniqueId
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateAnnouncementByIdData} opts.updateAnnouncementByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateAnnouncementByIdResponse}
- */
- }, {
- key: "updateAnnouncementById",
- value: function updateAnnouncementById(apiToken, uniqueId, opts) {
- return this.updateAnnouncementByIdWithHttpInfo(apiToken, uniqueId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View an announcement
- * ## View an announcement Retrieves information on a specific announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-view-an-announcement ----------------------------
- * @param {String} apiToken
- * @param {String} uniqueId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewAnnouncementByIdResponse} and HTTP response
- */
- }, {
- key: "viewAnnouncementByIdWithHttpInfo",
- value: function viewAnnouncementByIdWithHttpInfo(apiToken, uniqueId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewAnnouncementById");
- }
- // verify the required parameter 'uniqueId' is set
- if (uniqueId === undefined || uniqueId === null) {
- throw new Error("Missing the required parameter 'uniqueId' when calling viewAnnouncementById");
- }
- var pathParams = {
- 'unique_id': uniqueId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewAnnouncementByIdResponse["default"];
- return this.apiClient.callApi('/v3/announcements/{unique_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View an announcement
- * ## View an announcement Retrieves information on a specific announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-view-an-announcement ----------------------------
- * @param {String} apiToken
- * @param {String} uniqueId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewAnnouncementByIdResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/ScheduleAnAnnouncementRequest} opts.scheduleAnAnnouncementRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ScheduleAnAnnouncementResponse}
*/
}, {
- key: "viewAnnouncementById",
- value: function viewAnnouncementById(apiToken, uniqueId) {
- return this.viewAnnouncementByIdWithHttpInfo(apiToken, uniqueId).then(function (response_and_data) {
+ key: "scheduleAnAnnouncement",
+ value: function scheduleAnAnnouncement(opts) {
+ return this.scheduleAnAnnouncementWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return AnnouncementApi;
-}();
-exports["default"] = AnnouncementApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/ApplicationApi.js b/dist/api/ApplicationApi.js
deleted file mode 100644
index eea8766..0000000
--- a/dist/api/ApplicationApi.js
+++ /dev/null
@@ -1,1615 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AddApnsPushConfigurationData = _interopRequireDefault(require("../model/AddApnsPushConfigurationData"));
-var _AddApnsPushConfigurationResponse = _interopRequireDefault(require("../model/AddApnsPushConfigurationResponse"));
-var _AddFcmPushConfigurationData = _interopRequireDefault(require("../model/AddFcmPushConfigurationData"));
-var _AddFcmPushConfigurationResponse = _interopRequireDefault(require("../model/AddFcmPushConfigurationResponse"));
-var _AddHmsPushConfigurationData = _interopRequireDefault(require("../model/AddHmsPushConfigurationData"));
-var _AddHmsPushConfigurationResponse = _interopRequireDefault(require("../model/AddHmsPushConfigurationResponse"));
-var _AddIpToWhitelistData = _interopRequireDefault(require("../model/AddIpToWhitelistData"));
-var _AddIpToWhitelistResponse = _interopRequireDefault(require("../model/AddIpToWhitelistResponse"));
-var _BanUsersInChannelsWithCustomChannelTypeData = _interopRequireDefault(require("../model/BanUsersInChannelsWithCustomChannelTypeData"));
-var _ConfigureAutoEventData = _interopRequireDefault(require("../model/ConfigureAutoEventData"));
-var _CustomTypeListBannedUsersResponse = _interopRequireDefault(require("../model/CustomTypeListBannedUsersResponse"));
-var _DeleteAllowedIpsFromWhitelistResponse = _interopRequireDefault(require("../model/DeleteAllowedIpsFromWhitelistResponse"));
-var _DeleteApnsCertificateByIdResponse = _interopRequireDefault(require("../model/DeleteApnsCertificateByIdResponse"));
-var _GenerateSecondaryApiTokenData = _interopRequireDefault(require("../model/GenerateSecondaryApiTokenData"));
-var _GenerateSecondaryApiTokenResponse = _interopRequireDefault(require("../model/GenerateSecondaryApiTokenResponse"));
-var _ListMutedUsersInChannelsWithCustomChannelType200Response = _interopRequireDefault(require("../model/ListMutedUsersInChannelsWithCustomChannelType200Response"));
-var _ListPushConfigurationsResponse = _interopRequireDefault(require("../model/ListPushConfigurationsResponse"));
-var _ListPushNotificationContentTemplatesResponse = _interopRequireDefault(require("../model/ListPushNotificationContentTemplatesResponse"));
-var _ListSecondaryApiTokensResponse = _interopRequireDefault(require("../model/ListSecondaryApiTokensResponse"));
-var _MuteUsersInChannelsWithCustomChannelTypeData = _interopRequireDefault(require("../model/MuteUsersInChannelsWithCustomChannelTypeData"));
-var _RemovePushConfigurationByIdResponse = _interopRequireDefault(require("../model/RemovePushConfigurationByIdResponse"));
-var _RetrieveIpWhitelistResponse = _interopRequireDefault(require("../model/RetrieveIpWhitelistResponse"));
-var _RevokeSecondaryApiTokenByTokenResponse = _interopRequireDefault(require("../model/RevokeSecondaryApiTokenByTokenResponse"));
-var _SendBirdAutoEventMessageSettings = _interopRequireDefault(require("../model/SendBirdAutoEventMessageSettings"));
-var _SendBirdChannelResponse = _interopRequireDefault(require("../model/SendBirdChannelResponse"));
-var _SetDomainFilterData = _interopRequireDefault(require("../model/SetDomainFilterData"));
-var _UpdateApnsPushConfigurationByIdData = _interopRequireDefault(require("../model/UpdateApnsPushConfigurationByIdData"));
-var _UpdateApnsPushConfigurationByIdResponse = _interopRequireDefault(require("../model/UpdateApnsPushConfigurationByIdResponse"));
-var _UpdateDefaultChannelInvitationPreferenceData = _interopRequireDefault(require("../model/UpdateDefaultChannelInvitationPreferenceData"));
-var _UpdateDefaultChannelInvitationPreferenceResponse = _interopRequireDefault(require("../model/UpdateDefaultChannelInvitationPreferenceResponse"));
-var _UpdateFcmPushConfigurationByIdData = _interopRequireDefault(require("../model/UpdateFcmPushConfigurationByIdData"));
-var _UpdateFcmPushConfigurationByIdResponse = _interopRequireDefault(require("../model/UpdateFcmPushConfigurationByIdResponse"));
-var _UpdateHmsPushConfigurationByIdData = _interopRequireDefault(require("../model/UpdateHmsPushConfigurationByIdData"));
-var _UpdateHmsPushConfigurationByIdResponse = _interopRequireDefault(require("../model/UpdateHmsPushConfigurationByIdResponse"));
-var _UpdatePushNotificationContentTemplateData = _interopRequireDefault(require("../model/UpdatePushNotificationContentTemplateData"));
-var _UpdatePushNotificationContentTemplateResponse = _interopRequireDefault(require("../model/UpdatePushNotificationContentTemplateResponse"));
-var _ViewDefaultChannelInvitationPreferenceResponse = _interopRequireDefault(require("../model/ViewDefaultChannelInvitationPreferenceResponse"));
-var _ViewPushConfigurationByIdResponse = _interopRequireDefault(require("../model/ViewPushConfigurationByIdResponse"));
-var _ViewPushNotificationContentTemplateResponse = _interopRequireDefault(require("../model/ViewPushNotificationContentTemplateResponse"));
-var _ViewSecondaryApiTokenByTokenResponse = _interopRequireDefault(require("../model/ViewSecondaryApiTokenByTokenResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
-* Application service.
-* @module api/ApplicationApi
-* @version 0.0.16
-*/
-var ApplicationApi = /*#__PURE__*/function () {
- /**
- * Constructs a new ApplicationApi.
- * @alias module:api/ApplicationApi
- * @class
- * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
- * default to {@link module:ApiClient#instance} if unspecified.
- */
- function ApplicationApi(apiClient) {
- _classCallCheck(this, ApplicationApi);
- this.apiClient = apiClient || _ApiClient["default"].instance;
- }
-
- /**
- * Add an APNs push configuration
- * ## Add an APNs push configuration Registers an APNs (Apple Push Notification service) push configuration for your client app. To send push notifications to iOS devices, your should first register the APNs push configuration. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. > __Note__: To upload a [.p12](https://sendbird.com/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) certificate file to Sendbird server, you should send a [Multipart request](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api#2-headers-3-multipart-requests). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-an-apns-push-configuration
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddApnsPushConfigurationData} opts.addApnsPushConfigurationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddApnsPushConfigurationResponse} and HTTP response
- */
- _createClass(ApplicationApi, [{
- key: "addApnsPushConfigurationWithHttpInfo",
- value: function addApnsPushConfigurationWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['addApnsPushConfigurationData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addApnsPushConfiguration");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddApnsPushConfigurationResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/apns', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add an APNs push configuration
- * ## Add an APNs push configuration Registers an APNs (Apple Push Notification service) push configuration for your client app. To send push notifications to iOS devices, your should first register the APNs push configuration. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. > __Note__: To upload a [.p12](https://sendbird.com/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) certificate file to Sendbird server, you should send a [Multipart request](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api#2-headers-3-multipart-requests). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-an-apns-push-configuration
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddApnsPushConfigurationData} opts.addApnsPushConfigurationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddApnsPushConfigurationResponse}
- */
- }, {
- key: "addApnsPushConfiguration",
- value: function addApnsPushConfiguration(apiToken, opts) {
- return this.addApnsPushConfigurationWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Add a FCM push configuration
- * ## Add a FCM push configuration Registers a FCM (Firebase Cloud Messaging) push configuration for your client app. To send push notifications to Android devices, you should first register the FCM push configuration. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-a-fcm-push-configuration
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddFcmPushConfigurationData} opts.addFcmPushConfigurationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddFcmPushConfigurationResponse} and HTTP response
- */
- }, {
- key: "addFcmPushConfigurationWithHttpInfo",
- value: function addFcmPushConfigurationWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['addFcmPushConfigurationData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addFcmPushConfiguration");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddFcmPushConfigurationResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/fcm', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add a FCM push configuration
- * ## Add a FCM push configuration Registers a FCM (Firebase Cloud Messaging) push configuration for your client app. To send push notifications to Android devices, you should first register the FCM push configuration. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-a-fcm-push-configuration
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddFcmPushConfigurationData} opts.addFcmPushConfigurationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddFcmPushConfigurationResponse}
- */
- }, {
- key: "addFcmPushConfiguration",
- value: function addFcmPushConfiguration(apiToken, opts) {
- return this.addFcmPushConfigurationWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Add an HMS push configuration
- * ## Add an HMS push configuration Registers an HMS (Huawei Mobile Services) push configuration for your client app. To send push notifications to Android devices for HMS, you should first register the HMS push configuration. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-an-hms-push-configuration
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddHmsPushConfigurationData} opts.addHmsPushConfigurationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddHmsPushConfigurationResponse} and HTTP response
- */
- }, {
- key: "addHmsPushConfigurationWithHttpInfo",
- value: function addHmsPushConfigurationWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['addHmsPushConfigurationData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addHmsPushConfiguration");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddHmsPushConfigurationResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/hms', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add an HMS push configuration
- * ## Add an HMS push configuration Registers an HMS (Huawei Mobile Services) push configuration for your client app. To send push notifications to Android devices for HMS, you should first register the HMS push configuration. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-an-hms-push-configuration
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddHmsPushConfigurationData} opts.addHmsPushConfigurationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddHmsPushConfigurationResponse}
- */
- }, {
- key: "addHmsPushConfiguration",
- value: function addHmsPushConfiguration(apiToken, opts) {
- return this.addHmsPushConfigurationWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Add an IP to a whitelist
- * ## Add an IP to a whitelist Adds IP addresses and ranges to your Sendbird application settings. Both currently added and any previously added IPs are granted API access. You can configure the IP whitelist under Settings > Security > Allowed IPs in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-an-ip-to-a-whitelist
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddIpToWhitelistData} opts.addIpToWhitelistData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddIpToWhitelistResponse} and HTTP response
- */
- }, {
- key: "addIpToWhitelistWithHttpInfo",
- value: function addIpToWhitelistWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['addIpToWhitelistData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addIpToWhitelist");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddIpToWhitelistResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/ip_whitelist', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add an IP to a whitelist
- * ## Add an IP to a whitelist Adds IP addresses and ranges to your Sendbird application settings. Both currently added and any previously added IPs are granted API access. You can configure the IP whitelist under Settings > Security > Allowed IPs in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-add-an-ip-to-a-whitelist
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddIpToWhitelistData} opts.addIpToWhitelistData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddIpToWhitelistResponse}
- */
- }, {
- key: "addIpToWhitelist",
- value: function addIpToWhitelist(apiToken, opts) {
- return this.addIpToWhitelistWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Ban users in channels with a custom channel type
- * ## Ban specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {module:model/BanUsersInChannelsWithCustomChannelTypeData} opts.banUsersInChannelsWithCustomChannelTypeData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "banUsersInChannelsWithCustomChannelTypeWithHttpInfo",
- value: function banUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts) {
- opts = opts || {};
- var postBody = opts['banUsersInChannelsWithCustomChannelTypeData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling banUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling banUsersInChannelsWithCustomChannelType");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/applications/settings_by_channel_custom_type/{custom_type}/ban', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Ban users in channels with a custom channel type
- * ## Ban specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {module:model/BanUsersInChannelsWithCustomChannelTypeData} opts.banUsersInChannelsWithCustomChannelTypeData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "banUsersInChannelsWithCustomChannelType",
- value: function banUsersInChannelsWithCustomChannelType(apiToken, customType, opts) {
- return this.banUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Configure auto event message settings
- * ## Configure auto event message settings Determines whether to automatically send event messages to group channels when events take place in an application. You can choose which auto event message to receive on the Sendbird Dashboard https://sendbird.com/docs/chat/v3/platform-api/application/managing-auto-event-messages/configure-auto-event-message-settings ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/ConfigureAutoEventData} opts.configureAutoEventData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdAutoEventMessageSettings} and HTTP response
- */
- }, {
- key: "configureAutoEventMessagesWithHttpInfo",
- value: function configureAutoEventMessagesWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['configureAutoEventData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling configureAutoEventMessages");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdAutoEventMessageSettings["default"];
- return this.apiClient.callApi('/v3/applications/settings/auto_event_message', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Configure auto event message settings
- * ## Configure auto event message settings Determines whether to automatically send event messages to group channels when events take place in an application. You can choose which auto event message to receive on the Sendbird Dashboard https://sendbird.com/docs/chat/v3/platform-api/application/managing-auto-event-messages/configure-auto-event-message-settings ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/ConfigureAutoEventData} opts.configureAutoEventData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdAutoEventMessageSettings}
- */
- }, {
- key: "configureAutoEventMessages",
- value: function configureAutoEventMessages(apiToken, opts) {
- return this.configureAutoEventMessagesWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete allowed IPs from a whitelist
- * ## Delete allowed IPs from a whitelist Deletes allowed IPs from the whitelist by specifying their IP addresses or ranges. You can configure the IP whitelist under Settings > Security > Allowed IPs in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-delete-allowed-ips-from-a-whitelist
- * @param {String} apiToken
- * @param {Array.} ipWhitelistAddresses
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteAllowedIpsFromWhitelistResponse} and HTTP response
- */
- }, {
- key: "deleteAllowedIpsFromWhitelistWithHttpInfo",
- value: function deleteAllowedIpsFromWhitelistWithHttpInfo(apiToken, ipWhitelistAddresses) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteAllowedIpsFromWhitelist");
- }
- // verify the required parameter 'ipWhitelistAddresses' is set
- if (ipWhitelistAddresses === undefined || ipWhitelistAddresses === null) {
- throw new Error("Missing the required parameter 'ipWhitelistAddresses' when calling deleteAllowedIpsFromWhitelist");
- }
- var pathParams = {};
- var queryParams = {
- 'ip_whitelist_addresses': this.apiClient.buildCollectionParam(ipWhitelistAddresses, 'multi')
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _DeleteAllowedIpsFromWhitelistResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/ip_whitelist', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete allowed IPs from a whitelist
- * ## Delete allowed IPs from a whitelist Deletes allowed IPs from the whitelist by specifying their IP addresses or ranges. You can configure the IP whitelist under Settings > Security > Allowed IPs in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-delete-allowed-ips-from-a-whitelist
- * @param {String} apiToken
- * @param {Array.} ipWhitelistAddresses
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteAllowedIpsFromWhitelistResponse}
- */
- }, {
- key: "deleteAllowedIpsFromWhitelist",
- value: function deleteAllowedIpsFromWhitelist(apiToken, ipWhitelistAddresses) {
- return this.deleteAllowedIpsFromWhitelistWithHttpInfo(apiToken, ipWhitelistAddresses).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete an APNs certificate
- * ## Delete an APNs certificate Deletes a specific APNs certificate. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-delete-an-apns-certificate ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteApnsCertificateByIdResponse} and HTTP response
- */
- }, {
- key: "deleteApnsCertificateByIdWithHttpInfo",
- value: function deleteApnsCertificateByIdWithHttpInfo(apiToken, providerId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteApnsCertificateById");
- }
- // verify the required parameter 'providerId' is set
- if (providerId === undefined || providerId === null) {
- throw new Error("Missing the required parameter 'providerId' when calling deleteApnsCertificateById");
- }
- var pathParams = {
- 'provider_id': providerId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _DeleteApnsCertificateByIdResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/apns/cert/{provider_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete an APNs certificate
- * ## Delete an APNs certificate Deletes a specific APNs certificate. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-delete-an-apns-certificate ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteApnsCertificateByIdResponse}
- */
- }, {
- key: "deleteApnsCertificateById",
- value: function deleteApnsCertificateById(apiToken, providerId) {
- return this.deleteApnsCertificateByIdWithHttpInfo(apiToken, providerId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Generate a secondary API token
- * ## Generate a secondary API token Generates a new secondary API token. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-generate-a-secondary-api-token
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/GenerateSecondaryApiTokenData} opts.generateSecondaryApiTokenData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GenerateSecondaryApiTokenResponse} and HTTP response
- */
- }, {
- key: "generateSecondaryApiTokenWithHttpInfo",
- value: function generateSecondaryApiTokenWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['generateSecondaryApiTokenData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling generateSecondaryApiToken");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _GenerateSecondaryApiTokenResponse["default"];
- return this.apiClient.callApi('/v3/applications/api_tokens', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Generate a secondary API token
- * ## Generate a secondary API token Generates a new secondary API token. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-generate-a-secondary-api-token
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/GenerateSecondaryApiTokenData} opts.generateSecondaryApiTokenData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GenerateSecondaryApiTokenResponse}
- */
- }, {
- key: "generateSecondaryApiToken",
- value: function generateSecondaryApiToken(apiToken, opts) {
- return this.generateSecondaryApiTokenWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List auto event messages
- * ## List auto event messages Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use. Auto event messages are Admin messages that are automatically generated when a specific event occurs. https://sendbird.com/docs/chat/v3/platform-api/application/managing-auto-event-messages/list-auto-event-messages ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdAutoEventMessageSettings} and HTTP response
- */
- }, {
- key: "listAutoEventMessagesWithHttpInfo",
- value: function listAutoEventMessagesWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listAutoEventMessages");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _SendBirdAutoEventMessageSettings["default"];
- return this.apiClient.callApi('/v3/applications/settings/auto_event_message', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List auto event messages
- * ## List auto event messages Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use. Auto event messages are Admin messages that are automatically generated when a specific event occurs. https://sendbird.com/docs/chat/v3/platform-api/application/managing-auto-event-messages/list-auto-event-messages ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdAutoEventMessageSettings}
- */
- }, {
- key: "listAutoEventMessages",
- value: function listAutoEventMessages(apiToken) {
- return this.listAutoEventMessagesWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List banned users in channels with a custom channel type
- * ## Retrieves a list of users banned from channels with the specified custom channel type.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CustomTypeListBannedUsersResponse} and HTTP response
- */
- }, {
- key: "listBannedUsersInChannelsWithCustomChannelTypeWithHttpInfo",
- value: function listBannedUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listBannedUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling listBannedUsersInChannelsWithCustomChannelType");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _CustomTypeListBannedUsersResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings_by_channel_custom_type/{custom_type}/ban', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List banned users in channels with a custom channel type
- * ## Retrieves a list of users banned from channels with the specified custom channel type.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomTypeListBannedUsersResponse}
- */
- }, {
- key: "listBannedUsersInChannelsWithCustomChannelType",
- value: function listBannedUsersInChannelsWithCustomChannelType(apiToken, customType, opts) {
- return this.listBannedUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List muted users in channels with a custom channel type
- * ## Retrieves a list of the muted users in channels with a custom channel type.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMutedUsersInChannelsWithCustomChannelType200Response} and HTTP response
- */
- }, {
- key: "listMutedUsersInChannelsWithCustomChannelTypeWithHttpInfo",
- value: function listMutedUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listMutedUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling listMutedUsersInChannelsWithCustomChannelType");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListMutedUsersInChannelsWithCustomChannelType200Response["default"];
- return this.apiClient.callApi('/v3/applications/settings_by_channel_custom_type/{custom_type}/mute', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List muted users in channels with a custom channel type
- * ## Retrieves a list of the muted users in channels with a custom channel type.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMutedUsersInChannelsWithCustomChannelType200Response}
- */
- }, {
- key: "listMutedUsersInChannelsWithCustomChannelType",
- value: function listMutedUsersInChannelsWithCustomChannelType(apiToken, customType, opts) {
- return this.listMutedUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List push configurations
- * ## List push configurations Retrieves a list of an application's registered push configurations. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-list-push-configurations ----------------------------
- * @param {String} apiToken
- * @param {String} pushType
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPushConfigurationsResponse} and HTTP response
- */
- }, {
- key: "listPushConfigurationsWithHttpInfo",
- value: function listPushConfigurationsWithHttpInfo(apiToken, pushType) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listPushConfigurations");
- }
- // verify the required parameter 'pushType' is set
- if (pushType === undefined || pushType === null) {
- throw new Error("Missing the required parameter 'pushType' when calling listPushConfigurations");
- }
- var pathParams = {
- 'push_type': pushType
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListPushConfigurationsResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/{push_type}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List push configurations
- * ## List push configurations Retrieves a list of an application's registered push configurations. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-list-push-configurations ----------------------------
- * @param {String} apiToken
- * @param {String} pushType
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPushConfigurationsResponse}
- */
- }, {
- key: "listPushConfigurations",
- value: function listPushConfigurations(apiToken, pushType) {
- return this.listPushConfigurationsWithHttpInfo(apiToken, pushType).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List push notification content templates
- * ## List push notification content templates Retrieves a list of push notification content templates of an application. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-list-push-notification-content-templates
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPushNotificationContentTemplatesResponse} and HTTP response
- */
- }, {
- key: "listPushNotificationContentTemplatesWithHttpInfo",
- value: function listPushNotificationContentTemplatesWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listPushNotificationContentTemplates");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListPushNotificationContentTemplatesResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/message_templates', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List push notification content templates
- * ## List push notification content templates Retrieves a list of push notification content templates of an application. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-list-push-notification-content-templates
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPushNotificationContentTemplatesResponse}
- */
- }, {
- key: "listPushNotificationContentTemplates",
- value: function listPushNotificationContentTemplates(apiToken) {
- return this.listPushNotificationContentTemplatesWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List secondary API tokens
- * ## List secondary API tokens Retrieves a list of secondary API tokens. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-list-secondary-api-tokens
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListSecondaryApiTokensResponse} and HTTP response
- */
- }, {
- key: "listSecondaryApiTokensWithHttpInfo",
- value: function listSecondaryApiTokensWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listSecondaryApiTokens");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListSecondaryApiTokensResponse["default"];
- return this.apiClient.callApi('/v3/applications/api_tokens', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List secondary API tokens
- * ## List secondary API tokens Retrieves a list of secondary API tokens. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-list-secondary-api-tokens
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListSecondaryApiTokensResponse}
- */
- }, {
- key: "listSecondaryApiTokens",
- value: function listSecondaryApiTokens(apiToken) {
- return this.listSecondaryApiTokensWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Mute users in channels with a custom channel type
- * ## Mutes specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {module:model/MuteUsersInChannelsWithCustomChannelTypeData} opts.muteUsersInChannelsWithCustomChannelTypeData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "muteUsersInChannelsWithCustomChannelTypeWithHttpInfo",
- value: function muteUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts) {
- opts = opts || {};
- var postBody = opts['muteUsersInChannelsWithCustomChannelTypeData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling muteUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling muteUsersInChannelsWithCustomChannelType");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/applications/settings_by_channel_custom_type/{custom_type}/mute', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Mute users in channels with a custom channel type
- * ## Mutes specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {module:model/MuteUsersInChannelsWithCustomChannelTypeData} opts.muteUsersInChannelsWithCustomChannelTypeData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "muteUsersInChannelsWithCustomChannelType",
- value: function muteUsersInChannelsWithCustomChannelType(apiToken, customType, opts) {
- return this.muteUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Remove a push configuration
- * ## Remove a push configuration Removes a specific push configuration from an application. The type of a push configuration is either `fcm`, `huawei`, or `apns`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-remove-a-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} pushType
- * @param {String} providerId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemovePushConfigurationByIdResponse} and HTTP response
- */
- }, {
- key: "removePushConfigurationByIdWithHttpInfo",
- value: function removePushConfigurationByIdWithHttpInfo(apiToken, pushType, providerId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling removePushConfigurationById");
- }
- // verify the required parameter 'pushType' is set
- if (pushType === undefined || pushType === null) {
- throw new Error("Missing the required parameter 'pushType' when calling removePushConfigurationById");
- }
- // verify the required parameter 'providerId' is set
- if (providerId === undefined || providerId === null) {
- throw new Error("Missing the required parameter 'providerId' when calling removePushConfigurationById");
- }
- var pathParams = {
- 'push_type': pushType,
- 'provider_id': providerId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _RemovePushConfigurationByIdResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/{push_type}/{provider_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Remove a push configuration
- * ## Remove a push configuration Removes a specific push configuration from an application. The type of a push configuration is either `fcm`, `huawei`, or `apns`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-remove-a-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} pushType
- * @param {String} providerId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemovePushConfigurationByIdResponse}
- */
- }, {
- key: "removePushConfigurationById",
- value: function removePushConfigurationById(apiToken, pushType, providerId) {
- return this.removePushConfigurationByIdWithHttpInfo(apiToken, pushType, providerId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Retrieve an IP whitelist
- * ## Retrieve an IP whitelist Retrieves a list of all the IP ranges and addresses that have access to your Sendbird application. This list is called an IP whitelist and its addresses are granted API access when the IP whitelist API enables [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notations. If you specify which IP addresses or ranges to include in the whitelist, any unlisted foreign IP addresses will be denied access. If you don't specify any IP address or range to include in the whitelist, all IP addresses will be granted API access. You can configure the IP whitelist under Settings > Security > Allowed IPs in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-retrieve-an-ip-whitelist
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveIpWhitelistResponse} and HTTP response
- */
- }, {
- key: "retrieveIpWhitelistWithHttpInfo",
- value: function retrieveIpWhitelistWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling retrieveIpWhitelist");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _RetrieveIpWhitelistResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/ip_whitelist', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Retrieve an IP whitelist
- * ## Retrieve an IP whitelist Retrieves a list of all the IP ranges and addresses that have access to your Sendbird application. This list is called an IP whitelist and its addresses are granted API access when the IP whitelist API enables [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notations. If you specify which IP addresses or ranges to include in the whitelist, any unlisted foreign IP addresses will be denied access. If you don't specify any IP address or range to include in the whitelist, all IP addresses will be granted API access. You can configure the IP whitelist under Settings > Security > Allowed IPs in the [Sendbird Dashboard](https://dashboard.sendbird.com). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-retrieve-an-ip-whitelist
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveIpWhitelistResponse}
- */
- }, {
- key: "retrieveIpWhitelist",
- value: function retrieveIpWhitelist(apiToken) {
- return this.retrieveIpWhitelistWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Revoke a secondary API token
- * ## Revoke a secondary API token Revokes a secondary API token. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-revoke-a-secondary-api-token
- * @param {String} apiToken
- * @param {String} apiToken2
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RevokeSecondaryApiTokenByTokenResponse} and HTTP response
- */
- }, {
- key: "revokeSecondaryApiTokenByTokenWithHttpInfo",
- value: function revokeSecondaryApiTokenByTokenWithHttpInfo(apiToken, apiToken2) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling revokeSecondaryApiTokenByToken");
- }
- // verify the required parameter 'apiToken2' is set
- if (apiToken2 === undefined || apiToken2 === null) {
- throw new Error("Missing the required parameter 'apiToken2' when calling revokeSecondaryApiTokenByToken");
- }
- var pathParams = {
- 'api_token': apiToken2
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _RevokeSecondaryApiTokenByTokenResponse["default"];
- return this.apiClient.callApi('/v3/applications/api_tokens/{api_token}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Revoke a secondary API token
- * ## Revoke a secondary API token Revokes a secondary API token. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-revoke-a-secondary-api-token
- * @param {String} apiToken
- * @param {String} apiToken2
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RevokeSecondaryApiTokenByTokenResponse}
- */
- }, {
- key: "revokeSecondaryApiTokenByToken",
- value: function revokeSecondaryApiTokenByToken(apiToken, apiToken2) {
- return this.revokeSecondaryApiTokenByTokenWithHttpInfo(apiToken, apiToken2).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Message moderation
- * ##
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {module:model/SetDomainFilterData} opts.setDomainFilterData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdChannelResponse} and HTTP response
- */
- }, {
- key: "setDomainFilterWithHttpInfo",
- value: function setDomainFilterWithHttpInfo(apiToken, customType, opts) {
- opts = opts || {};
- var postBody = opts['setDomainFilterData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling setDomainFilter");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling setDomainFilter");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdChannelResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings_global/{custom_type}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Message moderation
- * ##
- * @param {String} apiToken
- * @param {String} customType
- * @param {Object} opts Optional parameters
- * @param {module:model/SetDomainFilterData} opts.setDomainFilterData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdChannelResponse}
- */
- }, {
- key: "setDomainFilter",
- value: function setDomainFilter(apiToken, customType, opts) {
- return this.setDomainFilterWithHttpInfo(apiToken, customType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Unban users in channels with a custom channel type
- * ## Unban specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Array.} userIds
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "unbanUsersInChannelsWithCustomChannelTypeWithHttpInfo",
- value: function unbanUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, userIds) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling unbanUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling unbanUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'userIds' is set
- if (userIds === undefined || userIds === null) {
- throw new Error("Missing the required parameter 'userIds' when calling unbanUsersInChannelsWithCustomChannelType");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {
- 'user_ids': this.apiClient.buildCollectionParam(userIds, 'multi')
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/applications/settings_by_channel_custom_type/{custom_type}/ban', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Unban users in channels with a custom channel type
- * ## Unban specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Array.} userIds
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "unbanUsersInChannelsWithCustomChannelType",
- value: function unbanUsersInChannelsWithCustomChannelType(apiToken, customType, userIds) {
- return this.unbanUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, userIds).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Unmute users in channels with a custom channel type
- * ## Unmute specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Array.} userIds
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "unmuteUsersInChannelsWithCustomChannelTypeWithHttpInfo",
- value: function unmuteUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, userIds) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling unmuteUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'customType' is set
- if (customType === undefined || customType === null) {
- throw new Error("Missing the required parameter 'customType' when calling unmuteUsersInChannelsWithCustomChannelType");
- }
- // verify the required parameter 'userIds' is set
- if (userIds === undefined || userIds === null) {
- throw new Error("Missing the required parameter 'userIds' when calling unmuteUsersInChannelsWithCustomChannelType");
- }
- var pathParams = {
- 'custom_type': customType
- };
- var queryParams = {
- 'user_ids': this.apiClient.buildCollectionParam(userIds, 'multi')
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/applications/settings_by_channel_custom_type/{custom_type}/mute', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Unmute users in channels with a custom channel type
- * ## Unmute specified users in channels with a custom channel type at once.
- * @param {String} apiToken
- * @param {String} customType
- * @param {Array.} userIds
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "unmuteUsersInChannelsWithCustomChannelType",
- value: function unmuteUsersInChannelsWithCustomChannelType(apiToken, customType, userIds) {
- return this.unmuteUsersInChannelsWithCustomChannelTypeWithHttpInfo(apiToken, customType, userIds).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update an APNs push configuration
- * ## Update an APNs push configuration Updates a specific APNs (Apple Push Notification service) push configuration for your client app. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. > __Note__: If your HTTP request body contains a [.p12](https://sendbird.com/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) certificate file to upload to Sendbird server, you should send a [Multipart request](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api#2-headers-3-multipart-requests) . https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-an-apns-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateApnsPushConfigurationByIdData} opts.updateApnsPushConfigurationByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateApnsPushConfigurationByIdResponse} and HTTP response
- */
- }, {
- key: "updateApnsPushConfigurationByIdWithHttpInfo",
- value: function updateApnsPushConfigurationByIdWithHttpInfo(apiToken, providerId, opts) {
- opts = opts || {};
- var postBody = opts['updateApnsPushConfigurationByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateApnsPushConfigurationById");
- }
- // verify the required parameter 'providerId' is set
- if (providerId === undefined || providerId === null) {
- throw new Error("Missing the required parameter 'providerId' when calling updateApnsPushConfigurationById");
- }
- var pathParams = {
- 'provider_id': providerId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateApnsPushConfigurationByIdResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/apns/{provider_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update an APNs push configuration
- * ## Update an APNs push configuration Updates a specific APNs (Apple Push Notification service) push configuration for your client app. You can also register the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. > __Note__: If your HTTP request body contains a [.p12](https://sendbird.com/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) certificate file to upload to Sendbird server, you should send a [Multipart request](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api#2-headers-3-multipart-requests) . https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-an-apns-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateApnsPushConfigurationByIdData} opts.updateApnsPushConfigurationByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateApnsPushConfigurationByIdResponse}
- */
- }, {
- key: "updateApnsPushConfigurationById",
- value: function updateApnsPushConfigurationById(apiToken, providerId, opts) {
- return this.updateApnsPushConfigurationByIdWithHttpInfo(apiToken, providerId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update default channel invitation preference
- * ## Update default channel invitation preference Updates the default channel invitation preference of an application. > __Note__: Using the [update channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action, you can update the value of a specific user's channel invitation preference, which can be set individually by user. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-default-channel-invitation-preference
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateDefaultChannelInvitationPreferenceData} opts.updateDefaultChannelInvitationPreferenceData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateDefaultChannelInvitationPreferenceResponse} and HTTP response
- */
- }, {
- key: "updateDefaultChannelInvitationPreferenceWithHttpInfo",
- value: function updateDefaultChannelInvitationPreferenceWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['updateDefaultChannelInvitationPreferenceData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateDefaultChannelInvitationPreference");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateDefaultChannelInvitationPreferenceResponse["default"];
- return this.apiClient.callApi('/v3/applications/default_channel_invitation_preference', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update default channel invitation preference
- * ## Update default channel invitation preference Updates the default channel invitation preference of an application. > __Note__: Using the [update channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action, you can update the value of a specific user's channel invitation preference, which can be set individually by user. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-default-channel-invitation-preference
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateDefaultChannelInvitationPreferenceData} opts.updateDefaultChannelInvitationPreferenceData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateDefaultChannelInvitationPreferenceResponse}
- */
- }, {
- key: "updateDefaultChannelInvitationPreference",
- value: function updateDefaultChannelInvitationPreference(apiToken, opts) {
- return this.updateDefaultChannelInvitationPreferenceWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a FCM push configuration
- * ## Update a FCM push configuration Updates a specific FCM (Firebase Cloud Messaging) push configuration for your client app. You can also update the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-a-fcm-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateFcmPushConfigurationByIdData} opts.updateFcmPushConfigurationByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateFcmPushConfigurationByIdResponse} and HTTP response
- */
- }, {
- key: "updateFcmPushConfigurationByIdWithHttpInfo",
- value: function updateFcmPushConfigurationByIdWithHttpInfo(apiToken, providerId, opts) {
- opts = opts || {};
- var postBody = opts['updateFcmPushConfigurationByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateFcmPushConfigurationById");
- }
- // verify the required parameter 'providerId' is set
- if (providerId === undefined || providerId === null) {
- throw new Error("Missing the required parameter 'providerId' when calling updateFcmPushConfigurationById");
- }
- var pathParams = {
- 'provider_id': providerId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateFcmPushConfigurationByIdResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/fcm/{provider_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a FCM push configuration
- * ## Update a FCM push configuration Updates a specific FCM (Firebase Cloud Messaging) push configuration for your client app. You can also update the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-a-fcm-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateFcmPushConfigurationByIdData} opts.updateFcmPushConfigurationByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateFcmPushConfigurationByIdResponse}
- */
- }, {
- key: "updateFcmPushConfigurationById",
- value: function updateFcmPushConfigurationById(apiToken, providerId, opts) {
- return this.updateFcmPushConfigurationByIdWithHttpInfo(apiToken, providerId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update an HMS push configuration
- * ## Update an HMS push configuration Updates a specific HMS (Huawei Mobile Services) push configuration for your client app. You can also update the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-an-hms-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateHmsPushConfigurationByIdData} opts.updateHmsPushConfigurationByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateHmsPushConfigurationByIdResponse} and HTTP response
- */
- }, {
- key: "updateHmsPushConfigurationByIdWithHttpInfo",
- value: function updateHmsPushConfigurationByIdWithHttpInfo(apiToken, providerId, opts) {
- opts = opts || {};
- var postBody = opts['updateHmsPushConfigurationByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateHmsPushConfigurationById");
- }
- // verify the required parameter 'providerId' is set
- if (providerId === undefined || providerId === null) {
- throw new Error("Missing the required parameter 'providerId' when calling updateHmsPushConfigurationById");
- }
- var pathParams = {
- 'provider_id': providerId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateHmsPushConfigurationByIdResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/hms/{provider_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update an HMS push configuration
- * ## Update an HMS push configuration Updates a specific HMS (Huawei Mobile Services) push configuration for your client app. You can also update the configurations in your [dashboard](https://dashboard.sendbird.com) under Settings > Application > Notifications. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-an-hms-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} providerId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateHmsPushConfigurationByIdData} opts.updateHmsPushConfigurationByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateHmsPushConfigurationByIdResponse}
- */
- }, {
- key: "updateHmsPushConfigurationById",
- value: function updateHmsPushConfigurationById(apiToken, providerId, opts) {
- return this.updateHmsPushConfigurationByIdWithHttpInfo(apiToken, providerId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a push notification content template
- * ## Update a push notification content template Updates a specific push notification content template of an application. The name of a content template is either `default` or `alternative`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-a-push-notification-content-template ----------------------------
- * @param {String} apiToken
- * @param {String} templateName
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdatePushNotificationContentTemplateData} opts.updatePushNotificationContentTemplateData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdatePushNotificationContentTemplateResponse} and HTTP response
- */
- }, {
- key: "updatePushNotificationContentTemplateWithHttpInfo",
- value: function updatePushNotificationContentTemplateWithHttpInfo(apiToken, templateName, opts) {
- opts = opts || {};
- var postBody = opts['updatePushNotificationContentTemplateData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updatePushNotificationContentTemplate");
- }
- // verify the required parameter 'templateName' is set
- if (templateName === undefined || templateName === null) {
- throw new Error("Missing the required parameter 'templateName' when calling updatePushNotificationContentTemplate");
- }
- var pathParams = {
- 'template_name': templateName
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdatePushNotificationContentTemplateResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/message_templates/{template_name}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a push notification content template
- * ## Update a push notification content template Updates a specific push notification content template of an application. The name of a content template is either `default` or `alternative`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-a-push-notification-content-template ----------------------------
- * @param {String} apiToken
- * @param {String} templateName
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdatePushNotificationContentTemplateData} opts.updatePushNotificationContentTemplateData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdatePushNotificationContentTemplateResponse}
- */
- }, {
- key: "updatePushNotificationContentTemplate",
- value: function updatePushNotificationContentTemplate(apiToken, templateName, opts) {
- return this.updatePushNotificationContentTemplateWithHttpInfo(apiToken, templateName, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View default channel invitation preference
- * ## View default channel invitation preference Retrieves the default channel invitation preference of an application. > __Note__: Using the [view channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-channel-invitation-preference) action, you can retrieve the value of a specific user's channel invitation preference, which can be set individually by user. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-default-channel-invitation-preference
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewDefaultChannelInvitationPreferenceResponse} and HTTP response
- */
- }, {
- key: "viewDefaultChannelInvitationPreferenceWithHttpInfo",
- value: function viewDefaultChannelInvitationPreferenceWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewDefaultChannelInvitationPreference");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewDefaultChannelInvitationPreferenceResponse["default"];
- return this.apiClient.callApi('/v3/applications/default_channel_invitation_preference', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View default channel invitation preference
- * ## View default channel invitation preference Retrieves the default channel invitation preference of an application. > __Note__: Using the [view channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-channel-invitation-preference) action, you can retrieve the value of a specific user's channel invitation preference, which can be set individually by user. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-default-channel-invitation-preference
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewDefaultChannelInvitationPreferenceResponse}
- */
- }, {
- key: "viewDefaultChannelInvitationPreference",
- value: function viewDefaultChannelInvitationPreference(apiToken) {
- return this.viewDefaultChannelInvitationPreferenceWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a push configuration
- * ## View a push configuration Retrieves a specific push configuration of an application. The type of a push configuration is either `fcm`, `huawei`, or `apns`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-a-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} pushType
- * @param {String} providerId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewPushConfigurationByIdResponse} and HTTP response
- */
- }, {
- key: "viewPushConfigurationByIdWithHttpInfo",
- value: function viewPushConfigurationByIdWithHttpInfo(apiToken, pushType, providerId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewPushConfigurationById");
- }
- // verify the required parameter 'pushType' is set
- if (pushType === undefined || pushType === null) {
- throw new Error("Missing the required parameter 'pushType' when calling viewPushConfigurationById");
- }
- // verify the required parameter 'providerId' is set
- if (providerId === undefined || providerId === null) {
- throw new Error("Missing the required parameter 'providerId' when calling viewPushConfigurationById");
- }
- var pathParams = {
- 'push_type': pushType,
- 'provider_id': providerId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewPushConfigurationByIdResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/{push_type}/{provider_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a push configuration
- * ## View a push configuration Retrieves a specific push configuration of an application. The type of a push configuration is either `fcm`, `huawei`, or `apns`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-a-push-configuration ----------------------------
- * @param {String} apiToken
- * @param {String} pushType
- * @param {String} providerId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewPushConfigurationByIdResponse}
- */
- }, {
- key: "viewPushConfigurationById",
- value: function viewPushConfigurationById(apiToken, pushType, providerId) {
- return this.viewPushConfigurationByIdWithHttpInfo(apiToken, pushType, providerId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a push notification content template
- * ## View a push notification content template Retrieves information on a specific push notification content templates of an application. The name of a content template is either `default` or `alternative`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-a-push-notification-content-template ----------------------------
- * @param {String} apiToken
- * @param {String} templateName
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewPushNotificationContentTemplateResponse} and HTTP response
- */
- }, {
- key: "viewPushNotificationContentTemplateWithHttpInfo",
- value: function viewPushNotificationContentTemplateWithHttpInfo(apiToken, templateName) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewPushNotificationContentTemplate");
- }
- // verify the required parameter 'templateName' is set
- if (templateName === undefined || templateName === null) {
- throw new Error("Missing the required parameter 'templateName' when calling viewPushNotificationContentTemplate");
- }
- var pathParams = {
- 'template_name': templateName
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewPushNotificationContentTemplateResponse["default"];
- return this.apiClient.callApi('/v3/applications/push/message_templates/{template_name}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a push notification content template
- * ## View a push notification content template Retrieves information on a specific push notification content templates of an application. The name of a content template is either `default` or `alternative`. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-a-push-notification-content-template ----------------------------
- * @param {String} apiToken
- * @param {String} templateName
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewPushNotificationContentTemplateResponse}
- */
- }, {
- key: "viewPushNotificationContentTemplate",
- value: function viewPushNotificationContentTemplate(apiToken, templateName) {
- return this.viewPushNotificationContentTemplateWithHttpInfo(apiToken, templateName).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a secondary API token
- * ## View a secondary API token Retrieves the information on a secondary API token. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-a-secondary-api-token
- * @param {String} apiToken
- * @param {String} apiToken2
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewSecondaryApiTokenByTokenResponse} and HTTP response
- */
- }, {
- key: "viewSecondaryApiTokenByTokenWithHttpInfo",
- value: function viewSecondaryApiTokenByTokenWithHttpInfo(apiToken, apiToken2) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewSecondaryApiTokenByToken");
- }
- // verify the required parameter 'apiToken2' is set
- if (apiToken2 === undefined || apiToken2 === null) {
- throw new Error("Missing the required parameter 'apiToken2' when calling viewSecondaryApiTokenByToken");
- }
- var pathParams = {
- 'api_token': apiToken2
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewSecondaryApiTokenByTokenResponse["default"];
- return this.apiClient.callApi('/v3/applications/api_tokens/{api_token}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a secondary API token
- * ## View a secondary API token Retrieves the information on a secondary API token. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-a-secondary-api-token
- * @param {String} apiToken
- * @param {String} apiToken2
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewSecondaryApiTokenByTokenResponse}
- */
- }, {
- key: "viewSecondaryApiTokenByToken",
- value: function viewSecondaryApiTokenByToken(apiToken, apiToken2) {
- return this.viewSecondaryApiTokenByTokenWithHttpInfo(apiToken, apiToken2).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
- }]);
- return ApplicationApi;
-}();
-exports["default"] = ApplicationApi;
\ No newline at end of file
diff --git a/dist/api/BotApi.js b/dist/api/BotApi.js
index ed4ef43..edb3edd 100644
--- a/dist/api/BotApi.js
+++ b/dist/api/BotApi.js
@@ -5,26 +5,37 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _CreateBotData = _interopRequireDefault(require("../model/CreateBotData"));
-var _CreateBotResponse = _interopRequireDefault(require("../model/CreateBotResponse"));
-var _JoinChannelsData = _interopRequireDefault(require("../model/JoinChannelsData"));
-var _JoinChannelsResponse = _interopRequireDefault(require("../model/JoinChannelsResponse"));
+var _CreateABotRequest = _interopRequireDefault(require("../model/CreateABotRequest"));
+var _CreateABotResponse = _interopRequireDefault(require("../model/CreateABotResponse"));
+var _JoinChannelsRequest = _interopRequireDefault(require("../model/JoinChannelsRequest"));
var _ListBotsResponse = _interopRequireDefault(require("../model/ListBotsResponse"));
-var _SendBirdMessageResponse = _interopRequireDefault(require("../model/SendBirdMessageResponse"));
-var _SendBotSMessageData = _interopRequireDefault(require("../model/SendBotSMessageData"));
-var _UpdateBotByIdData = _interopRequireDefault(require("../model/UpdateBotByIdData"));
-var _UpdateBotByIdResponse = _interopRequireDefault(require("../model/UpdateBotByIdResponse"));
-var _ViewBotByIdResponse = _interopRequireDefault(require("../model/ViewBotByIdResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _SendABotMessageRequest = _interopRequireDefault(require("../model/SendABotMessageRequest"));
+var _SendbirdGroupChannelDetail = _interopRequireDefault(require("../model/SendbirdGroupChannelDetail"));
+var _SendbirdMessageResponse = _interopRequireDefault(require("../model/SendbirdMessageResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* Bot service.
* @module api/BotApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var BotApi = /*#__PURE__*/function () {
+var BotApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new BotApi.
* @alias module:api/BotApi
@@ -39,117 +50,60 @@ var BotApi = /*#__PURE__*/function () {
/**
* Create a bot
- * ## Create a bot Creates a new bot within the application. Creating a bot is similar to creating a normal user, except that a callback URL is specified in order for the bot to receive events. > __Note__: The bot must [join](#2-join-channels) a group channel first to interact with users. In group channels, you can invite a bot through the [invite as members](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-invite-as-members) action instead. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-create-a-bot
- * @param {String} apiToken
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {module:model/CreateBotData} opts.createBotData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateBotResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateABotRequest} opts.createABotRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateABotResponse} and HTTP response
*/
- _createClass(BotApi, [{
- key: "createBotWithHttpInfo",
- value: function createBotWithHttpInfo(apiToken, opts) {
+ return _createClass(BotApi, [{
+ key: "createABotWithHttpInfo",
+ value: function createABotWithHttpInfo(opts) {
opts = opts || {};
- var postBody = opts['createBotData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling createBot");
- }
+ var postBody = opts['createABotRequest'];
var pathParams = {};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _CreateBotResponse["default"];
+ var returnType = _CreateABotResponse["default"];
return this.apiClient.callApi('/v3/bots', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Create a bot
- * ## Create a bot Creates a new bot within the application. Creating a bot is similar to creating a normal user, except that a callback URL is specified in order for the bot to receive events. > __Note__: The bot must [join](#2-join-channels) a group channel first to interact with users. In group channels, you can invite a bot through the [invite as members](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-invite-as-members) action instead. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-create-a-bot
- * @param {String} apiToken
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {module:model/CreateBotData} opts.createBotData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateBotResponse}
- */
- }, {
- key: "createBot",
- value: function createBot(apiToken, opts) {
- return this.createBotWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a bot
- * ## Delete a bot Deletes a bot from an application. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-delete-a-bot ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "deleteBotByIdWithHttpInfo",
- value: function deleteBotByIdWithHttpInfo(apiToken, botUserid) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteBotById");
- }
- // verify the required parameter 'botUserid' is set
- if (botUserid === undefined || botUserid === null) {
- throw new Error("Missing the required parameter 'botUserid' when calling deleteBotById");
- }
- var pathParams = {
- 'bot_userid': botUserid
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/bots/{bot_userid}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a bot
- * ## Delete a bot Deletes a bot from an application. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-delete-a-bot ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateABotRequest} opts.createABotRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateABotResponse}
*/
}, {
- key: "deleteBotById",
- value: function deleteBotById(apiToken, botUserid) {
- return this.deleteBotByIdWithHttpInfo(apiToken, botUserid).then(function (response_and_data) {
+ key: "createABot",
+ value: function createABot(opts) {
+ return this.createABotWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Join channels
- * ## Join channels Makes a bot join one or more channels. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-join-channels ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
+ * ## 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)
+ * @param {String} botUserid (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/JoinChannelsData} opts.joinChannelsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/JoinChannelsResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/JoinChannelsRequest} opts.joinChannelsRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdGroupChannelDetail} and HTTP response
*/
}, {
key: "joinChannelsWithHttpInfo",
- value: function joinChannelsWithHttpInfo(apiToken, botUserid, opts) {
+ value: function joinChannelsWithHttpInfo(botUserid, opts) {
opts = opts || {};
- var postBody = opts['joinChannelsData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling joinChannels");
- }
+ var postBody = opts['joinChannelsRequest'];
// verify the required parameter 'botUserid' is set
if (botUserid === undefined || botUserid === null) {
throw new Error("Missing the required parameter 'botUserid' when calling joinChannels");
@@ -159,170 +113,157 @@ var BotApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _JoinChannelsResponse["default"];
+ var returnType = _SendbirdGroupChannelDetail["default"];
return this.apiClient.callApi('/v3/bots/{bot_userid}/channels', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Join channels
- * ## Join channels Makes a bot join one or more channels. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-join-channels ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
+ * ## 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)
+ * @param {String} botUserid (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/JoinChannelsData} opts.joinChannelsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/JoinChannelsResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/JoinChannelsRequest} opts.joinChannelsRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdGroupChannelDetail}
*/
}, {
key: "joinChannels",
- value: function joinChannels(apiToken, botUserid, opts) {
- return this.joinChannelsWithHttpInfo(apiToken, botUserid, opts).then(function (response_and_data) {
+ value: function joinChannels(botUserid, opts) {
+ return this.joinChannelsWithHttpInfo(botUserid, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Leave channels - When leaving all channels
- * ## Leave channels Makes a bot leave one or more group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-leave-channels ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
+ * Leave channels - When leaving a specific channel
+ * ## 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)
+ * @param {String} channelUrl
+ * @param {String} botUserid (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "leaveChannelsWithHttpInfo",
- value: function leaveChannelsWithHttpInfo(apiToken, botUserid, opts) {
+ key: "leaveAGroupChannelWithHttpInfo",
+ value: function leaveAGroupChannelWithHttpInfo(channelUrl, botUserid, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling leaveChannels");
+ // verify the required parameter 'channelUrl' is set
+ if (channelUrl === undefined || channelUrl === null) {
+ throw new Error("Missing the required parameter 'channelUrl' when calling leaveAGroupChannel");
}
// verify the required parameter 'botUserid' is set
if (botUserid === undefined || botUserid === null) {
- throw new Error("Missing the required parameter 'botUserid' when calling leaveChannels");
+ throw new Error("Missing the required parameter 'botUserid' when calling leaveAGroupChannel");
}
var pathParams = {
+ 'channel_url': channelUrl,
'bot_userid': botUserid
};
- var queryParams = {
- 'channel_url': opts['channelUrl']
- };
+ var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/bots/{bot_userid}/channels', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var accepts = ['application/json'];
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/bots/{bot_userid}/channels/{channel_url}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Leave channels - When leaving all channels
- * ## Leave channels Makes a bot leave one or more group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-leave-channels ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
+ * Leave channels - When leaving a specific channel
+ * ## 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)
+ * @param {String} channelUrl
+ * @param {String} botUserid (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "leaveChannels",
- value: function leaveChannels(apiToken, botUserid, opts) {
- return this.leaveChannelsWithHttpInfo(apiToken, botUserid, opts).then(function (response_and_data) {
+ key: "leaveAGroupChannel",
+ value: function leaveAGroupChannel(channelUrl, botUserid, opts) {
+ return this.leaveAGroupChannelWithHttpInfo(channelUrl, botUserid, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Leave channels - When leaving a channel by its channel URL
- * ## Leave channels Makes a bot leave one or more group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-leave-channels ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @param {String} channelUrl
+ * Leave channels - When leaving all channels
+ * ## 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)
+ * @param {String} botUserid (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "leaveChannelsByUrlWithHttpInfo",
- value: function leaveChannelsByUrlWithHttpInfo(apiToken, botUserid, channelUrl) {
+ key: "leaveGroupChannelsWithHttpInfo",
+ value: function leaveGroupChannelsWithHttpInfo(botUserid, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling leaveChannelsByUrl");
- }
// verify the required parameter 'botUserid' is set
if (botUserid === undefined || botUserid === null) {
- throw new Error("Missing the required parameter 'botUserid' when calling leaveChannelsByUrl");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling leaveChannelsByUrl");
+ throw new Error("Missing the required parameter 'botUserid' when calling leaveGroupChannels");
}
var pathParams = {
- 'bot_userid': botUserid,
- 'channel_url': channelUrl
+ 'bot_userid': botUserid
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
var returnType = Object;
- return this.apiClient.callApi('/v3/bots/{bot_userid}/channels/{channel_url}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ return this.apiClient.callApi('/v3/bots/{bot_userid}/channels', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Leave channels - When leaving a channel by its channel URL
- * ## Leave channels Makes a bot leave one or more group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-leave-channels ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @param {String} channelUrl
+ * Leave channels - When leaving all channels
+ * ## 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)
+ * @param {String} botUserid (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "leaveChannelsByUrl",
- value: function leaveChannelsByUrl(apiToken, botUserid, channelUrl) {
- return this.leaveChannelsByUrlWithHttpInfo(apiToken, botUserid, channelUrl).then(function (response_and_data) {
+ key: "leaveGroupChannels",
+ value: function leaveGroupChannels(botUserid, opts) {
+ return this.leaveGroupChannelsWithHttpInfo(botUserid, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List bots
- * ## List bots Retrieves a list of all bots within an application. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-list-bots ----------------------------
- * @param {String} apiToken
+ * ## 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
* @param {Object} opts Optional parameters
* @param {String} opts.token
* @param {Number} opts.limit
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListBotsResponse} and HTTP response
*/
}, {
key: "listBotsWithHttpInfo",
- value: function listBotsWithHttpInfo(apiToken, opts) {
+ value: function listBotsWithHttpInfo(opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listBots");
- }
var pathParams = {};
var queryParams = {
'token': opts['token'],
'limit': opts['limit']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -334,178 +275,69 @@ var BotApi = /*#__PURE__*/function () {
/**
* List bots
- * ## List bots Retrieves a list of all bots within an application. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-list-bots ----------------------------
- * @param {String} apiToken
+ * ## 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
* @param {Object} opts Optional parameters
* @param {String} opts.token
* @param {Number} opts.limit
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListBotsResponse}
*/
}, {
key: "listBots",
- value: function listBots(apiToken, opts) {
- return this.listBotsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ value: function listBots(opts) {
+ return this.listBotsWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Send a bot's message
- * ## Send a bot's message Sends a bot's message to a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-send-a-bot-s-message ---------------------------- `bot_userid` Type: string Description: Specifies the ID of the bot to send a message.
- * @param {String} apiToken
- * @param {String} botUserid
+ * ## 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.
+ * @param {String} botUserid (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/SendBotSMessageData} opts.sendBotSMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdMessageResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/SendABotMessageRequest} opts.sendABotMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdMessageResponse} and HTTP response
*/
}, {
- key: "sendBotsMessageWithHttpInfo",
- value: function sendBotsMessageWithHttpInfo(apiToken, botUserid, opts) {
+ key: "sendABotMessageWithHttpInfo",
+ value: function sendABotMessageWithHttpInfo(botUserid, opts) {
opts = opts || {};
- var postBody = opts['sendBotSMessageData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling sendBotsMessage");
- }
+ var postBody = opts['sendABotMessageRequest'];
// verify the required parameter 'botUserid' is set
if (botUserid === undefined || botUserid === null) {
- throw new Error("Missing the required parameter 'botUserid' when calling sendBotsMessage");
+ throw new Error("Missing the required parameter 'botUserid' when calling sendABotMessage");
}
var pathParams = {
'bot_userid': botUserid
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdMessageResponse["default"];
+ var returnType = _SendbirdMessageResponse["default"];
return this.apiClient.callApi('/v3/bots/{bot_userid}/send', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Send a bot's message
- * ## Send a bot's message Sends a bot's message to a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-send-a-bot-s-message ---------------------------- `bot_userid` Type: string Description: Specifies the ID of the bot to send a message.
- * @param {String} apiToken
- * @param {String} botUserid
+ * ## 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.
+ * @param {String} botUserid (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/SendBotSMessageData} opts.sendBotSMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdMessageResponse}
- */
- }, {
- key: "sendBotsMessage",
- value: function sendBotsMessage(apiToken, botUserid, opts) {
- return this.sendBotsMessageWithHttpInfo(apiToken, botUserid, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a bot
- * ## Update a bot Updates information on a bot. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-update-a-bot ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateBotByIdData} opts.updateBotByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateBotByIdResponse} and HTTP response
- */
- }, {
- key: "updateBotByIdWithHttpInfo",
- value: function updateBotByIdWithHttpInfo(apiToken, botUserid, opts) {
- opts = opts || {};
- var postBody = opts['updateBotByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateBotById");
- }
- // verify the required parameter 'botUserid' is set
- if (botUserid === undefined || botUserid === null) {
- throw new Error("Missing the required parameter 'botUserid' when calling updateBotById");
- }
- var pathParams = {
- 'bot_userid': botUserid
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateBotByIdResponse["default"];
- return this.apiClient.callApi('/v3/bots/{bot_userid}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a bot
- * ## Update a bot Updates information on a bot. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-update-a-bot ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateBotByIdData} opts.updateBotByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateBotByIdResponse}
- */
- }, {
- key: "updateBotById",
- value: function updateBotById(apiToken, botUserid, opts) {
- return this.updateBotByIdWithHttpInfo(apiToken, botUserid, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a bot
- * ## View a bot Retrieves information on a bot. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-view-a-bot ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewBotByIdResponse} and HTTP response
- */
- }, {
- key: "viewBotByIdWithHttpInfo",
- value: function viewBotByIdWithHttpInfo(apiToken, botUserid) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewBotById");
- }
- // verify the required parameter 'botUserid' is set
- if (botUserid === undefined || botUserid === null) {
- throw new Error("Missing the required parameter 'botUserid' when calling viewBotById");
- }
- var pathParams = {
- 'bot_userid': botUserid
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewBotByIdResponse["default"];
- return this.apiClient.callApi('/v3/bots/{bot_userid}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a bot
- * ## View a bot Retrieves information on a bot. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-view-a-bot ----------------------------
- * @param {String} apiToken
- * @param {String} botUserid
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewBotByIdResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/SendABotMessageRequest} opts.sendABotMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdMessageResponse}
*/
}, {
- key: "viewBotById",
- value: function viewBotById(apiToken, botUserid) {
- return this.viewBotByIdWithHttpInfo(apiToken, botUserid).then(function (response_and_data) {
+ key: "sendABotMessage",
+ value: function sendABotMessage(botUserid, opts) {
+ return this.sendABotMessageWithHttpInfo(botUserid, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return BotApi;
-}();
-exports["default"] = BotApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/DataExportApi.js b/dist/api/DataExportApi.js
deleted file mode 100644
index 49bb165..0000000
--- a/dist/api/DataExportApi.js
+++ /dev/null
@@ -1,205 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _ListDataExportsByMessageChannelOrUserResponse = _interopRequireDefault(require("../model/ListDataExportsByMessageChannelOrUserResponse"));
-var _RegisterAndScheduleDataExportData = _interopRequireDefault(require("../model/RegisterAndScheduleDataExportData"));
-var _RegisterAndScheduleDataExportResponse = _interopRequireDefault(require("../model/RegisterAndScheduleDataExportResponse"));
-var _ViewDataExportByIdResponse = _interopRequireDefault(require("../model/ViewDataExportByIdResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
-* DataExport service.
-* @module api/DataExportApi
-* @version 0.0.16
-*/
-var DataExportApi = /*#__PURE__*/function () {
- /**
- * Constructs a new DataExportApi.
- * @alias module:api/DataExportApi
- * @class
- * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
- * default to {@link module:ApiClient#instance} if unspecified.
- */
- function DataExportApi(apiClient) {
- _classCallCheck(this, DataExportApi);
- this.apiClient = apiClient || _ApiClient["default"].instance;
- }
-
- /**
- * List data exports by message, channel, or user
- * ## List data exports by message, channel, or user Retrieves a list of message, channel or user data exports https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-list-data-exports-by-message,-channel,-or-user ---------------------------- `data_type` Type: string Description: Specifies the type of a data export to retrieve. Acceptable values are messages, channels, users, and failed_webhooks.
- * @param {String} apiToken
- * @param {String} dataType
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListDataExportsByMessageChannelOrUserResponse} and HTTP response
- */
- _createClass(DataExportApi, [{
- key: "listDataExportsByMessageChannelOrUserWithHttpInfo",
- value: function listDataExportsByMessageChannelOrUserWithHttpInfo(apiToken, dataType, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listDataExportsByMessageChannelOrUser");
- }
- // verify the required parameter 'dataType' is set
- if (dataType === undefined || dataType === null) {
- throw new Error("Missing the required parameter 'dataType' when calling listDataExportsByMessageChannelOrUser");
- }
- var pathParams = {
- 'data_type': dataType
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListDataExportsByMessageChannelOrUserResponse["default"];
- return this.apiClient.callApi('/v3/export/{data_type}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List data exports by message, channel, or user
- * ## List data exports by message, channel, or user Retrieves a list of message, channel or user data exports https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-list-data-exports-by-message,-channel,-or-user ---------------------------- `data_type` Type: string Description: Specifies the type of a data export to retrieve. Acceptable values are messages, channels, users, and failed_webhooks.
- * @param {String} apiToken
- * @param {String} dataType
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListDataExportsByMessageChannelOrUserResponse}
- */
- }, {
- key: "listDataExportsByMessageChannelOrUser",
- value: function listDataExportsByMessageChannelOrUser(apiToken, dataType, opts) {
- return this.listDataExportsByMessageChannelOrUserWithHttpInfo(apiToken, dataType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Register and schedule a data export
- * ## Register and schedule a data export Registers and schedules a message, channel, or user data export. https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-register-and-schedule-a-data-export ----------------------------
- * @param {String} apiToken
- * @param {String} dataType
- * @param {Object} opts Optional parameters
- * @param {module:model/RegisterAndScheduleDataExportData} opts.registerAndScheduleDataExportData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RegisterAndScheduleDataExportResponse} and HTTP response
- */
- }, {
- key: "registerAndScheduleDataExportWithHttpInfo",
- value: function registerAndScheduleDataExportWithHttpInfo(apiToken, dataType, opts) {
- opts = opts || {};
- var postBody = opts['registerAndScheduleDataExportData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling registerAndScheduleDataExport");
- }
- // verify the required parameter 'dataType' is set
- if (dataType === undefined || dataType === null) {
- throw new Error("Missing the required parameter 'dataType' when calling registerAndScheduleDataExport");
- }
- var pathParams = {
- 'data_type': dataType
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _RegisterAndScheduleDataExportResponse["default"];
- return this.apiClient.callApi('/v3/export/{data_type}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Register and schedule a data export
- * ## Register and schedule a data export Registers and schedules a message, channel, or user data export. https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-register-and-schedule-a-data-export ----------------------------
- * @param {String} apiToken
- * @param {String} dataType
- * @param {Object} opts Optional parameters
- * @param {module:model/RegisterAndScheduleDataExportData} opts.registerAndScheduleDataExportData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RegisterAndScheduleDataExportResponse}
- */
- }, {
- key: "registerAndScheduleDataExport",
- value: function registerAndScheduleDataExport(apiToken, dataType, opts) {
- return this.registerAndScheduleDataExportWithHttpInfo(apiToken, dataType, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a data export
- * ## View a data export Retrieves information on a message, channel or user data export. https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-view-a-data-export ---------------------------- `data_type` Type: string Description: Specifies the type of a targeted data export. Acceptable values are messages, channels, users, and failed_webhooks. `request_id` Type: string Description: Specifies the unique ID of a data export to retrieve.
- * @param {String} apiToken
- * @param {String} dataType
- * @param {String} requestId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewDataExportByIdResponse} and HTTP response
- */
- }, {
- key: "viewDataExportByIdWithHttpInfo",
- value: function viewDataExportByIdWithHttpInfo(apiToken, dataType, requestId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewDataExportById");
- }
- // verify the required parameter 'dataType' is set
- if (dataType === undefined || dataType === null) {
- throw new Error("Missing the required parameter 'dataType' when calling viewDataExportById");
- }
- // verify the required parameter 'requestId' is set
- if (requestId === undefined || requestId === null) {
- throw new Error("Missing the required parameter 'requestId' when calling viewDataExportById");
- }
- var pathParams = {
- 'data_type': dataType,
- 'request_id': requestId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewDataExportByIdResponse["default"];
- return this.apiClient.callApi('/v3/export/{data_type}/{request_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a data export
- * ## View a data export Retrieves information on a message, channel or user data export. https://sendbird.com/docs/chat/v3/platform-api/guides/data-export#2-view-a-data-export ---------------------------- `data_type` Type: string Description: Specifies the type of a targeted data export. Acceptable values are messages, channels, users, and failed_webhooks. `request_id` Type: string Description: Specifies the unique ID of a data export to retrieve.
- * @param {String} apiToken
- * @param {String} dataType
- * @param {String} requestId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewDataExportByIdResponse}
- */
- }, {
- key: "viewDataExportById",
- value: function viewDataExportById(apiToken, dataType, requestId) {
- return this.viewDataExportByIdWithHttpInfo(apiToken, dataType, requestId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
- }]);
- return DataExportApi;
-}();
-exports["default"] = DataExportApi;
\ No newline at end of file
diff --git a/dist/api/GroupChannelApi.js b/dist/api/GroupChannelApi.js
index 06d9795..40a7c56 100644
--- a/dist/api/GroupChannelApi.js
+++ b/dist/api/GroupChannelApi.js
@@ -5,34 +5,48 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _GcAcceptInvitationData = _interopRequireDefault(require("../model/GcAcceptInvitationData"));
-var _GcCheckIfMemberByIdResponse = _interopRequireDefault(require("../model/GcCheckIfMemberByIdResponse"));
-var _GcCreateChannelData = _interopRequireDefault(require("../model/GcCreateChannelData"));
-var _GcDeclineInvitationData = _interopRequireDefault(require("../model/GcDeclineInvitationData"));
-var _GcHideOrArchiveChannelData = _interopRequireDefault(require("../model/GcHideOrArchiveChannelData"));
-var _GcInviteAsMembersData = _interopRequireDefault(require("../model/GcInviteAsMembersData"));
-var _GcJoinChannelData = _interopRequireDefault(require("../model/GcJoinChannelData"));
-var _GcLeaveChannelData = _interopRequireDefault(require("../model/GcLeaveChannelData"));
-var _GcListChannelsResponse = _interopRequireDefault(require("../model/GcListChannelsResponse"));
-var _GcListMembersResponse = _interopRequireDefault(require("../model/GcListMembersResponse"));
-var _GcListOperatorsResponse = _interopRequireDefault(require("../model/GcListOperatorsResponse"));
-var _GcRegisterOperatorsData = _interopRequireDefault(require("../model/GcRegisterOperatorsData"));
-var _GcRegisterOperatorsResponse = _interopRequireDefault(require("../model/GcRegisterOperatorsResponse"));
-var _GcResetChatHistoryData = _interopRequireDefault(require("../model/GcResetChatHistoryData"));
-var _GcResetChatHistoryResponse = _interopRequireDefault(require("../model/GcResetChatHistoryResponse"));
-var _GcUpdateChannelByUrlData = _interopRequireDefault(require("../model/GcUpdateChannelByUrlData"));
-var _OcDeleteChannelByUrl200Response = _interopRequireDefault(require("../model/OcDeleteChannelByUrl200Response"));
-var _SendBirdGroupChannel = _interopRequireDefault(require("../model/SendBirdGroupChannel"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _AcceptAnInvitationRequest = _interopRequireDefault(require("../model/AcceptAnInvitationRequest"));
+var _CheckIfMemberResponse = _interopRequireDefault(require("../model/CheckIfMemberResponse"));
+var _CreateAGroupChannelRequest = _interopRequireDefault(require("../model/CreateAGroupChannelRequest"));
+var _GetAGroupChannelResponse = _interopRequireDefault(require("../model/GetAGroupChannelResponse"));
+var _GroupChannelListMembersResponse = _interopRequireDefault(require("../model/GroupChannelListMembersResponse"));
+var _GroupChatListChannelsResponse = _interopRequireDefault(require("../model/GroupChatListChannelsResponse"));
+var _HideAChannelRequest = _interopRequireDefault(require("../model/HideAChannelRequest"));
+var _InviteAsMembersRequest = _interopRequireDefault(require("../model/InviteAsMembersRequest"));
+var _InviteAsMembersResponse = _interopRequireDefault(require("../model/InviteAsMembersResponse"));
+var _JoinAChannelRequest = _interopRequireDefault(require("../model/JoinAChannelRequest"));
+var _LeaveAChannelRequest = _interopRequireDefault(require("../model/LeaveAChannelRequest"));
+var _ListOperatorsResponse = _interopRequireDefault(require("../model/ListOperatorsResponse"));
+var _RegisterOperatorsToAGroupChannelRequest = _interopRequireDefault(require("../model/RegisterOperatorsToAGroupChannelRequest"));
+var _ResetChatHistoryRequest = _interopRequireDefault(require("../model/ResetChatHistoryRequest"));
+var _ResetChatHistoryResponse = _interopRequireDefault(require("../model/ResetChatHistoryResponse"));
+var _SendbirdGroupChannelDetail = _interopRequireDefault(require("../model/SendbirdGroupChannelDetail"));
+var _StartTypingIndicatorsRequest = _interopRequireDefault(require("../model/StartTypingIndicatorsRequest"));
+var _UpdateAGroupChannelRequest = _interopRequireDefault(require("../model/UpdateAGroupChannelRequest"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* GroupChannel service.
* @module api/GroupChannelApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var GroupChannelApi = /*#__PURE__*/function () {
+var GroupChannelApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new GroupChannelApi.
* @alias module:api/GroupChannelApi
@@ -47,144 +61,134 @@ var GroupChannelApi = /*#__PURE__*/function () {
/**
* Accept an invitation
- * ## Accept an invitation Accepts an invitation from a [private](#4-private-vs-public) group channel for a user to join. Since a user is allowed to join up to 2,000 group channels, the invitation to a user who already belongs to a maximum number of group channels will be canceled automatically. > __Note__: This action is effective only 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/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action, or [update a user's channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-accept-an-invitation ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcAcceptInvitationData} opts.gcAcceptInvitationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/AcceptAnInvitationRequest} opts.acceptAnInvitationRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdGroupChannelDetail} and HTTP response
*/
- _createClass(GroupChannelApi, [{
- key: "gcAcceptInvitationWithHttpInfo",
- value: function gcAcceptInvitationWithHttpInfo(apiToken, channelUrl, opts) {
+ return _createClass(GroupChannelApi, [{
+ key: "acceptAnInvitationWithHttpInfo",
+ value: function acceptAnInvitationWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcAcceptInvitationData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcAcceptInvitation");
- }
+ var postBody = opts['acceptAnInvitationRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcAcceptInvitation");
+ throw new Error("Missing the required parameter 'channelUrl' when calling acceptAnInvitation");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
+ var returnType = _SendbirdGroupChannelDetail["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/accept', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Accept an invitation
- * ## Accept an invitation Accepts an invitation from a [private](#4-private-vs-public) group channel for a user to join. Since a user is allowed to join up to 2,000 group channels, the invitation to a user who already belongs to a maximum number of group channels will be canceled automatically. > __Note__: This action is effective only 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/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action, or [update a user's channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-accept-an-invitation ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcAcceptInvitationData} opts.gcAcceptInvitationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
+ * @param {String} opts.apiToken
+ * @param {module:model/AcceptAnInvitationRequest} opts.acceptAnInvitationRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdGroupChannelDetail}
*/
}, {
- key: "gcAcceptInvitation",
- value: function gcAcceptInvitation(apiToken, channelUrl, opts) {
- return this.gcAcceptInvitationWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "acceptAnInvitation",
+ value: function acceptAnInvitation(channelUrl, opts) {
+ return this.acceptAnInvitationWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Cancel the registration of operators
- * ## Cancel the registration of operators Cancels the registration of operators from a group channel but leave them as members. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-cancel-the-registration-of-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to cancel the registration of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Array.} operatorIds
+ * ## 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.
+ * @param {String} channelUrl (Required)
+ * @param {String} 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.
* @param {Object} opts Optional parameters
* @param {Boolean} opts.deleteAll
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcCancelTheRegistrationOfOperatorsWithHttpInfo",
- value: function gcCancelTheRegistrationOfOperatorsWithHttpInfo(apiToken, channelUrl, operatorIds, opts) {
+ key: "cancelTheRegistrationOfOperatorsWithHttpInfo",
+ value: function cancelTheRegistrationOfOperatorsWithHttpInfo(channelUrl, operatorIds, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcCancelTheRegistrationOfOperators");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcCancelTheRegistrationOfOperators");
+ throw new Error("Missing the required parameter 'channelUrl' when calling cancelTheRegistrationOfOperators");
}
// verify the required parameter 'operatorIds' is set
if (operatorIds === undefined || operatorIds === null) {
- throw new Error("Missing the required parameter 'operatorIds' when calling gcCancelTheRegistrationOfOperators");
+ throw new Error("Missing the required parameter 'operatorIds' when calling cancelTheRegistrationOfOperators");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {
- 'operator_ids': this.apiClient.buildCollectionParam(operatorIds, 'multi'),
+ 'operator_ids': operatorIds,
'delete_all': opts['deleteAll']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
+ var returnType = Object;
return this.apiClient.callApi('/v3/group_channels/{channel_url}/operators', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Cancel the registration of operators
- * ## Cancel the registration of operators Cancels the registration of operators from a group channel but leave them as members. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-cancel-the-registration-of-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to cancel the registration of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Array.} operatorIds
+ * ## 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.
+ * @param {String} channelUrl (Required)
+ * @param {String} 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.
* @param {Object} opts Optional parameters
* @param {Boolean} opts.deleteAll
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcCancelTheRegistrationOfOperators",
- value: function gcCancelTheRegistrationOfOperators(apiToken, channelUrl, operatorIds, opts) {
- return this.gcCancelTheRegistrationOfOperatorsWithHttpInfo(apiToken, channelUrl, operatorIds, opts).then(function (response_and_data) {
+ key: "cancelTheRegistrationOfOperators",
+ value: function cancelTheRegistrationOfOperators(channelUrl, operatorIds, opts) {
+ return this.cancelTheRegistrationOfOperatorsWithHttpInfo(channelUrl, operatorIds, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Check if member
- * ## Check if member Checks whether the user is a member of the group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-check-if-member ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcCheckIfMemberByIdResponse} and HTTP response
+ * ## 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)
+ * @param {String} channelUrl (Required)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CheckIfMemberResponse} and HTTP response
*/
}, {
- key: "gcCheckIfMemberByIdWithHttpInfo",
- value: function gcCheckIfMemberByIdWithHttpInfo(apiToken, channelUrl, userId) {
+ key: "checkIfMemberWithHttpInfo",
+ value: function checkIfMemberWithHttpInfo(channelUrl, userId, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcCheckIfMemberById");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcCheckIfMemberById");
+ throw new Error("Missing the required parameter 'channelUrl' when calling checkIfMember");
}
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling gcCheckIfMemberById");
+ throw new Error("Missing the required parameter 'userId' when calling checkIfMember");
}
var pathParams = {
'channel_url': channelUrl,
@@ -192,339 +196,333 @@ var GroupChannelApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _GcCheckIfMemberByIdResponse["default"];
+ var returnType = _CheckIfMemberResponse["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/members/{user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Check if member
- * ## Check if member Checks whether the user is a member of the group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-check-if-member ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcCheckIfMemberByIdResponse}
+ * ## 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)
+ * @param {String} channelUrl (Required)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CheckIfMemberResponse}
*/
}, {
- key: "gcCheckIfMemberById",
- value: function gcCheckIfMemberById(apiToken, channelUrl, userId) {
- return this.gcCheckIfMemberByIdWithHttpInfo(apiToken, channelUrl, userId).then(function (response_and_data) {
+ key: "checkIfMember",
+ value: function checkIfMember(channelUrl, userId, opts) {
+ return this.checkIfMemberWithHttpInfo(channelUrl, userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Create a channel
- * ## Create a channel Creates a new group channel. > If you are creating a 1-on-1 direct messaging channel for a user, it is recommended that you turn on the `distinct` property. If the property is turned off, a user can create a new channel even if they have had the previous chat between them, and therefore can't see previously sent messages or data in the new channel. On the other hand, if the `distinct` property is turned on, every 1-on-1 conversation between the same two users occurs within the same channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-create-a-channel
- * @param {String} apiToken
+ * Create a group channel
+ * ## 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
* @param {Object} opts Optional parameters
- * @param {module:model/GcCreateChannelData} opts.gcCreateChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAGroupChannelRequest} opts.createAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdGroupChannelDetail} and HTTP response
*/
}, {
- key: "gcCreateChannelWithHttpInfo",
- value: function gcCreateChannelWithHttpInfo(apiToken, opts) {
+ key: "createAGroupChannelWithHttpInfo",
+ value: function createAGroupChannelWithHttpInfo(opts) {
opts = opts || {};
- var postBody = opts['gcCreateChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcCreateChannel");
- }
+ var postBody = opts['createAGroupChannelRequest'];
var pathParams = {};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
+ var returnType = _SendbirdGroupChannelDetail["default"];
return this.apiClient.callApi('/v3/group_channels', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Create a channel
- * ## Create a channel Creates a new group channel. > If you are creating a 1-on-1 direct messaging channel for a user, it is recommended that you turn on the `distinct` property. If the property is turned off, a user can create a new channel even if they have had the previous chat between them, and therefore can't see previously sent messages or data in the new channel. On the other hand, if the `distinct` property is turned on, every 1-on-1 conversation between the same two users occurs within the same channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-create-a-channel
- * @param {String} apiToken
+ * Create a group channel
+ * ## 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
* @param {Object} opts Optional parameters
- * @param {module:model/GcCreateChannelData} opts.gcCreateChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAGroupChannelRequest} opts.createAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdGroupChannelDetail}
*/
}, {
- key: "gcCreateChannel",
- value: function gcCreateChannel(apiToken, opts) {
- return this.gcCreateChannelWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ key: "createAGroupChannel",
+ value: function createAGroupChannel(opts) {
+ return this.createAGroupChannelWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Decline an invitation
- * ## Decline an invitation Declines an invitation for a user to not join a [private](#4-private-vs-public) group channel. > __Note__: This action is effective only 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/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action, or [update a user's channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-decline-an-invitation ----------------------------
- * @param {String} apiToken
+ * Delete a group channel
+ * ## 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)
* @param {String} channelUrl
* @param {Object} opts Optional parameters
- * @param {module:model/GcDeclineInvitationData} opts.gcDeclineInvitationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcDeclineInvitationWithHttpInfo",
- value: function gcDeclineInvitationWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "deleteAGroupChannelWithHttpInfo",
+ value: function deleteAGroupChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcDeclineInvitationData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcDeclineInvitation");
- }
+ var postBody = null;
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcDeclineInvitation");
+ throw new Error("Missing the required parameter 'channelUrl' when calling deleteAGroupChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = ['application/json'];
+ var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/decline', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Decline an invitation
- * ## Decline an invitation Declines an invitation for a user to not join a [private](#4-private-vs-public) group channel. > __Note__: This action is effective only 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/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action, or [update a user's channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-decline-an-invitation ----------------------------
- * @param {String} apiToken
+ * Delete a group channel
+ * ## 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)
* @param {String} channelUrl
* @param {Object} opts Optional parameters
- * @param {module:model/GcDeclineInvitationData} opts.gcDeclineInvitationData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcDeclineInvitation",
- value: function gcDeclineInvitation(apiToken, channelUrl, opts) {
- return this.gcDeclineInvitationWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "deleteAGroupChannel",
+ value: function deleteAGroupChannel(channelUrl, opts) {
+ return this.deleteAGroupChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Delete a channel
- * ## Delete a channel Deletes a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-delete-a-channel ----------------------------
- * @param {String} apiToken
+ * Get a group channel
+ * ## 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.
* @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {Object} opts Optional parameters
+ * @param {Boolean} opts.showDeliveryReceipt
+ * @param {Boolean} opts.showReadReceipt
+ * @param {Boolean} opts.showMember
+ * @param {module:model/String} opts.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)
+ * @param {String} opts.userId
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAGroupChannelResponse} and HTTP response
*/
}, {
- key: "gcDeleteChannelByUrlWithHttpInfo",
- value: function gcDeleteChannelByUrlWithHttpInfo(apiToken, channelUrl) {
+ key: "getAGroupChannelWithHttpInfo",
+ value: function getAGroupChannelWithHttpInfo(channelUrl, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcDeleteChannelByUrl");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcDeleteChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling getAGroupChannel");
}
var pathParams = {
'channel_url': channelUrl
};
- var queryParams = {};
+ var queryParams = {
+ 'show_delivery_receipt': opts['showDeliveryReceipt'],
+ 'show_read_receipt': opts['showReadReceipt'],
+ 'show_member': opts['showMember'],
+ 'member_active_mode': opts['memberActiveMode'],
+ 'user_id': opts['userId']
+ };
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _GetAGroupChannelResponse["default"];
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Delete a channel
- * ## Delete a channel Deletes a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-delete-a-channel ----------------------------
- * @param {String} apiToken
+ * Get a group channel
+ * ## 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.
* @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {Object} opts Optional parameters
+ * @param {Boolean} opts.showDeliveryReceipt
+ * @param {Boolean} opts.showReadReceipt
+ * @param {Boolean} opts.showMember
+ * @param {module:model/String} opts.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)
+ * @param {String} opts.userId
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAGroupChannelResponse}
*/
}, {
- key: "gcDeleteChannelByUrl",
- value: function gcDeleteChannelByUrl(apiToken, channelUrl) {
- return this.gcDeleteChannelByUrlWithHttpInfo(apiToken, channelUrl).then(function (response_and_data) {
+ key: "getAGroupChannel",
+ value: function getAGroupChannel(channelUrl, opts) {
+ return this.getAGroupChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Hide or archive a channel
- * ## Hide or archive a channel Hides or archives a channel from the channel list of either a specific user or entire channel members. Normally, a hidden channel comes back and shows up in the channel list when a member in the channel sends a new message. This automatically-triggered behavior is intended for users who want to temporarily remove a channel from their list because [leaving the channel](#2-leave-the-channel) would delete all the past messages and stored data. You can also leave out a channel from the list and archive the channel. The channel doesn't appear even when receiving a new message from other member. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-hide-or-archive-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Hide a channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcHideOrArchiveChannelData} opts.gcHideOrArchiveChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/HideAChannelRequest} opts.hideAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcHideOrArchiveChannelWithHttpInfo",
- value: function gcHideOrArchiveChannelWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "hideAChannelWithHttpInfo",
+ value: function hideAChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcHideOrArchiveChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcHideOrArchiveChannel");
- }
+ var postBody = opts['hideAChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcHideOrArchiveChannel");
+ throw new Error("Missing the required parameter 'channelUrl' when calling hideAChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
+ var returnType = Object;
return this.apiClient.callApi('/v3/group_channels/{channel_url}/hide', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Hide or archive a channel
- * ## Hide or archive a channel Hides or archives a channel from the channel list of either a specific user or entire channel members. Normally, a hidden channel comes back and shows up in the channel list when a member in the channel sends a new message. This automatically-triggered behavior is intended for users who want to temporarily remove a channel from their list because [leaving the channel](#2-leave-the-channel) would delete all the past messages and stored data. You can also leave out a channel from the list and archive the channel. The channel doesn't appear even when receiving a new message from other member. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-hide-or-archive-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Hide a channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcHideOrArchiveChannelData} opts.gcHideOrArchiveChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {String} opts.apiToken
+ * @param {module:model/HideAChannelRequest} opts.hideAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcHideOrArchiveChannel",
- value: function gcHideOrArchiveChannel(apiToken, channelUrl, opts) {
- return this.gcHideOrArchiveChannelWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "hideAChannel",
+ value: function hideAChannel(channelUrl, opts) {
+ return this.hideAChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Invite as members
- * ## Invite as members Invites one or more users as members into the group channel. > __Note__: By default, users in your application automatically join a [private](#4-private-vs-public) group channel promptly from an invitation without having to accept it. If you want to give them the option to decide whether to accept or decline an invitation, you should set the value of channel invitation preference to false through the [update default channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action. Or using the [update a user's channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action, you can also allow the option individually by user. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-invite-as-members ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcInviteAsMembersData} opts.gcInviteAsMembersData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/InviteAsMembersRequest} opts.inviteAsMembersRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/InviteAsMembersResponse} and HTTP response
*/
}, {
- key: "gcInviteAsMembersWithHttpInfo",
- value: function gcInviteAsMembersWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "inviteAsMembersWithHttpInfo",
+ value: function inviteAsMembersWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcInviteAsMembersData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcInviteAsMembers");
- }
+ var postBody = opts['inviteAsMembersRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcInviteAsMembers");
+ throw new Error("Missing the required parameter 'channelUrl' when calling inviteAsMembers");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
+ var returnType = _InviteAsMembersResponse["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/invite', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Invite as members
- * ## Invite as members Invites one or more users as members into the group channel. > __Note__: By default, users in your application automatically join a [private](#4-private-vs-public) group channel promptly from an invitation without having to accept it. If you want to give them the option to decide whether to accept or decline an invitation, you should set the value of channel invitation preference to false through the [update default channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action. Or using the [update a user's channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference) action, you can also allow the option individually by user. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-invite-as-members ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcInviteAsMembersData} opts.gcInviteAsMembersData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
+ * @param {String} opts.apiToken
+ * @param {module:model/InviteAsMembersRequest} opts.inviteAsMembersRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/InviteAsMembersResponse}
*/
}, {
- key: "gcInviteAsMembers",
- value: function gcInviteAsMembers(apiToken, channelUrl, opts) {
- return this.gcInviteAsMembersWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "inviteAsMembers",
+ value: function inviteAsMembers(channelUrl, opts) {
+ return this.inviteAsMembersWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Join a channel
- * ## Join a channel Allows a user to join a [public](#4-private-vs-public) group channel. Since a user is allowed to join up to 2,000 group channels, a user who already belongs to a maximum number of group channels can't join a new channel. > __Note__: This action is only permitted for public group channels where the `is_public` property is true. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-join-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcJoinChannelData} opts.gcJoinChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/JoinAChannelRequest} opts.joinAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdGroupChannelDetail} and HTTP response
*/
}, {
- key: "gcJoinChannelWithHttpInfo",
- value: function gcJoinChannelWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "joinAChannelWithHttpInfo",
+ value: function joinAChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcJoinChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcJoinChannel");
- }
+ var postBody = opts['joinAChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcJoinChannel");
+ throw new Error("Missing the required parameter 'channelUrl' when calling joinAChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
- var accepts = [];
- var returnType = null;
+ var accepts = ['application/json'];
+ var returnType = _SendbirdGroupChannelDetail["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/join', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Join a channel
- * ## Join a channel Allows a user to join a [public](#4-private-vs-public) group channel. Since a user is allowed to join up to 2,000 group channels, a user who already belongs to a maximum number of group channels can't join a new channel. > __Note__: This action is only permitted for public group channels where the `is_public` property is true. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-join-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcJoinChannelData} opts.gcJoinChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+ * @param {String} opts.apiToken
+ * @param {module:model/JoinAChannelRequest} opts.joinAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdGroupChannelDetail}
*/
}, {
- key: "gcJoinChannel",
- value: function gcJoinChannel(apiToken, channelUrl, opts) {
- return this.gcJoinChannelWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "joinAChannel",
+ value: function joinAChannel(channelUrl, opts) {
+ return this.joinAChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
@@ -532,114 +530,110 @@ var GroupChannelApi = /*#__PURE__*/function () {
/**
* Leave a channel
* ## 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 ----------------------------
- * @param {String} apiToken
* @param {String} channelUrl
* @param {Object} opts Optional parameters
- * @param {module:model/GcLeaveChannelData} opts.gcLeaveChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/LeaveAChannelRequest} opts.leaveAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcLeaveChannelWithHttpInfo",
- value: function gcLeaveChannelWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "leaveAChannelWithHttpInfo",
+ value: function leaveAChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcLeaveChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcLeaveChannel");
- }
+ var postBody = opts['leaveAChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcLeaveChannel");
+ throw new Error("Missing the required parameter 'channelUrl' when calling leaveAChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'Api-Token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
+ var returnType = Object;
return this.apiClient.callApi('/v3/group_channels/{channel_url}/leave', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Leave a channel
* ## 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 ----------------------------
- * @param {String} apiToken
* @param {String} channelUrl
* @param {Object} opts Optional parameters
- * @param {module:model/GcLeaveChannelData} opts.gcLeaveChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {String} opts.apiToken
+ * @param {module:model/LeaveAChannelRequest} opts.leaveAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcLeaveChannel",
- value: function gcLeaveChannel(apiToken, channelUrl, opts) {
- return this.gcLeaveChannelWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "leaveAChannel",
+ value: function leaveAChannel(channelUrl, opts) {
+ return this.leaveAChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List channels
- * ## List channels Retrieves a list of group channels in the application. > __Note__: If you want to get a list of a specific user's group channels, use the [list my group channels](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-my-group-channels) action instead. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-channels ----------------------------
+ * ## 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
* @param {String} apiToken
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.distinctMode
- * @param {String} opts.publicMode
- * @param {String} opts.superMode
- * @param {Number} opts.createdAfter
- * @param {Number} opts.createdBefore
+ * @param {String} opts.token Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {module:model/String} opts.distinctMode
+ * @param {module:model/String} opts.publicMode
+ * @param {module:model/String} opts.superMode
+ * @param {Number} opts.createdAfter Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
+ * @param {Number} opts.createdBefore Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
* @param {Boolean} opts.showEmpty
* @param {Boolean} opts.showMember
* @param {Boolean} opts.showDeliveryReceipt
* @param {Boolean} opts.showReadReceipt
* @param {Boolean} opts.showMetadata
* @param {Boolean} opts.showFrozen
- * @param {String} opts.order
- * @param {String} opts.metadataOrderKey
- * @param {String} opts.customTypes
- * @param {String} opts.customTypeStartswith
- * @param {String} opts.channelUrls
- * @param {String} opts.name
- * @param {String} opts.nameContains
- * @param {String} opts.nameStartswith
- * @param {String} opts.membersExactlyIn
- * @param {String} opts.membersIncludeIn
- * @param {String} opts.queryType
- * @param {String} opts.membersNickname
- * @param {String} opts.membersNicknameContains
- * @param {String} opts.metadataKey
- * @param {String} opts.metadataValues
- * @param {String} opts.metadataValueStartswith
- * @param {String} opts.metacounterKey
- * @param {String} opts.metacounterValues
- * @param {String} opts.metacounterValueGt
- * @param {String} opts.metacounterValueGte
- * @param {String} opts.metacounterValueLt
- * @param {String} opts.metacounterValueLte
- * @param {Boolean} opts.includeSortedMetaarrayInLastMessage
- * @param {String} opts.customType
- * @param {Boolean} opts.readReceipt
- * @param {Boolean} opts.member
- * @param {Boolean} opts.isDistinct
- * @param {String} opts.membersIn
- * @param {String} opts.userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcListChannelsResponse} and HTTP response
+ * @param {module:model/String} opts.order
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.customTypeStartswith Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.name Specifies one or more group channel names.
+ * @param {String} opts.nameContains Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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)
+ * @param {String} opts.membersNickname Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {Boolean} opts.includeSortedMetaarrayInLastMessage Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
+ * @param {String} opts.customType (Deprecated) Returns channels whose custom_type matches the given value. If this field is not specified, all channels are returned, regardless of their custom type. The string passed here must be urlencoded.
+ * @param {Boolean} opts.readReceipt (Deprecated) Superseded by show_read_receipt.
+ * @param {Boolean} opts.member (Deprecated) Superseded by show_member.
+ * @param {Boolean} opts.isDistinct (Deprecated) Superseded by distinct_mode.
+ * @param {String} opts.membersIn (Deprecated) Superseded by members_exactly_in.
+ * @param {String} opts.userId (Deprecated) Restricts the search scope to only retrieve the target user's group channels. It's recommended to use the list group channels by user action instead.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GroupChatListChannelsResponse} and HTTP response
*/
}, {
- key: "gcListChannelsWithHttpInfo",
- value: function gcListChannelsWithHttpInfo(apiToken, opts) {
+ key: "listChannelsWithHttpInfo",
+ value: function listChannelsWithHttpInfo(apiToken, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'apiToken' is set
if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcListChannels");
+ throw new Error("Missing the required parameter 'apiToken' when calling listChannels");
}
var pathParams = {};
var queryParams = {
@@ -687,102 +681,102 @@ var GroupChannelApi = /*#__PURE__*/function () {
'user_id': opts['userId']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': apiToken
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _GcListChannelsResponse["default"];
+ var returnType = _GroupChatListChannelsResponse["default"];
return this.apiClient.callApi('/v3/group_channels', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* List channels
- * ## List channels Retrieves a list of group channels in the application. > __Note__: If you want to get a list of a specific user's group channels, use the [list my group channels](https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-my-group-channels) action instead. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-channels ----------------------------
+ * ## 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
* @param {String} apiToken
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.distinctMode
- * @param {String} opts.publicMode
- * @param {String} opts.superMode
- * @param {Number} opts.createdAfter
- * @param {Number} opts.createdBefore
+ * @param {String} opts.token Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {module:model/String} opts.distinctMode
+ * @param {module:model/String} opts.publicMode
+ * @param {module:model/String} opts.superMode
+ * @param {Number} opts.createdAfter Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
+ * @param {Number} opts.createdBefore Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
* @param {Boolean} opts.showEmpty
* @param {Boolean} opts.showMember
* @param {Boolean} opts.showDeliveryReceipt
* @param {Boolean} opts.showReadReceipt
* @param {Boolean} opts.showMetadata
* @param {Boolean} opts.showFrozen
- * @param {String} opts.order
- * @param {String} opts.metadataOrderKey
- * @param {String} opts.customTypes
- * @param {String} opts.customTypeStartswith
- * @param {String} opts.channelUrls
- * @param {String} opts.name
- * @param {String} opts.nameContains
- * @param {String} opts.nameStartswith
- * @param {String} opts.membersExactlyIn
- * @param {String} opts.membersIncludeIn
- * @param {String} opts.queryType
- * @param {String} opts.membersNickname
- * @param {String} opts.membersNicknameContains
- * @param {String} opts.metadataKey
- * @param {String} opts.metadataValues
- * @param {String} opts.metadataValueStartswith
- * @param {String} opts.metacounterKey
- * @param {String} opts.metacounterValues
- * @param {String} opts.metacounterValueGt
- * @param {String} opts.metacounterValueGte
- * @param {String} opts.metacounterValueLt
- * @param {String} opts.metacounterValueLte
- * @param {Boolean} opts.includeSortedMetaarrayInLastMessage
- * @param {String} opts.customType
- * @param {Boolean} opts.readReceipt
- * @param {Boolean} opts.member
- * @param {Boolean} opts.isDistinct
- * @param {String} opts.membersIn
- * @param {String} opts.userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcListChannelsResponse}
+ * @param {module:model/String} opts.order
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.customTypeStartswith Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.name Specifies one or more group channel names.
+ * @param {String} opts.nameContains Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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)
+ * @param {String} opts.membersNickname Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {Boolean} opts.includeSortedMetaarrayInLastMessage Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
+ * @param {String} opts.customType (Deprecated) Returns channels whose custom_type matches the given value. If this field is not specified, all channels are returned, regardless of their custom type. The string passed here must be urlencoded.
+ * @param {Boolean} opts.readReceipt (Deprecated) Superseded by show_read_receipt.
+ * @param {Boolean} opts.member (Deprecated) Superseded by show_member.
+ * @param {Boolean} opts.isDistinct (Deprecated) Superseded by distinct_mode.
+ * @param {String} opts.membersIn (Deprecated) Superseded by members_exactly_in.
+ * @param {String} opts.userId (Deprecated) Restricts the search scope to only retrieve the target user's group channels. It's recommended to use the list group channels by user action instead.
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GroupChatListChannelsResponse}
*/
}, {
- key: "gcListChannels",
- value: function gcListChannels(apiToken, opts) {
- return this.gcListChannelsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ key: "listChannels",
+ value: function listChannels(apiToken, opts) {
+ return this.listChannelsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List members
- * ## List members Retrieves a list of members of a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-members ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of members of.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.token
- * @param {Number} opts.limit
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {String} opts.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.
* @param {Boolean} opts.showDeliveryReceipt
* @param {Boolean} opts.showReadReceipt
- * @param {String} opts.order
- * @param {String} opts.operatorFilter
- * @param {String} opts.memberStateFilter
- * @param {String} opts.mutedMemberFilter
- * @param {String} opts.nicknameStartswith
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcListMembersResponse} and HTTP response
+ * @param {Boolean} opts.showMemberIsMuted
+ * @param {module:model/String} opts.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.
+ * @param {module:model/String} opts.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.
+ * @param {module:model/String} opts.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`)
+ * @param {module:model/String} opts.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`)
+ * @param {module:model/String} opts.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`)
+ * @param {String} opts.nicknameStartswith Searches for members whose nicknames start with the specified value. Urlencoding the value is recommended.
+ * @param {Boolean} opts.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`)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GroupChannelListMembersResponse} and HTTP response
*/
}, {
- key: "gcListMembersWithHttpInfo",
- value: function gcListMembersWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "listMembersWithHttpInfo",
+ value: function listMembersWithHttpInfo(channelUrl, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcListMembers");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcListMembers");
+ throw new Error("Missing the required parameter 'channelUrl' when calling listMembers");
}
var pathParams = {
'channel_url': channelUrl
@@ -790,72 +784,76 @@ var GroupChannelApi = /*#__PURE__*/function () {
var queryParams = {
'token': opts['token'],
'limit': opts['limit'],
+ 'user_id': opts['userId'],
'show_delivery_receipt': opts['showDeliveryReceipt'],
'show_read_receipt': opts['showReadReceipt'],
+ 'show_member_is_muted': opts['showMemberIsMuted'],
'order': opts['order'],
'operator_filter': opts['operatorFilter'],
'member_state_filter': opts['memberStateFilter'],
'muted_member_filter': opts['mutedMemberFilter'],
- 'nickname_startswith': opts['nicknameStartswith']
+ 'member_active_mode_filter': opts['memberActiveModeFilter'],
+ 'nickname_startswith': opts['nicknameStartswith'],
+ 'include_push_preference': opts['includePushPreference']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _GcListMembersResponse["default"];
+ var returnType = _GroupChannelListMembersResponse["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/members', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* List members
- * ## List members Retrieves a list of members of a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-members ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of members of.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.token
- * @param {Number} opts.limit
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {String} opts.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.
* @param {Boolean} opts.showDeliveryReceipt
* @param {Boolean} opts.showReadReceipt
- * @param {String} opts.order
- * @param {String} opts.operatorFilter
- * @param {String} opts.memberStateFilter
- * @param {String} opts.mutedMemberFilter
- * @param {String} opts.nicknameStartswith
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcListMembersResponse}
+ * @param {Boolean} opts.showMemberIsMuted
+ * @param {module:model/String} opts.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.
+ * @param {module:model/String} opts.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.
+ * @param {module:model/String} opts.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`)
+ * @param {module:model/String} opts.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`)
+ * @param {module:model/String} opts.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`)
+ * @param {String} opts.nicknameStartswith Searches for members whose nicknames start with the specified value. Urlencoding the value is recommended.
+ * @param {Boolean} opts.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`)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GroupChannelListMembersResponse}
*/
}, {
- key: "gcListMembers",
- value: function gcListMembers(apiToken, channelUrl, opts) {
- return this.gcListMembersWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "listMembers",
+ value: function listMembers(channelUrl, opts) {
+ return this.listMembersWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List operators
- * ## List operators Retrieves a list of operators of a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcListOperatorsResponse} and HTTP response
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListOperatorsResponse} and HTTP response
*/
}, {
- key: "gcListOperatorsWithHttpInfo",
- value: function gcListOperatorsWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "listOperatorsWithHttpInfo",
+ value: function listOperatorsWithHttpInfo(channelUrl, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcListOperators");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcListOperators");
+ throw new Error("Missing the required parameter 'channelUrl' when calling listOperators");
}
var pathParams = {
'channel_url': channelUrl
@@ -865,327 +863,341 @@ var GroupChannelApi = /*#__PURE__*/function () {
'limit': opts['limit']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _GcListOperatorsResponse["default"];
+ var returnType = _ListOperatorsResponse["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/operators', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* List operators
- * ## List operators Retrieves a list of operators of a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcListOperatorsResponse}
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListOperatorsResponse}
*/
}, {
- key: "gcListOperators",
- value: function gcListOperators(apiToken, channelUrl, opts) {
- return this.gcListOperatorsWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "listOperators",
+ value: function listOperators(channelUrl, opts) {
+ return this.listOperatorsWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Register operators
- * ## Register operators Registers one or more operators to a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-register-operators ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Register operators to a group channel
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcRegisterOperatorsData} opts.gcRegisterOperatorsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcRegisterOperatorsResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/RegisterOperatorsToAGroupChannelRequest} opts.registerOperatorsToAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcRegisterOperatorsWithHttpInfo",
- value: function gcRegisterOperatorsWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "registerOperatorsToAGroupChannelWithHttpInfo",
+ value: function registerOperatorsToAGroupChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcRegisterOperatorsData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcRegisterOperators");
- }
+ var postBody = opts['registerOperatorsToAGroupChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcRegisterOperators");
+ throw new Error("Missing the required parameter 'channelUrl' when calling registerOperatorsToAGroupChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _GcRegisterOperatorsResponse["default"];
+ var returnType = Object;
return this.apiClient.callApi('/v3/group_channels/{channel_url}/operators', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Register operators
- * ## Register operators Registers one or more operators to a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-register-operators ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Register operators to a group channel
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcRegisterOperatorsData} opts.gcRegisterOperatorsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcRegisterOperatorsResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/RegisterOperatorsToAGroupChannelRequest} opts.registerOperatorsToAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcRegisterOperators",
- value: function gcRegisterOperators(apiToken, channelUrl, opts) {
- return this.gcRegisterOperatorsWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "registerOperatorsToAGroupChannel",
+ value: function registerOperatorsToAGroupChannel(channelUrl, opts) {
+ return this.registerOperatorsToAGroupChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Reset chat history
- * ## Reset chat history Resets the properties related to a user's chat history in a group channel, then clears the existing messages in the channel on the user's side only. A user can no longer see the messages in a group channel once this action is called, but those messages are not deleted from the database of the Sendbird system. All other members in the channel can retrieve and see the messages. This action simply clears the messages for the user by updating the `last_message` and `read_receipt` properties of the [channel](#2-types-of-a-channel-3-resource-representation) resource in addition to other internally managed data such as the number of the user's unread message. Using the `reset_all` property, you can also reset the properties related to all users' chat history in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-reset-chat-history ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcResetChatHistoryData} opts.gcResetChatHistoryData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcResetChatHistoryResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/ResetChatHistoryRequest} opts.resetChatHistoryRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ResetChatHistoryResponse} and HTTP response
*/
}, {
- key: "gcResetChatHistoryWithHttpInfo",
- value: function gcResetChatHistoryWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "resetChatHistoryWithHttpInfo",
+ value: function resetChatHistoryWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcResetChatHistoryData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcResetChatHistory");
- }
+ var postBody = opts['resetChatHistoryRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcResetChatHistory");
+ throw new Error("Missing the required parameter 'channelUrl' when calling resetChatHistory");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _GcResetChatHistoryResponse["default"];
+ var returnType = _ResetChatHistoryResponse["default"];
return this.apiClient.callApi('/v3/group_channels/{channel_url}/reset_user_history', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Reset chat history
- * ## Reset chat history Resets the properties related to a user's chat history in a group channel, then clears the existing messages in the channel on the user's side only. A user can no longer see the messages in a group channel once this action is called, but those messages are not deleted from the database of the Sendbird system. All other members in the channel can retrieve and see the messages. This action simply clears the messages for the user by updating the `last_message` and `read_receipt` properties of the [channel](#2-types-of-a-channel-3-resource-representation) resource in addition to other internally managed data such as the number of the user's unread message. Using the `reset_all` property, you can also reset the properties related to all users' chat history in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-reset-chat-history ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcResetChatHistoryData} opts.gcResetChatHistoryData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcResetChatHistoryResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/ResetChatHistoryRequest} opts.resetChatHistoryRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResetChatHistoryResponse}
*/
}, {
- key: "gcResetChatHistory",
- value: function gcResetChatHistory(apiToken, channelUrl, opts) {
- return this.gcResetChatHistoryWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "resetChatHistory",
+ value: function resetChatHistory(channelUrl, opts) {
+ return this.resetChatHistoryWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Unhide or unarchive a channel
- * ## Unhide or unarchive a channel Makes a hidden or archived channel reappear in the channel list of either a specific user or entire channel members. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-unhide-or-unarchive-a-channel ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to unhide or unarchive.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} userId
+ * Start typing indicators
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.shouldUnhideAll
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/StartTypingIndicatorsRequest} opts.startTypingIndicatorsRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcUnhideOrUnarchiveChannelWithHttpInfo",
- value: function gcUnhideOrUnarchiveChannelWithHttpInfo(apiToken, channelUrl, userId, opts) {
+ key: "startTypingIndicatorsWithHttpInfo",
+ value: function startTypingIndicatorsWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcUnhideOrUnarchiveChannel");
- }
+ var postBody = opts['startTypingIndicatorsRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcUnhideOrUnarchiveChannel");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling gcUnhideOrUnarchiveChannel");
+ throw new Error("Missing the required parameter 'channelUrl' when calling startTypingIndicators");
}
var pathParams = {
'channel_url': channelUrl
};
- var queryParams = {
- 'user_id': userId,
- 'should_unhide_all': opts['shouldUnhideAll']
- };
+ var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = [];
+ var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/hide', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}/typing', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Unhide or unarchive a channel
- * ## Unhide or unarchive a channel Makes a hidden or archived channel reappear in the channel list of either a specific user or entire channel members. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-unhide-or-unarchive-a-channel ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to unhide or unarchive.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} userId
+ * Start typing indicators
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.shouldUnhideAll
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {String} opts.apiToken
+ * @param {module:model/StartTypingIndicatorsRequest} opts.startTypingIndicatorsRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcUnhideOrUnarchiveChannel",
- value: function gcUnhideOrUnarchiveChannel(apiToken, channelUrl, userId, opts) {
- return this.gcUnhideOrUnarchiveChannelWithHttpInfo(apiToken, channelUrl, userId, opts).then(function (response_and_data) {
+ key: "startTypingIndicators",
+ value: function startTypingIndicators(channelUrl, opts) {
+ return this.startTypingIndicatorsWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update a channel
- * ## Update a channel Updates information on a group channel. > __Note__: You can't change the members of the channel here. To do so, see [invite as members](#2-invite-as-members) action below. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-update-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Stop typing indicators
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcUpdateChannelByUrlData} opts.gcUpdateChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/StartTypingIndicatorsRequest} opts.startTypingIndicatorsRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcUpdateChannelByUrlWithHttpInfo",
- value: function gcUpdateChannelByUrlWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "stopTypingIndicatorsWithHttpInfo",
+ value: function stopTypingIndicatorsWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['gcUpdateChannelByUrlData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcUpdateChannelByUrl");
- }
+ var postBody = opts['startTypingIndicatorsRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcUpdateChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling stopTypingIndicators");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}/typing', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Update a channel
- * ## Update a channel Updates information on a group channel. > __Note__: You can't change the members of the channel here. To do so, see [invite as members](#2-invite-as-members) action below. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-update-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Stop typing indicators
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/GcUpdateChannelByUrlData} opts.gcUpdateChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
+ * @param {String} opts.apiToken
+ * @param {module:model/StartTypingIndicatorsRequest} opts.startTypingIndicatorsRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "gcUpdateChannelByUrl",
- value: function gcUpdateChannelByUrl(apiToken, channelUrl, opts) {
- return this.gcUpdateChannelByUrlWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "stopTypingIndicators",
+ value: function stopTypingIndicators(channelUrl, opts) {
+ return this.stopTypingIndicatorsWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * View a channel
- * ## View a channel Retrieves information on a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-view-a-channel ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Unhide a channel
+ * ## 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.
+ * @param {String} channelUrl (Required)
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.showDeliveryReceipt
- * @param {Boolean} opts.showReadReceipt
- * @param {Boolean} opts.showMember
- * @param {Boolean} opts.readReceipt
- * @param {Boolean} opts.member
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
+ * @param {Boolean} opts.shouldUnhideAll
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "gcViewChannelByUrlWithHttpInfo",
- value: function gcViewChannelByUrlWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "unhideAChannelWithHttpInfo",
+ value: function unhideAChannelWithHttpInfo(channelUrl, userId, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcViewChannelByUrl");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcViewChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling unhideAChannel");
+ }
+ // verify the required parameter 'userId' is set
+ if (userId === undefined || userId === null) {
+ throw new Error("Missing the required parameter 'userId' when calling unhideAChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {
- 'show_delivery_receipt': opts['showDeliveryReceipt'],
- 'show_read_receipt': opts['showReadReceipt'],
- 'show_member': opts['showMember'],
- 'read_receipt': opts['readReceipt'],
- 'member': opts['member']
+ 'user_id': userId,
+ 'should_unhide_all': opts['shouldUnhideAll']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}/hide', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View a channel
- * ## View a channel Retrieves information on a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-view-a-channel ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve.
- * @param {String} apiToken
+ * Unhide a channel
+ * ## 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.
+ * @param {String} channelUrl (Required)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {Boolean} opts.shouldUnhideAll
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
+ */
+ }, {
+ key: "unhideAChannel",
+ value: function unhideAChannel(channelUrl, userId, opts) {
+ return this.unhideAChannelWithHttpInfo(channelUrl, userId, opts).then(function (response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+ /**
+ * Update a group channel
+ * ## 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
* @param {String} channelUrl
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.showDeliveryReceipt
- * @param {Boolean} opts.showReadReceipt
- * @param {Boolean} opts.showMember
- * @param {Boolean} opts.readReceipt
- * @param {Boolean} opts.member
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAGroupChannelRequest} opts.updateAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdGroupChannelDetail} and HTTP response
+ */
+ }, {
+ key: "updateAGroupChannelWithHttpInfo",
+ value: function updateAGroupChannelWithHttpInfo(channelUrl, opts) {
+ opts = opts || {};
+ var postBody = opts['updateAGroupChannelRequest'];
+ // verify the required parameter 'channelUrl' is set
+ if (channelUrl === undefined || channelUrl === null) {
+ throw new Error("Missing the required parameter 'channelUrl' when calling updateAGroupChannel");
+ }
+ var pathParams = {
+ 'channel_url': channelUrl
+ };
+ var queryParams = {};
+ var headerParams = {
+ 'api-token': opts['apiToken']
+ };
+ var formParams = {};
+ var authNames = [];
+ var contentTypes = ['application/json'];
+ var accepts = ['application/json'];
+ var returnType = _SendbirdGroupChannelDetail["default"];
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ }
+
+ /**
+ * Update a group channel
+ * ## 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
+ * @param {String} channelUrl
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAGroupChannelRequest} opts.updateAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdGroupChannelDetail}
*/
}, {
- key: "gcViewChannelByUrl",
- value: function gcViewChannelByUrl(apiToken, channelUrl, opts) {
- return this.gcViewChannelByUrlWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "updateAGroupChannel",
+ value: function updateAGroupChannel(channelUrl, opts) {
+ return this.updateAGroupChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return GroupChannelApi;
-}();
-exports["default"] = GroupChannelApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/MessageApi.js b/dist/api/MessageApi.js
index dc5a7f4..2a7757a 100644
--- a/dist/api/MessageApi.js
+++ b/dist/api/MessageApi.js
@@ -5,48 +5,40 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AddEmojiCategoriesResponse = _interopRequireDefault(require("../model/AddEmojiCategoriesResponse"));
-var _AddEmojisData = _interopRequireDefault(require("../model/AddEmojisData"));
-var _AddEmojisResponse = _interopRequireDefault(require("../model/AddEmojisResponse"));
-var _AddExtraDataToMessageData = _interopRequireDefault(require("../model/AddExtraDataToMessageData"));
-var _AddExtraDataToMessageResponse = _interopRequireDefault(require("../model/AddExtraDataToMessageResponse"));
-var _AddReactionToAMessageData = _interopRequireDefault(require("../model/AddReactionToAMessageData"));
-var _AddReactionToAMessageResponse = _interopRequireDefault(require("../model/AddReactionToAMessageResponse"));
-var _EnableReactionsData = _interopRequireDefault(require("../model/EnableReactionsData"));
-var _EnableReactionsResponse = _interopRequireDefault(require("../model/EnableReactionsResponse"));
-var _GcMarkAllMessagesAsDeliveredData = _interopRequireDefault(require("../model/GcMarkAllMessagesAsDeliveredData"));
-var _GcMarkAllMessagesAsDeliveredResponse = _interopRequireDefault(require("../model/GcMarkAllMessagesAsDeliveredResponse"));
-var _GcMarkAllMessagesAsReadData = _interopRequireDefault(require("../model/GcMarkAllMessagesAsReadData"));
-var _GcViewNumberOfEachMembersUnreadMessagesResponse = _interopRequireDefault(require("../model/GcViewNumberOfEachMembersUnreadMessagesResponse"));
-var _ListAllEmojisAndEmojiCategoriesResponse = _interopRequireDefault(require("../model/ListAllEmojisAndEmojiCategoriesResponse"));
-var _ListAnnouncementsResponse = _interopRequireDefault(require("../model/ListAnnouncementsResponse"));
-var _ListEmojisResponse = _interopRequireDefault(require("../model/ListEmojisResponse"));
+var _AddExtraDataToAMessageRequest = _interopRequireDefault(require("../model/AddExtraDataToAMessageRequest"));
+var _AddExtraDataToAMessageResponse = _interopRequireDefault(require("../model/AddExtraDataToAMessageResponse"));
+var _GetTotalNumberOfMessagesInAChannelResponse = _interopRequireDefault(require("../model/GetTotalNumberOfMessagesInAChannelResponse"));
var _ListMessagesResponse = _interopRequireDefault(require("../model/ListMessagesResponse"));
-var _ListReactionsOfMessageResponse = _interopRequireDefault(require("../model/ListReactionsOfMessageResponse"));
-var _RemoveReactionFromAMessageResponse = _interopRequireDefault(require("../model/RemoveReactionFromAMessageResponse"));
-var _SendBirdEmoji = _interopRequireDefault(require("../model/SendBirdEmoji"));
-var _SendBirdEmojiCategory = _interopRequireDefault(require("../model/SendBirdEmojiCategory"));
-var _SendBirdMessageResponse = _interopRequireDefault(require("../model/SendBirdMessageResponse"));
-var _SendMessageData = _interopRequireDefault(require("../model/SendMessageData"));
-var _TranslateMessageIntoOtherLanguagesData = _interopRequireDefault(require("../model/TranslateMessageIntoOtherLanguagesData"));
-var _UpdateEmojiCategoryUrlByIdData = _interopRequireDefault(require("../model/UpdateEmojiCategoryUrlByIdData"));
-var _UpdateEmojiUrlByKeyData = _interopRequireDefault(require("../model/UpdateEmojiUrlByKeyData"));
-var _UpdateExtraDataInMessageData = _interopRequireDefault(require("../model/UpdateExtraDataInMessageData"));
-var _UpdateExtraDataInMessageResponse = _interopRequireDefault(require("../model/UpdateExtraDataInMessageResponse"));
-var _UpdateMessageByIdData = _interopRequireDefault(require("../model/UpdateMessageByIdData"));
-var _UseDefaultEmojisData = _interopRequireDefault(require("../model/UseDefaultEmojisData"));
-var _UseDefaultEmojisResponse = _interopRequireDefault(require("../model/UseDefaultEmojisResponse"));
-var _ViewTotalNumberOfMessagesInChannelResponse = _interopRequireDefault(require("../model/ViewTotalNumberOfMessagesInChannelResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _MarkChannelMessagesAsReadRequest = _interopRequireDefault(require("../model/MarkChannelMessagesAsReadRequest"));
+var _SendAMessageRequest = _interopRequireDefault(require("../model/SendAMessageRequest"));
+var _SendbirdMessageResponse = _interopRequireDefault(require("../model/SendbirdMessageResponse"));
+var _UpdateAMessageRequest = _interopRequireDefault(require("../model/UpdateAMessageRequest"));
+var _UpdateExtraDataInAMessageRequest = _interopRequireDefault(require("../model/UpdateExtraDataInAMessageRequest"));
+var _UpdateExtraDataInAMessageResponse = _interopRequireDefault(require("../model/UpdateExtraDataInAMessageResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* Message service.
* @module api/MessageApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var MessageApi = /*#__PURE__*/function () {
+var MessageApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new MessageApi.
* @alias module:api/MessageApi
@@ -60,1184 +52,162 @@ var MessageApi = /*#__PURE__*/function () {
}
/**
- * Add emoji categories
- * ## Add emoji categories Adds a list of one or more new emoji categories to the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-add-emoji-categories
- * @param {String} apiToken
+ * Add extra data to a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddEmojiCategoriesResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/AddExtraDataToAMessageRequest} opts.addExtraDataToAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddExtraDataToAMessageResponse} and HTTP response
*/
- _createClass(MessageApi, [{
- key: "addEmojiCategoriesWithHttpInfo",
- value: function addEmojiCategoriesWithHttpInfo(apiToken, opts) {
+ return _createClass(MessageApi, [{
+ key: "addExtraDataToAMessageWithHttpInfo",
+ value: function addExtraDataToAMessageWithHttpInfo(channelType, channelUrl, messageId, opts) {
opts = opts || {};
- var postBody = opts['body'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addEmojiCategories");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddEmojiCategoriesResponse["default"];
- return this.apiClient.callApi('/v3/emoji_categories', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add emoji categories
- * ## Add emoji categories Adds a list of one or more new emoji categories to the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-add-emoji-categories
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddEmojiCategoriesResponse}
- */
- }, {
- key: "addEmojiCategories",
- value: function addEmojiCategories(apiToken, opts) {
- return this.addEmojiCategoriesWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Add emojis
- * ## Add emojis Adds a list of one or more new emojis to the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-add-emojis
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddEmojisData} opts.addEmojisData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddEmojisResponse} and HTTP response
- */
- }, {
- key: "addEmojisWithHttpInfo",
- value: function addEmojisWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['addEmojisData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addEmojis");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddEmojisResponse["default"];
- return this.apiClient.callApi('/v3/emojis', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add emojis
- * ## Add emojis Adds a list of one or more new emojis to the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-add-emojis
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/AddEmojisData} opts.addEmojisData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddEmojisResponse}
- */
- }, {
- key: "addEmojis",
- value: function addEmojis(apiToken, opts) {
- return this.addEmojisWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Add extra data to a message
- * ## 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/v3/platform-api/guides/messages#2-add-extra-data-to-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/AddExtraDataToMessageData} opts.addExtraDataToMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddExtraDataToMessageResponse} and HTTP response
- */
- }, {
- key: "addExtraDataToMessageWithHttpInfo",
- value: function addExtraDataToMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
- opts = opts || {};
- var postBody = opts['addExtraDataToMessageData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addExtraDataToMessage");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling addExtraDataToMessage");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling addExtraDataToMessage");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling addExtraDataToMessage");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddExtraDataToMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add extra data to a message
- * ## 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/v3/platform-api/guides/messages#2-add-extra-data-to-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/AddExtraDataToMessageData} opts.addExtraDataToMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddExtraDataToMessageResponse}
- */
- }, {
- key: "addExtraDataToMessage",
- value: function addExtraDataToMessage(apiToken, channelType, channelUrl, messageId, opts) {
- return this.addExtraDataToMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Add a reaction to a message
- * ## Add a reaction to a message Adds a specific reaction to a message. > __Note__: Currently, this action is only available in group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-add-a-reaction-to-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/AddReactionToAMessageData} opts.addReactionToAMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddReactionToAMessageResponse} and HTTP response
- */
- }, {
- key: "addReactionToAMessageWithHttpInfo",
- value: function addReactionToAMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
- opts = opts || {};
- var postBody = opts['addReactionToAMessageData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addReactionToAMessage");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling addReactionToAMessage");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling addReactionToAMessage");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling addReactionToAMessage");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _AddReactionToAMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/reactions', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Add a reaction to a message
- * ## Add a reaction to a message Adds a specific reaction to a message. > __Note__: Currently, this action is only available in group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-add-a-reaction-to-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/AddReactionToAMessageData} opts.addReactionToAMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddReactionToAMessageResponse}
- */
- }, {
- key: "addReactionToAMessage",
- value: function addReactionToAMessage(apiToken, channelType, channelUrl, messageId, opts) {
- return this.addReactionToAMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete an emoji
- * ## Delete an emoji Deletes an emoji from the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-delete-an-emoji ----------------------------
- * @param {String} apiToken
- * @param {String} emojiKey
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteEmojiByKeyWithHttpInfo",
- value: function deleteEmojiByKeyWithHttpInfo(apiToken, emojiKey) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteEmojiByKey");
- }
- // verify the required parameter 'emojiKey' is set
- if (emojiKey === undefined || emojiKey === null) {
- throw new Error("Missing the required parameter 'emojiKey' when calling deleteEmojiByKey");
- }
- var pathParams = {
- 'emoji_key': emojiKey
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/emojis/{emoji_key}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete an emoji
- * ## Delete an emoji Deletes an emoji from the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-delete-an-emoji ----------------------------
- * @param {String} apiToken
- * @param {String} emojiKey
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteEmojiByKey",
- value: function deleteEmojiByKey(apiToken, emojiKey) {
- return this.deleteEmojiByKeyWithHttpInfo(apiToken, emojiKey).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete an emoji category
- * ## Delete an emoji category Deletes an emoji category with the specified ID. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-delete-an-emoji-category ----------------------------
- * @param {String} apiToken
- * @param {String} emojiCategoryId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "deleteEmojiCategoryByIdWithHttpInfo",
- value: function deleteEmojiCategoryByIdWithHttpInfo(apiToken, emojiCategoryId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteEmojiCategoryById");
- }
- // verify the required parameter 'emojiCategoryId' is set
- if (emojiCategoryId === undefined || emojiCategoryId === null) {
- throw new Error("Missing the required parameter 'emojiCategoryId' when calling deleteEmojiCategoryById");
- }
- var pathParams = {
- 'emoji_category_id': emojiCategoryId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/emoji_categories/{emoji_category_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete an emoji category
- * ## Delete an emoji category Deletes an emoji category with the specified ID. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-delete-an-emoji-category ----------------------------
- * @param {String} apiToken
- * @param {String} emojiCategoryId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "deleteEmojiCategoryById",
- value: function deleteEmojiCategoryById(apiToken, emojiCategoryId) {
- return this.deleteEmojiCategoryByIdWithHttpInfo(apiToken, emojiCategoryId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a message
- * ## Delete a message Deletes a message from a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-delete-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "deleteMessageByIdWithHttpInfo",
- value: function deleteMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteMessageById");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling deleteMessageById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling deleteMessageById");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling deleteMessageById");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a message
- * ## Delete a message Deletes a message from a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-delete-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "deleteMessageById",
- value: function deleteMessageById(apiToken, channelType, channelUrl, messageId) {
- return this.deleteMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Enable reactions
- * ## Enable reactions Turn on or off reactions in a Sendbird application. > __Note__: This action also allows reactions in UIKit. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-enable-reactions
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/EnableReactionsData} opts.enableReactionsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EnableReactionsResponse} and HTTP response
- */
- }, {
- key: "enableReactionsWithHttpInfo",
- value: function enableReactionsWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['enableReactionsData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling enableReactions");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _EnableReactionsResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/reactions', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Enable reactions
- * ## Enable reactions Turn on or off reactions in a Sendbird application. > __Note__: This action also allows reactions in UIKit. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-enable-reactions
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/EnableReactionsData} opts.enableReactionsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EnableReactionsResponse}
- */
- }, {
- key: "enableReactions",
- value: function enableReactions(apiToken, opts) {
- return this.enableReactionsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Mark all messages as delivered
- * ## Mark all messages as delivered Marks all messages in a group channel as delivered for a given user. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-mark-all-messages-as-delivered ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcMarkAllMessagesAsDeliveredData} opts.gcMarkAllMessagesAsDeliveredData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcMarkAllMessagesAsDeliveredResponse} and HTTP response
- */
- }, {
- key: "gcMarkAllMessagesAsDeliveredWithHttpInfo",
- value: function gcMarkAllMessagesAsDeliveredWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['gcMarkAllMessagesAsDeliveredData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcMarkAllMessagesAsDelivered");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcMarkAllMessagesAsDelivered");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _GcMarkAllMessagesAsDeliveredResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/messages/mark_as_delivered', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Mark all messages as delivered
- * ## Mark all messages as delivered Marks all messages in a group channel as delivered for a given user. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-mark-all-messages-as-delivered ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcMarkAllMessagesAsDeliveredData} opts.gcMarkAllMessagesAsDeliveredData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcMarkAllMessagesAsDeliveredResponse}
- */
- }, {
- key: "gcMarkAllMessagesAsDelivered",
- value: function gcMarkAllMessagesAsDelivered(apiToken, channelUrl, opts) {
- return this.gcMarkAllMessagesAsDeliveredWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Mark all messages as read
- * ## Mark all messages as read Marks all messages in a group channel as read for a given user. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-mark-all-messages-as-read ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcMarkAllMessagesAsReadData} opts.gcMarkAllMessagesAsReadData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "gcMarkAllMessagesAsReadWithHttpInfo",
- value: function gcMarkAllMessagesAsReadWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['gcMarkAllMessagesAsReadData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcMarkAllMessagesAsRead");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcMarkAllMessagesAsRead");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/messages/mark_as_read', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Mark all messages as read
- * ## Mark all messages as read Marks all messages in a group channel as read for a given user. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-mark-all-messages-as-read ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcMarkAllMessagesAsReadData} opts.gcMarkAllMessagesAsReadData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "gcMarkAllMessagesAsRead",
- value: function gcMarkAllMessagesAsRead(apiToken, channelUrl, opts) {
- return this.gcMarkAllMessagesAsReadWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View number of each member's unread messages
- * ## View number of each member's unread messages Retrieves the total number of each member's unread messages in a group channel. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-view-number-of-each-member-s-unread-messages ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.userIds
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcViewNumberOfEachMembersUnreadMessagesResponse} and HTTP response
- */
- }, {
- key: "gcViewNumberOfEachMembersUnreadMessagesWithHttpInfo",
- value: function gcViewNumberOfEachMembersUnreadMessagesWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcViewNumberOfEachMembersUnreadMessages");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcViewNumberOfEachMembersUnreadMessages");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'user_ids': opts['userIds']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GcViewNumberOfEachMembersUnreadMessagesResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/messages/unread_count', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View number of each member's unread messages
- * ## View number of each member's unread messages Retrieves the total number of each member's unread messages in a group channel. This action is only applicable for users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-view-number-of-each-member-s-unread-messages ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.userIds
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcViewNumberOfEachMembersUnreadMessagesResponse}
- */
- }, {
- key: "gcViewNumberOfEachMembersUnreadMessages",
- value: function gcViewNumberOfEachMembersUnreadMessages(apiToken, channelUrl, opts) {
- return this.gcViewNumberOfEachMembersUnreadMessagesWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Get an emoji
- * ## Get an emoji Retrieves an emoji with the specified key. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-get-an-emoji ----------------------------
- * @param {String} apiToken
- * @param {String} emojiKey
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdEmoji} and HTTP response
- */
- }, {
- key: "getEmojiByKeyWithHttpInfo",
- value: function getEmojiByKeyWithHttpInfo(apiToken, emojiKey) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getEmojiByKey");
- }
- // verify the required parameter 'emojiKey' is set
- if (emojiKey === undefined || emojiKey === null) {
- throw new Error("Missing the required parameter 'emojiKey' when calling getEmojiByKey");
- }
- var pathParams = {
- 'emoji_key': emojiKey
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _SendBirdEmoji["default"];
- return this.apiClient.callApi('/v3/emojis/{emoji_key}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get an emoji
- * ## Get an emoji Retrieves an emoji with the specified key. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-get-an-emoji ----------------------------
- * @param {String} apiToken
- * @param {String} emojiKey
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdEmoji}
- */
- }, {
- key: "getEmojiByKey",
- value: function getEmojiByKey(apiToken, emojiKey) {
- return this.getEmojiByKeyWithHttpInfo(apiToken, emojiKey).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Get an emoji category
- * ## Get an emoji category Retrieves an emoji category with the specified ID, including its emojis. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-get-an-emoji-category ---------------------------- `emoji_category_id` Type: int Description: Specifies the unique ID of the emoji category to retrieve.
- * @param {String} apiToken
- * @param {String} emojiCategoryId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdEmojiCategory} and HTTP response
- */
- }, {
- key: "getEmojiCategoryByIdWithHttpInfo",
- value: function getEmojiCategoryByIdWithHttpInfo(apiToken, emojiCategoryId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getEmojiCategoryById");
- }
- // verify the required parameter 'emojiCategoryId' is set
- if (emojiCategoryId === undefined || emojiCategoryId === null) {
- throw new Error("Missing the required parameter 'emojiCategoryId' when calling getEmojiCategoryById");
- }
- var pathParams = {
- 'emoji_category_id': emojiCategoryId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _SendBirdEmojiCategory["default"];
- return this.apiClient.callApi('/v3/emoji_categories/{emoji_category_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get an emoji category
- * ## Get an emoji category Retrieves an emoji category with the specified ID, including its emojis. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-get-an-emoji-category ---------------------------- `emoji_category_id` Type: int Description: Specifies the unique ID of the emoji category to retrieve.
- * @param {String} apiToken
- * @param {String} emojiCategoryId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdEmojiCategory}
- */
- }, {
- key: "getEmojiCategoryById",
- value: function getEmojiCategoryById(apiToken, emojiCategoryId) {
- return this.getEmojiCategoryByIdWithHttpInfo(apiToken, emojiCategoryId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List all emojis and emoji categories
- * ## List all emojis and emoji categories Retrieves a list of all emoji categories registered to the application, including their emojis. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-list-all-emojis-and-emoji-categories
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAllEmojisAndEmojiCategoriesResponse} and HTTP response
- */
- }, {
- key: "listAllEmojisAndEmojiCategoriesWithHttpInfo",
- value: function listAllEmojisAndEmojiCategoriesWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listAllEmojisAndEmojiCategories");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListAllEmojisAndEmojiCategoriesResponse["default"];
- return this.apiClient.callApi('/v3/emoji_categories', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List all emojis and emoji categories
- * ## List all emojis and emoji categories Retrieves a list of all emoji categories registered to the application, including their emojis. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-list-all-emojis-and-emoji-categories
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListAllEmojisAndEmojiCategoriesResponse}
- */
- }, {
- key: "listAllEmojisAndEmojiCategories",
- value: function listAllEmojisAndEmojiCategories(apiToken) {
- return this.listAllEmojisAndEmojiCategoriesWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List announcements
- * ## List announcements Retrieves a list of announcements. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-list-announcements ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.order
- * @param {String} opts.status
- * @param {String} opts.announcementGroup
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAnnouncementsResponse} and HTTP response
- */
- }, {
- key: "listAnnouncementsWithHttpInfo",
- value: function listAnnouncementsWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listAnnouncements");
- }
- var pathParams = {};
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit'],
- 'order': opts['order'],
- 'status': opts['status'],
- 'announcement_group': opts['announcementGroup']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListAnnouncementsResponse["default"];
- return this.apiClient.callApi('/v3/announcements', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List announcements
- * ## List announcements Retrieves a list of announcements. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-list-announcements ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.order
- * @param {String} opts.status
- * @param {String} opts.announcementGroup
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListAnnouncementsResponse}
- */
- }, {
- key: "listAnnouncements",
- value: function listAnnouncements(apiToken, opts) {
- return this.listAnnouncementsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List emojis
- * ## List emojis Retrieves a list of all emojis registered to the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-list-emojis
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListEmojisResponse} and HTTP response
- */
- }, {
- key: "listEmojisWithHttpInfo",
- value: function listEmojisWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listEmojis");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListEmojisResponse["default"];
- return this.apiClient.callApi('/v3/emojis', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List emojis
- * ## List emojis Retrieves a list of all emojis registered to the application. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-list-emojis
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListEmojisResponse}
- */
- }, {
- key: "listEmojis",
- value: function listEmojis(apiToken) {
- return this.listEmojisWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List messages
- * ## List messages Retrieves a list of past messages of a channel. > This message retrieval is one of Sendbird's [premium features](https://sendbird.com/docs/chat/v3/platform-api/guides/application#-3-sendbird-s-premium-features). Contact our [sales team](https://get.sendbird.com/talk-to-sales.html) for further assistance. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.messageTs
- * @param {Number} opts.messageId
- * @param {Number} opts.prevLimit
- * @param {Number} opts.nextLimit
- * @param {Boolean} opts.include
- * @param {Boolean} opts.reverse
- * @param {String} opts.senderId
- * @param {String} opts.senderIds
- * @param {String} opts.operatorFilter
- * @param {String} opts.customTypes
- * @param {String} opts.messageType
- * @param {Boolean} opts.includingRemoved
- * @param {Boolean} opts.includeReactions
- * @param {Boolean} opts.withSortedMetaArray
- * @param {Boolean} opts.showSubchannelMessagesOnly
- * @param {String} opts.userId
- * @param {String} opts.customType
- * @param {Boolean} opts.withMetaArray
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMessagesResponse} and HTTP response
- */
- }, {
- key: "listMessagesWithHttpInfo",
- value: function listMessagesWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listMessages");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling listMessages");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling listMessages");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'message_ts': opts['messageTs'],
- 'message_id': opts['messageId'],
- 'prev_limit': opts['prevLimit'],
- 'next_limit': opts['nextLimit'],
- 'include': opts['include'],
- 'reverse': opts['reverse'],
- 'sender_id': opts['senderId'],
- 'sender_ids': opts['senderIds'],
- 'operator_filter': opts['operatorFilter'],
- 'custom_types': opts['customTypes'],
- 'message_type': opts['messageType'],
- 'including_removed': opts['includingRemoved'],
- 'include_reactions': opts['includeReactions'],
- 'with_sorted_meta_array': opts['withSortedMetaArray'],
- 'show_subchannel_messages_only': opts['showSubchannelMessagesOnly'],
- 'user_id': opts['userId'],
- 'custom_type': opts['customType'],
- 'with_meta_array': opts['withMetaArray']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListMessagesResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List messages
- * ## List messages Retrieves a list of past messages of a channel. > This message retrieval is one of Sendbird's [premium features](https://sendbird.com/docs/chat/v3/platform-api/guides/application#-3-sendbird-s-premium-features). Contact our [sales team](https://get.sendbird.com/talk-to-sales.html) for further assistance. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.messageTs
- * @param {Number} opts.messageId
- * @param {Number} opts.prevLimit
- * @param {Number} opts.nextLimit
- * @param {Boolean} opts.include
- * @param {Boolean} opts.reverse
- * @param {String} opts.senderId
- * @param {String} opts.senderIds
- * @param {String} opts.operatorFilter
- * @param {String} opts.customTypes
- * @param {String} opts.messageType
- * @param {Boolean} opts.includingRemoved
- * @param {Boolean} opts.includeReactions
- * @param {Boolean} opts.withSortedMetaArray
- * @param {Boolean} opts.showSubchannelMessagesOnly
- * @param {String} opts.userId
- * @param {String} opts.customType
- * @param {Boolean} opts.withMetaArray
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMessagesResponse}
- */
- }, {
- key: "listMessages",
- value: function listMessages(apiToken, channelType, channelUrl, opts) {
- return this.listMessagesWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List reactions of a message
- * ## List reactions of a message Retrieves a list of reactions made to a message. > __Note__: Currently, this action is only available in group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-list-reactions-of-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 add a reaction to.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.listUsers
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListReactionsOfMessageResponse} and HTTP response
- */
- }, {
- key: "listReactionsOfMessageWithHttpInfo",
- value: function listReactionsOfMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listReactionsOfMessage");
- }
+ var postBody = opts['addExtraDataToAMessageRequest'];
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling listReactionsOfMessage");
+ throw new Error("Missing the required parameter 'channelType' when calling addExtraDataToAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling listReactionsOfMessage");
+ throw new Error("Missing the required parameter 'channelUrl' when calling addExtraDataToAMessage");
}
// verify the required parameter 'messageId' is set
if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling listReactionsOfMessage");
+ throw new Error("Missing the required parameter 'messageId' when calling addExtraDataToAMessage");
}
var pathParams = {
'channel_type': channelType,
'channel_url': channelUrl,
'message_id': messageId
};
- var queryParams = {
- 'list_users': opts['listUsers']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListReactionsOfMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/reactions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List reactions of a message
- * ## List reactions of a message Retrieves a list of reactions made to a message. > __Note__: Currently, this action is only available in group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-list-reactions-of-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 add a reaction to.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.listUsers
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListReactionsOfMessageResponse}
- */
- }, {
- key: "listReactionsOfMessage",
- value: function listReactionsOfMessage(apiToken, channelType, channelUrl, messageId, opts) {
- return this.listReactionsOfMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Migrate messages
- * ## 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/v3/platform-api/guides/migration#2-migrate-messages ----------------------------
- * @param {String} apiToken
- * @param {String} targetChannelUrl
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "migrateMessagesByUrlWithHttpInfo",
- value: function migrateMessagesByUrlWithHttpInfo(apiToken, targetChannelUrl, opts) {
- opts = opts || {};
- var postBody = opts['body'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling migrateMessagesByUrl");
- }
- // verify the required parameter 'targetChannelUrl' is set
- if (targetChannelUrl === undefined || targetChannelUrl === null) {
- throw new Error("Missing the required parameter 'targetChannelUrl' when calling migrateMessagesByUrl");
- }
- var pathParams = {
- 'target_channel_url': targetChannelUrl
- };
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/migration/{target_channel_url}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var accepts = ['application/json'];
+ var returnType = _AddExtraDataToAMessageResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Migrate messages
- * ## 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/v3/platform-api/guides/migration#2-migrate-messages ----------------------------
- * @param {String} apiToken
- * @param {String} targetChannelUrl
+ * Add extra data to a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+ * @param {String} opts.apiToken
+ * @param {module:model/AddExtraDataToAMessageRequest} opts.addExtraDataToAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddExtraDataToAMessageResponse}
*/
}, {
- key: "migrateMessagesByUrl",
- value: function migrateMessagesByUrl(apiToken, targetChannelUrl, opts) {
- return this.migrateMessagesByUrlWithHttpInfo(apiToken, targetChannelUrl, opts).then(function (response_and_data) {
+ key: "addExtraDataToAMessage",
+ value: function addExtraDataToAMessage(channelType, channelUrl, messageId, opts) {
+ return this.addExtraDataToAMessageWithHttpInfo(channelType, channelUrl, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Remove extra data from a message
- * ## Remove extra data from a message Removes specific items from a message by their keys. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-remove-extra-data-from-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Delete a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {Array.} opts.keys
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "removeExtraDataFromMessageWithHttpInfo",
- value: function removeExtraDataFromMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
+ key: "deleteAMessageWithHttpInfo",
+ value: function deleteAMessageWithHttpInfo(channelType, channelUrl, messageId, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling removeExtraDataFromMessage");
- }
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling removeExtraDataFromMessage");
+ throw new Error("Missing the required parameter 'channelType' when calling deleteAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling removeExtraDataFromMessage");
+ throw new Error("Missing the required parameter 'channelUrl' when calling deleteAMessage");
}
// verify the required parameter 'messageId' is set
if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling removeExtraDataFromMessage");
+ throw new Error("Missing the required parameter 'messageId' when calling deleteAMessage");
}
var pathParams = {
'channel_type': channelType,
'channel_url': channelUrl,
'message_id': messageId
};
- var queryParams = {
- 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi')
- };
+ var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
var returnType = Object;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Remove extra data from a message
- * ## Remove extra data from a message Removes specific items from a message by their keys. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-remove-extra-data-from-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Delete a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {Array.} opts.keys
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "removeExtraDataFromMessage",
- value: function removeExtraDataFromMessage(apiToken, channelType, channelUrl, messageId, opts) {
- return this.removeExtraDataFromMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
+ key: "deleteAMessage",
+ value: function deleteAMessage(channelType, channelUrl, messageId, opts) {
+ return this.deleteAMessageWithHttpInfo(channelType, channelUrl, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Remove a reaction from a message
- * ## Remove a reaction from a message Removes a specific reaction from a message. > __Note__: Currently, this action is only available in group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-remove-a-reaction-from-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Get a message
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.userId
- * @param {String} opts.reaction
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveReactionFromAMessageResponse} and HTTP response
+ * @param {Boolean} opts.includeReactions
+ * @param {Boolean} opts.includeThreadInfo
+ * @param {Boolean} opts.includeParentMessageInfo
+ * @param {Boolean} opts.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.
+ * @param {Boolean} opts.withSortedMetaArray
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdMessageResponse} and HTTP response
*/
}, {
- key: "removeReactionFromAMessageWithHttpInfo",
- value: function removeReactionFromAMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
+ key: "getAMessageWithHttpInfo",
+ value: function getAMessageWithHttpInfo(channelType, channelUrl, messageId, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling removeReactionFromAMessage");
- }
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling removeReactionFromAMessage");
+ throw new Error("Missing the required parameter 'channelType' when calling getAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling removeReactionFromAMessage");
+ throw new Error("Missing the required parameter 'channelUrl' when calling getAMessage");
}
// verify the required parameter 'messageId' is set
if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling removeReactionFromAMessage");
+ throw new Error("Missing the required parameter 'messageId' when calling getAMessage");
}
var pathParams = {
'channel_type': channelType,
@@ -1245,66 +215,67 @@ var MessageApi = /*#__PURE__*/function () {
'message_id': messageId
};
var queryParams = {
- 'user_id': opts['userId'],
- 'reaction': opts['reaction']
+ 'include_reactions': opts['includeReactions'],
+ 'include_thread_info': opts['includeThreadInfo'],
+ 'include_parent_message_info': opts['includeParentMessageInfo'],
+ 'include_poll_details': opts['includePollDetails'],
+ 'with_sorted_meta_array': opts['withSortedMetaArray']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _RemoveReactionFromAMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/reactions', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdMessageResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Remove a reaction from a message
- * ## Remove a reaction from a message Removes a specific reaction from a message. > __Note__: Currently, this action is only available in group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-remove-a-reaction-from-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Get a message
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.userId
- * @param {String} opts.reaction
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveReactionFromAMessageResponse}
+ * @param {Boolean} opts.includeReactions
+ * @param {Boolean} opts.includeThreadInfo
+ * @param {Boolean} opts.includeParentMessageInfo
+ * @param {Boolean} opts.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.
+ * @param {Boolean} opts.withSortedMetaArray
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdMessageResponse}
*/
}, {
- key: "removeReactionFromAMessage",
- value: function removeReactionFromAMessage(apiToken, channelType, channelUrl, messageId, opts) {
- return this.removeReactionFromAMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
+ key: "getAMessage",
+ value: function getAMessage(channelType, channelUrl, messageId, opts) {
+ return this.getAMessageWithHttpInfo(channelType, channelUrl, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Send a message
- * ## Send a message Sends a message to a channel. You can send a text message, a file message, and an admin message. >__Note__: With Sendbird Chat SDKs and the platform API, any type of files in messages can be uploaded to Sendbird server. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-send-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
+ * Get total number of messages in a channel
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/SendMessageData} opts.sendMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdMessageResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTotalNumberOfMessagesInAChannelResponse} and HTTP response
*/
}, {
- key: "sendMessageWithHttpInfo",
- value: function sendMessageWithHttpInfo(apiToken, channelType, channelUrl, opts) {
+ key: "getTotalNumberOfMessagesInAChannelWithHttpInfo",
+ value: function getTotalNumberOfMessagesInAChannelWithHttpInfo(channelType, channelUrl, opts) {
opts = opts || {};
- var postBody = opts['sendMessageData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling sendMessage");
- }
+ var postBody = null;
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling sendMessage");
+ throw new Error("Missing the required parameter 'channelType' when calling getTotalNumberOfMessagesInAChannel");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling sendMessage");
+ throw new Error("Missing the required parameter 'channelUrl' when calling getTotalNumberOfMessagesInAChannel");
}
var pathParams = {
'channel_type': channelType,
@@ -1312,521 +283,506 @@ var MessageApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = ['application/json'];
+ var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _SendBirdMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _GetTotalNumberOfMessagesInAChannelResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/total_count', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Send a message
- * ## Send a message Sends a message to a channel. You can send a text message, a file message, and an admin message. >__Note__: With Sendbird Chat SDKs and the platform API, any type of files in messages can be uploaded to Sendbird server. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-send-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
+ * Get total number of messages in a channel
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/SendMessageData} opts.sendMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdMessageResponse}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTotalNumberOfMessagesInAChannelResponse}
*/
}, {
- key: "sendMessage",
- value: function sendMessage(apiToken, channelType, channelUrl, opts) {
- return this.sendMessageWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
+ key: "getTotalNumberOfMessagesInAChannel",
+ value: function getTotalNumberOfMessagesInAChannel(channelType, channelUrl, opts) {
+ return this.getTotalNumberOfMessagesInAChannelWithHttpInfo(channelType, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Translate a message into other languages
- * ## Translate a message into other languages Translates a message into specific languages. Only text messages of which type is MESG can be translated into other languages. > __Note__: Message translation is powered by [Google Cloud Translation API recognition engine](https://cloud.google.com/translate/). Find language codes supported by the engine in the [Miscellaneous](https://sendbird.com/docs/chat/v3/platform-api/guides/Miscellaneous) page or visit the [Language Support](https://cloud.google.com/translate/docs/languages) for Google Cloud Translation. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-translate-a-message-into-other-languages ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/TranslateMessageIntoOtherLanguagesData} opts.translateMessageIntoOtherLanguagesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdMessageResponse} and HTTP response
+ * List messages
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {Number} 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.
+ * @param {Number} 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.
+ * @param {Object} opts Optional parameters
+ * @param {Number} opts.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)
+ * @param {Number} opts.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)
+ * @param {Boolean} opts.include Determines whether to include messages sent exactly on the specified message_ts in the results. (Default: true)
+ * @param {Boolean} opts.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)
+ * @param {String} opts.senderId Restricts the search scope to only retrieve messages sent by the user with the specified ID.
+ * @param {String} opts.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.
+ * @param {module:model/String} opts.operatorFilter
+ * @param {String} opts.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.
+ * @param {module:model/String} opts.messageType
+ * @param {Boolean} opts.includingRemoved
+ * @param {Boolean} opts.includeReactions
+ * @param {module:model/String} opts.includeReplyType One of following values: NONE, ALL, ONLY_REPLY_TO_CHANNEL
+ * @param {Boolean} opts.includeParentMessageInfo
+ * @param {Boolean} opts.includeThreadInfo
+ * @param {Boolean} opts.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.
+ * @param {Boolean} opts.withSortedMetaArray Determines whether to include the sorted_metaarray property in the response. (Default: false)
+ * @param {Boolean} opts.showSubchannelMessagesOnly
+ * @param {String} opts.userId
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMessagesResponse} and HTTP response
*/
}, {
- key: "translateMessageIntoOtherLanguagesWithHttpInfo",
- value: function translateMessageIntoOtherLanguagesWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
+ key: "listMessagesWithHttpInfo",
+ value: function listMessagesWithHttpInfo(channelType, channelUrl, messageTs, messageId, opts) {
opts = opts || {};
- var postBody = opts['translateMessageIntoOtherLanguagesData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling translateMessageIntoOtherLanguages");
- }
+ var postBody = null;
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling translateMessageIntoOtherLanguages");
+ throw new Error("Missing the required parameter 'channelType' when calling listMessages");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling translateMessageIntoOtherLanguages");
+ throw new Error("Missing the required parameter 'channelUrl' when calling listMessages");
+ }
+ // verify the required parameter 'messageTs' is set
+ if (messageTs === undefined || messageTs === null) {
+ throw new Error("Missing the required parameter 'messageTs' when calling listMessages");
}
// verify the required parameter 'messageId' is set
if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling translateMessageIntoOtherLanguages");
+ throw new Error("Missing the required parameter 'messageId' when calling listMessages");
}
var pathParams = {
'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
+ 'channel_url': channelUrl
+ };
+ var queryParams = {
+ 'message_ts': messageTs,
+ 'message_id': messageId,
+ 'prev_limit': opts['prevLimit'],
+ 'next_limit': opts['nextLimit'],
+ 'include': opts['include'],
+ 'reverse': opts['reverse'],
+ 'sender_id': opts['senderId'],
+ 'sender_ids': opts['senderIds'],
+ 'operator_filter': opts['operatorFilter'],
+ 'custom_types': opts['customTypes'],
+ 'message_type': opts['messageType'],
+ 'including_removed': opts['includingRemoved'],
+ 'include_reactions': opts['includeReactions'],
+ 'include_reply_type': opts['includeReplyType'],
+ 'include_parent_message_info': opts['includeParentMessageInfo'],
+ 'include_thread_info': opts['includeThreadInfo'],
+ 'include_poll_details': opts['includePollDetails'],
+ 'with_sorted_meta_array': opts['withSortedMetaArray'],
+ 'show_subchannel_messages_only': opts['showSubchannelMessagesOnly'],
+ 'user_id': opts['userId']
};
- var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = ['application/json'];
+ var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _SendBirdMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/translation', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _ListMessagesResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Translate a message into other languages
- * ## Translate a message into other languages Translates a message into specific languages. Only text messages of which type is MESG can be translated into other languages. > __Note__: Message translation is powered by [Google Cloud Translation API recognition engine](https://cloud.google.com/translate/). Find language codes supported by the engine in the [Miscellaneous](https://sendbird.com/docs/chat/v3/platform-api/guides/Miscellaneous) page or visit the [Language Support](https://cloud.google.com/translate/docs/languages) for Google Cloud Translation. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-translate-a-message-into-other-languages ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/TranslateMessageIntoOtherLanguagesData} opts.translateMessageIntoOtherLanguagesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdMessageResponse}
+ * List messages
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {Number} 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.
+ * @param {Number} 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.
+ * @param {Object} opts Optional parameters
+ * @param {Number} opts.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)
+ * @param {Number} opts.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)
+ * @param {Boolean} opts.include Determines whether to include messages sent exactly on the specified message_ts in the results. (Default: true)
+ * @param {Boolean} opts.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)
+ * @param {String} opts.senderId Restricts the search scope to only retrieve messages sent by the user with the specified ID.
+ * @param {String} opts.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.
+ * @param {module:model/String} opts.operatorFilter
+ * @param {String} opts.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.
+ * @param {module:model/String} opts.messageType
+ * @param {Boolean} opts.includingRemoved
+ * @param {Boolean} opts.includeReactions
+ * @param {module:model/String} opts.includeReplyType One of following values: NONE, ALL, ONLY_REPLY_TO_CHANNEL
+ * @param {Boolean} opts.includeParentMessageInfo
+ * @param {Boolean} opts.includeThreadInfo
+ * @param {Boolean} opts.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.
+ * @param {Boolean} opts.withSortedMetaArray Determines whether to include the sorted_metaarray property in the response. (Default: false)
+ * @param {Boolean} opts.showSubchannelMessagesOnly
+ * @param {String} opts.userId
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMessagesResponse}
*/
}, {
- key: "translateMessageIntoOtherLanguages",
- value: function translateMessageIntoOtherLanguages(apiToken, channelType, channelUrl, messageId, opts) {
- return this.translateMessageIntoOtherLanguagesWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
+ key: "listMessages",
+ value: function listMessages(channelType, channelUrl, messageTs, messageId, opts) {
+ return this.listMessagesWithHttpInfo(channelType, channelUrl, messageTs, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update an emoji category URL
- * ## Update an emoji category URL Updates the URL of an emoji category with the specified ID. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-update-an-emoji-category-url ----------------------------
- * @param {String} apiToken
- * @param {String} emojiCategoryId
+ * Mark all messages as read
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateEmojiCategoryUrlByIdData} opts.updateEmojiCategoryUrlByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdEmojiCategory} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/MarkChannelMessagesAsReadRequest} opts.markChannelMessagesAsReadRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "updateEmojiCategoryUrlByIdWithHttpInfo",
- value: function updateEmojiCategoryUrlByIdWithHttpInfo(apiToken, emojiCategoryId, opts) {
+ key: "markChannelMessagesAsReadWithHttpInfo",
+ value: function markChannelMessagesAsReadWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['updateEmojiCategoryUrlByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateEmojiCategoryUrlById");
- }
- // verify the required parameter 'emojiCategoryId' is set
- if (emojiCategoryId === undefined || emojiCategoryId === null) {
- throw new Error("Missing the required parameter 'emojiCategoryId' when calling updateEmojiCategoryUrlById");
+ var postBody = opts['markChannelMessagesAsReadRequest'];
+ // verify the required parameter 'channelUrl' is set
+ if (channelUrl === undefined || channelUrl === null) {
+ throw new Error("Missing the required parameter 'channelUrl' when calling markChannelMessagesAsRead");
}
var pathParams = {
- 'emoji_category_id': emojiCategoryId
+ 'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdEmojiCategory["default"];
- return this.apiClient.callApi('/v3/emoji_categories/{emoji_category_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}/messages/mark_as_read', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Update an emoji category URL
- * ## Update an emoji category URL Updates the URL of an emoji category with the specified ID. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-update-an-emoji-category-url ----------------------------
- * @param {String} apiToken
- * @param {String} emojiCategoryId
+ * Mark all messages as read
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateEmojiCategoryUrlByIdData} opts.updateEmojiCategoryUrlByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdEmojiCategory}
+ * @param {String} opts.apiToken
+ * @param {module:model/MarkChannelMessagesAsReadRequest} opts.markChannelMessagesAsReadRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "updateEmojiCategoryUrlById",
- value: function updateEmojiCategoryUrlById(apiToken, emojiCategoryId, opts) {
- return this.updateEmojiCategoryUrlByIdWithHttpInfo(apiToken, emojiCategoryId, opts).then(function (response_and_data) {
+ key: "markChannelMessagesAsRead",
+ value: function markChannelMessagesAsRead(channelUrl, opts) {
+ return this.markChannelMessagesAsReadWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update an emoji URL
- * ## Update an emoji URL Updates the image URL of an emoji with the specified key. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-update-an-emoji-url ----------------------------
- * @param {String} apiToken
- * @param {String} emojiKey
+ * Migrate messages
+ * ## 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
+ * @param {String} targetChannelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateEmojiUrlByKeyData} opts.updateEmojiUrlByKeyData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdEmoji} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {Object.} opts.body
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "updateEmojiUrlByKeyWithHttpInfo",
- value: function updateEmojiUrlByKeyWithHttpInfo(apiToken, emojiKey, opts) {
+ key: "migrateMessagesWithHttpInfo",
+ value: function migrateMessagesWithHttpInfo(targetChannelUrl, opts) {
opts = opts || {};
- var postBody = opts['updateEmojiUrlByKeyData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateEmojiUrlByKey");
- }
- // verify the required parameter 'emojiKey' is set
- if (emojiKey === undefined || emojiKey === null) {
- throw new Error("Missing the required parameter 'emojiKey' when calling updateEmojiUrlByKey");
+ var postBody = opts['body'];
+ // verify the required parameter 'targetChannelUrl' is set
+ if (targetChannelUrl === undefined || targetChannelUrl === null) {
+ throw new Error("Missing the required parameter 'targetChannelUrl' when calling migrateMessages");
}
var pathParams = {
- 'emoji_key': emojiKey
+ 'target_channel_url': targetChannelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdEmoji["default"];
- return this.apiClient.callApi('/v3/emojis/{emoji_key}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/migration/{target_channel_url}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Update an emoji URL
- * ## Update an emoji URL Updates the image URL of an emoji with the specified key. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-update-an-emoji-url ----------------------------
- * @param {String} apiToken
- * @param {String} emojiKey
+ * Migrate messages
+ * ## 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
+ * @param {String} targetChannelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateEmojiUrlByKeyData} opts.updateEmojiUrlByKeyData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdEmoji}
+ * @param {String} opts.apiToken
+ * @param {Object.} opts.body
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "updateEmojiUrlByKey",
- value: function updateEmojiUrlByKey(apiToken, emojiKey, opts) {
- return this.updateEmojiUrlByKeyWithHttpInfo(apiToken, emojiKey, opts).then(function (response_and_data) {
+ key: "migrateMessages",
+ value: function migrateMessages(targetChannelUrl, opts) {
+ return this.migrateMessagesWithHttpInfo(targetChannelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update extra data in a message
- * ## Update extra data in a message Updates the values of specific items by their keys. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-update-extra-data-in-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Remove extra data from a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateExtraDataInMessageData} opts.updateExtraDataInMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateExtraDataInMessageResponse} and HTTP response
+ * @param {String} opts.keys
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "updateExtraDataInMessageWithHttpInfo",
- value: function updateExtraDataInMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
+ key: "removeExtraDataFromAMessageWithHttpInfo",
+ value: function removeExtraDataFromAMessageWithHttpInfo(channelType, channelUrl, messageId, opts) {
opts = opts || {};
- var postBody = opts['updateExtraDataInMessageData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateExtraDataInMessage");
- }
+ var postBody = null;
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling updateExtraDataInMessage");
+ throw new Error("Missing the required parameter 'channelType' when calling removeExtraDataFromAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateExtraDataInMessage");
+ throw new Error("Missing the required parameter 'channelUrl' when calling removeExtraDataFromAMessage");
}
// verify the required parameter 'messageId' is set
if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling updateExtraDataInMessage");
+ throw new Error("Missing the required parameter 'messageId' when calling removeExtraDataFromAMessage");
}
var pathParams = {
'channel_type': channelType,
'channel_url': channelUrl,
'message_id': messageId
};
- var queryParams = {};
+ var queryParams = {
+ 'keys': opts['keys']
+ };
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = ['application/json'];
+ var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _UpdateExtraDataInMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Update extra data in a message
- * ## Update extra data in a message Updates the values of specific items by their keys. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-update-extra-data-in-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Remove extra data from a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateExtraDataInMessageData} opts.updateExtraDataInMessageData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateExtraDataInMessageResponse}
+ * @param {String} opts.keys
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "updateExtraDataInMessage",
- value: function updateExtraDataInMessage(apiToken, channelType, channelUrl, messageId, opts) {
- return this.updateExtraDataInMessageWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
+ key: "removeExtraDataFromAMessage",
+ value: function removeExtraDataFromAMessage(channelType, channelUrl, messageId, opts) {
+ return this.removeExtraDataFromAMessageWithHttpInfo(channelType, channelUrl, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update a message
- * ## Update a message Updates information on a message in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-update-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Send a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateMessageByIdData} opts.updateMessageByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdMessageResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/SendAMessageRequest} opts.sendAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdMessageResponse} and HTTP response
*/
}, {
- key: "updateMessageByIdWithHttpInfo",
- value: function updateMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
+ key: "sendAMessageWithHttpInfo",
+ value: function sendAMessageWithHttpInfo(channelType, channelUrl, opts) {
opts = opts || {};
- var postBody = opts['updateMessageByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateMessageById");
- }
+ var postBody = opts['sendAMessageRequest'];
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling updateMessageById");
+ throw new Error("Missing the required parameter 'channelType' when calling sendAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateMessageById");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling updateMessageById");
+ throw new Error("Missing the required parameter 'channelUrl' when calling sendAMessage");
}
var pathParams = {
'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
+ 'channel_url': channelUrl
};
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a message
- * ## Update a message Updates information on a message in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-update-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateMessageByIdData} opts.updateMessageByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdMessageResponse}
- */
- }, {
- key: "updateMessageById",
- value: function updateMessageById(apiToken, channelType, channelUrl, messageId, opts) {
- return this.updateMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Use default emojis
- * ## Use default emojis Determines whether to use the 7 default emojis initially provided. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-use-default-emojis
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/UseDefaultEmojisData} opts.useDefaultEmojisData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UseDefaultEmojisResponse} and HTTP response
- */
- }, {
- key: "useDefaultEmojisWithHttpInfo",
- value: function useDefaultEmojisWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['useDefaultEmojisData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling useDefaultEmojis");
- }
- var pathParams = {};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _UseDefaultEmojisResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/use_default_emoji', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdMessageResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Use default emojis
- * ## Use default emojis Determines whether to use the 7 default emojis initially provided. https://sendbird.com/docs/chat/v3/platform-api/guides/emojis#2-use-default-emojis
- * @param {String} apiToken
+ * Send a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UseDefaultEmojisData} opts.useDefaultEmojisData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UseDefaultEmojisResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/SendAMessageRequest} opts.sendAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdMessageResponse}
*/
}, {
- key: "useDefaultEmojis",
- value: function useDefaultEmojis(apiToken, opts) {
- return this.useDefaultEmojisWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ key: "sendAMessage",
+ value: function sendAMessage(channelType, channelUrl, opts) {
+ return this.sendAMessageWithHttpInfo(channelType, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * View a message
- * ## View a message Retrieves information on a message. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-view-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Update a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.withSortedMetaArray
- * @param {Boolean} opts.withMetaArray
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdMessageResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAMessageRequest} opts.updateAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdMessageResponse} and HTTP response
*/
}, {
- key: "viewMessageByIdWithHttpInfo",
- value: function viewMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
+ key: "updateAMessageWithHttpInfo",
+ value: function updateAMessageWithHttpInfo(channelType, channelUrl, messageId, opts) {
opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewMessageById");
- }
+ var postBody = opts['updateAMessageRequest'];
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewMessageById");
+ throw new Error("Missing the required parameter 'channelType' when calling updateAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewMessageById");
+ throw new Error("Missing the required parameter 'channelUrl' when calling updateAMessage");
}
// verify the required parameter 'messageId' is set
if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling viewMessageById");
+ throw new Error("Missing the required parameter 'messageId' when calling updateAMessage");
}
var pathParams = {
'channel_type': channelType,
'channel_url': channelUrl,
'message_id': messageId
};
- var queryParams = {
- 'with_sorted_meta_array': opts['withSortedMetaArray'],
- 'with_meta_array': opts['withMetaArray']
- };
+ var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = [];
+ var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdMessageResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdMessageResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View a message
- * ## View a message Retrieves information on a message. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-view-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
+ * Update a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.withSortedMetaArray
- * @param {Boolean} opts.withMetaArray
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdMessageResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAMessageRequest} opts.updateAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdMessageResponse}
*/
}, {
- key: "viewMessageById",
- value: function viewMessageById(apiToken, channelType, channelUrl, messageId, opts) {
- return this.viewMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
+ key: "updateAMessage",
+ value: function updateAMessage(channelType, channelUrl, messageId, opts) {
+ return this.updateAMessageWithHttpInfo(channelType, channelUrl, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * View total number of messages in a channel
- * ## View total number of messages in a channel Retrieves the total number of messages in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-view-total-number-of-messages-in-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewTotalNumberOfMessagesInChannelResponse} and HTTP response
+ * Update extra data in a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateExtraDataInAMessageRequest} opts.updateExtraDataInAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateExtraDataInAMessageResponse} and HTTP response
*/
}, {
- key: "viewTotalNumberOfMessagesInChannelWithHttpInfo",
- value: function viewTotalNumberOfMessagesInChannelWithHttpInfo(apiToken, channelType, channelUrl) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewTotalNumberOfMessagesInChannel");
- }
+ key: "updateExtraDataInAMessageWithHttpInfo",
+ value: function updateExtraDataInAMessageWithHttpInfo(channelType, channelUrl, messageId, opts) {
+ opts = opts || {};
+ var postBody = opts['updateExtraDataInAMessageRequest'];
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewTotalNumberOfMessagesInChannel");
+ throw new Error("Missing the required parameter 'channelType' when calling updateExtraDataInAMessage");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewTotalNumberOfMessagesInChannel");
+ throw new Error("Missing the required parameter 'channelUrl' when calling updateExtraDataInAMessage");
+ }
+ // verify the required parameter 'messageId' is set
+ if (messageId === undefined || messageId === null) {
+ throw new Error("Missing the required parameter 'messageId' when calling updateExtraDataInAMessage");
}
var pathParams = {
'channel_type': channelType,
- 'channel_url': channelUrl
+ 'channel_url': channelUrl,
+ 'message_id': messageId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = [];
+ var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _ViewTotalNumberOfMessagesInChannelResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/total_count', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _UpdateExtraDataInAMessageResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View total number of messages in a channel
- * ## View total number of messages in a channel Retrieves the total number of messages in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-view-total-number-of-messages-in-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewTotalNumberOfMessagesInChannelResponse}
+ * Update extra data in a message
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {String} messageId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateExtraDataInAMessageRequest} opts.updateExtraDataInAMessageRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateExtraDataInAMessageResponse}
*/
}, {
- key: "viewTotalNumberOfMessagesInChannel",
- value: function viewTotalNumberOfMessagesInChannel(apiToken, channelType, channelUrl) {
- return this.viewTotalNumberOfMessagesInChannelWithHttpInfo(apiToken, channelType, channelUrl).then(function (response_and_data) {
+ key: "updateExtraDataInAMessage",
+ value: function updateExtraDataInAMessage(channelType, channelUrl, messageId, opts) {
+ return this.updateExtraDataInAMessageWithHttpInfo(channelType, channelUrl, messageId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return MessageApi;
-}();
-exports["default"] = MessageApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/MetadataApi.js b/dist/api/MetadataApi.js
index bf13d63..ec134d0 100644
--- a/dist/api/MetadataApi.js
+++ b/dist/api/MetadataApi.js
@@ -5,26 +5,33 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _CreateChannelMetacounterData = _interopRequireDefault(require("../model/CreateChannelMetacounterData"));
-var _CreateChannelMetadataData = _interopRequireDefault(require("../model/CreateChannelMetadataData"));
-var _CreateChannelMetadataResponse = _interopRequireDefault(require("../model/CreateChannelMetadataResponse"));
-var _CreateUserMetadataData = _interopRequireDefault(require("../model/CreateUserMetadataData"));
-var _CreateUserMetadataResponse = _interopRequireDefault(require("../model/CreateUserMetadataResponse"));
-var _UpdateChannelMetacounterData = _interopRequireDefault(require("../model/UpdateChannelMetacounterData"));
-var _UpdateChannelMetadataData = _interopRequireDefault(require("../model/UpdateChannelMetadataData"));
-var _UpdateUserMetadataData = _interopRequireDefault(require("../model/UpdateUserMetadataData"));
-var _UpdateUserMetadataResponse = _interopRequireDefault(require("../model/UpdateUserMetadataResponse"));
-var _ViewUserMetadataResponse = _interopRequireDefault(require("../model/ViewUserMetadataResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _CreateAChannelMetadataRequest = _interopRequireDefault(require("../model/CreateAChannelMetadataRequest"));
+var _CreateAChannelMetadataResponse = _interopRequireDefault(require("../model/CreateAChannelMetadataResponse"));
+var _UpdateAChannelMetadataRequest = _interopRequireDefault(require("../model/UpdateAChannelMetadataRequest"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* Metadata service.
* @module api/MetadataApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var MetadataApi = /*#__PURE__*/function () {
+var MetadataApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new MetadataApi.
* @alias module:api/MetadataApi
@@ -38,695 +45,27 @@ var MetadataApi = /*#__PURE__*/function () {
}
/**
- * Create a channel metacounter
- * ## Create a channel metacounter Creates a channel metacounter's items to store in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-create-a-channel-metacounter ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
+ * Create a channel metadata
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/CreateChannelMetacounterData} opts.createChannelMetacounterData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAChannelMetadataRequest} opts.createAChannelMetadataRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateAChannelMetadataResponse} and HTTP response
*/
- _createClass(MetadataApi, [{
- key: "createChannelMetacounterWithHttpInfo",
- value: function createChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl, opts) {
+ return _createClass(MetadataApi, [{
+ key: "createAChannelMetadataWithHttpInfo",
+ value: function createAChannelMetadataWithHttpInfo(channelType, channelUrl, opts) {
opts = opts || {};
- var postBody = opts['createChannelMetacounterData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling createChannelMetacounter");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling createChannelMetacounter");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling createChannelMetacounter");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Create a channel metacounter
- * ## Create a channel metacounter Creates a channel metacounter's items to store in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-create-a-channel-metacounter ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/CreateChannelMetacounterData} opts.createChannelMetacounterData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "createChannelMetacounter",
- value: function createChannelMetacounter(apiToken, channelType, channelUrl, opts) {
- return this.createChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Create a channel metadata
- * ## Create a channel metadata Creates a channel metadata's items to store in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-create-a-channel-metadata ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/CreateChannelMetadataData} opts.createChannelMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateChannelMetadataResponse} and HTTP response
- */
- }, {
- key: "createChannelMetadataWithHttpInfo",
- value: function createChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['createChannelMetadataData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling createChannelMetadata");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling createChannelMetadata");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling createChannelMetadata");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _CreateChannelMetadataResponse["default"];
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Create a channel metadata
- * ## Create a channel metadata Creates a channel metadata's items to store in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-create-a-channel-metadata ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/CreateChannelMetadataData} opts.createChannelMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateChannelMetadataResponse}
- */
- }, {
- key: "createChannelMetadata",
- value: function createChannelMetadata(apiToken, channelType, channelUrl, opts) {
- return this.createChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Create a user metadata
- * ## Create a user metadata Creates a user metadata's items to store in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-create-a-user-metadata ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/CreateUserMetadataData} opts.createUserMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateUserMetadataResponse} and HTTP response
- */
- }, {
- key: "createUserMetadataWithHttpInfo",
- value: function createUserMetadataWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = opts['createUserMetadataData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling createUserMetadata");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling createUserMetadata");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _CreateUserMetadataResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/metadata', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Create a user metadata
- * ## Create a user metadata Creates a user metadata's items to store in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-create-a-user-metadata ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/CreateUserMetadataData} opts.createUserMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateUserMetadataResponse}
- */
- }, {
- key: "createUserMetadata",
- value: function createUserMetadata(apiToken, userId, opts) {
- return this.createUserMetadataWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a channel metacounter - When deleting all items of a channel metacounter
- * ## Delete a channel metacounter Deletes a channel metacounter's item that is stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-metacounter ---------------------------- `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 metacounter to delete.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteChannelMetacounterWithHttpInfo",
- value: function deleteChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteChannelMetacounter");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling deleteChannelMetacounter");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling deleteChannelMetacounter");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a channel metacounter - When deleting all items of a channel metacounter
- * ## Delete a channel metacounter Deletes a channel metacounter's item that is stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-metacounter ---------------------------- `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 metacounter to delete.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteChannelMetacounter",
- value: function deleteChannelMetacounter(apiToken, channelType, channelUrl) {
- return this.deleteChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a channel metacounter - When deleting a specific item of a channel metacounter by its key
- * ## Delete a channel metacounter Deletes a channel metacounter's item that is stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-metacounter ---------------------------- `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 metacounter to delete.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteChannelMetacounterByKeyWithHttpInfo",
- value: function deleteChannelMetacounterByKeyWithHttpInfo(apiToken, channelType, channelUrl, key) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteChannelMetacounterByKey");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling deleteChannelMetacounterByKey");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling deleteChannelMetacounterByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling deleteChannelMetacounterByKey");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter/{key}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a channel metacounter - When deleting a specific item of a channel metacounter by its key
- * ## Delete a channel metacounter Deletes a channel metacounter's item that is stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-metacounter ---------------------------- `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 metacounter to delete.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteChannelMetacounterByKey",
- value: function deleteChannelMetacounterByKey(apiToken, channelType, channelUrl, key) {
- return this.deleteChannelMetacounterByKeyWithHttpInfo(apiToken, channelType, channelUrl, key).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a channel metadata - When deleting all items of a channel metadata
- * ## Delete a channel metadata Deletes a channel metadata's one or all items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteChannelMetadataWithHttpInfo",
- value: function deleteChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteChannelMetadata");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling deleteChannelMetadata");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling deleteChannelMetadata");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'key': opts['key']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a channel metadata - When deleting all items of a channel metadata
- * ## Delete a channel metadata Deletes a channel metadata's one or all items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteChannelMetadata",
- value: function deleteChannelMetadata(apiToken, channelType, channelUrl, opts) {
- return this.deleteChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a channel metadata - When deleting a specific item of a channel metadata by its key
- * ## Delete a channel metadata Deletes a channel metadata's one or all items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteChannelMetadataByKeyWithHttpInfo",
- value: function deleteChannelMetadataByKeyWithHttpInfo(apiToken, channelType, channelUrl, key) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteChannelMetadataByKey");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling deleteChannelMetadataByKey");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling deleteChannelMetadataByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling deleteChannelMetadataByKey");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata/{key}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a channel metadata - When deleting a specific item of a channel metadata by its key
- * ## Delete a channel metadata Deletes a channel metadata's one or all items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteChannelMetadataByKey",
- value: function deleteChannelMetadataByKey(apiToken, channelType, channelUrl, key) {
- return this.deleteChannelMetadataByKeyWithHttpInfo(apiToken, channelType, channelUrl, key).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a user metadata - When deleting all items of a user metadata
- * ## Delete a user metadata Deletes a user metadata's one or all items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user who has the metadata to delete.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteUserMetadataWithHttpInfo",
- value: function deleteUserMetadataWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteUserMetadata");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling deleteUserMetadata");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'key': opts['key']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/users/{user_id}/metadata', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a user metadata - When deleting all items of a user metadata
- * ## Delete a user metadata Deletes a user metadata's one or all items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user who has the metadata to delete.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteUserMetadata",
- value: function deleteUserMetadata(apiToken, userId, opts) {
- return this.deleteUserMetadataWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Delete a user metadata - When deleting a specific item of a user metadata by its key
- * ## Delete a user metadata Deletes a user metadata's one or all items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user who has the metadata to delete.
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- }, {
- key: "deleteUserMetadataByKeyWithHttpInfo",
- value: function deleteUserMetadataByKeyWithHttpInfo(apiToken, userId, key) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteUserMetadataByKey");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling deleteUserMetadataByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling deleteUserMetadataByKey");
- }
- var pathParams = {
- 'user_id': userId,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/users/{user_id}/metadata/{key}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Delete a user metadata - When deleting a specific item of a user metadata by its key
- * ## Delete a user metadata Deletes a user metadata's one or all items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-delete-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user who has the metadata to delete.
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "deleteUserMetadataByKey",
- value: function deleteUserMetadataByKey(apiToken, userId, key) {
- return this.deleteUserMetadataByKeyWithHttpInfo(apiToken, userId, key).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a channel metacounter - When updating existing items of a channel metacounter by their keys or adding new items to the metacounter
- * ## Update a channel metacounter Updates existing items of a channel metacounter by their keys, or adds new items to the metacounter. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateChannelMetacounterData} opts.updateChannelMetacounterData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "updateChannelMetacounterWithHttpInfo",
- value: function updateChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['updateChannelMetacounterData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateChannelMetacounter");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling updateChannelMetacounter");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateChannelMetacounter");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a channel metacounter - When updating existing items of a channel metacounter by their keys or adding new items to the metacounter
- * ## Update a channel metacounter Updates existing items of a channel metacounter by their keys, or adds new items to the metacounter. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateChannelMetacounterData} opts.updateChannelMetacounterData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "updateChannelMetacounter",
- value: function updateChannelMetacounter(apiToken, channelType, channelUrl, opts) {
- return this.updateChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a channel metacounter - When updating a specific item of a channel metacounter by its key
- * ## Update a channel metacounter Updates existing items of a channel metacounter by their keys, or adds new items to the metacounter. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
- */
- }, {
- key: "updateChannelMetacounterByKeyWithHttpInfo",
- value: function updateChannelMetacounterByKeyWithHttpInfo(apiToken, channelType, channelUrl, key, opts) {
- opts = opts || {};
- var postBody = opts['body'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateChannelMetacounterByKey");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling updateChannelMetacounterByKey");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateChannelMetacounterByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling updateChannelMetacounterByKey");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter/{key}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a channel metacounter - When updating a specific item of a channel metacounter by its key
- * ## Update a channel metacounter Updates existing items of a channel metacounter by their keys, or adds new items to the metacounter. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
- */
- }, {
- key: "updateChannelMetacounterByKey",
- value: function updateChannelMetacounterByKey(apiToken, channelType, channelUrl, key, opts) {
- return this.updateChannelMetacounterByKeyWithHttpInfo(apiToken, channelType, channelUrl, key, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata
- * ## 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/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateChannelMetadataData} opts.updateChannelMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
- */
- }, {
- key: "updateChannelMetadataWithHttpInfo",
- value: function updateChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['updateChannelMetadataData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateChannelMetadata");
- }
+ var postBody = opts['createAChannelMetadataRequest'];
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling updateChannelMetadata");
+ throw new Error("Missing the required parameter 'channelType' when calling createAChannelMetadata");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateChannelMetadata");
+ throw new Error("Missing the required parameter 'channelUrl' when calling createAChannelMetadata");
}
var pathParams = {
'channel_type': channelType,
@@ -734,381 +73,173 @@ var MetadataApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata
- * ## 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/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateChannelMetadataData} opts.updateChannelMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
- */
- }, {
- key: "updateChannelMetadata",
- value: function updateChannelMetadata(apiToken, channelType, channelUrl, opts) {
- return this.updateChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a channel metadata - When updating a specific item of a channel metadata by its key
- * ## 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/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
- */
- }, {
- key: "updateChannelMetadataByKeyWithHttpInfo",
- value: function updateChannelMetadataByKeyWithHttpInfo(apiToken, channelType, channelUrl, key, opts) {
- opts = opts || {};
- var postBody = opts['body'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateChannelMetadataByKey");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling updateChannelMetadataByKey");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateChannelMetadataByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling updateChannelMetadataByKey");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata/{key}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a channel metadata - When updating a specific item of a channel metadata by its key
- * ## 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/v3/platform-api/guides/user-and-channel-metadata#2-update-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
- */
- }, {
- key: "updateChannelMetadataByKey",
- value: function updateChannelMetadataByKey(apiToken, channelType, channelUrl, key, opts) {
- return this.updateChannelMetadataByKeyWithHttpInfo(apiToken, channelType, channelUrl, key, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a user metadata - When updating existing items of a user metadata by their keys or adding new items to the metadata
- * ## Update a user metadata Updates existing items of a user metadata by their keys, or adds new items to the metadata. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to update the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateUserMetadataData} opts.updateUserMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateUserMetadataResponse} and HTTP response
- */
- }, {
- key: "updateUserMetadataWithHttpInfo",
- value: function updateUserMetadataWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = opts['updateUserMetadataData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateUserMetadata");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling updateUserMetadata");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _UpdateUserMetadataResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/metadata', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a user metadata - When updating existing items of a user metadata by their keys or adding new items to the metadata
- * ## Update a user metadata Updates existing items of a user metadata by their keys, or adds new items to the metadata. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to update the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateUserMetadataData} opts.updateUserMetadataData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateUserMetadataResponse}
- */
- }, {
- key: "updateUserMetadata",
- value: function updateUserMetadata(apiToken, userId, opts) {
- return this.updateUserMetadataWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a user metadata - When updating a specific item of a user metadata by its key
- * ## Update a user metadata Updates existing items of a user metadata by their keys, or adds new items to the metadata. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to update the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} key
- * @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
- */
- }, {
- key: "updateUserMetadataByKeyWithHttpInfo",
- value: function updateUserMetadataByKeyWithHttpInfo(apiToken, userId, key, opts) {
- opts = opts || {};
- var postBody = opts['body'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateUserMetadataByKey");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling updateUserMetadataByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling updateUserMetadataByKey");
- }
- var pathParams = {
- 'user_id': userId,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/users/{user_id}/metadata/{key}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _CreateAChannelMetadataResponse["default"];
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Update a user metadata - When updating a specific item of a user metadata by its key
- * ## Update a user metadata Updates existing items of a user metadata by their keys, or adds new items to the metadata. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-update-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to update the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} key
+ * Create a channel metadata
+ * ## 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 ----------------------------
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAChannelMetadataRequest} opts.createAChannelMetadataRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateAChannelMetadataResponse}
*/
}, {
- key: "updateUserMetadataByKey",
- value: function updateUserMetadataByKey(apiToken, userId, key, opts) {
- return this.updateUserMetadataByKeyWithHttpInfo(apiToken, userId, key, opts).then(function (response_and_data) {
+ key: "createAChannelMetadata",
+ value: function createAChannelMetadata(channelType, channelUrl, opts) {
+ return this.createAChannelMetadataWithHttpInfo(channelType, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * View a channel metacounter - When retrieving all items of a channel metacounter
- * ## View a channel metacounter Retrieves channel metacounter's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
+ * Delete a channel metadata - When deleting all items of a channel metadata
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.key
- * @param {Array.} opts.keys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "viewChannelMetacounterWithHttpInfo",
- value: function viewChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl, opts) {
+ key: "deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadataWithHttpInfo",
+ value: function deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadataWithHttpInfo(channelType, channelUrl, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewChannelMetacounter");
- }
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewChannelMetacounter");
+ throw new Error("Missing the required parameter 'channelType' when calling deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewChannelMetacounter");
+ throw new Error("Missing the required parameter 'channelUrl' when calling deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata");
}
var pathParams = {
'channel_type': channelType,
'channel_url': channelUrl
};
var queryParams = {
- 'key': opts['key'],
- 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi')
+ 'key': opts['key']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View a channel metacounter - When retrieving all items of a channel metacounter
- * ## View a channel metacounter Retrieves channel metacounter's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
+ * Delete a channel metadata - When deleting all items of a channel metadata
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.key
- * @param {Array.} opts.keys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "viewChannelMetacounter",
- value: function viewChannelMetacounter(apiToken, channelType, channelUrl, opts) {
- return this.viewChannelMetacounterWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
+ key: "deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata",
+ value: function deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata(channelType, channelUrl, opts) {
+ return this.deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadataWithHttpInfo(channelType, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * View a channel metacounter - When retrieving a specific item of a channel metacounter by its key
- * ## View a channel metacounter Retrieves channel metacounter's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
+ * Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAChannelMetadataRequest} opts.updateAChannelMetadataRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "viewChannelMetacounterByKeyWithHttpInfo",
- value: function viewChannelMetacounterByKeyWithHttpInfo(apiToken, channelType, channelUrl, key) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewChannelMetacounterByKey");
- }
+ key: "updateAChannelMetadataWithHttpInfo",
+ value: function updateAChannelMetadataWithHttpInfo(channelType, channelUrl, opts) {
+ opts = opts || {};
+ var postBody = opts['updateAChannelMetadataRequest'];
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewChannelMetacounterByKey");
+ throw new Error("Missing the required parameter 'channelType' when calling updateAChannelMetadata");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewChannelMetacounterByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling viewChannelMetacounterByKey");
+ throw new Error("Missing the required parameter 'channelUrl' when calling updateAChannelMetadata");
}
var pathParams = {
'channel_type': channelType,
- 'channel_url': channelUrl,
- 'key': key
+ 'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = [];
+ var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = Object;
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metacounter/{key}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View a channel metacounter - When retrieving a specific item of a channel metacounter by its key
- * ## View a channel metacounter Retrieves channel metacounter's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-metacounter ---------------------------- `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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
+ * Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAChannelMetadataRequest} opts.updateAChannelMetadataRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "viewChannelMetacounterByKey",
- value: function viewChannelMetacounterByKey(apiToken, channelType, channelUrl, key) {
- return this.viewChannelMetacounterByKeyWithHttpInfo(apiToken, channelType, channelUrl, key).then(function (response_and_data) {
+ key: "updateAChannelMetadata",
+ value: function updateAChannelMetadata(channelType, channelUrl, opts) {
+ return this.updateAChannelMetadataWithHttpInfo(channelType, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View a channel metadata - When retrieving all items of a channel metadata
- * ## View a channel metadata Retrieves a channel metadata's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.key
- * @param {Array.} opts.keys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
+ * @param {String} opts.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.
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "viewChannelMetadataWithHttpInfo",
- value: function viewChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts) {
+ key: "viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadataWithHttpInfo",
+ value: function viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadataWithHttpInfo(channelType, channelUrl, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewChannelMetadata");
- }
// verify the required parameter 'channelType' is set
if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewChannelMetadata");
+ throw new Error("Missing the required parameter 'channelType' when calling viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewChannelMetadata");
+ throw new Error("Missing the required parameter 'channelUrl' when calling viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata");
}
var pathParams = {
'channel_type': channelType,
@@ -1116,222 +247,36 @@ var MetadataApi = /*#__PURE__*/function () {
};
var queryParams = {
'key': opts['key'],
- 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi')
+ 'keys': opts['keys']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
+ var returnType = Object;
return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* View a channel metadata - When retrieving all items of a channel metadata
- * ## View a channel metadata Retrieves a channel metadata's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.key
- * @param {Array.} opts.keys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
- */
- }, {
- key: "viewChannelMetadata",
- value: function viewChannelMetadata(apiToken, channelType, channelUrl, opts) {
- return this.viewChannelMetadataWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a channel metadata - When retrieving a specific item of a channel metadata by its key
- * ## View a channel metadata Retrieves a channel metadata's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
- */
- }, {
- key: "viewChannelMetadataByKeyWithHttpInfo",
- value: function viewChannelMetadataByKeyWithHttpInfo(apiToken, channelType, channelUrl, key) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewChannelMetadataByKey");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewChannelMetadataByKey");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewChannelMetadataByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling viewChannelMetadataByKey");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/{channel_type}/{channel_url}/metadata/{key}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a channel metadata - When retrieving a specific item of a channel metadata by its key
- * ## View a channel metadata Retrieves a channel metadata's one or more items that are stored in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-channel-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.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
- */
- }, {
- key: "viewChannelMetadataByKey",
- value: function viewChannelMetadataByKey(apiToken, channelType, channelUrl, key) {
- return this.viewChannelMetadataByKeyWithHttpInfo(apiToken, channelType, channelUrl, key).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a user metadata - When retrieving all items of a user metadata
- * ## View a user metadata Retrieves a user metadata's one or more items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to retrieve the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.key
- * @param {Array.} opts.keys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewUserMetadataResponse} and HTTP response
- */
- }, {
- key: "viewUserMetadataWithHttpInfo",
- value: function viewUserMetadataWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewUserMetadata");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewUserMetadata");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'key': opts['key'],
- 'keys': this.apiClient.buildCollectionParam(opts['keys'], 'multi')
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewUserMetadataResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/metadata', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a user metadata - When retrieving all items of a user metadata
- * ## View a user metadata Retrieves a user metadata's one or more items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to retrieve the metadata in.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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.
+ * @param {module:model/String} channelType (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.key
- * @param {Array.} opts.keys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewUserMetadataResponse}
- */
- }, {
- key: "viewUserMetadata",
- value: function viewUserMetadata(apiToken, userId, opts) {
- return this.viewUserMetadataWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a user metadata - When retrieving a specific item of a user metadata by its key
- * ## View a user metadata Retrieves a user metadata's one or more items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to retrieve the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object.} and HTTP response
- */
- }, {
- key: "viewUserMetadataByKeyWithHttpInfo",
- value: function viewUserMetadataByKeyWithHttpInfo(apiToken, userId, key) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewUserMetadataByKey");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewUserMetadataByKey");
- }
- // verify the required parameter 'key' is set
- if (key === undefined || key === null) {
- throw new Error("Missing the required parameter 'key' when calling viewUserMetadataByKey");
- }
- var pathParams = {
- 'user_id': userId,
- 'key': key
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = {
- 'String': 'String'
- };
- return this.apiClient.callApi('/v3/users/{user_id}/metadata/{key}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a user metadata - When retrieving a specific item of a user metadata by its key
- * ## View a user metadata Retrieves a user metadata's one or more items that are stored in a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user-and-channel-metadata#2-view-a-user-metadata ---------------------------- `user_id` Type: string Description: Specifies the ID of the user to retrieve the metadata in.
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} key
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object.}
+ * @param {String} opts.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.
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "viewUserMetadataByKey",
- value: function viewUserMetadataByKey(apiToken, userId, key) {
- return this.viewUserMetadataByKeyWithHttpInfo(apiToken, userId, key).then(function (response_and_data) {
+ key: "viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata",
+ value: function viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata(channelType, channelUrl, opts) {
+ return this.viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadataWithHttpInfo(channelType, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return MetadataApi;
-}();
-exports["default"] = MetadataApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/ModerationApi.js b/dist/api/ModerationApi.js
index 107443a..7205c57 100644
--- a/dist/api/ModerationApi.js
+++ b/dist/api/ModerationApi.js
@@ -5,46 +5,37 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _BanFromChannelsWithCustomChannelTypesData = _interopRequireDefault(require("../model/BanFromChannelsWithCustomChannelTypesData"));
-var _BlockUserData = _interopRequireDefault(require("../model/BlockUserData"));
-var _BlockUserResponse = _interopRequireDefault(require("../model/BlockUserResponse"));
-var _GcBanUserData = _interopRequireDefault(require("../model/GcBanUserData"));
-var _GcBanUserResponse = _interopRequireDefault(require("../model/GcBanUserResponse"));
-var _GcFreezeChannelData = _interopRequireDefault(require("../model/GcFreezeChannelData"));
-var _GcListBannedUsersResponse = _interopRequireDefault(require("../model/GcListBannedUsersResponse"));
-var _GcListMutedUsersResponse = _interopRequireDefault(require("../model/GcListMutedUsersResponse"));
-var _GcMuteUserData = _interopRequireDefault(require("../model/GcMuteUserData"));
-var _GcUpdateBanByIdData = _interopRequireDefault(require("../model/GcUpdateBanByIdData"));
-var _GcUpdateBanByIdResponse = _interopRequireDefault(require("../model/GcUpdateBanByIdResponse"));
-var _GcViewBanByIdResponse = _interopRequireDefault(require("../model/GcViewBanByIdResponse"));
-var _GcViewMuteByIdResponse = _interopRequireDefault(require("../model/GcViewMuteByIdResponse"));
-var _ListBannedChannelsResponse = _interopRequireDefault(require("../model/ListBannedChannelsResponse"));
+var _BlockAUserRequest = _interopRequireDefault(require("../model/BlockAUserRequest"));
+var _BlockAUserResponse = _interopRequireDefault(require("../model/BlockAUserResponse"));
+var _FreezeAGroupChannelRequest = _interopRequireDefault(require("../model/FreezeAGroupChannelRequest"));
+var _FreezeAnOpenChannelRequest = _interopRequireDefault(require("../model/FreezeAnOpenChannelRequest"));
var _ListBlockedUsersResponse = _interopRequireDefault(require("../model/ListBlockedUsersResponse"));
-var _ListMutedChannelsResponse = _interopRequireDefault(require("../model/ListMutedChannelsResponse"));
-var _MuteInChannelsWithCustomChannelTypesData = _interopRequireDefault(require("../model/MuteInChannelsWithCustomChannelTypesData"));
-var _OcBanUserData = _interopRequireDefault(require("../model/OcBanUserData"));
-var _OcBanUserResponse = _interopRequireDefault(require("../model/OcBanUserResponse"));
-var _OcDeleteChannelByUrl200Response = _interopRequireDefault(require("../model/OcDeleteChannelByUrl200Response"));
-var _OcFreezeChannelData = _interopRequireDefault(require("../model/OcFreezeChannelData"));
-var _OcListBannedUsersResponse = _interopRequireDefault(require("../model/OcListBannedUsersResponse"));
-var _OcListMutedUsersResponse = _interopRequireDefault(require("../model/OcListMutedUsersResponse"));
-var _OcMuteUserData = _interopRequireDefault(require("../model/OcMuteUserData"));
-var _OcUpdateBanByIdData = _interopRequireDefault(require("../model/OcUpdateBanByIdData"));
-var _OcUpdateBanByIdResponse = _interopRequireDefault(require("../model/OcUpdateBanByIdResponse"));
-var _OcViewBanByIdResponse = _interopRequireDefault(require("../model/OcViewBanByIdResponse"));
-var _OcViewMuteByIdResponse = _interopRequireDefault(require("../model/OcViewMuteByIdResponse"));
-var _SendBirdGroupChannel = _interopRequireDefault(require("../model/SendBirdGroupChannel"));
-var _SendBirdOpenChannel = _interopRequireDefault(require("../model/SendBirdOpenChannel"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _SendbirdGroupChannelDetail = _interopRequireDefault(require("../model/SendbirdGroupChannelDetail"));
+var _SendbirdOpenChannel = _interopRequireDefault(require("../model/SendbirdOpenChannel"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* Moderation service.
* @module api/ModerationApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var ModerationApi = /*#__PURE__*/function () {
+var ModerationApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new ModerationApi.
* @alias module:api/ModerationApi
@@ -58,1506 +49,243 @@ var ModerationApi = /*#__PURE__*/function () {
}
/**
- * Ban from channels with custom channel types
- * ## Ban from channels with custom channel types Bans a user from channels with particular custom channel types. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-ban-from-channels-with-custom-channel-types ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * Block a user
+ * ## 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)
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/BanFromChannelsWithCustomChannelTypesData} opts.banFromChannelsWithCustomChannelTypesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/BlockAUserRequest} opts.blockAUserRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BlockAUserResponse} and HTTP response
*/
- _createClass(ModerationApi, [{
- key: "banFromChannelsWithCustomChannelTypesWithHttpInfo",
- value: function banFromChannelsWithCustomChannelTypesWithHttpInfo(apiToken, userId, opts) {
+ return _createClass(ModerationApi, [{
+ key: "blockAUserWithHttpInfo",
+ value: function blockAUserWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['banFromChannelsWithCustomChannelTypesData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling banFromChannelsWithCustomChannelTypes");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling banFromChannelsWithCustomChannelTypes");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/users/{user_id}/banned_channel_custom_types', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Ban from channels with custom channel types
- * ## Ban from channels with custom channel types Bans a user from channels with particular custom channel types. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-ban-from-channels-with-custom-channel-types ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/BanFromChannelsWithCustomChannelTypesData} opts.banFromChannelsWithCustomChannelTypesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "banFromChannelsWithCustomChannelTypes",
- value: function banFromChannelsWithCustomChannelTypes(apiToken, userId, opts) {
- return this.banFromChannelsWithCustomChannelTypesWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Block a user
- * ## Block a user Allows a user to block another user. A user doesn't receive messages from someone they have blocked anymore. Also, blocking someone doesn't alert them that they have been blocked. Blocked users still can send messages as normal in the channel: however, they can't receive any messages from the users who have blocked them. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-block-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/BlockUserData} opts.blockUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BlockUserResponse} and HTTP response
- */
- }, {
- key: "blockUserWithHttpInfo",
- value: function blockUserWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = opts['blockUserData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling blockUser");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling blockUser");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _BlockUserResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/block', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Block a user
- * ## Block a user Allows a user to block another user. A user doesn't receive messages from someone they have blocked anymore. Also, blocking someone doesn't alert them that they have been blocked. Blocked users still can send messages as normal in the channel: however, they can't receive any messages from the users who have blocked them. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-block-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/BlockUserData} opts.blockUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BlockUserResponse}
- */
- }, {
- key: "blockUser",
- value: function blockUser(apiToken, userId, opts) {
- return this.blockUserWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Ban a user
- * ## Ban a user Bans a user from a group channel. A banned user is immediately expelled from a channel and allowed to join the channel again after a set time period. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-ban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcBanUserData} opts.gcBanUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcBanUserResponse} and HTTP response
- */
- }, {
- key: "gcBanUserWithHttpInfo",
- value: function gcBanUserWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['gcBanUserData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcBanUser");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcBanUser");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _GcBanUserResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/ban', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Ban a user
- * ## Ban a user Bans a user from a group channel. A banned user is immediately expelled from a channel and allowed to join the channel again after a set time period. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-ban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcBanUserData} opts.gcBanUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcBanUserResponse}
- */
- }, {
- key: "gcBanUser",
- value: function gcBanUser(apiToken, channelUrl, opts) {
- return this.gcBanUserWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Freeze a channel
- * ## Freeze a channel Freezes or unfreezes a group channel. > __Note__: Only users designated as channel operators are allowed to talk when a channel is frozen. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-freeze-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcFreezeChannelData} opts.gcFreezeChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
- */
- }, {
- key: "gcFreezeChannelWithHttpInfo",
- value: function gcFreezeChannelWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['gcFreezeChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcFreezeChannel");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcFreezeChannel");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/freeze', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Freeze a channel
- * ## Freeze a channel Freezes or unfreezes a group channel. > __Note__: Only users designated as channel operators are allowed to talk when a channel is frozen. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-freeze-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcFreezeChannelData} opts.gcFreezeChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
- */
- }, {
- key: "gcFreezeChannel",
- value: function gcFreezeChannel(apiToken, channelUrl, opts) {
- return this.gcFreezeChannelWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List banned users
- * ## List banned users Retrieves a list of the banned users from a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-banned-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel where to retrieve a list of banned users.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcListBannedUsersResponse} and HTTP response
- */
- }, {
- key: "gcListBannedUsersWithHttpInfo",
- value: function gcListBannedUsersWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcListBannedUsers");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcListBannedUsers");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GcListBannedUsersResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/ban', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List banned users
- * ## List banned users Retrieves a list of the banned users from a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-banned-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel where to retrieve a list of banned users.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcListBannedUsersResponse}
- */
- }, {
- key: "gcListBannedUsers",
- value: function gcListBannedUsers(apiToken, channelUrl, opts) {
- return this.gcListBannedUsersWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List muted users
- * ## List muted users Retrieves a list of the muted users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-muted-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of muted users.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcListMutedUsersResponse} and HTTP response
- */
- }, {
- key: "gcListMutedUsersWithHttpInfo",
- value: function gcListMutedUsersWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcListMutedUsers");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcListMutedUsers");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GcListMutedUsersResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/mute', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List muted users
- * ## List muted users Retrieves a list of the muted users in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-list-muted-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of muted users.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcListMutedUsersResponse}
- */
- }, {
- key: "gcListMutedUsers",
- value: function gcListMutedUsers(apiToken, channelUrl, opts) {
- return this.gcListMutedUsersWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Mute a user
- * ## Mute a user Mutes a user in a group channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-mute-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcMuteUserData} opts.gcMuteUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdGroupChannel} and HTTP response
- */
- }, {
- key: "gcMuteUserWithHttpInfo",
- value: function gcMuteUserWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['gcMuteUserData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcMuteUser");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcMuteUser");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdGroupChannel["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/mute', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Mute a user
- * ## Mute a user Mutes a user in a group channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-mute-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/GcMuteUserData} opts.gcMuteUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdGroupChannel}
- */
- }, {
- key: "gcMuteUser",
- value: function gcMuteUser(apiToken, channelUrl, opts) {
- return this.gcMuteUserWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Unban a user
- * ## Unban a user Unbans a user from a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-unban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
- */
- }, {
- key: "gcUnbanUserByIdWithHttpInfo",
- value: function gcUnbanUserByIdWithHttpInfo(apiToken, channelUrl, bannedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcUnbanUserById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcUnbanUserById");
- }
- // verify the required parameter 'bannedUserId' is set
- if (bannedUserId === undefined || bannedUserId === null) {
- throw new Error("Missing the required parameter 'bannedUserId' when calling gcUnbanUserById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'banned_user_id': bannedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/ban/{banned_user_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Unban a user
- * ## Unban a user Unbans a user from a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-unban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
- */
- }, {
- key: "gcUnbanUserById",
- value: function gcUnbanUserById(apiToken, channelUrl, bannedUserId) {
- return this.gcUnbanUserByIdWithHttpInfo(apiToken, channelUrl, bannedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Unmute a user
- * ## Unmute a user Unmutes a user within a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-unmute-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
- */
- }, {
- key: "gcUnmuteUserByIdWithHttpInfo",
- value: function gcUnmuteUserByIdWithHttpInfo(apiToken, channelUrl, mutedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcUnmuteUserById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcUnmuteUserById");
- }
- // verify the required parameter 'mutedUserId' is set
- if (mutedUserId === undefined || mutedUserId === null) {
- throw new Error("Missing the required parameter 'mutedUserId' when calling gcUnmuteUserById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'muted_user_id': mutedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/mute/{muted_user_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Unmute a user
- * ## Unmute a user Unmutes a user within a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-unmute-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
- */
- }, {
- key: "gcUnmuteUserById",
- value: function gcUnmuteUserById(apiToken, channelUrl, mutedUserId) {
- return this.gcUnmuteUserByIdWithHttpInfo(apiToken, channelUrl, mutedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a ban
- * ## Update a ban Updates details of a ban imposed on a user. You can change the length of the ban with this action, and also provide an updated description. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-update-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @param {Object} opts Optional parameters
- * @param {module:model/GcUpdateBanByIdData} opts.gcUpdateBanByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcUpdateBanByIdResponse} and HTTP response
- */
- }, {
- key: "gcUpdateBanByIdWithHttpInfo",
- value: function gcUpdateBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId, opts) {
- opts = opts || {};
- var postBody = opts['gcUpdateBanByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcUpdateBanById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcUpdateBanById");
- }
- // verify the required parameter 'bannedUserId' is set
- if (bannedUserId === undefined || bannedUserId === null) {
- throw new Error("Missing the required parameter 'bannedUserId' when calling gcUpdateBanById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'banned_user_id': bannedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _GcUpdateBanByIdResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/ban/{banned_user_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a ban
- * ## Update a ban Updates details of a ban imposed on a user. You can change the length of the ban with this action, and also provide an updated description. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-update-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @param {Object} opts Optional parameters
- * @param {module:model/GcUpdateBanByIdData} opts.gcUpdateBanByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcUpdateBanByIdResponse}
- */
- }, {
- key: "gcUpdateBanById",
- value: function gcUpdateBanById(apiToken, channelUrl, bannedUserId, opts) {
- return this.gcUpdateBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a ban
- * ## View a ban Retrieves details of a ban imposed on a user. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-view-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcViewBanByIdResponse} and HTTP response
- */
- }, {
- key: "gcViewBanByIdWithHttpInfo",
- value: function gcViewBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcViewBanById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcViewBanById");
- }
- // verify the required parameter 'bannedUserId' is set
- if (bannedUserId === undefined || bannedUserId === null) {
- throw new Error("Missing the required parameter 'bannedUserId' when calling gcViewBanById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'banned_user_id': bannedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GcViewBanByIdResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/ban/{banned_user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a ban
- * ## View a ban Retrieves details of a ban imposed on a user. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-view-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcViewBanByIdResponse}
- */
- }, {
- key: "gcViewBanById",
- value: function gcViewBanById(apiToken, channelUrl, bannedUserId) {
- return this.gcViewBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a mute
- * ## View a mute Checks if a user is muted in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-view-a-mute ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GcViewMuteByIdResponse} and HTTP response
- */
- }, {
- key: "gcViewMuteByIdWithHttpInfo",
- value: function gcViewMuteByIdWithHttpInfo(apiToken, channelUrl, mutedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling gcViewMuteById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling gcViewMuteById");
- }
- // verify the required parameter 'mutedUserId' is set
- if (mutedUserId === undefined || mutedUserId === null) {
- throw new Error("Missing the required parameter 'mutedUserId' when calling gcViewMuteById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'muted_user_id': mutedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GcViewMuteByIdResponse["default"];
- return this.apiClient.callApi('/v3/group_channels/{channel_url}/mute/{muted_user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a mute
- * ## View a mute Checks if a user is muted in a group channel. https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-view-a-mute ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GcViewMuteByIdResponse}
- */
- }, {
- key: "gcViewMuteById",
- value: function gcViewMuteById(apiToken, channelUrl, mutedUserId) {
- return this.gcViewMuteByIdWithHttpInfo(apiToken, channelUrl, mutedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List banned channels
- * ## List banned channels Retrieves a list of open and group channels with additional information where a user is banned. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-banned-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListBannedChannelsResponse} and HTTP response
- */
- }, {
- key: "listBannedChannelsWithHttpInfo",
- value: function listBannedChannelsWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listBannedChannels");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling listBannedChannels");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListBannedChannelsResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/ban', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List banned channels
- * ## List banned channels Retrieves a list of open and group channels with additional information where a user is banned. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-banned-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListBannedChannelsResponse}
- */
- }, {
- key: "listBannedChannels",
- value: function listBannedChannels(apiToken, userId, opts) {
- return this.listBannedChannelsWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List blocked users
- * ## List blocked users Retrieves a list of other users that a user has blocked. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-blocked-users ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.userIds
- * @param {String} opts.metadatakey
- * @param {String} opts.metadatavaluesIn
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListBlockedUsersResponse} and HTTP response
- */
- }, {
- key: "listBlockedUsersWithHttpInfo",
- value: function listBlockedUsersWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listBlockedUsers");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling listBlockedUsers");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit'],
- 'user_ids': opts['userIds'],
- 'metadatakey': opts['metadatakey'],
- 'metadatavalues_in': opts['metadatavaluesIn']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListBlockedUsersResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/block', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List blocked users
- * ## List blocked users Retrieves a list of other users that a user has blocked. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-blocked-users ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.userIds
- * @param {String} opts.metadatakey
- * @param {String} opts.metadatavaluesIn
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListBlockedUsersResponse}
- */
- }, {
- key: "listBlockedUsers",
- value: function listBlockedUsers(apiToken, userId, opts) {
- return this.listBlockedUsersWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List muted channels
- * ## List muted channels Retrieves a list of open and group channels with additional information where a user is muted. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-muted-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMutedChannelsResponse} and HTTP response
- */
- }, {
- key: "listMutedChannelsWithHttpInfo",
- value: function listMutedChannelsWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listMutedChannels");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling listMutedChannels");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListMutedChannelsResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/mute', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List muted channels
- * ## List muted channels Retrieves a list of open and group channels with additional information where a user is muted. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-muted-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMutedChannelsResponse}
- */
- }, {
- key: "listMutedChannels",
- value: function listMutedChannels(apiToken, userId, opts) {
- return this.listMutedChannelsWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Mute in channels with custom channel types
- * ## Mute in channels with custom channel types Mutes a user in channels with particular custom channel types. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-mute-in-channels-with-custom-channel-types ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/MuteInChannelsWithCustomChannelTypesData} opts.muteInChannelsWithCustomChannelTypesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "muteInChannelsWithCustomChannelTypesWithHttpInfo",
- value: function muteInChannelsWithCustomChannelTypesWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = opts['muteInChannelsWithCustomChannelTypesData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling muteInChannelsWithCustomChannelTypes");
- }
+ var postBody = opts['blockAUserRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling muteInChannelsWithCustomChannelTypes");
+ throw new Error("Missing the required parameter 'userId' when calling blockAUser");
}
var pathParams = {
'user_id': userId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/users/{user_id}/muted_channel_custom_types', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _BlockAUserResponse["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}/block', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Mute in channels with custom channel types
- * ## Mute in channels with custom channel types Mutes a user in channels with particular custom channel types. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-mute-in-channels-with-custom-channel-types ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * Block a user
+ * ## 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)
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/MuteInChannelsWithCustomChannelTypesData} opts.muteInChannelsWithCustomChannelTypesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
+ * @param {String} opts.apiToken
+ * @param {module:model/BlockAUserRequest} opts.blockAUserRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BlockAUserResponse}
*/
}, {
- key: "muteInChannelsWithCustomChannelTypes",
- value: function muteInChannelsWithCustomChannelTypes(apiToken, userId, opts) {
- return this.muteInChannelsWithCustomChannelTypesWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ key: "blockAUser",
+ value: function blockAUser(userId, opts) {
+ return this.blockAUserWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Ban a user
- * ## Ban a user Bans a user from an open channel. A banned user is immediately expelled from a channel and allowed to participate in the channel again after a set time period. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-ban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Freeze a group channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/OcBanUserData} opts.ocBanUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcBanUserResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/FreezeAGroupChannelRequest} opts.freezeAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdGroupChannelDetail} and HTTP response
*/
}, {
- key: "ocBanUserWithHttpInfo",
- value: function ocBanUserWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "freezeAGroupChannelWithHttpInfo",
+ value: function freezeAGroupChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['ocBanUserData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocBanUser");
- }
+ var postBody = opts['freezeAGroupChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocBanUser");
+ throw new Error("Missing the required parameter 'channelUrl' when calling freezeAGroupChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _OcBanUserResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/ban', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdGroupChannelDetail["default"];
+ return this.apiClient.callApi('/v3/group_channels/{channel_url}/freeze', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Ban a user
- * ## Ban a user Bans a user from an open channel. A banned user is immediately expelled from a channel and allowed to participate in the channel again after a set time period. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-ban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Freeze a group channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/OcBanUserData} opts.ocBanUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcBanUserResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/FreezeAGroupChannelRequest} opts.freezeAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdGroupChannelDetail}
*/
}, {
- key: "ocBanUser",
- value: function ocBanUser(apiToken, channelUrl, opts) {
- return this.ocBanUserWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "freezeAGroupChannel",
+ value: function freezeAGroupChannel(channelUrl, opts) {
+ return this.freezeAGroupChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Freeze a channel
- * ## Freeze a channel Freezes or unfreezes an open channel. > __Note__: Only users designated as channel operators are allowed to talk when a channel is frozen. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-freeze-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Freeze an open channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/OcFreezeChannelData} opts.ocFreezeChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdOpenChannel} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/FreezeAnOpenChannelRequest} opts.freezeAnOpenChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdOpenChannel} and HTTP response
*/
}, {
- key: "ocFreezeChannelWithHttpInfo",
- value: function ocFreezeChannelWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "freezeAnOpenChannelWithHttpInfo",
+ value: function freezeAnOpenChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['ocFreezeChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocFreezeChannel");
- }
+ var postBody = opts['freezeAnOpenChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocFreezeChannel");
+ throw new Error("Missing the required parameter 'channelUrl' when calling freezeAnOpenChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdOpenChannel["default"];
+ var returnType = _SendbirdOpenChannel["default"];
return this.apiClient.callApi('/v3/open_channels/{channel_url}/freeze', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Freeze a channel
- * ## Freeze a channel Freezes or unfreezes an open channel. > __Note__: Only users designated as channel operators are allowed to talk when a channel is frozen. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-freeze-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/OcFreezeChannelData} opts.ocFreezeChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdOpenChannel}
- */
- }, {
- key: "ocFreezeChannel",
- value: function ocFreezeChannel(apiToken, channelUrl, opts) {
- return this.ocFreezeChannelWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List banned users
- * ## List banned users Retrieves a list of banned users from a specific open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-banned-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel where to retrieve a list of banned users.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcListBannedUsersResponse} and HTTP response
- */
- }, {
- key: "ocListBannedUsersWithHttpInfo",
- value: function ocListBannedUsersWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocListBannedUsers");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocListBannedUsers");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcListBannedUsersResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/ban', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List banned users
- * ## List banned users Retrieves a list of banned users from a specific open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-banned-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel where to retrieve a list of banned users.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Freeze an open channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcListBannedUsersResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/FreezeAnOpenChannelRequest} opts.freezeAnOpenChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdOpenChannel}
*/
}, {
- key: "ocListBannedUsers",
- value: function ocListBannedUsers(apiToken, channelUrl, opts) {
- return this.ocListBannedUsersWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "freezeAnOpenChannel",
+ value: function freezeAnOpenChannel(channelUrl, opts) {
+ return this.freezeAnOpenChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * List muted users
- * ## List muted users Retrieves a list of muted users in the channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-muted-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of muted users.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * List blocked users
+ * ## 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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
+ * @param {module:model/String} opts.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)
* @param {String} opts.token
* @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcListMutedUsersResponse} and HTTP response
+ * @param {String} opts.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.
+ * @param {String} opts.metadatakey
+ * @param {String} opts.metadatavaluesIn
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListBlockedUsersResponse} and HTTP response
*/
}, {
- key: "ocListMutedUsersWithHttpInfo",
- value: function ocListMutedUsersWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "listBlockedUsersWithHttpInfo",
+ value: function listBlockedUsersWithHttpInfo(userId, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocListMutedUsers");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocListMutedUsers");
+ // verify the required parameter 'userId' is set
+ if (userId === undefined || userId === null) {
+ throw new Error("Missing the required parameter 'userId' when calling listBlockedUsers");
}
var pathParams = {
- 'channel_url': channelUrl
+ 'user_id': userId
};
var queryParams = {
+ 'list': opts['list'],
'token': opts['token'],
- 'limit': opts['limit']
+ 'limit': opts['limit'],
+ 'user_ids': opts['userIds'],
+ 'metadatakey': opts['metadatakey'],
+ 'metadatavalues_in': opts['metadatavaluesIn']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcListMutedUsersResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/mute', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _ListBlockedUsersResponse["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}/block', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * List muted users
- * ## List muted users Retrieves a list of muted users in the channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-muted-users ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of muted users.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * List blocked users
+ * ## 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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
+ * @param {module:model/String} opts.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)
* @param {String} opts.token
* @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcListMutedUsersResponse}
- */
- }, {
- key: "ocListMutedUsers",
- value: function ocListMutedUsers(apiToken, channelUrl, opts) {
- return this.ocListMutedUsersWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Mute a user
- * ## Mute a user Mutes a user in the channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-mute-a-user
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/OcMuteUserData} opts.ocMuteUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdOpenChannel} and HTTP response
- */
- }, {
- key: "ocMuteUserWithHttpInfo",
- value: function ocMuteUserWithHttpInfo(apiToken, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['ocMuteUserData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocMuteUser");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocMuteUser");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdOpenChannel["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/mute', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Mute a user
- * ## Mute a user Mutes a user in the channel. A muted user remains in the channel and is allowed to view the messages, but can't send any messages until unmuted. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-mute-a-user
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/OcMuteUserData} opts.ocMuteUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdOpenChannel}
- */
- }, {
- key: "ocMuteUser",
- value: function ocMuteUser(apiToken, channelUrl, opts) {
- return this.ocMuteUserWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Unban a user
- * ## Unban a user Unbans a user from an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-unban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
- */
- }, {
- key: "ocUnbanUserByIdWithHttpInfo",
- value: function ocUnbanUserByIdWithHttpInfo(apiToken, channelUrl, bannedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocUnbanUserById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocUnbanUserById");
- }
- // verify the required parameter 'bannedUserId' is set
- if (bannedUserId === undefined || bannedUserId === null) {
- throw new Error("Missing the required parameter 'bannedUserId' when calling ocUnbanUserById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'banned_user_id': bannedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/ban/{banned_user_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Unban a user
- * ## Unban a user Unbans a user from an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-unban-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
- */
- }, {
- key: "ocUnbanUserById",
- value: function ocUnbanUserById(apiToken, channelUrl, bannedUserId) {
- return this.ocUnbanUserByIdWithHttpInfo(apiToken, channelUrl, bannedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Unmute a user
- * ## Unmute a user Unmutes a user from an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-unmute-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
- */
- }, {
- key: "ocUnmuteUserByIdWithHttpInfo",
- value: function ocUnmuteUserByIdWithHttpInfo(apiToken, channelUrl, mutedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocUnmuteUserById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocUnmuteUserById");
- }
- // verify the required parameter 'mutedUserId' is set
- if (mutedUserId === undefined || mutedUserId === null) {
- throw new Error("Missing the required parameter 'mutedUserId' when calling ocUnmuteUserById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'muted_user_id': mutedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/mute/{muted_user_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Unmute a user
- * ## Unmute a user Unmutes a user from an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-unmute-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
- */
- }, {
- key: "ocUnmuteUserById",
- value: function ocUnmuteUserById(apiToken, channelUrl, mutedUserId) {
- return this.ocUnmuteUserByIdWithHttpInfo(apiToken, channelUrl, mutedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Update a ban
- * ## Update a ban Updates details of a ban imposed on a user. You can change the length of a ban with this action, and also provide an updated description. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-update-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @param {Object} opts Optional parameters
- * @param {module:model/OcUpdateBanByIdData} opts.ocUpdateBanByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcUpdateBanByIdResponse} and HTTP response
- */
- }, {
- key: "ocUpdateBanByIdWithHttpInfo",
- value: function ocUpdateBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId, opts) {
- opts = opts || {};
- var postBody = opts['ocUpdateBanByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocUpdateBanById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocUpdateBanById");
- }
- // verify the required parameter 'bannedUserId' is set
- if (bannedUserId === undefined || bannedUserId === null) {
- throw new Error("Missing the required parameter 'bannedUserId' when calling ocUpdateBanById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'banned_user_id': bannedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _OcUpdateBanByIdResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/ban/{banned_user_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a ban
- * ## Update a ban Updates details of a ban imposed on a user. You can change the length of a ban with this action, and also provide an updated description. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-update-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @param {Object} opts Optional parameters
- * @param {module:model/OcUpdateBanByIdData} opts.ocUpdateBanByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcUpdateBanByIdResponse}
- */
- }, {
- key: "ocUpdateBanById",
- value: function ocUpdateBanById(apiToken, channelUrl, bannedUserId, opts) {
- return this.ocUpdateBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a ban
- * ## View a ban Retrieves details of a ban imposed on a user. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-view-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcViewBanByIdResponse} and HTTP response
- */
- }, {
- key: "ocViewBanByIdWithHttpInfo",
- value: function ocViewBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocViewBanById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocViewBanById");
- }
- // verify the required parameter 'bannedUserId' is set
- if (bannedUserId === undefined || bannedUserId === null) {
- throw new Error("Missing the required parameter 'bannedUserId' when calling ocViewBanById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'banned_user_id': bannedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcViewBanByIdResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/ban/{banned_user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a ban
- * ## View a ban Retrieves details of a ban imposed on a user. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-view-a-ban ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} bannedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcViewBanByIdResponse}
- */
- }, {
- key: "ocViewBanById",
- value: function ocViewBanById(apiToken, channelUrl, bannedUserId) {
- return this.ocViewBanByIdWithHttpInfo(apiToken, channelUrl, bannedUserId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a mute
- * ## View a mute Checks if a user is muted in an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-view-a-mute ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcViewMuteByIdResponse} and HTTP response
- */
- }, {
- key: "ocViewMuteByIdWithHttpInfo",
- value: function ocViewMuteByIdWithHttpInfo(apiToken, channelUrl, mutedUserId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocViewMuteById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocViewMuteById");
- }
- // verify the required parameter 'mutedUserId' is set
- if (mutedUserId === undefined || mutedUserId === null) {
- throw new Error("Missing the required parameter 'mutedUserId' when calling ocViewMuteById");
- }
- var pathParams = {
- 'channel_url': channelUrl,
- 'muted_user_id': mutedUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _OcViewMuteByIdResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/mute/{muted_user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a mute
- * ## View a mute Checks if a user is muted in an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-view-a-mute ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {String} mutedUserId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcViewMuteByIdResponse}
+ * @param {String} opts.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.
+ * @param {String} opts.metadatakey
+ * @param {String} opts.metadatavaluesIn
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListBlockedUsersResponse}
*/
}, {
- key: "ocViewMuteById",
- value: function ocViewMuteById(apiToken, channelUrl, mutedUserId) {
- return this.ocViewMuteByIdWithHttpInfo(apiToken, channelUrl, mutedUserId).then(function (response_and_data) {
+ key: "listBlockedUsers",
+ value: function listBlockedUsers(userId, opts) {
+ return this.listBlockedUsersWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Unblock a user
- * ## Unblock a user Unblocks the user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-unblock-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} targetId
+ * ## Unblock a user Unblocks the user. https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/unblock-a-user#1-unblock-a-user
+ * @param {String} userId (Required)
+ * @param {String} targetId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "unblockUserByIdWithHttpInfo",
- value: function unblockUserByIdWithHttpInfo(apiToken, userId, targetId) {
+ key: "unblockAUserWithHttpInfo",
+ value: function unblockAUserWithHttpInfo(userId, targetId, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling unblockUserById");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling unblockUserById");
+ throw new Error("Missing the required parameter 'userId' when calling unblockAUser");
}
// verify the required parameter 'targetId' is set
if (targetId === undefined || targetId === null) {
- throw new Error("Missing the required parameter 'targetId' when calling unblockUserById");
+ throw new Error("Missing the required parameter 'targetId' when calling unblockAUser");
}
var pathParams = {
'user_id': userId,
@@ -1565,7 +293,7 @@ var ModerationApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1577,20 +305,19 @@ var ModerationApi = /*#__PURE__*/function () {
/**
* Unblock a user
- * ## Unblock a user Unblocks the user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-unblock-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} targetId
+ * ## Unblock a user Unblocks the user. https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/unblock-a-user#1-unblock-a-user
+ * @param {String} userId (Required)
+ * @param {String} targetId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "unblockUserById",
- value: function unblockUserById(apiToken, userId, targetId) {
- return this.unblockUserByIdWithHttpInfo(apiToken, userId, targetId).then(function (response_and_data) {
+ key: "unblockAUser",
+ value: function unblockAUser(userId, targetId, opts) {
+ return this.unblockAUserWithHttpInfo(userId, targetId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return ModerationApi;
-}();
-exports["default"] = ModerationApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/OpenChannelApi.js b/dist/api/OpenChannelApi.js
index e2b7c9d..f41abaa 100644
--- a/dist/api/OpenChannelApi.js
+++ b/dist/api/OpenChannelApi.js
@@ -5,24 +5,36 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _OcCreateChannelData = _interopRequireDefault(require("../model/OcCreateChannelData"));
-var _OcDeleteChannelByUrl200Response = _interopRequireDefault(require("../model/OcDeleteChannelByUrl200Response"));
-var _OcListChannelsResponse = _interopRequireDefault(require("../model/OcListChannelsResponse"));
-var _OcListOperatorsResponse = _interopRequireDefault(require("../model/OcListOperatorsResponse"));
-var _OcListParticipantsResponse = _interopRequireDefault(require("../model/OcListParticipantsResponse"));
-var _OcRegisterOperatorsData = _interopRequireDefault(require("../model/OcRegisterOperatorsData"));
-var _OcUpdateChannelByUrlData = _interopRequireDefault(require("../model/OcUpdateChannelByUrlData"));
-var _SendBirdOpenChannel = _interopRequireDefault(require("../model/SendBirdOpenChannel"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var _CreateAnOpenChannelRequest = _interopRequireDefault(require("../model/CreateAnOpenChannelRequest"));
+var _ListOpenChannelsResponse = _interopRequireDefault(require("../model/ListOpenChannelsResponse"));
+var _ListOperatorsResponse = _interopRequireDefault(require("../model/ListOperatorsResponse"));
+var _RegisterOperatorsToAGroupChannelRequest = _interopRequireDefault(require("../model/RegisterOperatorsToAGroupChannelRequest"));
+var _SendbirdOpenChannel = _interopRequireDefault(require("../model/SendbirdOpenChannel"));
+var _UpdateAnOpenChannelRequest = _interopRequireDefault(require("../model/UpdateAnOpenChannelRequest"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* OpenChannel service.
* @module api/OpenChannelApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var OpenChannelApi = /*#__PURE__*/function () {
+var OpenChannelApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new OpenChannelApi.
* @alias module:api/OpenChannelApi
@@ -36,254 +48,165 @@ var OpenChannelApi = /*#__PURE__*/function () {
}
/**
- * Cancel the registration of operators
- * ## Cancel the registration of operators Cancels the registration of operators from an open channel but leave them as participants. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-cancel-the-registration-of-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to cancel the registration of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Array.} operatorIds
+ * Create an open channel
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.deleteAll
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAnOpenChannelRequest} opts.createAnOpenChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdOpenChannel} and HTTP response
*/
- _createClass(OpenChannelApi, [{
- key: "ocCancelTheRegistrationOfOperatorsWithHttpInfo",
- value: function ocCancelTheRegistrationOfOperatorsWithHttpInfo(apiToken, channelUrl, operatorIds, opts) {
+ return _createClass(OpenChannelApi, [{
+ key: "createAnOpenChannelWithHttpInfo",
+ value: function createAnOpenChannelWithHttpInfo(opts) {
opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocCancelTheRegistrationOfOperators");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocCancelTheRegistrationOfOperators");
- }
- // verify the required parameter 'operatorIds' is set
- if (operatorIds === undefined || operatorIds === null) {
- throw new Error("Missing the required parameter 'operatorIds' when calling ocCancelTheRegistrationOfOperators");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'operator_ids': this.apiClient.buildCollectionParam(operatorIds, 'multi'),
- 'delete_all': opts['deleteAll']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/operators', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Cancel the registration of operators
- * ## Cancel the registration of operators Cancels the registration of operators from an open channel but leave them as participants. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-cancel-the-registration-of-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to cancel the registration of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
- * @param {Array.} operatorIds
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.deleteAll
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "ocCancelTheRegistrationOfOperators",
- value: function ocCancelTheRegistrationOfOperators(apiToken, channelUrl, operatorIds, opts) {
- return this.ocCancelTheRegistrationOfOperatorsWithHttpInfo(apiToken, channelUrl, operatorIds, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Create a channel
- * ## Create a channel Creates an open channel. >__Note__: Classic open channels created before the deprecation date of March 2021 will maintain their original form and functions. However, new applications created after December 15, 2020, will be able to create dynamic partitioning open channels only. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-create-a-channel
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/OcCreateChannelData} opts.ocCreateChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdOpenChannel} and HTTP response
- */
- }, {
- key: "ocCreateChannelWithHttpInfo",
- value: function ocCreateChannelWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['ocCreateChannelData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocCreateChannel");
- }
+ var postBody = opts['createAnOpenChannelRequest'];
var pathParams = {};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdOpenChannel["default"];
+ var returnType = _SendbirdOpenChannel["default"];
return this.apiClient.callApi('/v3/open_channels', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Create a channel
- * ## Create a channel Creates an open channel. >__Note__: Classic open channels created before the deprecation date of March 2021 will maintain their original form and functions. However, new applications created after December 15, 2020, will be able to create dynamic partitioning open channels only. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-create-a-channel
- * @param {String} apiToken
+ * Create an open channel
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {module:model/OcCreateChannelData} opts.ocCreateChannelData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdOpenChannel}
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAnOpenChannelRequest} opts.createAnOpenChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdOpenChannel}
*/
}, {
- key: "ocCreateChannel",
- value: function ocCreateChannel(apiToken, opts) {
- return this.ocCreateChannelWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ key: "createAnOpenChannel",
+ value: function createAnOpenChannel(opts) {
+ return this.createAnOpenChannelWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Delete a channel
- * ## Delete a channel Deletes an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-delete-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * Delete an open channel
+ * ## 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
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "ocDeleteChannelByUrlWithHttpInfo",
- value: function ocDeleteChannelByUrlWithHttpInfo(apiToken, channelUrl) {
+ key: "deleteAnOpenChannelWithHttpInfo",
+ value: function deleteAnOpenChannelWithHttpInfo(channelUrl, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocDeleteChannelByUrl");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocDeleteChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling deleteAnOpenChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
+ var returnType = Object;
return this.apiClient.callApi('/v3/open_channels/{channel_url}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Delete a channel
- * ## Delete a channel Deletes an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-delete-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * Delete an open channel
+ * ## 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
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "ocDeleteChannelByUrl",
- value: function ocDeleteChannelByUrl(apiToken, channelUrl) {
- return this.ocDeleteChannelByUrlWithHttpInfo(apiToken, channelUrl).then(function (response_and_data) {
+ key: "deleteAnOpenChannel",
+ value: function deleteAnOpenChannel(channelUrl, opts) {
+ return this.deleteAnOpenChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * List channels
- * ## List channels Retrieves a list of open channels. You can query the list using various parameters. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-channels ----------------------------
- * @param {String} apiToken
+ * Get an open channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.customTypes
- * @param {String} opts.nameContains
- * @param {String} opts.urlContains
- * @param {Boolean} opts.showFrozen
- * @param {Boolean} opts.showMetadata
- * @param {String} opts.customType
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcListChannelsResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {Boolean} opts.includeOperators Determines whether to include a list of operators in the response. (Default: false)
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdOpenChannel} and HTTP response
*/
}, {
- key: "ocListChannelsWithHttpInfo",
- value: function ocListChannelsWithHttpInfo(apiToken, opts) {
+ key: "getAnOpenChannelWithHttpInfo",
+ value: function getAnOpenChannelWithHttpInfo(channelUrl, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocListChannels");
+ // verify the required parameter 'channelUrl' is set
+ if (channelUrl === undefined || channelUrl === null) {
+ throw new Error("Missing the required parameter 'channelUrl' when calling getAnOpenChannel");
}
- var pathParams = {};
+ var pathParams = {
+ 'channel_url': channelUrl
+ };
var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit'],
- 'custom_types': opts['customTypes'],
- 'name_contains': opts['nameContains'],
- 'url_contains': opts['urlContains'],
- 'show_frozen': opts['showFrozen'],
- 'show_metadata': opts['showMetadata'],
- 'custom_type': opts['customType']
+ 'include_operators': opts['includeOperators']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcListChannelsResponse["default"];
- return this.apiClient.callApi('/v3/open_channels', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdOpenChannel["default"];
+ return this.apiClient.callApi('/v3/open_channels/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * List channels
- * ## List channels Retrieves a list of open channels. You can query the list using various parameters. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-channels ----------------------------
- * @param {String} apiToken
+ * Get an open channel
+ * ## 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)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.customTypes
- * @param {String} opts.nameContains
- * @param {String} opts.urlContains
- * @param {Boolean} opts.showFrozen
- * @param {Boolean} opts.showMetadata
- * @param {String} opts.customType
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcListChannelsResponse}
+ * @param {String} opts.apiToken
+ * @param {Boolean} opts.includeOperators Determines whether to include a list of operators in the response. (Default: false)
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdOpenChannel}
*/
}, {
- key: "ocListChannels",
- value: function ocListChannels(apiToken, opts) {
- return this.ocListChannelsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ key: "getAnOpenChannel",
+ value: function getAnOpenChannel(channelUrl, opts) {
+ return this.getAnOpenChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * List operators
- * ## List operators Retrieves a list of operators of an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * List operators of an open channel
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.token
* @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcListOperatorsResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListOperatorsResponse} and HTTP response
*/
}, {
- key: "ocListOperatorsWithHttpInfo",
- value: function ocListOperatorsWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "listChannelOperatorsWithHttpInfo",
+ value: function listChannelOperatorsWithHttpInfo(channelUrl, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocListOperators");
- }
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocListOperators");
+ throw new Error("Missing the required parameter 'channelUrl' when calling listChannelOperators");
}
var pathParams = {
'channel_url': channelUrl
@@ -293,250 +216,256 @@ var OpenChannelApi = /*#__PURE__*/function () {
'limit': opts['limit']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcListOperatorsResponse["default"];
+ var returnType = _ListOperatorsResponse["default"];
return this.apiClient.callApi('/v3/open_channels/{channel_url}/operators', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * List operators
- * ## List operators Retrieves a list of operators of an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-operators ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of operators.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * List operators of an open channel
+ * ## 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.
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
* @param {String} opts.token
* @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcListOperatorsResponse}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListOperatorsResponse}
*/
}, {
- key: "ocListOperators",
- value: function ocListOperators(apiToken, channelUrl, opts) {
- return this.ocListOperatorsWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "listChannelOperators",
+ value: function listChannelOperators(channelUrl, opts) {
+ return this.listChannelOperatorsWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * List participants
- * ## List participants Retrieves a list of the participants of an open channel. A participant refers to a user who has entered the open channel and is currently online. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-participants ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of participants in.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * List open channels
+ * ## 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)
* @param {Object} opts Optional parameters
* @param {String} opts.token
+ * @param {String} opts.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.
* @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcListParticipantsResponse} and HTTP response
+ * @param {String} opts.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.
+ * @param {String} opts.nameContains
+ * @param {String} opts.urlContains
+ * @param {Boolean} opts.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)
+ * @param {Boolean} opts.showMetadata Determines whether to include channel metadata in the response. (Default: false)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListOpenChannelsResponse} and HTTP response
*/
}, {
- key: "ocListParticipantsWithHttpInfo",
- value: function ocListParticipantsWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "listOpenChannelsWithHttpInfo",
+ value: function listOpenChannelsWithHttpInfo(opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocListParticipants");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocListParticipants");
- }
- var pathParams = {
- 'channel_url': channelUrl
- };
+ var pathParams = {};
var queryParams = {
'token': opts['token'],
- 'limit': opts['limit']
+ 'channel_urls': opts['channelUrls'],
+ 'limit': opts['limit'],
+ 'custom_types': opts['customTypes'],
+ 'name_contains': opts['nameContains'],
+ 'url_contains': opts['urlContains'],
+ 'show_frozen': opts['showFrozen'],
+ 'show_metadata': opts['showMetadata']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _OcListParticipantsResponse["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}/participants', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _ListOpenChannelsResponse["default"];
+ return this.apiClient.callApi('/v3/open_channels', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * List participants
- * ## List participants Retrieves a list of the participants of an open channel. A participant refers to a user who has entered the open channel and is currently online. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-list-participants ---------------------------- `channel_url` Type: string Description: Specifies the URL of the channel to retrieve a list of participants in.
- * @param {String} apiToken
- * @param {String} channelUrl
+ * List open channels
+ * ## 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)
* @param {Object} opts Optional parameters
* @param {String} opts.token
+ * @param {String} opts.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.
* @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcListParticipantsResponse}
+ * @param {String} opts.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.
+ * @param {String} opts.nameContains
+ * @param {String} opts.urlContains
+ * @param {Boolean} opts.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)
+ * @param {Boolean} opts.showMetadata Determines whether to include channel metadata in the response. (Default: false)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListOpenChannelsResponse}
*/
}, {
- key: "ocListParticipants",
- value: function ocListParticipants(apiToken, channelUrl, opts) {
- return this.ocListParticipantsWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "listOpenChannels",
+ value: function listOpenChannels(opts) {
+ return this.listOpenChannelsWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Register operators
- * ## Register operators Registers one or more operators to an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-register-operators ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Register operators to an open channel
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/OcRegisterOperatorsData} opts.ocRegisterOperatorsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcDeleteChannelByUrl200Response} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/RegisterOperatorsToAGroupChannelRequest} opts.registerOperatorsToAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "ocRegisterOperatorsWithHttpInfo",
- value: function ocRegisterOperatorsWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "registerOperatorsWithHttpInfo",
+ value: function registerOperatorsWithHttpInfo(channelUrl, opts) {
opts = opts || {};
- var postBody = opts['ocRegisterOperatorsData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocRegisterOperators");
- }
+ var postBody = opts['registerOperatorsToAGroupChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocRegisterOperators");
+ throw new Error("Missing the required parameter 'channelUrl' when calling registerOperators");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _OcDeleteChannelByUrl200Response["default"];
+ var returnType = Object;
return this.apiClient.callApi('/v3/open_channels/{channel_url}/operators', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Register operators
- * ## Register operators Registers one or more operators to an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-register-operators ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Register operators to an open channel
+ * ## 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
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/OcRegisterOperatorsData} opts.ocRegisterOperatorsData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcDeleteChannelByUrl200Response}
+ * @param {String} opts.apiToken
+ * @param {module:model/RegisterOperatorsToAGroupChannelRequest} opts.registerOperatorsToAGroupChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "ocRegisterOperators",
- value: function ocRegisterOperators(apiToken, channelUrl, opts) {
- return this.ocRegisterOperatorsWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "registerOperators",
+ value: function registerOperators(channelUrl, opts) {
+ return this.registerOperatorsWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update a channel
- * ## Update a channel Updates information on an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-update-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Unregister operators from an open channel
+ * ## 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.
+ * @param {String} channelUrl (Required)
+ * @param {String} 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.
* @param {Object} opts Optional parameters
- * @param {module:model/OcUpdateChannelByUrlData} opts.ocUpdateChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdOpenChannel} and HTTP response
+ * @param {Boolean} opts.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)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "ocUpdateChannelByUrlWithHttpInfo",
- value: function ocUpdateChannelByUrlWithHttpInfo(apiToken, channelUrl, opts) {
+ key: "unregisterOperatorsWithHttpInfo",
+ value: function unregisterOperatorsWithHttpInfo(channelUrl, operatorIds, opts) {
opts = opts || {};
- var postBody = opts['ocUpdateChannelByUrlData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocUpdateChannelByUrl");
- }
+ var postBody = null;
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocUpdateChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling unregisterOperators");
+ }
+ // verify the required parameter 'operatorIds' is set
+ if (operatorIds === undefined || operatorIds === null) {
+ throw new Error("Missing the required parameter 'operatorIds' when calling unregisterOperators");
}
var pathParams = {
'channel_url': channelUrl
};
- var queryParams = {};
+ var queryParams = {
+ 'operator_ids': operatorIds,
+ 'delete_all': opts['deleteAll']
+ };
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = ['application/json'];
+ var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _SendBirdOpenChannel["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/open_channels/{channel_url}/operators', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Update a channel
- * ## Update a channel Updates information on an open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-update-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
+ * Unregister operators from an open channel
+ * ## 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.
+ * @param {String} channelUrl (Required)
+ * @param {String} 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.
* @param {Object} opts Optional parameters
- * @param {module:model/OcUpdateChannelByUrlData} opts.ocUpdateChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdOpenChannel}
+ * @param {Boolean} opts.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)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "ocUpdateChannelByUrl",
- value: function ocUpdateChannelByUrl(apiToken, channelUrl, opts) {
- return this.ocUpdateChannelByUrlWithHttpInfo(apiToken, channelUrl, opts).then(function (response_and_data) {
+ key: "unregisterOperators",
+ value: function unregisterOperators(channelUrl, operatorIds, opts) {
+ return this.unregisterOperatorsWithHttpInfo(channelUrl, operatorIds, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * View a channel
- * ## View a channel Retrieves information on a specific open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-view-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdOpenChannel} and HTTP response
+ * Update an open channel
+ * ## 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
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAnOpenChannelRequest} opts.updateAnOpenChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdOpenChannel} and HTTP response
*/
}, {
- key: "ocViewChannelByUrlWithHttpInfo",
- value: function ocViewChannelByUrlWithHttpInfo(apiToken, channelUrl) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling ocViewChannelByUrl");
- }
+ key: "updateAnOpenChannelWithHttpInfo",
+ value: function updateAnOpenChannelWithHttpInfo(channelUrl, opts) {
+ opts = opts || {};
+ var postBody = opts['updateAnOpenChannelRequest'];
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling ocViewChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling updateAnOpenChannel");
}
var pathParams = {
'channel_url': channelUrl
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = [];
+ var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdOpenChannel["default"];
- return this.apiClient.callApi('/v3/open_channels/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdOpenChannel["default"];
+ return this.apiClient.callApi('/v3/open_channels/{channel_url}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View a channel
- * ## View a channel Retrieves information on a specific open channel. https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-view-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdOpenChannel}
+ * Update an open channel
+ * ## 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
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAnOpenChannelRequest} opts.updateAnOpenChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdOpenChannel}
*/
}, {
- key: "ocViewChannelByUrl",
- value: function ocViewChannelByUrl(apiToken, channelUrl) {
- return this.ocViewChannelByUrlWithHttpInfo(apiToken, channelUrl).then(function (response_and_data) {
+ key: "updateAnOpenChannel",
+ value: function updateAnOpenChannel(channelUrl, opts) {
+ return this.updateAnOpenChannelWithHttpInfo(channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return OpenChannelApi;
-}();
-exports["default"] = OpenChannelApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/PrivacyApi.js b/dist/api/PrivacyApi.js
deleted file mode 100644
index 775333d..0000000
--- a/dist/api/PrivacyApi.js
+++ /dev/null
@@ -1,231 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _ListGdprRequestsResponse = _interopRequireDefault(require("../model/ListGdprRequestsResponse"));
-var _RegisterGdprRequestData = _interopRequireDefault(require("../model/RegisterGdprRequestData"));
-var _RegisterGdprRequestResponse = _interopRequireDefault(require("../model/RegisterGdprRequestResponse"));
-var _ViewGdprRequestByIdResponse = _interopRequireDefault(require("../model/ViewGdprRequestByIdResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
-* Privacy service.
-* @module api/PrivacyApi
-* @version 0.0.16
-*/
-var PrivacyApi = /*#__PURE__*/function () {
- /**
- * Constructs a new PrivacyApi.
- * @alias module:api/PrivacyApi
- * @class
- * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
- * default to {@link module:ApiClient#instance} if unspecified.
- */
- function PrivacyApi(apiClient) {
- _classCallCheck(this, PrivacyApi);
- this.apiClient = apiClient || _ApiClient["default"].instance;
- }
-
- /**
- * Cancel the registration of a GDPR request
- * ## Cancel the registration of a GDPR request Cancels the registration of a specific GDPR request. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-cancel-the-registration-of-a-gdpr-request ----------------------------
- * @param {String} apiToken
- * @param {String} requestId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
- */
- _createClass(PrivacyApi, [{
- key: "cancelTheRegistrationOfGdprRequestByIdWithHttpInfo",
- value: function cancelTheRegistrationOfGdprRequestByIdWithHttpInfo(apiToken, requestId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling cancelTheRegistrationOfGdprRequestById");
- }
- // verify the required parameter 'requestId' is set
- if (requestId === undefined || requestId === null) {
- throw new Error("Missing the required parameter 'requestId' when calling cancelTheRegistrationOfGdprRequestById");
- }
- var pathParams = {
- 'request_id': requestId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = [];
- var returnType = null;
- return this.apiClient.callApi('/v3/privacy/gdpr/{request_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Cancel the registration of a GDPR request
- * ## Cancel the registration of a GDPR request Cancels the registration of a specific GDPR request. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-cancel-the-registration-of-a-gdpr-request ----------------------------
- * @param {String} apiToken
- * @param {String} requestId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}
- */
- }, {
- key: "cancelTheRegistrationOfGdprRequestById",
- value: function cancelTheRegistrationOfGdprRequestById(apiToken, requestId) {
- return this.cancelTheRegistrationOfGdprRequestByIdWithHttpInfo(apiToken, requestId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List GDPR requests
- * ## List GDPR requests Retrieves a list of GDPR requests of all types. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-list-gdpr-requests ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListGdprRequestsResponse} and HTTP response
- */
- }, {
- key: "listGdprRequestsWithHttpInfo",
- value: function listGdprRequestsWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listGdprRequests");
- }
- var pathParams = {};
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListGdprRequestsResponse["default"];
- return this.apiClient.callApi('/v3/privacy/gdpr', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List GDPR requests
- * ## List GDPR requests Retrieves a list of GDPR requests of all types. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-list-gdpr-requests ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListGdprRequestsResponse}
- */
- }, {
- key: "listGdprRequests",
- value: function listGdprRequests(apiToken, opts) {
- return this.listGdprRequestsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Register a GDPR request
- * ## Register a GDPR request Registers a specific type of GDPR request to meet the GDPR's requirements. > __Note__: Currently, only delete and access of the user data are supported. The features for the [right to restriction of processing](https://gdpr-info.eu/art-18-gdpr/) and [right to object](https://gdpr-info.eu/art-21-gdpr/) will be available soon. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-register-a-gdpr-request
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/RegisterGdprRequestData} opts.registerGdprRequestData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RegisterGdprRequestResponse} and HTTP response
- */
- }, {
- key: "registerGdprRequestWithHttpInfo",
- value: function registerGdprRequestWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['registerGdprRequestData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling registerGdprRequest");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _RegisterGdprRequestResponse["default"];
- return this.apiClient.callApi('/v3/privacy/gdpr', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Register a GDPR request
- * ## Register a GDPR request Registers a specific type of GDPR request to meet the GDPR's requirements. > __Note__: Currently, only delete and access of the user data are supported. The features for the [right to restriction of processing](https://gdpr-info.eu/art-18-gdpr/) and [right to object](https://gdpr-info.eu/art-21-gdpr/) will be available soon. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-register-a-gdpr-request
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/RegisterGdprRequestData} opts.registerGdprRequestData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RegisterGdprRequestResponse}
- */
- }, {
- key: "registerGdprRequest",
- value: function registerGdprRequest(apiToken, opts) {
- return this.registerGdprRequestWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a GDPR request
- * ## View a GDPR request Retrieves a specific GDPR request. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-view-a-gdpr-request ----------------------------
- * @param {String} apiToken
- * @param {String} requestId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewGdprRequestByIdResponse} and HTTP response
- */
- }, {
- key: "viewGdprRequestByIdWithHttpInfo",
- value: function viewGdprRequestByIdWithHttpInfo(apiToken, requestId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewGdprRequestById");
- }
- // verify the required parameter 'requestId' is set
- if (requestId === undefined || requestId === null) {
- throw new Error("Missing the required parameter 'requestId' when calling viewGdprRequestById");
- }
- var pathParams = {
- 'request_id': requestId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewGdprRequestByIdResponse["default"];
- return this.apiClient.callApi('/v3/privacy/gdpr/{request_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a GDPR request
- * ## View a GDPR request Retrieves a specific GDPR request. https://sendbird.com/docs/chat/v3/platform-api/guides/data-privacy#2-view-a-gdpr-request ----------------------------
- * @param {String} apiToken
- * @param {String} requestId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewGdprRequestByIdResponse}
- */
- }, {
- key: "viewGdprRequestById",
- value: function viewGdprRequestById(apiToken, requestId) {
- return this.viewGdprRequestByIdWithHttpInfo(apiToken, requestId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
- }]);
- return PrivacyApi;
-}();
-exports["default"] = PrivacyApi;
\ No newline at end of file
diff --git a/dist/api/ReportApi.js b/dist/api/ReportApi.js
deleted file mode 100644
index fdc6279..0000000
--- a/dist/api/ReportApi.js
+++ /dev/null
@@ -1,543 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _ListReportsOnChannelByUrlResponse = _interopRequireDefault(require("../model/ListReportsOnChannelByUrlResponse"));
-var _ListReportsOnMessageByIdResponse = _interopRequireDefault(require("../model/ListReportsOnMessageByIdResponse"));
-var _ListReportsOnUserByIdResponse = _interopRequireDefault(require("../model/ListReportsOnUserByIdResponse"));
-var _ListReportsResponse = _interopRequireDefault(require("../model/ListReportsResponse"));
-var _ReportChannelByUrlData = _interopRequireDefault(require("../model/ReportChannelByUrlData"));
-var _ReportChannelByUrlResponse = _interopRequireDefault(require("../model/ReportChannelByUrlResponse"));
-var _ReportMessageByIdData = _interopRequireDefault(require("../model/ReportMessageByIdData"));
-var _ReportMessageByIdResponse = _interopRequireDefault(require("../model/ReportMessageByIdResponse"));
-var _ReportUserByIdData = _interopRequireDefault(require("../model/ReportUserByIdData"));
-var _ReportUserByIdResponse = _interopRequireDefault(require("../model/ReportUserByIdResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
-* Report service.
-* @module api/ReportApi
-* @version 0.0.16
-*/
-var ReportApi = /*#__PURE__*/function () {
- /**
- * Constructs a new ReportApi.
- * @alias module:api/ReportApi
- * @class
- * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
- * default to {@link module:ApiClient#instance} if unspecified.
- */
- function ReportApi(apiClient) {
- _classCallCheck(this, ReportApi);
- this.apiClient = apiClient || _ApiClient["default"].instance;
- }
-
- /**
- * List reports
- * ## List reports Retrieves a list of reports within an application regardless of object types. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {Number} opts.startTs
- * @param {Number} opts.endTs
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListReportsResponse} and HTTP response
- */
- _createClass(ReportApi, [{
- key: "listReportsWithHttpInfo",
- value: function listReportsWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listReports");
- }
- var pathParams = {};
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit'],
- 'start_ts': opts['startTs'],
- 'end_ts': opts['endTs']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListReportsResponse["default"];
- return this.apiClient.callApi('/v3/report', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List reports
- * ## List reports Retrieves a list of reports within an application regardless of object types. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {Number} opts.startTs
- * @param {Number} opts.endTs
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListReportsResponse}
- */
- }, {
- key: "listReports",
- value: function listReports(apiToken, opts) {
- return this.listReportsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List reports on a channel
- * ## List reports on a channel Retrieves a list of reports on a channel that has offensive messages or abusive activities. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports-on-a-channel ---------------------------- `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 is reported for offensive messages or inappropriate activities.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListReportsOnChannelByUrlResponse} and HTTP response
- */
- }, {
- key: "listReportsOnChannelByUrlWithHttpInfo",
- value: function listReportsOnChannelByUrlWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listReportsOnChannelByUrl");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling listReportsOnChannelByUrl");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling listReportsOnChannelByUrl");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListReportsOnChannelByUrlResponse["default"];
- return this.apiClient.callApi('/v3/report/{channel_type}/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List reports on a channel
- * ## List reports on a channel Retrieves a list of reports on a channel that has offensive messages or abusive activities. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports-on-a-channel ---------------------------- `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 is reported for offensive messages or inappropriate activities.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListReportsOnChannelByUrlResponse}
- */
- }, {
- key: "listReportsOnChannelByUrl",
- value: function listReportsOnChannelByUrl(apiToken, channelType, channelUrl, opts) {
- return this.listReportsOnChannelByUrlWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List reports on a message
- * ## List reports on a message Retrieves a list of reports on a message which contains suspicious, harassing, or inappropriate content. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports-on-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 channel where the reported message is in. `message_id` Type: string Description: Specifies the unique ID of the reported message.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListReportsOnMessageByIdResponse} and HTTP response
- */
- }, {
- key: "listReportsOnMessageByIdWithHttpInfo",
- value: function listReportsOnMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listReportsOnMessageById");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling listReportsOnMessageById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling listReportsOnMessageById");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling listReportsOnMessageById");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListReportsOnMessageByIdResponse["default"];
- return this.apiClient.callApi('/v3/report/{channel_type}/{channel_url}/messages/{message_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List reports on a message
- * ## List reports on a message Retrieves a list of reports on a message which contains suspicious, harassing, or inappropriate content. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports-on-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 channel where the reported message is in. `message_id` Type: string Description: Specifies the unique ID of the reported message.
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListReportsOnMessageByIdResponse}
- */
- }, {
- key: "listReportsOnMessageById",
- value: function listReportsOnMessageById(apiToken, channelType, channelUrl, messageId, opts) {
- return this.listReportsOnMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * List reports on a user
- * ## List reports on a user Retrieves a list of reports on a user who sends an offensive message. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports-on-a-user ---------------------------- `offending_user_id` Type: string Description: Specifies the unique ID of the user who has sent the message to report.
- * @param {String} apiToken
- * @param {String} offendingUserId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListReportsOnUserByIdResponse} and HTTP response
- */
- }, {
- key: "listReportsOnUserByIdWithHttpInfo",
- value: function listReportsOnUserByIdWithHttpInfo(apiToken, offendingUserId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listReportsOnUserById");
- }
- // verify the required parameter 'offendingUserId' is set
- if (offendingUserId === undefined || offendingUserId === null) {
- throw new Error("Missing the required parameter 'offendingUserId' when calling listReportsOnUserById");
- }
- var pathParams = {
- 'offending_user_id': offendingUserId
- };
- var queryParams = {
- 'token': opts['token'],
- 'limit': opts['limit']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ListReportsOnUserByIdResponse["default"];
- return this.apiClient.callApi('/v3/report/users/{offending_user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * List reports on a user
- * ## List reports on a user Retrieves a list of reports on a user who sends an offensive message. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-list-reports-on-a-user ---------------------------- `offending_user_id` Type: string Description: Specifies the unique ID of the user who has sent the message to report.
- * @param {String} apiToken
- * @param {String} offendingUserId
- * @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListReportsOnUserByIdResponse}
- */
- }, {
- key: "listReportsOnUserById",
- value: function listReportsOnUserById(apiToken, offendingUserId, opts) {
- return this.listReportsOnUserByIdWithHttpInfo(apiToken, offendingUserId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Report a channel
- * ## Report a channel Reports a channel that has offensive messages or abusive activities. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-report-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/ReportChannelByUrlData} opts.reportChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ReportChannelByUrlResponse} and HTTP response
- */
- }, {
- key: "reportChannelByUrlWithHttpInfo",
- value: function reportChannelByUrlWithHttpInfo(apiToken, channelType, channelUrl, opts) {
- opts = opts || {};
- var postBody = opts['reportChannelByUrlData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling reportChannelByUrl");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling reportChannelByUrl");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling reportChannelByUrl");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _ReportChannelByUrlResponse["default"];
- return this.apiClient.callApi('/v3/report/{channel_type}/{channel_url}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Report a channel
- * ## Report a channel Reports a channel that has offensive messages or abusive activities. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-report-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {Object} opts Optional parameters
- * @param {module:model/ReportChannelByUrlData} opts.reportChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ReportChannelByUrlResponse}
- */
- }, {
- key: "reportChannelByUrl",
- value: function reportChannelByUrl(apiToken, channelType, channelUrl, opts) {
- return this.reportChannelByUrlWithHttpInfo(apiToken, channelType, channelUrl, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Report a message
- * ## Report a message Reports a message which contains suspicious, harassing, or inappropriate content. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-report-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/ReportMessageByIdData} opts.reportMessageByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ReportMessageByIdResponse} and HTTP response
- */
- }, {
- key: "reportMessageByIdWithHttpInfo",
- value: function reportMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts) {
- opts = opts || {};
- var postBody = opts['reportMessageByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling reportMessageById");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling reportMessageById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling reportMessageById");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling reportMessageById");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _ReportMessageByIdResponse["default"];
- return this.apiClient.callApi('/v3/report/{channel_type}/{channel_url}/messages/{message_id}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Report a message
- * ## Report a message Reports a message which contains suspicious, harassing, or inappropriate content. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-report-a-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @param {Object} opts Optional parameters
- * @param {module:model/ReportMessageByIdData} opts.reportMessageByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ReportMessageByIdResponse}
- */
- }, {
- key: "reportMessageById",
- value: function reportMessageById(apiToken, channelType, channelUrl, messageId, opts) {
- return this.reportMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Report a user
- * ## Report a user Reports a user who sends an offensive message in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-report-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} offendingUserId
- * @param {Object} opts Optional parameters
- * @param {module:model/ReportUserByIdData} opts.reportUserByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ReportUserByIdResponse} and HTTP response
- */
- }, {
- key: "reportUserByIdWithHttpInfo",
- value: function reportUserByIdWithHttpInfo(apiToken, offendingUserId, opts) {
- opts = opts || {};
- var postBody = opts['reportUserByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling reportUserById");
- }
- // verify the required parameter 'offendingUserId' is set
- if (offendingUserId === undefined || offendingUserId === null) {
- throw new Error("Missing the required parameter 'offendingUserId' when calling reportUserById");
- }
- var pathParams = {
- 'offending_user_id': offendingUserId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _ReportUserByIdResponse["default"];
- return this.apiClient.callApi('/v3/report/users/{offending_user_id}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Report a user
- * ## Report a user Reports a user who sends an offensive message in a channel. https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-report-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} offendingUserId
- * @param {Object} opts Optional parameters
- * @param {module:model/ReportUserByIdData} opts.reportUserByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ReportUserByIdResponse}
- */
- }, {
- key: "reportUserById",
- value: function reportUserById(apiToken, offendingUserId, opts) {
- return this.reportUserByIdWithHttpInfo(apiToken, offendingUserId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a moderated message
- * ## View a moderated message Retrieves information on a message that has been moderated by the [profanity filter](https://sendbird.com/docs/chat/v3/platform-api/guides/filter-and-moderation#2-profanity-filter). https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-view-a-moderated-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
- */
- }, {
- key: "viewModeratedMessageByIdWithHttpInfo",
- value: function viewModeratedMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewModeratedMessageById");
- }
- // verify the required parameter 'channelType' is set
- if (channelType === undefined || channelType === null) {
- throw new Error("Missing the required parameter 'channelType' when calling viewModeratedMessageById");
- }
- // verify the required parameter 'channelUrl' is set
- if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewModeratedMessageById");
- }
- // verify the required parameter 'messageId' is set
- if (messageId === undefined || messageId === null) {
- throw new Error("Missing the required parameter 'messageId' when calling viewModeratedMessageById");
- }
- var pathParams = {
- 'channel_type': channelType,
- 'channel_url': channelUrl,
- 'message_id': messageId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/report/{channel_type}/{channel_url}/profanity_messages/{message_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a moderated message
- * ## View a moderated message Retrieves information on a message that has been moderated by the [profanity filter](https://sendbird.com/docs/chat/v3/platform-api/guides/filter-and-moderation#2-profanity-filter). https://sendbird.com/docs/chat/v3/platform-api/guides/report-content-and-subject#2-view-a-moderated-message ----------------------------
- * @param {String} apiToken
- * @param {String} channelType
- * @param {String} channelUrl
- * @param {String} messageId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
- */
- }, {
- key: "viewModeratedMessageById",
- value: function viewModeratedMessageById(apiToken, channelType, channelUrl, messageId) {
- return this.viewModeratedMessageByIdWithHttpInfo(apiToken, channelType, channelUrl, messageId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
- }]);
- return ReportApi;
-}();
-exports["default"] = ReportApi;
\ No newline at end of file
diff --git a/dist/api/StatisticsApi.js b/dist/api/StatisticsApi.js
index ca948ab..7b47e64 100644
--- a/dist/api/StatisticsApi.js
+++ b/dist/api/StatisticsApi.js
@@ -5,23 +5,32 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _GetDetailedOpenRateOfAnnouncementByIdResponse = _interopRequireDefault(require("../model/GetDetailedOpenRateOfAnnouncementByIdResponse"));
-var _GetDetailedOpenStatusOfAnnouncementByIdResponse = _interopRequireDefault(require("../model/GetDetailedOpenStatusOfAnnouncementByIdResponse"));
-var _RetrieveAdvancedAnalyticsMetricsResponse = _interopRequireDefault(require("../model/RetrieveAdvancedAnalyticsMetricsResponse"));
-var _ViewNumberOfConcurrentConnectionsResponse = _interopRequireDefault(require("../model/ViewNumberOfConcurrentConnectionsResponse"));
var _ViewNumberOfDailyActiveUsersResponse = _interopRequireDefault(require("../model/ViewNumberOfDailyActiveUsersResponse"));
var _ViewNumberOfMonthlyActiveUsersResponse = _interopRequireDefault(require("../model/ViewNumberOfMonthlyActiveUsersResponse"));
-var _ViewNumberOfPeakConnectionsResponse = _interopRequireDefault(require("../model/ViewNumberOfPeakConnectionsResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* Statistics service.
* @module api/StatisticsApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var StatisticsApi = /*#__PURE__*/function () {
+var StatisticsApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new StatisticsApi.
* @alias module:api/StatisticsApi
@@ -35,227 +44,24 @@ var StatisticsApi = /*#__PURE__*/function () {
}
/**
- * Get detailed open rate of an announcement
- * ## Get detailed open rate of an announcement Retrieves the detailed open rate information of an announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-rate-of-an-announcement ---------------------------- `unique_id` Type: string Description: Specifies the unique ID of the announcement to get its open rate.
- * @param {String} apiToken
- * @param {String} uniqueId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDetailedOpenRateOfAnnouncementByIdResponse} and HTTP response
+ * View number of daily active users
+ * ## 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)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.date YYYY-MM-DD
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfDailyActiveUsersResponse} and HTTP response
*/
- _createClass(StatisticsApi, [{
- key: "getDetailedOpenRateOfAnnouncementByIdWithHttpInfo",
- value: function getDetailedOpenRateOfAnnouncementByIdWithHttpInfo(apiToken, uniqueId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getDetailedOpenRateOfAnnouncementById");
- }
- // verify the required parameter 'uniqueId' is set
- if (uniqueId === undefined || uniqueId === null) {
- throw new Error("Missing the required parameter 'uniqueId' when calling getDetailedOpenRateOfAnnouncementById");
- }
- var pathParams = {
- 'unique_id': uniqueId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GetDetailedOpenRateOfAnnouncementByIdResponse["default"];
- return this.apiClient.callApi('/v3/announcement_open_rate/{unique_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get detailed open rate of an announcement
- * ## Get detailed open rate of an announcement Retrieves the detailed open rate information of an announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-rate-of-an-announcement ---------------------------- `unique_id` Type: string Description: Specifies the unique ID of the announcement to get its open rate.
- * @param {String} apiToken
- * @param {String} uniqueId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDetailedOpenRateOfAnnouncementByIdResponse}
- */
- }, {
- key: "getDetailedOpenRateOfAnnouncementById",
- value: function getDetailedOpenRateOfAnnouncementById(apiToken, uniqueId) {
- return this.getDetailedOpenRateOfAnnouncementByIdWithHttpInfo(apiToken, uniqueId).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Get detailed open status of an announcement
- * ## Get detailed open status of an announcement Retrieves the detailed open status information of a specific announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-status-of-an-announcement ----------------------------
- * @param {String} apiToken
- * @param {String} uniqueId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.limit
- * @param {String} opts.next
- * @param {Array.} opts.uniqueIds
- * @param {Array.} opts.channelUrls
- * @param {Boolean} opts.hasOpened
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDetailedOpenStatusOfAnnouncementByIdResponse} and HTTP response
- */
- }, {
- key: "getDetailedOpenStatusOfAnnouncementByIdWithHttpInfo",
- value: function getDetailedOpenStatusOfAnnouncementByIdWithHttpInfo(apiToken, uniqueId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling getDetailedOpenStatusOfAnnouncementById");
- }
- // verify the required parameter 'uniqueId' is set
- if (uniqueId === undefined || uniqueId === null) {
- throw new Error("Missing the required parameter 'uniqueId' when calling getDetailedOpenStatusOfAnnouncementById");
- }
- var pathParams = {
- 'unique_id': uniqueId
- };
- var queryParams = {
- 'limit': opts['limit'],
- 'next': opts['next'],
- 'unique_ids': this.apiClient.buildCollectionParam(opts['uniqueIds'], 'multi'),
- 'channel_urls': this.apiClient.buildCollectionParam(opts['channelUrls'], 'multi'),
- 'has_opened': opts['hasOpened']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _GetDetailedOpenStatusOfAnnouncementByIdResponse["default"];
- return this.apiClient.callApi('/v3/announcement_open_status/{unique_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Get detailed open status of an announcement
- * ## Get detailed open status of an announcement Retrieves the detailed open status information of a specific announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-status-of-an-announcement ----------------------------
- * @param {String} apiToken
- * @param {String} uniqueId
- * @param {Object} opts Optional parameters
- * @param {Number} opts.limit
- * @param {String} opts.next
- * @param {Array.} opts.uniqueIds
- * @param {Array.} opts.channelUrls
- * @param {Boolean} opts.hasOpened
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDetailedOpenStatusOfAnnouncementByIdResponse}
- */
- }, {
- key: "getDetailedOpenStatusOfAnnouncementById",
- value: function getDetailedOpenStatusOfAnnouncementById(apiToken, uniqueId, opts) {
- return this.getDetailedOpenStatusOfAnnouncementByIdWithHttpInfo(apiToken, uniqueId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Retrieve Advanced analytics metrics
- * ## Retrieve Advanced analytics metrics Retrieves Advanced analytics metrics based on the specified parameters. You can retrieve either daily or monthly metrics using the time_dimension parameter. >__Note__: Daily metrics are calculated and updated every three hours, starting at 1 a.m. in UTC. Meanwhile, monthly metrics are calculated after the last day of the month. https://sendbird.com/docs/chat/v3/platform-api/guides/advanced-analytics#2-retrieve-advanced-analytics-metrics ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveAdvancedAnalyticsMetricsResponse} and HTTP response
- */
- }, {
- key: "retrieveAdvancedAnalyticsMetricsWithHttpInfo",
- value: function retrieveAdvancedAnalyticsMetricsWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling retrieveAdvancedAnalyticsMetrics");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _RetrieveAdvancedAnalyticsMetricsResponse["default"];
- return this.apiClient.callApi('/v3/statistics/metric', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Retrieve Advanced analytics metrics
- * ## Retrieve Advanced analytics metrics Retrieves Advanced analytics metrics based on the specified parameters. You can retrieve either daily or monthly metrics using the time_dimension parameter. >__Note__: Daily metrics are calculated and updated every three hours, starting at 1 a.m. in UTC. Meanwhile, monthly metrics are calculated after the last day of the month. https://sendbird.com/docs/chat/v3/platform-api/guides/advanced-analytics#2-retrieve-advanced-analytics-metrics ----------------------------
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveAdvancedAnalyticsMetricsResponse}
- */
- }, {
- key: "retrieveAdvancedAnalyticsMetrics",
- value: function retrieveAdvancedAnalyticsMetrics(apiToken) {
- return this.retrieveAdvancedAnalyticsMetricsWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View number of concurrent connections
- * ## View number of concurrent connections Retrieves the number of devices and opened browser tabs which are currently connected to Sendbird server. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-concurrent-connections
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfConcurrentConnectionsResponse} and HTTP response
- */
- }, {
- key: "viewNumberOfConcurrentConnectionsWithHttpInfo",
- value: function viewNumberOfConcurrentConnectionsWithHttpInfo(apiToken) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfConcurrentConnections");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewNumberOfConcurrentConnectionsResponse["default"];
- return this.apiClient.callApi('/v3/applications/ccu', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View number of concurrent connections
- * ## View number of concurrent connections Retrieves the number of devices and opened browser tabs which are currently connected to Sendbird server. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-concurrent-connections
- * @param {String} apiToken
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfConcurrentConnectionsResponse}
- */
- }, {
- key: "viewNumberOfConcurrentConnections",
- value: function viewNumberOfConcurrentConnections(apiToken) {
- return this.viewNumberOfConcurrentConnectionsWithHttpInfo(apiToken).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View number of daily active users
- * ## View number of daily active users Retrieves the number of daily active users of the application (DAU). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-daily-active-users ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {String} opts.date
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfDailyActiveUsersResponse} and HTTP response
- */
- }, {
+ return _createClass(StatisticsApi, [{
key: "viewNumberOfDailyActiveUsersWithHttpInfo",
- value: function viewNumberOfDailyActiveUsersWithHttpInfo(apiToken, opts) {
+ value: function viewNumberOfDailyActiveUsersWithHttpInfo(opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfDailyActiveUsers");
- }
var pathParams = {};
var queryParams = {
'date': opts['date']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -267,43 +73,39 @@ var StatisticsApi = /*#__PURE__*/function () {
/**
* View number of daily active users
- * ## View number of daily active users Retrieves the number of daily active users of the application (DAU). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-daily-active-users ----------------------------
- * @param {String} apiToken
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {String} opts.date
+ * @param {String} opts.date YYYY-MM-DD
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfDailyActiveUsersResponse}
*/
}, {
key: "viewNumberOfDailyActiveUsers",
- value: function viewNumberOfDailyActiveUsers(apiToken, opts) {
- return this.viewNumberOfDailyActiveUsersWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ value: function viewNumberOfDailyActiveUsers(opts) {
+ return this.viewNumberOfDailyActiveUsersWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View number of monthly active users
- * ## View number of monthly active users Retrieves the number of monthly active users of the application (MAU). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-monthly-active-users ----------------------------
- * @param {String} apiToken
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {String} opts.date
+ * @param {String} opts.date YYYY-MM-DD
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfMonthlyActiveUsersResponse} and HTTP response
*/
}, {
key: "viewNumberOfMonthlyActiveUsersWithHttpInfo",
- value: function viewNumberOfMonthlyActiveUsersWithHttpInfo(apiToken, opts) {
+ value: function viewNumberOfMonthlyActiveUsersWithHttpInfo(opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfMonthlyActiveUsers");
- }
var pathParams = {};
var queryParams = {
'date': opts['date']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -315,106 +117,18 @@ var StatisticsApi = /*#__PURE__*/function () {
/**
* View number of monthly active users
- * ## View number of monthly active users Retrieves the number of monthly active users of the application (MAU). https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-monthly-active-users ----------------------------
- * @param {String} apiToken
+ * ## 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)
* @param {Object} opts Optional parameters
- * @param {String} opts.date
+ * @param {String} opts.date YYYY-MM-DD
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfMonthlyActiveUsersResponse}
*/
}, {
key: "viewNumberOfMonthlyActiveUsers",
- value: function viewNumberOfMonthlyActiveUsers(apiToken, opts) {
- return this.viewNumberOfMonthlyActiveUsersWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View number of peak connections
- * ## View number of peak connections Retrieves the number of concurrently connected devices to Sendbird server during the requested time period. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-peak-connections ----------------------------
- * @param {String} apiToken
- * @param {String} timeDimension
- * @param {Number} startYear
- * @param {Number} startMonth
- * @param {Number} endYear
- * @param {Number} endMonth
- * @param {Object} opts Optional parameters
- * @param {Number} opts.startDay
- * @param {Number} opts.endDay
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfPeakConnectionsResponse} and HTTP response
- */
- }, {
- key: "viewNumberOfPeakConnectionsWithHttpInfo",
- value: function viewNumberOfPeakConnectionsWithHttpInfo(apiToken, timeDimension, startYear, startMonth, endYear, endMonth, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfPeakConnections");
- }
- // verify the required parameter 'timeDimension' is set
- if (timeDimension === undefined || timeDimension === null) {
- throw new Error("Missing the required parameter 'timeDimension' when calling viewNumberOfPeakConnections");
- }
- // verify the required parameter 'startYear' is set
- if (startYear === undefined || startYear === null) {
- throw new Error("Missing the required parameter 'startYear' when calling viewNumberOfPeakConnections");
- }
- // verify the required parameter 'startMonth' is set
- if (startMonth === undefined || startMonth === null) {
- throw new Error("Missing the required parameter 'startMonth' when calling viewNumberOfPeakConnections");
- }
- // verify the required parameter 'endYear' is set
- if (endYear === undefined || endYear === null) {
- throw new Error("Missing the required parameter 'endYear' when calling viewNumberOfPeakConnections");
- }
- // verify the required parameter 'endMonth' is set
- if (endMonth === undefined || endMonth === null) {
- throw new Error("Missing the required parameter 'endMonth' when calling viewNumberOfPeakConnections");
- }
- var pathParams = {};
- var queryParams = {
- 'time_dimension': timeDimension,
- 'start_year': startYear,
- 'start_month': startMonth,
- 'end_year': endYear,
- 'end_month': endMonth,
- 'start_day': opts['startDay'],
- 'end_day': opts['endDay']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewNumberOfPeakConnectionsResponse["default"];
- return this.apiClient.callApi('/v3/applications/peak_connections', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View number of peak connections
- * ## View number of peak connections Retrieves the number of concurrently connected devices to Sendbird server during the requested time period. https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-peak-connections ----------------------------
- * @param {String} apiToken
- * @param {String} timeDimension
- * @param {Number} startYear
- * @param {Number} startMonth
- * @param {Number} endYear
- * @param {Number} endMonth
- * @param {Object} opts Optional parameters
- * @param {Number} opts.startDay
- * @param {Number} opts.endDay
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfPeakConnectionsResponse}
- */
- }, {
- key: "viewNumberOfPeakConnections",
- value: function viewNumberOfPeakConnections(apiToken, timeDimension, startYear, startMonth, endYear, endMonth, opts) {
- return this.viewNumberOfPeakConnectionsWithHttpInfo(apiToken, timeDimension, startYear, startMonth, endYear, endMonth, opts).then(function (response_and_data) {
+ value: function viewNumberOfMonthlyActiveUsers(opts) {
+ return this.viewNumberOfMonthlyActiveUsersWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return StatisticsApi;
-}();
-exports["default"] = StatisticsApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/UserApi.js b/dist/api/UserApi.js
index f3f7190..8b747b6 100644
--- a/dist/api/UserApi.js
+++ b/dist/api/UserApi.js
@@ -5,51 +5,61 @@ Object.defineProperty(exports, "__esModule", {
});
exports["default"] = void 0;
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AddRegistrationOrDeviceTokenData = _interopRequireDefault(require("../model/AddRegistrationOrDeviceTokenData"));
-var _AddRegistrationOrDeviceTokenResponse = _interopRequireDefault(require("../model/AddRegistrationOrDeviceTokenResponse"));
-var _ChoosePushNotificationContentTemplateResponse = _interopRequireDefault(require("../model/ChoosePushNotificationContentTemplateResponse"));
-var _CreateUserData = _interopRequireDefault(require("../model/CreateUserData"));
-var _CreateUserTokenData = _interopRequireDefault(require("../model/CreateUserTokenData"));
+var _AddARegistrationOrDeviceTokenRequest = _interopRequireDefault(require("../model/AddARegistrationOrDeviceTokenRequest"));
+var _AddARegistrationOrDeviceTokenResponse = _interopRequireDefault(require("../model/AddARegistrationOrDeviceTokenResponse"));
+var _ChooseAPushNotificationContentTemplateRequest = _interopRequireDefault(require("../model/ChooseAPushNotificationContentTemplateRequest"));
+var _ChooseAPushNotificationContentTemplateResponse = _interopRequireDefault(require("../model/ChooseAPushNotificationContentTemplateResponse"));
+var _CreateAUserRequest = _interopRequireDefault(require("../model/CreateAUserRequest"));
+var _CreateUserTokenRequest = _interopRequireDefault(require("../model/CreateUserTokenRequest"));
var _CreateUserTokenResponse = _interopRequireDefault(require("../model/CreateUserTokenResponse"));
-var _LeaveMyGroupChannelsData = _interopRequireDefault(require("../model/LeaveMyGroupChannelsData"));
+var _GetChannelInvitationPreferenceResponse = _interopRequireDefault(require("../model/GetChannelInvitationPreferenceResponse"));
+var _LeaveMyGroupChannelsRequest = _interopRequireDefault(require("../model/LeaveMyGroupChannelsRequest"));
var _ListMyGroupChannelsResponse = _interopRequireDefault(require("../model/ListMyGroupChannelsResponse"));
var _ListRegistrationOrDeviceTokensResponse = _interopRequireDefault(require("../model/ListRegistrationOrDeviceTokensResponse"));
var _ListUsersResponse = _interopRequireDefault(require("../model/ListUsersResponse"));
-var _MarkAllMessagesAsReadData = _interopRequireDefault(require("../model/MarkAllMessagesAsReadData"));
-var _RegisterAsOperatorToChannelsWithCustomChannelTypesData = _interopRequireDefault(require("../model/RegisterAsOperatorToChannelsWithCustomChannelTypesData"));
-var _RemoveRegistrationOrDeviceTokenByTokenResponse = _interopRequireDefault(require("../model/RemoveRegistrationOrDeviceTokenByTokenResponse"));
-var _RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse = _interopRequireDefault(require("../model/RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse"));
-var _RemoveRegistrationOrDeviceTokenResponse = _interopRequireDefault(require("../model/RemoveRegistrationOrDeviceTokenResponse"));
-var _ResetPushPreferencesResponse = _interopRequireDefault(require("../model/ResetPushPreferencesResponse"));
-var _SendBirdUser = _interopRequireDefault(require("../model/SendBirdUser"));
-var _UpdateChannelInvitationPreferenceData = _interopRequireDefault(require("../model/UpdateChannelInvitationPreferenceData"));
+var _MarkAllMessagesAsReadRequest = _interopRequireDefault(require("../model/MarkAllMessagesAsReadRequest"));
+var _MarkChannelMessagesAsReadRequest = _interopRequireDefault(require("../model/MarkChannelMessagesAsReadRequest"));
+var _RemoveARegistrationOrDeviceTokenResponse = _interopRequireDefault(require("../model/RemoveARegistrationOrDeviceTokenResponse"));
+var _RemoveAllRegistrationOrDeviceTokenResponse = _interopRequireDefault(require("../model/RemoveAllRegistrationOrDeviceTokenResponse"));
+var _SendbirdUser = _interopRequireDefault(require("../model/SendbirdUser"));
+var _UpdateAUserRequest = _interopRequireDefault(require("../model/UpdateAUserRequest"));
+var _UpdateChannelInvitationPreferenceRequest = _interopRequireDefault(require("../model/UpdateChannelInvitationPreferenceRequest"));
var _UpdateChannelInvitationPreferenceResponse = _interopRequireDefault(require("../model/UpdateChannelInvitationPreferenceResponse"));
-var _UpdateCountPreferenceOfChannelByUrlData = _interopRequireDefault(require("../model/UpdateCountPreferenceOfChannelByUrlData"));
+var _UpdateCountPreferenceOfAChannelRequest = _interopRequireDefault(require("../model/UpdateCountPreferenceOfAChannelRequest"));
var _UpdateCountPreferenceOfChannelByUrlResponse = _interopRequireDefault(require("../model/UpdateCountPreferenceOfChannelByUrlResponse"));
-var _UpdatePushPreferencesData = _interopRequireDefault(require("../model/UpdatePushPreferencesData"));
-var _UpdatePushPreferencesForChannelByUrlData = _interopRequireDefault(require("../model/UpdatePushPreferencesForChannelByUrlData"));
-var _UpdatePushPreferencesForChannelByUrlResponse = _interopRequireDefault(require("../model/UpdatePushPreferencesForChannelByUrlResponse"));
+var _UpdatePushPreferencesForAChannelRequest = _interopRequireDefault(require("../model/UpdatePushPreferencesForAChannelRequest"));
+var _UpdatePushPreferencesForAChannelResponse = _interopRequireDefault(require("../model/UpdatePushPreferencesForAChannelResponse"));
+var _UpdatePushPreferencesRequest = _interopRequireDefault(require("../model/UpdatePushPreferencesRequest"));
var _UpdatePushPreferencesResponse = _interopRequireDefault(require("../model/UpdatePushPreferencesResponse"));
-var _UpdateUserByIdData = _interopRequireDefault(require("../model/UpdateUserByIdData"));
-var _ViewChannelInvitationPreferenceResponse = _interopRequireDefault(require("../model/ViewChannelInvitationPreferenceResponse"));
-var _ViewCountPreferenceOfChannelByUrlResponse = _interopRequireDefault(require("../model/ViewCountPreferenceOfChannelByUrlResponse"));
-var _ViewNumberOfChannelsByJoinStatusResponse = _interopRequireDefault(require("../model/ViewNumberOfChannelsByJoinStatusResponse"));
+var _ViewCountPreferenceOfAChannelResponse = _interopRequireDefault(require("../model/ViewCountPreferenceOfAChannelResponse"));
var _ViewNumberOfChannelsWithUnreadMessagesResponse = _interopRequireDefault(require("../model/ViewNumberOfChannelsWithUnreadMessagesResponse"));
-var _ViewNumberOfUnreadItemsResponse = _interopRequireDefault(require("../model/ViewNumberOfUnreadItemsResponse"));
var _ViewNumberOfUnreadMessagesResponse = _interopRequireDefault(require("../model/ViewNumberOfUnreadMessagesResponse"));
-var _ViewPushPreferencesForChannelByUrlResponse = _interopRequireDefault(require("../model/ViewPushPreferencesForChannelByUrlResponse"));
+var _ViewPushPreferencesForAChannelResponse = _interopRequireDefault(require("../model/ViewPushPreferencesForAChannelResponse"));
var _ViewPushPreferencesResponse = _interopRequireDefault(require("../model/ViewPushPreferencesResponse"));
-var _ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner = _interopRequireDefault(require("../model/ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
/**
* User service.
* @module api/UserApi
-* @version 0.0.16
+* @version 2.0.0
*/
-var UserApi = /*#__PURE__*/function () {
+var UserApi = exports["default"] = /*#__PURE__*/function () {
/**
* Constructs a new UserApi.
* @alias module:api/UserApi
@@ -65,29 +75,25 @@ var UserApi = /*#__PURE__*/function () {
/**
* Add a registration or device token
* ## 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 ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} tokenType
+ * @param {String} userId (Required)
+ * @param {module:model/String} tokenType (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/AddRegistrationOrDeviceTokenData} opts.addRegistrationOrDeviceTokenData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddRegistrationOrDeviceTokenResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/AddARegistrationOrDeviceTokenRequest} opts.addARegistrationOrDeviceTokenRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddARegistrationOrDeviceTokenResponse} and HTTP response
*/
- _createClass(UserApi, [{
- key: "addRegistrationOrDeviceTokenWithHttpInfo",
- value: function addRegistrationOrDeviceTokenWithHttpInfo(apiToken, userId, tokenType, opts) {
+ return _createClass(UserApi, [{
+ key: "addARegistrationOrDeviceTokenWithHttpInfo",
+ value: function addARegistrationOrDeviceTokenWithHttpInfo(userId, tokenType, opts) {
opts = opts || {};
- var postBody = opts['addRegistrationOrDeviceTokenData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling addRegistrationOrDeviceToken");
- }
+ var postBody = opts['addARegistrationOrDeviceTokenRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling addRegistrationOrDeviceToken");
+ throw new Error("Missing the required parameter 'userId' when calling addARegistrationOrDeviceToken");
}
// verify the required parameter 'tokenType' is set
if (tokenType === undefined || tokenType === null) {
- throw new Error("Missing the required parameter 'tokenType' when calling addRegistrationOrDeviceToken");
+ throw new Error("Missing the required parameter 'tokenType' when calling addARegistrationOrDeviceToken");
}
var pathParams = {
'user_id': userId,
@@ -95,152 +101,140 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _AddRegistrationOrDeviceTokenResponse["default"];
+ var returnType = _AddARegistrationOrDeviceTokenResponse["default"];
return this.apiClient.callApi('/v3/users/{user_id}/push/{token_type}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Add a registration or device token
* ## 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 ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} tokenType
+ * @param {String} userId (Required)
+ * @param {module:model/String} tokenType (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/AddRegistrationOrDeviceTokenData} opts.addRegistrationOrDeviceTokenData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddRegistrationOrDeviceTokenResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/AddARegistrationOrDeviceTokenRequest} opts.addARegistrationOrDeviceTokenRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddARegistrationOrDeviceTokenResponse}
*/
}, {
- key: "addRegistrationOrDeviceToken",
- value: function addRegistrationOrDeviceToken(apiToken, userId, tokenType, opts) {
- return this.addRegistrationOrDeviceTokenWithHttpInfo(apiToken, userId, tokenType, opts).then(function (response_and_data) {
+ key: "addARegistrationOrDeviceToken",
+ value: function addARegistrationOrDeviceToken(userId, tokenType, opts) {
+ return this.addARegistrationOrDeviceTokenWithHttpInfo(userId, tokenType, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Choose a push notification content template
- * ## Choose a push notification content template Chooses a push notification content template of a user's own. The push notifications feature is only available for group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-choose-a-push-notification-content-template ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChoosePushNotificationContentTemplateResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/ChooseAPushNotificationContentTemplateRequest} opts.chooseAPushNotificationContentTemplateRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChooseAPushNotificationContentTemplateResponse} and HTTP response
*/
}, {
- key: "choosePushNotificationContentTemplateWithHttpInfo",
- value: function choosePushNotificationContentTemplateWithHttpInfo(apiToken, userId, opts) {
+ key: "chooseAPushNotificationContentTemplateWithHttpInfo",
+ value: function chooseAPushNotificationContentTemplateWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['body'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling choosePushNotificationContentTemplate");
- }
+ var postBody = opts['chooseAPushNotificationContentTemplateRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling choosePushNotificationContentTemplate");
+ throw new Error("Missing the required parameter 'userId' when calling chooseAPushNotificationContentTemplate");
}
var pathParams = {
'user_id': userId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _ChoosePushNotificationContentTemplateResponse["default"];
+ var returnType = _ChooseAPushNotificationContentTemplateResponse["default"];
return this.apiClient.callApi('/v3/users/{user_id}/push/template', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Choose a push notification content template
- * ## Choose a push notification content template Chooses a push notification content template of a user's own. The push notifications feature is only available for group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-choose-a-push-notification-content-template ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {Object.} opts.body
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChoosePushNotificationContentTemplateResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/ChooseAPushNotificationContentTemplateRequest} opts.chooseAPushNotificationContentTemplateRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChooseAPushNotificationContentTemplateResponse}
*/
}, {
- key: "choosePushNotificationContentTemplate",
- value: function choosePushNotificationContentTemplate(apiToken, userId, opts) {
- return this.choosePushNotificationContentTemplateWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ key: "chooseAPushNotificationContentTemplate",
+ value: function chooseAPushNotificationContentTemplate(userId, opts) {
+ return this.chooseAPushNotificationContentTemplateWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Create a user
- * ## Create a user Creates a new user in the application. A user is identified by its unique user ID, and additionally have a changeable nickname, profile image, and so on. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-create-a-user
- * @param {String} apiToken
+ * ## 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
* @param {Object} opts Optional parameters
- * @param {module:model/CreateUserData} opts.createUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdUser} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAUserRequest} opts.createAUserRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdUser} and HTTP response
*/
}, {
- key: "createUserWithHttpInfo",
- value: function createUserWithHttpInfo(apiToken, opts) {
+ key: "createAUserWithHttpInfo",
+ value: function createAUserWithHttpInfo(opts) {
opts = opts || {};
- var postBody = opts['createUserData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling createUser");
- }
+ var postBody = opts['createAUserRequest'];
var pathParams = {};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _SendBirdUser["default"];
+ var returnType = _SendbirdUser["default"];
return this.apiClient.callApi('/v3/users', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Create a user
- * ## Create a user Creates a new user in the application. A user is identified by its unique user ID, and additionally have a changeable nickname, profile image, and so on. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-create-a-user
- * @param {String} apiToken
+ * ## 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
* @param {Object} opts Optional parameters
- * @param {module:model/CreateUserData} opts.createUserData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdUser}
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateAUserRequest} opts.createAUserRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdUser}
*/
}, {
- key: "createUser",
- value: function createUser(apiToken, opts) {
- return this.createUserWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ key: "createAUser",
+ value: function createAUser(opts) {
+ return this.createAUserWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Create user token
- * ## Create user token
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/CreateUserTokenData} opts.createUserTokenData
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateUserTokenRequest} opts.createUserTokenRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateUserTokenResponse} and HTTP response
*/
}, {
key: "createUserTokenWithHttpInfo",
- value: function createUserTokenWithHttpInfo(apiToken, userId, opts) {
+ value: function createUserTokenWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['createUserTokenData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling createUserToken");
- }
+ var postBody = opts['createUserTokenRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling createUserToken");
@@ -250,7 +244,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -262,46 +256,44 @@ var UserApi = /*#__PURE__*/function () {
/**
* Create user token
- * ## Create user token
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/CreateUserTokenData} opts.createUserTokenData
+ * @param {String} opts.apiToken
+ * @param {module:model/CreateUserTokenRequest} opts.createUserTokenRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateUserTokenResponse}
*/
}, {
key: "createUserToken",
- value: function createUserToken(apiToken, userId, opts) {
- return this.createUserTokenWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function createUserToken(userId, opts) {
+ return this.createUserTokenWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Delete a user
- * ## Delete a user Deletes a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-delete-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "deleteUserByIdWithHttpInfo",
- value: function deleteUserByIdWithHttpInfo(apiToken, userId) {
+ key: "deleteAUserWithHttpInfo",
+ value: function deleteAUserWithHttpInfo(userId, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling deleteUserById");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling deleteUserById");
+ throw new Error("Missing the required parameter 'userId' when calling deleteAUser");
}
var pathParams = {
'user_id': userId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -313,37 +305,82 @@ var UserApi = /*#__PURE__*/function () {
/**
* Delete a user
- * ## Delete a user Deletes a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-delete-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "deleteUserById",
- value: function deleteUserById(apiToken, userId) {
- return this.deleteUserByIdWithHttpInfo(apiToken, userId).then(function (response_and_data) {
+ key: "deleteAUser",
+ value: function deleteAUser(userId, opts) {
+ return this.deleteAUserWithHttpInfo(userId, opts).then(function (response_and_data) {
+ return response_and_data.data;
+ });
+ }
+
+ /**
+ * Get channel invitation preference
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetChannelInvitationPreferenceResponse} and HTTP response
+ */
+ }, {
+ key: "getChannelInvitationPreferenceWithHttpInfo",
+ value: function getChannelInvitationPreferenceWithHttpInfo(userId, opts) {
+ opts = opts || {};
+ var postBody = null;
+ // verify the required parameter 'userId' is set
+ if (userId === undefined || userId === null) {
+ throw new Error("Missing the required parameter 'userId' when calling getChannelInvitationPreference");
+ }
+ var pathParams = {
+ 'user_id': userId
+ };
+ var queryParams = {};
+ var headerParams = {
+ 'api-token': opts['apiToken']
+ };
+ var formParams = {};
+ var authNames = [];
+ var contentTypes = [];
+ var accepts = ['application/json'];
+ var returnType = _GetChannelInvitationPreferenceResponse["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}/channel_invitation_preference', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ }
+
+ /**
+ * Get channel invitation preference
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetChannelInvitationPreferenceResponse}
+ */
+ }, {
+ key: "getChannelInvitationPreference",
+ value: function getChannelInvitationPreference(userId, opts) {
+ return this.getChannelInvitationPreferenceWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Leave my group channels
- * ## Leave my group channels Makes a user leave all joined group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-leave-my-group-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to leave all joined group channels.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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 [leave_all_when_deactivated](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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/LeaveMyGroupChannelsData} opts.leaveMyGroupChannelsData
+ * @param {String} opts.apiToken
+ * @param {module:model/LeaveMyGroupChannelsRequest} opts.leaveMyGroupChannelsRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
key: "leaveMyGroupChannelsWithHttpInfo",
- value: function leaveMyGroupChannelsWithHttpInfo(apiToken, userId, opts) {
+ value: function leaveMyGroupChannelsWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['leaveMyGroupChannelsData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling leaveMyGroupChannels");
- }
+ var postBody = opts['leaveMyGroupChannelsRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling leaveMyGroupChannels");
@@ -353,7 +390,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -365,82 +402,84 @@ var UserApi = /*#__PURE__*/function () {
/**
* Leave my group channels
- * ## Leave my group channels Makes a user leave all joined group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-leave-my-group-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to leave all joined group channels.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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 [leave_all_when_deactivated](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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/LeaveMyGroupChannelsData} opts.leaveMyGroupChannelsData
+ * @param {String} opts.apiToken
+ * @param {module:model/LeaveMyGroupChannelsRequest} opts.leaveMyGroupChannelsRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
key: "leaveMyGroupChannels",
- value: function leaveMyGroupChannels(apiToken, userId, opts) {
- return this.leaveMyGroupChannelsWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function leaveMyGroupChannels(userId, opts) {
+ return this.leaveMyGroupChannelsWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List my group channels
- * ## List my group channels Retrieves all group channels that the user has joined. You can create a request based on various query parameters. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-my-group-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
+ * ## 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.
+ * @param {String} userId (Required)
* @param {String} apiToken
- * @param {String} userId
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.distinctMode
- * @param {String} opts.publicMode
- * @param {String} opts.superMode
- * @param {String} opts.hiddenMode
- * @param {String} opts.memberStateFilter
- * @param {String} opts.unreadFilter
- * @param {Number} opts.createdAfter
- * @param {Number} opts.createdBefore
+ * @param {String} opts.token Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {module:model/String} opts.distinctMode
+ * @param {module:model/String} opts.publicMode
+ * @param {module:model/String} opts.superMode
+ * @param {Number} opts.createdAfter Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
+ * @param {Number} opts.createdBefore Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
* @param {Boolean} opts.showEmpty
- * @param {Boolean} opts.showFrozen
* @param {Boolean} opts.showMember
* @param {Boolean} opts.showDeliveryReceipt
* @param {Boolean} opts.showReadReceipt
- * @param {String} opts.order
- * @param {String} opts.metadataOrderKey
- * @param {String} opts.customTypes
- * @param {String} opts.customTypeStartswith
- * @param {String} opts.channelUrls
- * @param {String} opts.name
- * @param {String} opts.nameContains
- * @param {String} opts.nameStartswith
- * @param {String} opts.membersExactlyIn
- * @param {String} opts.membersIncludeIn
- * @param {String} opts.queryType
- * @param {String} opts.membersNickname
- * @param {String} opts.membersNicknameContains
- * @param {String} opts.searchQuery
- * @param {String} opts.searchFields
- * @param {String} opts.metadataKey
- * @param {String} opts.metadataValues
- * @param {String} opts.metadataValueStartswith
- * @param {String} opts.metacounterKey
- * @param {String} opts.metacounterValues
- * @param {String} opts.metacounterValueGt
- * @param {String} opts.metacounterValueGte
- * @param {String} opts.metacounterValueLt
- * @param {String} opts.metacounterValueLte
- * @param {String} opts.customType
+ * @param {Boolean} opts.showMetadata
+ * @param {Boolean} opts.showFrozen
+ * @param {module:model/String} opts.order
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.customTypeStartswith Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.name Specifies one or more group channel names.
+ * @param {String} opts.nameContains Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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)
+ * @param {String} opts.membersNickname Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {Boolean} opts.includeSortedMetaarrayInLastMessage Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
+ * @param {String} opts.customType (Deprecated) Returns channels whose custom_type matches the given value. If this field is not specified, all channels are returned, regardless of their custom type. The string passed here must be urlencoded.
+ * @param {Boolean} opts.readReceipt (Deprecated) Superseded by show_read_receipt.
+ * @param {Boolean} opts.member (Deprecated) Superseded by show_member.
+ * @param {Boolean} opts.isDistinct (Deprecated) Superseded by distinct_mode.
+ * @param {String} opts.membersIn (Deprecated) Superseded by members_exactly_in.
+ * @param {String} opts.userId2 (Deprecated) Restricts the search scope to only retrieve the target user's group channels. It's recommended to use the list group channels by user action instead.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMyGroupChannelsResponse} and HTTP response
*/
}, {
key: "listMyGroupChannelsWithHttpInfo",
- value: function listMyGroupChannelsWithHttpInfo(apiToken, userId, opts) {
+ value: function listMyGroupChannelsWithHttpInfo(userId, apiToken, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listMyGroupChannels");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling listMyGroupChannels");
}
+ // verify the required parameter 'apiToken' is set
+ if (apiToken === undefined || apiToken === null) {
+ throw new Error("Missing the required parameter 'apiToken' when calling listMyGroupChannels");
+ }
var pathParams = {
'user_id': userId
};
@@ -450,16 +489,14 @@ var UserApi = /*#__PURE__*/function () {
'distinct_mode': opts['distinctMode'],
'public_mode': opts['publicMode'],
'super_mode': opts['superMode'],
- 'hidden_mode': opts['hiddenMode'],
- 'member_state_filter': opts['memberStateFilter'],
- 'unread_filter': opts['unreadFilter'],
'created_after': opts['createdAfter'],
'created_before': opts['createdBefore'],
'show_empty': opts['showEmpty'],
- 'show_frozen': opts['showFrozen'],
'show_member': opts['showMember'],
'show_delivery_receipt': opts['showDeliveryReceipt'],
'show_read_receipt': opts['showReadReceipt'],
+ 'show_metadata': opts['showMetadata'],
+ 'show_frozen': opts['showFrozen'],
'order': opts['order'],
'metadata_order_key': opts['metadataOrderKey'],
'custom_types': opts['customTypes'],
@@ -473,8 +510,6 @@ var UserApi = /*#__PURE__*/function () {
'query_type': opts['queryType'],
'members_nickname': opts['membersNickname'],
'members_nickname_contains': opts['membersNicknameContains'],
- 'search_query': opts['searchQuery'],
- 'search_fields': opts['searchFields'],
'metadata_key': opts['metadataKey'],
'metadata_values': opts['metadataValues'],
'metadata_value_startswith': opts['metadataValueStartswith'],
@@ -484,10 +519,16 @@ var UserApi = /*#__PURE__*/function () {
'metacounter_value_gte': opts['metacounterValueGte'],
'metacounter_value_lt': opts['metacounterValueLt'],
'metacounter_value_lte': opts['metacounterValueLte'],
- 'custom_type': opts['customType']
+ 'include_sorted_metaarray_in_last_message': opts['includeSortedMetaarrayInLastMessage'],
+ 'custom_type': opts['customType'],
+ 'read_receipt': opts['readReceipt'],
+ 'member': opts['member'],
+ 'is_distinct': opts['isDistinct'],
+ 'members_in': opts['membersIn'],
+ 'user_id': opts['userId2']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': apiToken
};
var formParams = {};
var authNames = [];
@@ -499,76 +540,76 @@ var UserApi = /*#__PURE__*/function () {
/**
* List my group channels
- * ## List my group channels Retrieves all group channels that the user has joined. You can create a request based on various query parameters. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-my-group-channels ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the target user.
+ * ## 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.
+ * @param {String} userId (Required)
* @param {String} apiToken
- * @param {String} userId
* @param {Object} opts Optional parameters
- * @param {String} opts.token
- * @param {Number} opts.limit
- * @param {String} opts.distinctMode
- * @param {String} opts.publicMode
- * @param {String} opts.superMode
- * @param {String} opts.hiddenMode
- * @param {String} opts.memberStateFilter
- * @param {String} opts.unreadFilter
- * @param {Number} opts.createdAfter
- * @param {Number} opts.createdBefore
+ * @param {String} opts.token Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
+ * @param {Number} opts.limit Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
+ * @param {module:model/String} opts.distinctMode
+ * @param {module:model/String} opts.publicMode
+ * @param {module:model/String} opts.superMode
+ * @param {Number} opts.createdAfter Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
+ * @param {Number} opts.createdBefore Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
* @param {Boolean} opts.showEmpty
- * @param {Boolean} opts.showFrozen
* @param {Boolean} opts.showMember
* @param {Boolean} opts.showDeliveryReceipt
* @param {Boolean} opts.showReadReceipt
- * @param {String} opts.order
- * @param {String} opts.metadataOrderKey
- * @param {String} opts.customTypes
- * @param {String} opts.customTypeStartswith
- * @param {String} opts.channelUrls
- * @param {String} opts.name
- * @param {String} opts.nameContains
- * @param {String} opts.nameStartswith
- * @param {String} opts.membersExactlyIn
- * @param {String} opts.membersIncludeIn
- * @param {String} opts.queryType
- * @param {String} opts.membersNickname
- * @param {String} opts.membersNicknameContains
- * @param {String} opts.searchQuery
- * @param {String} opts.searchFields
- * @param {String} opts.metadataKey
- * @param {String} opts.metadataValues
- * @param {String} opts.metadataValueStartswith
- * @param {String} opts.metacounterKey
- * @param {String} opts.metacounterValues
- * @param {String} opts.metacounterValueGt
- * @param {String} opts.metacounterValueGte
- * @param {String} opts.metacounterValueLt
- * @param {String} opts.metacounterValueLte
- * @param {String} opts.customType
+ * @param {Boolean} opts.showMetadata
+ * @param {Boolean} opts.showFrozen
+ * @param {module:model/String} opts.order
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.customTypeStartswith Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.name Specifies one or more group channel names.
+ * @param {String} opts.nameContains Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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)
+ * @param {String} opts.membersNickname Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {String} opts.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.
+ * @param {Boolean} opts.includeSortedMetaarrayInLastMessage Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
+ * @param {String} opts.customType (Deprecated) Returns channels whose custom_type matches the given value. If this field is not specified, all channels are returned, regardless of their custom type. The string passed here must be urlencoded.
+ * @param {Boolean} opts.readReceipt (Deprecated) Superseded by show_read_receipt.
+ * @param {Boolean} opts.member (Deprecated) Superseded by show_member.
+ * @param {Boolean} opts.isDistinct (Deprecated) Superseded by distinct_mode.
+ * @param {String} opts.membersIn (Deprecated) Superseded by members_exactly_in.
+ * @param {String} opts.userId2 (Deprecated) Restricts the search scope to only retrieve the target user's group channels. It's recommended to use the list group channels by user action instead.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMyGroupChannelsResponse}
*/
}, {
key: "listMyGroupChannels",
- value: function listMyGroupChannels(apiToken, userId, opts) {
- return this.listMyGroupChannelsWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function listMyGroupChannels(userId, apiToken, opts) {
+ return this.listMyGroupChannelsWithHttpInfo(userId, apiToken, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List registration or device tokens
- * ## List registration or device tokens Retrieves a list of a specific user's FCM registration tokens, HMS device tokens, or APNs device tokens. You can specify either `gcm`, `huawei`, or `apns` in the `token_type` parameter, depending on which push notification service you are using. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-registration-or-device-tokens ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} tokenType
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {module:model/String} tokenType (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListRegistrationOrDeviceTokensResponse} and HTTP response
*/
}, {
key: "listRegistrationOrDeviceTokensWithHttpInfo",
- value: function listRegistrationOrDeviceTokensWithHttpInfo(apiToken, userId, tokenType) {
+ value: function listRegistrationOrDeviceTokensWithHttpInfo(userId, tokenType, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listRegistrationOrDeviceTokens");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling listRegistrationOrDeviceTokens");
@@ -583,7 +624,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -595,45 +636,42 @@ var UserApi = /*#__PURE__*/function () {
/**
* List registration or device tokens
- * ## List registration or device tokens Retrieves a list of a specific user's FCM registration tokens, HMS device tokens, or APNs device tokens. You can specify either `gcm`, `huawei`, or `apns` in the `token_type` parameter, depending on which push notification service you are using. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-registration-or-device-tokens ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} tokenType
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {module:model/String} tokenType (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListRegistrationOrDeviceTokensResponse}
*/
}, {
key: "listRegistrationOrDeviceTokens",
- value: function listRegistrationOrDeviceTokens(apiToken, userId, tokenType) {
- return this.listRegistrationOrDeviceTokensWithHttpInfo(apiToken, userId, tokenType).then(function (response_and_data) {
+ value: function listRegistrationOrDeviceTokens(userId, tokenType, opts) {
+ return this.listRegistrationOrDeviceTokensWithHttpInfo(userId, tokenType, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* List users
- * ## List users Retrieves a list of users in your application. You can query the list using various parameters. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-users ----------------------------
- * @param {String} apiToken
+ * ## 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
* @param {Object} opts Optional parameters
* @param {String} opts.token
* @param {Number} opts.limit
- * @param {String} opts.activeMode
- * @param {Boolean} opts.showBot
- * @param {String} opts.userIds
+ * @param {module:model/String} opts.activeMode Specifies the activation status of the users in the list. Acceptable values are `activated`, `deactivated`, and `all`. (Default: `activated`)
+ * @param {Boolean} opts.showBot Determines whether to include bots in the list. (Default: true)
+ * @param {String} opts.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.
* @param {String} opts.nickname
* @param {String} opts.nicknameStartswith
* @param {String} opts.metadatakey
- * @param {String} opts.metadatavaluesIn
+ * @param {String} opts.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.
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListUsersResponse} and HTTP response
*/
}, {
key: "listUsersWithHttpInfo",
- value: function listUsersWithHttpInfo(apiToken, opts) {
+ value: function listUsersWithHttpInfo(opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling listUsers");
- }
var pathParams = {};
var queryParams = {
'token': opts['token'],
@@ -647,7 +685,7 @@ var UserApi = /*#__PURE__*/function () {
'metadatavalues_in': opts['metadatavaluesIn']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -659,46 +697,42 @@ var UserApi = /*#__PURE__*/function () {
/**
* List users
- * ## List users Retrieves a list of users in your application. You can query the list using various parameters. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-list-users ----------------------------
- * @param {String} apiToken
+ * ## 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
* @param {Object} opts Optional parameters
* @param {String} opts.token
* @param {Number} opts.limit
- * @param {String} opts.activeMode
- * @param {Boolean} opts.showBot
- * @param {String} opts.userIds
+ * @param {module:model/String} opts.activeMode Specifies the activation status of the users in the list. Acceptable values are `activated`, `deactivated`, and `all`. (Default: `activated`)
+ * @param {Boolean} opts.showBot Determines whether to include bots in the list. (Default: true)
+ * @param {String} opts.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.
* @param {String} opts.nickname
* @param {String} opts.nicknameStartswith
* @param {String} opts.metadatakey
- * @param {String} opts.metadatavaluesIn
+ * @param {String} opts.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.
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListUsersResponse}
*/
}, {
key: "listUsers",
- value: function listUsers(apiToken, opts) {
- return this.listUsersWithHttpInfo(apiToken, opts).then(function (response_and_data) {
+ value: function listUsers(opts) {
+ return this.listUsersWithHttpInfo(opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Mark all messages as read
- * ## Mark all messages as read Marks all of a user's unread messages as read in the joined group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-mark-all-messages-as-read ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/MarkAllMessagesAsReadData} opts.markAllMessagesAsReadData
+ * @param {String} opts.apiToken
+ * @param {module:model/MarkAllMessagesAsReadRequest} opts.markAllMessagesAsReadRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
key: "markAllMessagesAsReadWithHttpInfo",
- value: function markAllMessagesAsReadWithHttpInfo(apiToken, userId, opts) {
+ value: function markAllMessagesAsReadWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['markAllMessagesAsReadData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling markAllMessagesAsRead");
- }
+ var postBody = opts['markAllMessagesAsReadRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling markAllMessagesAsRead");
@@ -708,7 +742,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -720,310 +754,298 @@ var UserApi = /*#__PURE__*/function () {
/**
* Mark all messages as read
- * ## Mark all messages as read Marks all of a user's unread messages as read in the joined group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-mark-all-messages-as-read ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/MarkAllMessagesAsReadData} opts.markAllMessagesAsReadData
+ * @param {String} opts.apiToken
+ * @param {module:model/MarkAllMessagesAsReadRequest} opts.markAllMessagesAsReadRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
key: "markAllMessagesAsRead",
- value: function markAllMessagesAsRead(apiToken, userId, opts) {
- return this.markAllMessagesAsReadWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function markAllMessagesAsRead(userId, opts) {
+ return this.markAllMessagesAsReadWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Register as an operator to channels with custom channel types
- * ## Register as an operator to channels with custom channel types Registers a user as an operator to channels with particular custom channel types. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-register-as-an-operator-to-channels-with-custom-channel-types ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * Remove a registration or device token - When unregistering a specific token
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {module:model/String} tokenType (Required)
+ * @param {String} token (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/RegisterAsOperatorToChannelsWithCustomChannelTypesData} opts.registerAsOperatorToChannelsWithCustomChannelTypesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveARegistrationOrDeviceTokenResponse} and HTTP response
*/
}, {
- key: "registerAsOperatorToChannelsWithCustomChannelTypesWithHttpInfo",
- value: function registerAsOperatorToChannelsWithCustomChannelTypesWithHttpInfo(apiToken, userId, opts) {
+ key: "removeARegistrationOrDeviceTokenWithHttpInfo",
+ value: function removeARegistrationOrDeviceTokenWithHttpInfo(userId, tokenType, token, opts) {
opts = opts || {};
- var postBody = opts['registerAsOperatorToChannelsWithCustomChannelTypesData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling registerAsOperatorToChannelsWithCustomChannelTypes");
- }
+ var postBody = null;
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling registerAsOperatorToChannelsWithCustomChannelTypes");
+ throw new Error("Missing the required parameter 'userId' when calling removeARegistrationOrDeviceToken");
+ }
+ // verify the required parameter 'tokenType' is set
+ if (tokenType === undefined || tokenType === null) {
+ throw new Error("Missing the required parameter 'tokenType' when calling removeARegistrationOrDeviceToken");
+ }
+ // verify the required parameter 'token' is set
+ if (token === undefined || token === null) {
+ throw new Error("Missing the required parameter 'token' when calling removeARegistrationOrDeviceToken");
}
var pathParams = {
- 'user_id': userId
+ 'user_id': userId,
+ 'token_type': tokenType,
+ 'token': token
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = ['application/json'];
+ var contentTypes = [];
var accepts = ['application/json'];
- var returnType = Object;
- return this.apiClient.callApi('/v3/users/{user_id}/operating_channel_custom_types', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _RemoveARegistrationOrDeviceTokenResponse["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}/push/{token_type}/{token}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Register as an operator to channels with custom channel types
- * ## Register as an operator to channels with custom channel types Registers a user as an operator to channels with particular custom channel types. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-register-as-an-operator-to-channels-with-custom-channel-types ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * Remove a registration or device token - When unregistering a specific token
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {module:model/String} tokenType (Required)
+ * @param {String} token (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/RegisterAsOperatorToChannelsWithCustomChannelTypesData} opts.registerAsOperatorToChannelsWithCustomChannelTypesData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveARegistrationOrDeviceTokenResponse}
*/
}, {
- key: "registerAsOperatorToChannelsWithCustomChannelTypes",
- value: function registerAsOperatorToChannelsWithCustomChannelTypes(apiToken, userId, opts) {
- return this.registerAsOperatorToChannelsWithCustomChannelTypesWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ key: "removeARegistrationOrDeviceToken",
+ value: function removeARegistrationOrDeviceToken(userId, tokenType, token, opts) {
+ return this.removeARegistrationOrDeviceTokenWithHttpInfo(userId, tokenType, token, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Remove a registration or device token - When unregistering all device tokens
- * ## Remove a registration or device token Removes a specific user's one or more FCM registration tokens, HMS device tokens, or APNs device tokens. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-remove-a-registration-or-device-token ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveRegistrationOrDeviceTokenResponse} and HTTP response
+ * Remove a registration or device token from an owner
+ * ## 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
+ * @param {String} tokenType (Required)
+ * @param {String} token (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response
*/
}, {
- key: "removeRegistrationOrDeviceTokenWithHttpInfo",
- value: function removeRegistrationOrDeviceTokenWithHttpInfo(apiToken, userId) {
+ key: "removeARegistrationOrDeviceTokenFromAnOwnerWithHttpInfo",
+ value: function removeARegistrationOrDeviceTokenFromAnOwnerWithHttpInfo(tokenType, token, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling removeRegistrationOrDeviceToken");
+ // verify the required parameter 'tokenType' is set
+ if (tokenType === undefined || tokenType === null) {
+ throw new Error("Missing the required parameter 'tokenType' when calling removeARegistrationOrDeviceTokenFromAnOwner");
}
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling removeRegistrationOrDeviceToken");
+ // verify the required parameter 'token' is set
+ if (token === undefined || token === null) {
+ throw new Error("Missing the required parameter 'token' when calling removeARegistrationOrDeviceTokenFromAnOwner");
}
var pathParams = {
- 'user_id': userId
+ 'token_type': tokenType,
+ 'token': token
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _RemoveRegistrationOrDeviceTokenResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/push', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = [_MarkChannelMessagesAsReadRequest["default"]];
+ return this.apiClient.callApi('/v3/push/device_tokens/{token_type}/{token}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Remove a registration or device token - When unregistering all device tokens
- * ## Remove a registration or device token Removes a specific user's one or more FCM registration tokens, HMS device tokens, or APNs device tokens. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-remove-a-registration-or-device-token ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveRegistrationOrDeviceTokenResponse}
+ * Remove a registration or device token from an owner
+ * ## 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
+ * @param {String} tokenType (Required)
+ * @param {String} token (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.}
*/
}, {
- key: "removeRegistrationOrDeviceToken",
- value: function removeRegistrationOrDeviceToken(apiToken, userId) {
- return this.removeRegistrationOrDeviceTokenWithHttpInfo(apiToken, userId).then(function (response_and_data) {
+ key: "removeARegistrationOrDeviceTokenFromAnOwner",
+ value: function removeARegistrationOrDeviceTokenFromAnOwner(tokenType, token, opts) {
+ return this.removeARegistrationOrDeviceTokenFromAnOwnerWithHttpInfo(tokenType, token, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Remove a registration or device token - When unregistering a specific token
- * ## Remove a registration or device token Removes a specific user's one or more FCM registration tokens, HMS device tokens, or APNs device tokens. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-remove-a-registration-or-device-token ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} tokenType
- * @param {String} token
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveRegistrationOrDeviceTokenByTokenResponse} and HTTP response
+ * Remove a registration or device token - When unregistering all device tokens
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveAllRegistrationOrDeviceTokenResponse} and HTTP response
*/
}, {
- key: "removeRegistrationOrDeviceTokenByTokenWithHttpInfo",
- value: function removeRegistrationOrDeviceTokenByTokenWithHttpInfo(apiToken, userId, tokenType, token) {
+ key: "removeAllRegistrationOrDeviceTokenWithHttpInfo",
+ value: function removeAllRegistrationOrDeviceTokenWithHttpInfo(userId, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling removeRegistrationOrDeviceTokenByToken");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling removeRegistrationOrDeviceTokenByToken");
- }
- // verify the required parameter 'tokenType' is set
- if (tokenType === undefined || tokenType === null) {
- throw new Error("Missing the required parameter 'tokenType' when calling removeRegistrationOrDeviceTokenByToken");
- }
- // verify the required parameter 'token' is set
- if (token === undefined || token === null) {
- throw new Error("Missing the required parameter 'token' when calling removeRegistrationOrDeviceTokenByToken");
+ throw new Error("Missing the required parameter 'userId' when calling removeAllRegistrationOrDeviceToken");
}
var pathParams = {
- 'user_id': userId,
- 'token_type': tokenType,
- 'token': token
+ 'user_id': userId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _RemoveRegistrationOrDeviceTokenByTokenResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/push/{token_type}/{token}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _RemoveAllRegistrationOrDeviceTokenResponse["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}/push', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Remove a registration or device token - When unregistering a specific token
- * ## Remove a registration or device token Removes a specific user's one or more FCM registration tokens, HMS device tokens, or APNs device tokens. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-remove-a-registration-or-device-token ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} tokenType
- * @param {String} token
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveRegistrationOrDeviceTokenByTokenResponse}
+ * Remove a registration or device token - When unregistering all device tokens
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveAllRegistrationOrDeviceTokenResponse}
*/
}, {
- key: "removeRegistrationOrDeviceTokenByToken",
- value: function removeRegistrationOrDeviceTokenByToken(apiToken, userId, tokenType, token) {
- return this.removeRegistrationOrDeviceTokenByTokenWithHttpInfo(apiToken, userId, tokenType, token).then(function (response_and_data) {
+ key: "removeAllRegistrationOrDeviceToken",
+ value: function removeAllRegistrationOrDeviceToken(userId, opts) {
+ return this.removeAllRegistrationOrDeviceTokenWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Remove a registration or device token from an owner
- * ## Remove a registration or device token from an owner Removes a registration or device token from a user who owns it. 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-remove-a-registration-or-device-token-from-an-owner ----------------------------
- * @param {String} apiToken
- * @param {String} tokenType
- * @param {String} token
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse} and HTTP response
+ * Reset push preferences
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
*/
}, {
- key: "removeRegistrationOrDeviceTokenFromOwnerByTokenWithHttpInfo",
- value: function removeRegistrationOrDeviceTokenFromOwnerByTokenWithHttpInfo(apiToken, tokenType, token) {
+ key: "resetPushPreferencesWithHttpInfo",
+ value: function resetPushPreferencesWithHttpInfo(userId, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling removeRegistrationOrDeviceTokenFromOwnerByToken");
- }
- // verify the required parameter 'tokenType' is set
- if (tokenType === undefined || tokenType === null) {
- throw new Error("Missing the required parameter 'tokenType' when calling removeRegistrationOrDeviceTokenFromOwnerByToken");
- }
- // verify the required parameter 'token' is set
- if (token === undefined || token === null) {
- throw new Error("Missing the required parameter 'token' when calling removeRegistrationOrDeviceTokenFromOwnerByToken");
+ // verify the required parameter 'userId' is set
+ if (userId === undefined || userId === null) {
+ throw new Error("Missing the required parameter 'userId' when calling resetPushPreferences");
}
var pathParams = {
- 'token_type': tokenType,
- 'token': token
+ 'user_id': userId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse["default"];
- return this.apiClient.callApi('/v3/push/device_tokens/{token_type}/{token}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = Object;
+ return this.apiClient.callApi('/v3/users/{user_id}/push_preference', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Remove a registration or device token from an owner
- * ## Remove a registration or device token from an owner Removes a registration or device token from a user who owns it. 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-remove-a-registration-or-device-token-from-an-owner ----------------------------
- * @param {String} apiToken
- * @param {String} tokenType
- * @param {String} token
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse}
+ * Reset push preferences
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
*/
}, {
- key: "removeRegistrationOrDeviceTokenFromOwnerByToken",
- value: function removeRegistrationOrDeviceTokenFromOwnerByToken(apiToken, tokenType, token) {
- return this.removeRegistrationOrDeviceTokenFromOwnerByTokenWithHttpInfo(apiToken, tokenType, token).then(function (response_and_data) {
+ key: "resetPushPreferences",
+ value: function resetPushPreferences(userId, opts) {
+ return this.resetPushPreferencesWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Reset push preferences
- * ## Reset push preferences Resets a user's push preferences. After performing this action, `do_not_disturb` and `snooze_enabled` are set to false. The values of the parameters associated with the time frame are all set to 0. `timezone` is reset to `UTC`. `push_sound` is reset to `default`. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-reset-push-preferences ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ResetPushPreferencesResponse} and HTTP response
+ * Update a user
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAUserRequest} opts.updateAUserRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdUser} and HTTP response
*/
}, {
- key: "resetPushPreferencesWithHttpInfo",
- value: function resetPushPreferencesWithHttpInfo(apiToken, userId) {
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling resetPushPreferences");
- }
+ key: "updateAUserWithHttpInfo",
+ value: function updateAUserWithHttpInfo(userId, opts) {
+ opts = opts || {};
+ var postBody = opts['updateAUserRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling resetPushPreferences");
+ throw new Error("Missing the required parameter 'userId' when calling updateAUser");
}
var pathParams = {
'user_id': userId
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
- var contentTypes = [];
+ var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _ResetPushPreferencesResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/push_preference', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdUser["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * Reset push preferences
- * ## Reset push preferences Resets a user's push preferences. After performing this action, `do_not_disturb` and `snooze_enabled` are set to false. The values of the parameters associated with the time frame are all set to 0. `timezone` is reset to `UTC`. `push_sound` is reset to `default`. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-reset-push-preferences ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResetPushPreferencesResponse}
+ * Update a user
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateAUserRequest} opts.updateAUserRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdUser}
*/
}, {
- key: "resetPushPreferences",
- value: function resetPushPreferences(apiToken, userId) {
- return this.resetPushPreferencesWithHttpInfo(apiToken, userId).then(function (response_and_data) {
+ key: "updateAUser",
+ value: function updateAUser(userId, opts) {
+ return this.updateAUserWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Update channel invitation preference
- * ## Update channel invitation preference Updates the channel invitation preference for a user's [private](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#-3-private-vs-public) group channels. > __Note__: Using the [update default channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action, you can update the value of channel invitation preference which is globally applied to all users within the application. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateChannelInvitationPreferenceData} opts.updateChannelInvitationPreferenceData
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateChannelInvitationPreferenceRequest} opts.updateChannelInvitationPreferenceRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateChannelInvitationPreferenceResponse} and HTTP response
*/
}, {
key: "updateChannelInvitationPreferenceWithHttpInfo",
- value: function updateChannelInvitationPreferenceWithHttpInfo(apiToken, userId, opts) {
+ value: function updateChannelInvitationPreferenceWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['updateChannelInvitationPreferenceData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateChannelInvitationPreference");
- }
+ var postBody = opts['updateChannelInvitationPreferenceRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling updateChannelInvitationPreference");
@@ -1033,7 +1055,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1045,47 +1067,43 @@ var UserApi = /*#__PURE__*/function () {
/**
* Update channel invitation preference
- * ## Update channel invitation preference Updates the channel invitation preference for a user's [private](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#-3-private-vs-public) group channels. > __Note__: Using the [update default channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-update-default-channel-invitation-preference) action, you can update the value of channel invitation preference which is globally applied to all users within the application. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-channel-invitation-preference
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateChannelInvitationPreferenceData} opts.updateChannelInvitationPreferenceData
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateChannelInvitationPreferenceRequest} opts.updateChannelInvitationPreferenceRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateChannelInvitationPreferenceResponse}
*/
}, {
key: "updateChannelInvitationPreference",
- value: function updateChannelInvitationPreference(apiToken, userId, opts) {
- return this.updateChannelInvitationPreferenceWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function updateChannelInvitationPreference(userId, opts) {
+ return this.updateChannelInvitationPreferenceWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Update count preference of a channel
- * ## Update count preference of a channel Updates count preference of a specific group channel of a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-count-preference-of-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateCountPreferenceOfChannelByUrlData} opts.updateCountPreferenceOfChannelByUrlData
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateCountPreferenceOfAChannelRequest} opts.updateCountPreferenceOfAChannelRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateCountPreferenceOfChannelByUrlResponse} and HTTP response
*/
}, {
- key: "updateCountPreferenceOfChannelByUrlWithHttpInfo",
- value: function updateCountPreferenceOfChannelByUrlWithHttpInfo(apiToken, userId, channelUrl, opts) {
+ key: "updateCountPreferenceOfAChannelWithHttpInfo",
+ value: function updateCountPreferenceOfAChannelWithHttpInfo(userId, channelUrl, opts) {
opts = opts || {};
- var postBody = opts['updateCountPreferenceOfChannelByUrlData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateCountPreferenceOfChannelByUrl");
- }
+ var postBody = opts['updateCountPreferenceOfAChannelRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling updateCountPreferenceOfChannelByUrl");
+ throw new Error("Missing the required parameter 'userId' when calling updateCountPreferenceOfAChannel");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updateCountPreferenceOfChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling updateCountPreferenceOfAChannel");
}
var pathParams = {
'user_id': userId,
@@ -1093,7 +1111,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1105,40 +1123,36 @@ var UserApi = /*#__PURE__*/function () {
/**
* Update count preference of a channel
- * ## Update count preference of a channel Updates count preference of a specific group channel of a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-count-preference-of-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateCountPreferenceOfChannelByUrlData} opts.updateCountPreferenceOfChannelByUrlData
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdateCountPreferenceOfAChannelRequest} opts.updateCountPreferenceOfAChannelRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateCountPreferenceOfChannelByUrlResponse}
*/
}, {
- key: "updateCountPreferenceOfChannelByUrl",
- value: function updateCountPreferenceOfChannelByUrl(apiToken, userId, channelUrl, opts) {
- return this.updateCountPreferenceOfChannelByUrlWithHttpInfo(apiToken, userId, channelUrl, opts).then(function (response_and_data) {
+ key: "updateCountPreferenceOfAChannel",
+ value: function updateCountPreferenceOfAChannel(userId, channelUrl, opts) {
+ return this.updateCountPreferenceOfAChannelWithHttpInfo(userId, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Update push preferences
- * ## Update push preferences Updates a user's push preferences. Through this action, you can set `do_not_disturb` for a user, and update the time frame in which the setting applies. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-push-preferences ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdatePushPreferencesData} opts.updatePushPreferencesData
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdatePushPreferencesRequest} opts.updatePushPreferencesRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdatePushPreferencesResponse} and HTTP response
*/
}, {
key: "updatePushPreferencesWithHttpInfo",
- value: function updatePushPreferencesWithHttpInfo(apiToken, userId, opts) {
+ value: function updatePushPreferencesWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['updatePushPreferencesData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updatePushPreferences");
- }
+ var postBody = opts['updatePushPreferencesRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling updatePushPreferences");
@@ -1148,7 +1162,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1160,47 +1174,43 @@ var UserApi = /*#__PURE__*/function () {
/**
* Update push preferences
- * ## Update push preferences Updates a user's push preferences. Through this action, you can set `do_not_disturb` for a user, and update the time frame in which the setting applies. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-push-preferences ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdatePushPreferencesData} opts.updatePushPreferencesData
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdatePushPreferencesRequest} opts.updatePushPreferencesRequest
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdatePushPreferencesResponse}
*/
}, {
key: "updatePushPreferences",
- value: function updatePushPreferences(apiToken, userId, opts) {
- return this.updatePushPreferencesWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function updatePushPreferences(userId, opts) {
+ return this.updatePushPreferencesWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* Update push preferences for a channel
- * ## Update push preferences for a channel Updates push preferences for a user's specific group channel. The push notifications feature is only available for group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-push-preferences-for-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdatePushPreferencesForChannelByUrlData} opts.updatePushPreferencesForChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdatePushPreferencesForChannelByUrlResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdatePushPreferencesForAChannelRequest} opts.updatePushPreferencesForAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdatePushPreferencesForAChannelResponse} and HTTP response
*/
}, {
- key: "updatePushPreferencesForChannelByUrlWithHttpInfo",
- value: function updatePushPreferencesForChannelByUrlWithHttpInfo(apiToken, userId, channelUrl, opts) {
+ key: "updatePushPreferencesForAChannelWithHttpInfo",
+ value: function updatePushPreferencesForAChannelWithHttpInfo(userId, channelUrl, opts) {
opts = opts || {};
- var postBody = opts['updatePushPreferencesForChannelByUrlData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updatePushPreferencesForChannelByUrl");
- }
+ var postBody = opts['updatePushPreferencesForAChannelRequest'];
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling updatePushPreferencesForChannelByUrl");
+ throw new Error("Missing the required parameter 'userId' when calling updatePushPreferencesForAChannel");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling updatePushPreferencesForChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling updatePushPreferencesForAChannel");
}
var pathParams = {
'user_id': userId,
@@ -1208,160 +1218,113 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
- var returnType = _UpdatePushPreferencesForChannelByUrlResponse["default"];
+ var returnType = _UpdatePushPreferencesForAChannelResponse["default"];
return this.apiClient.callApi('/v3/users/{user_id}/push_preference/{channel_url}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* Update push preferences for a channel
- * ## Update push preferences for a channel Updates push preferences for a user's specific group channel. The push notifications feature is only available for group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-push-preferences-for-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdatePushPreferencesForChannelByUrlData} opts.updatePushPreferencesForChannelByUrlData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdatePushPreferencesForChannelByUrlResponse}
+ * @param {String} opts.apiToken
+ * @param {module:model/UpdatePushPreferencesForAChannelRequest} opts.updatePushPreferencesForAChannelRequest
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdatePushPreferencesForAChannelResponse}
*/
}, {
- key: "updatePushPreferencesForChannelByUrl",
- value: function updatePushPreferencesForChannelByUrl(apiToken, userId, channelUrl, opts) {
- return this.updatePushPreferencesForChannelByUrlWithHttpInfo(apiToken, userId, channelUrl, opts).then(function (response_and_data) {
+ key: "updatePushPreferencesForAChannel",
+ value: function updatePushPreferencesForAChannel(userId, channelUrl, opts) {
+ return this.updatePushPreferencesForAChannelWithHttpInfo(userId, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
- * Update a user
- * ## Update a user Updates information on a user. 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. If the `leave_all_when_deactivated` is true (which it is by default), a user leaves all joined group channels when deactivated. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * View a user
+ * ## 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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {module:model/UpdateUserByIdData} opts.updateUserByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdUser} and HTTP response
+ * @param {Boolean} opts.includeUnreadCount
+ * @param {String} opts.customTypes
+ * @param {module:model/String} opts.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`)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendbirdUser} and HTTP response
*/
}, {
- key: "updateUserByIdWithHttpInfo",
- value: function updateUserByIdWithHttpInfo(apiToken, userId, opts) {
+ key: "viewAUserWithHttpInfo",
+ value: function viewAUserWithHttpInfo(userId, opts) {
opts = opts || {};
- var postBody = opts['updateUserByIdData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling updateUserById");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling updateUserById");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _SendBirdUser["default"];
- return this.apiClient.callApi('/v3/users/{user_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Update a user
- * ## Update a user Updates information on a user. 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. If the `leave_all_when_deactivated` is true (which it is by default), a user leaves all joined group channels when deactivated. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-update-a-user ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {module:model/UpdateUserByIdData} opts.updateUserByIdData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdUser}
- */
- }, {
- key: "updateUserById",
- value: function updateUserById(apiToken, userId, opts) {
- return this.updateUserByIdWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View channel invitation preference
- * ## View channel invitation preference Retrieves channel invitation preference for a user's [private](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#-3-private-vs-public) group channels. > __Note__: Using the [view default channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-default-channel-invitation-preference) action, you can retrieve the value of channel invitation preference which is globally applied to all users within the application. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-channel-invitation-preference
- * @param {String} apiToken
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewChannelInvitationPreferenceResponse} and HTTP response
- */
- }, {
- key: "viewChannelInvitationPreferenceWithHttpInfo",
- value: function viewChannelInvitationPreferenceWithHttpInfo(apiToken, userId) {
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewChannelInvitationPreference");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewChannelInvitationPreference");
+ throw new Error("Missing the required parameter 'userId' when calling viewAUser");
}
var pathParams = {
'user_id': userId
};
- var queryParams = {};
+ var queryParams = {
+ 'include_unread_count': opts['includeUnreadCount'],
+ 'custom_types': opts['customTypes'],
+ 'super_mode': opts['superMode']
+ };
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _ViewChannelInvitationPreferenceResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/channel_invitation_preference', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+ var returnType = _SendbirdUser["default"];
+ return this.apiClient.callApi('/v3/users/{user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
- * View channel invitation preference
- * ## View channel invitation preference Retrieves channel invitation preference for a user's [private](https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#-3-private-vs-public) group channels. > __Note__: Using the [view default channel invitation preference](https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-default-channel-invitation-preference) action, you can retrieve the value of channel invitation preference which is globally applied to all users within the application. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-channel-invitation-preference
- * @param {String} apiToken
- * @param {String} userId
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewChannelInvitationPreferenceResponse}
+ * View a user
+ * ## 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.
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {Boolean} opts.includeUnreadCount
+ * @param {String} opts.customTypes
+ * @param {module:model/String} opts.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`)
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendbirdUser}
*/
}, {
- key: "viewChannelInvitationPreference",
- value: function viewChannelInvitationPreference(apiToken, userId) {
- return this.viewChannelInvitationPreferenceWithHttpInfo(apiToken, userId).then(function (response_and_data) {
+ key: "viewAUser",
+ value: function viewAUser(userId, opts) {
+ return this.viewAUserWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View count preference of a channel
- * ## View count preference of a channel Retrieves count preference of a specific group channel of a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-count-preference-of-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewCountPreferenceOfChannelByUrlResponse} and HTTP response
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewCountPreferenceOfAChannelResponse} and HTTP response
*/
}, {
- key: "viewCountPreferenceOfChannelByUrlWithHttpInfo",
- value: function viewCountPreferenceOfChannelByUrlWithHttpInfo(apiToken, userId, channelUrl) {
+ key: "viewCountPreferenceOfAChannelWithHttpInfo",
+ value: function viewCountPreferenceOfAChannelWithHttpInfo(userId, channelUrl, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewCountPreferenceOfChannelByUrl");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewCountPreferenceOfChannelByUrl");
+ throw new Error("Missing the required parameter 'userId' when calling viewCountPreferenceOfAChannel");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewCountPreferenceOfChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling viewCountPreferenceOfAChannel");
}
var pathParams = {
'user_id': userId,
@@ -1369,107 +1332,48 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _ViewCountPreferenceOfChannelByUrlResponse["default"];
+ var returnType = _ViewCountPreferenceOfAChannelResponse["default"];
return this.apiClient.callApi('/v3/users/{user_id}/count_preference/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* View count preference of a channel
- * ## View count preference of a channel Retrieves count preference of a specific group channel of a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-count-preference-of-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewCountPreferenceOfChannelByUrlResponse}
- */
- }, {
- key: "viewCountPreferenceOfChannelByUrl",
- value: function viewCountPreferenceOfChannelByUrl(apiToken, userId, channelUrl) {
- return this.viewCountPreferenceOfChannelByUrlWithHttpInfo(apiToken, userId, channelUrl).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View number of channels by join status
- * ## View number of channels by join status Retrieves the number of a user's group channels by their join status. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-channels-by-join-status ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to retrieve the number.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.state
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfChannelsByJoinStatusResponse} and HTTP response
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewCountPreferenceOfAChannelResponse}
*/
}, {
- key: "viewNumberOfChannelsByJoinStatusWithHttpInfo",
- value: function viewNumberOfChannelsByJoinStatusWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfChannelsByJoinStatus");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewNumberOfChannelsByJoinStatus");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'state': opts['state']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewNumberOfChannelsByJoinStatusResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/group_channel_count', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View number of channels by join status
- * ## View number of channels by join status Retrieves the number of a user's group channels by their join status. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-channels-by-join-status ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to retrieve the number.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.state
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfChannelsByJoinStatusResponse}
- */
- }, {
- key: "viewNumberOfChannelsByJoinStatus",
- value: function viewNumberOfChannelsByJoinStatus(apiToken, userId, opts) {
- return this.viewNumberOfChannelsByJoinStatusWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ key: "viewCountPreferenceOfAChannel",
+ value: function viewCountPreferenceOfAChannel(userId, channelUrl, opts) {
+ return this.viewCountPreferenceOfAChannelWithHttpInfo(userId, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View number of channels with unread messages
- * ## View number of channels with unread messages Retrieves the total number of a user's group channels with unread messages. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-channels-with-unread-messages ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {Array.} opts.customTypes
- * @param {String} opts.superMode
+ * @param {String} opts.customTypes
+ * @param {module:model/String} opts.superMode Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are all, super, and nonsuper. (Default: all)
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfChannelsWithUnreadMessagesResponse} and HTTP response
*/
}, {
key: "viewNumberOfChannelsWithUnreadMessagesWithHttpInfo",
- value: function viewNumberOfChannelsWithUnreadMessagesWithHttpInfo(apiToken, userId, opts) {
+ value: function viewNumberOfChannelsWithUnreadMessagesWithHttpInfo(userId, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfChannelsWithUnreadMessages");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling viewNumberOfChannelsWithUnreadMessages");
@@ -1478,11 +1382,11 @@ var UserApi = /*#__PURE__*/function () {
'user_id': userId
};
var queryParams = {
- 'custom_types': this.apiClient.buildCollectionParam(opts['customTypes'], 'multi'),
+ 'custom_types': opts['customTypes'],
'super_mode': opts['superMode']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1494,100 +1398,37 @@ var UserApi = /*#__PURE__*/function () {
/**
* View number of channels with unread messages
- * ## View number of channels with unread messages Retrieves the total number of a user's group channels with unread messages. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-channels-with-unread-messages ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {Array.} opts.customTypes
- * @param {String} opts.superMode
+ * @param {String} opts.customTypes
+ * @param {module:model/String} opts.superMode Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are all, super, and nonsuper. (Default: all)
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfChannelsWithUnreadMessagesResponse}
*/
}, {
key: "viewNumberOfChannelsWithUnreadMessages",
- value: function viewNumberOfChannelsWithUnreadMessages(apiToken, userId, opts) {
- return this.viewNumberOfChannelsWithUnreadMessagesWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View number of unread items
- * ## View number of unread items Retrieves a set of total numbers of a user's unread messages, unread mentioned messages, or received invitations in either super or non-super group channels. This action is only available for the group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-unread-items ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.customType
- * @param {String} opts.itemKeys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfUnreadItemsResponse} and HTTP response
- */
- }, {
- key: "viewNumberOfUnreadItemsWithHttpInfo",
- value: function viewNumberOfUnreadItemsWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfUnreadItems");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewNumberOfUnreadItems");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'custom_type': opts['customType'],
- 'item_keys': opts['itemKeys']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _ViewNumberOfUnreadItemsResponse["default"];
- return this.apiClient.callApi('/v3/users/{user_id}/unread_item_count', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View number of unread items
- * ## View number of unread items Retrieves a set of total numbers of a user's unread messages, unread mentioned messages, or received invitations in either super or non-super group channels. This action is only available for the group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-unread-items ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {String} opts.customType
- * @param {String} opts.itemKeys
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfUnreadItemsResponse}
- */
- }, {
- key: "viewNumberOfUnreadItems",
- value: function viewNumberOfUnreadItems(apiToken, userId, opts) {
- return this.viewNumberOfUnreadItemsWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function viewNumberOfChannelsWithUnreadMessages(userId, opts) {
+ return this.viewNumberOfChannelsWithUnreadMessagesWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View number of unread messages
- * ## View number of unread messages Retrieves the total number of a user's currently unread messages in the group channels. The unread counts feature is only available for the group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-unread-messages ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to retrieve the number.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.customTypes
- * @param {String} opts.superMode
+ * @param {String} opts.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.
+ * @param {String} opts.superMode Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are `all`, `super`, and `nonsuper`. (Default: `all`)
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewNumberOfUnreadMessagesResponse} and HTTP response
*/
}, {
key: "viewNumberOfUnreadMessagesWithHttpInfo",
- value: function viewNumberOfUnreadMessagesWithHttpInfo(apiToken, userId, opts) {
+ value: function viewNumberOfUnreadMessagesWithHttpInfo(userId, opts) {
opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewNumberOfUnreadMessages");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling viewNumberOfUnreadMessages");
@@ -1600,7 +1441,7 @@ var UserApi = /*#__PURE__*/function () {
'super_mode': opts['superMode']
};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1612,37 +1453,35 @@ var UserApi = /*#__PURE__*/function () {
/**
* View number of unread messages
- * ## View number of unread messages Retrieves the total number of a user's currently unread messages in the group channels. The unread counts feature is only available for the group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-number-of-unread-messages ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to retrieve the number.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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.
+ * @param {String} userId (Required)
* @param {Object} opts Optional parameters
- * @param {String} opts.customTypes
- * @param {String} opts.superMode
+ * @param {String} opts.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.
+ * @param {String} opts.superMode Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are `all`, `super`, and `nonsuper`. (Default: `all`)
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewNumberOfUnreadMessagesResponse}
*/
}, {
key: "viewNumberOfUnreadMessages",
- value: function viewNumberOfUnreadMessages(apiToken, userId, opts) {
- return this.viewNumberOfUnreadMessagesWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ value: function viewNumberOfUnreadMessages(userId, opts) {
+ return this.viewNumberOfUnreadMessagesWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View push preferences
- * ## View push preferences Retrieves a user's push preferences about whether the user has set `do_not_disturb` to pause notifications for a certain period of time, and the time frame in which the user has applied the setting. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-push-preferences ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewPushPreferencesResponse} and HTTP response
*/
}, {
key: "viewPushPreferencesWithHttpInfo",
- value: function viewPushPreferencesWithHttpInfo(apiToken, userId) {
+ value: function viewPushPreferencesWithHttpInfo(userId, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewPushPreferences");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
throw new Error("Missing the required parameter 'userId' when calling viewPushPreferences");
@@ -1652,7 +1491,7 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
@@ -1664,42 +1503,41 @@ var UserApi = /*#__PURE__*/function () {
/**
* View push preferences
- * ## View push preferences Retrieves a user's push preferences about whether the user has set `do_not_disturb` to pause notifications for a certain period of time, and the time frame in which the user has applied the setting. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-push-preferences ----------------------------
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewPushPreferencesResponse}
*/
}, {
key: "viewPushPreferences",
- value: function viewPushPreferences(apiToken, userId) {
- return this.viewPushPreferencesWithHttpInfo(apiToken, userId).then(function (response_and_data) {
+ value: function viewPushPreferences(userId, opts) {
+ return this.viewPushPreferencesWithHttpInfo(userId, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
/**
* View push preferences for a channel
- * ## View push preferences for a channel Retrieves whether a user has turned on notification messages for a specific channel. The push notifications feature is only available for group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-push-preferences-for-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewPushPreferencesForChannelByUrlResponse} and HTTP response
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ViewPushPreferencesForAChannelResponse} and HTTP response
*/
}, {
- key: "viewPushPreferencesForChannelByUrlWithHttpInfo",
- value: function viewPushPreferencesForChannelByUrlWithHttpInfo(apiToken, userId, channelUrl) {
+ key: "viewPushPreferencesForAChannelWithHttpInfo",
+ value: function viewPushPreferencesForAChannelWithHttpInfo(userId, channelUrl, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewPushPreferencesForChannelByUrl");
- }
// verify the required parameter 'userId' is set
if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewPushPreferencesForChannelByUrl");
+ throw new Error("Missing the required parameter 'userId' when calling viewPushPreferencesForAChannel");
}
// verify the required parameter 'channelUrl' is set
if (channelUrl === undefined || channelUrl === null) {
- throw new Error("Missing the required parameter 'channelUrl' when calling viewPushPreferencesForChannelByUrl");
+ throw new Error("Missing the required parameter 'channelUrl' when calling viewPushPreferencesForAChannel");
}
var pathParams = {
'user_id': userId,
@@ -1707,90 +1545,29 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = _ViewPushPreferencesForChannelByUrlResponse["default"];
+ var returnType = _ViewPushPreferencesForAChannelResponse["default"];
return this.apiClient.callApi('/v3/users/{user_id}/push_preference/{channel_url}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* View push preferences for a channel
- * ## View push preferences for a channel Retrieves whether a user has turned on notification messages for a specific channel. The push notifications feature is only available for group channels. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-push-preferences-for-a-channel ----------------------------
- * @param {String} apiToken
- * @param {String} userId
- * @param {String} channelUrl
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewPushPreferencesForChannelByUrlResponse}
- */
- }, {
- key: "viewPushPreferencesForChannelByUrl",
- value: function viewPushPreferencesForChannelByUrl(apiToken, userId, channelUrl) {
- return this.viewPushPreferencesForChannelByUrlWithHttpInfo(apiToken, userId, channelUrl).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * View a user
- * ## View a user Retrieves information on a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-a-user ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to retrieve.
- * @param {String} apiToken
- * @param {String} userId
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.includeUnreadCount
- * @param {String} opts.customTypes
- * @param {String} opts.superMode
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SendBirdUser} and HTTP response
- */
- }, {
- key: "viewUserByIdWithHttpInfo",
- value: function viewUserByIdWithHttpInfo(apiToken, userId, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewUserById");
- }
- // verify the required parameter 'userId' is set
- if (userId === undefined || userId === null) {
- throw new Error("Missing the required parameter 'userId' when calling viewUserById");
- }
- var pathParams = {
- 'user_id': userId
- };
- var queryParams = {
- 'include_unread_count': opts['includeUnreadCount'],
- 'custom_types': opts['customTypes'],
- 'super_mode': opts['superMode']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _SendBirdUser["default"];
- return this.apiClient.callApi('/v3/users/{user_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * View a user
- * ## View a user Retrieves information on a user. https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-view-a-user ---------------------------- `user_id` Type: string Description: Specifies the unique ID of the user to retrieve.
- * @param {String} apiToken
- * @param {String} userId
+ * ## 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)
+ * @param {String} userId (Required)
+ * @param {String} channelUrl (Required)
* @param {Object} opts Optional parameters
- * @param {Boolean} opts.includeUnreadCount
- * @param {String} opts.customTypes
- * @param {String} opts.superMode
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SendBirdUser}
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ViewPushPreferencesForAChannelResponse}
*/
}, {
- key: "viewUserById",
- value: function viewUserById(apiToken, userId, opts) {
- return this.viewUserByIdWithHttpInfo(apiToken, userId, opts).then(function (response_and_data) {
+ key: "viewPushPreferencesForAChannel",
+ value: function viewPushPreferencesForAChannel(userId, channelUrl, opts) {
+ return this.viewPushPreferencesForAChannelWithHttpInfo(userId, channelUrl, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
@@ -1798,26 +1575,24 @@ var UserApi = /*#__PURE__*/function () {
/**
* View who owns a registration or device token
* ## 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 ----------------------------
- * @param {String} apiToken
- * @param {String} tokenType
- * @param {String} token
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response
+ * @param {String} tokenType (Required)
+ * @param {String} token (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response
*/
}, {
- key: "viewWhoOwnsRegistrationOrDeviceTokenByTokenWithHttpInfo",
- value: function viewWhoOwnsRegistrationOrDeviceTokenByTokenWithHttpInfo(apiToken, tokenType, token) {
+ key: "viewWhoOwnsARegistrationOrDeviceTokenWithHttpInfo",
+ value: function viewWhoOwnsARegistrationOrDeviceTokenWithHttpInfo(tokenType, token, opts) {
+ opts = opts || {};
var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling viewWhoOwnsRegistrationOrDeviceTokenByToken");
- }
// verify the required parameter 'tokenType' is set
if (tokenType === undefined || tokenType === null) {
- throw new Error("Missing the required parameter 'tokenType' when calling viewWhoOwnsRegistrationOrDeviceTokenByToken");
+ throw new Error("Missing the required parameter 'tokenType' when calling viewWhoOwnsARegistrationOrDeviceToken");
}
// verify the required parameter 'token' is set
if (token === undefined || token === null) {
- throw new Error("Missing the required parameter 'token' when calling viewWhoOwnsRegistrationOrDeviceTokenByToken");
+ throw new Error("Missing the required parameter 'token' when calling viewWhoOwnsARegistrationOrDeviceToken");
}
var pathParams = {
'token_type': tokenType,
@@ -1825,32 +1600,31 @@ var UserApi = /*#__PURE__*/function () {
};
var queryParams = {};
var headerParams = {
- 'Api-Token': apiToken
+ 'api-token': opts['apiToken']
};
var formParams = {};
var authNames = [];
var contentTypes = [];
var accepts = ['application/json'];
- var returnType = [_ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner["default"]];
+ var returnType = [_MarkChannelMessagesAsReadRequest["default"]];
return this.apiClient.callApi('/v3/push/device_tokens/{token_type}/{token}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
}
/**
* View who owns a registration or device token
* ## 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 ----------------------------
- * @param {String} apiToken
- * @param {String} tokenType
- * @param {String} token
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.}
+ * @param {String} tokenType (Required)
+ * @param {String} token (Required)
+ * @param {Object} opts Optional parameters
+ * @param {String} opts.apiToken
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.}
*/
}, {
- key: "viewWhoOwnsRegistrationOrDeviceTokenByToken",
- value: function viewWhoOwnsRegistrationOrDeviceTokenByToken(apiToken, tokenType, token) {
- return this.viewWhoOwnsRegistrationOrDeviceTokenByTokenWithHttpInfo(apiToken, tokenType, token).then(function (response_and_data) {
+ key: "viewWhoOwnsARegistrationOrDeviceToken",
+ value: function viewWhoOwnsARegistrationOrDeviceToken(tokenType, token, opts) {
+ return this.viewWhoOwnsARegistrationOrDeviceTokenWithHttpInfo(tokenType, token, opts).then(function (response_and_data) {
return response_and_data.data;
});
}
}]);
- return UserApi;
-}();
-exports["default"] = UserApi;
\ No newline at end of file
+}();
\ No newline at end of file
diff --git a/dist/api/WebhookApi.js b/dist/api/WebhookApi.js
deleted file mode 100644
index 5fda4a7..0000000
--- a/dist/api/WebhookApi.js
+++ /dev/null
@@ -1,129 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _ChooseWhichEventsToSubscribeToData = _interopRequireDefault(require("../model/ChooseWhichEventsToSubscribeToData"));
-var _ChooseWhichEventsToSubscribeToResponse = _interopRequireDefault(require("../model/ChooseWhichEventsToSubscribeToResponse"));
-var _RetrieveListOfSubscribedEventsResponse = _interopRequireDefault(require("../model/RetrieveListOfSubscribedEventsResponse"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
-* Webhook service.
-* @module api/WebhookApi
-* @version 0.0.16
-*/
-var WebhookApi = /*#__PURE__*/function () {
- /**
- * Constructs a new WebhookApi.
- * @alias module:api/WebhookApi
- * @class
- * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
- * default to {@link module:ApiClient#instance} if unspecified.
- */
- function WebhookApi(apiClient) {
- _classCallCheck(this, WebhookApi);
- this.apiClient = apiClient || _ApiClient["default"].instance;
- }
-
- /**
- * Choose which events to subscribe to
- * ## Choose which events to subscribe to Chooses which events for your webhook server to receive payloads for. By subscribing to specific events based on your own needs, you can control the number of HTTP requests to your webhook server. https://sendbird.com/docs/chat/v3/platform-api/guides/webhooks#2-choose-which-events-to-subscribe-to
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/ChooseWhichEventsToSubscribeToData} opts.chooseWhichEventsToSubscribeToData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChooseWhichEventsToSubscribeToResponse} and HTTP response
- */
- _createClass(WebhookApi, [{
- key: "chooseWhichEventsToSubscribeToWithHttpInfo",
- value: function chooseWhichEventsToSubscribeToWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = opts['chooseWhichEventsToSubscribeToData'];
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling chooseWhichEventsToSubscribeTo");
- }
- var pathParams = {};
- var queryParams = {};
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = ['application/json'];
- var accepts = ['application/json'];
- var returnType = _ChooseWhichEventsToSubscribeToResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/webhook', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Choose which events to subscribe to
- * ## Choose which events to subscribe to Chooses which events for your webhook server to receive payloads for. By subscribing to specific events based on your own needs, you can control the number of HTTP requests to your webhook server. https://sendbird.com/docs/chat/v3/platform-api/guides/webhooks#2-choose-which-events-to-subscribe-to
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {module:model/ChooseWhichEventsToSubscribeToData} opts.chooseWhichEventsToSubscribeToData
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChooseWhichEventsToSubscribeToResponse}
- */
- }, {
- key: "chooseWhichEventsToSubscribeTo",
- value: function chooseWhichEventsToSubscribeTo(apiToken, opts) {
- return this.chooseWhichEventsToSubscribeToWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
-
- /**
- * Retrieve a list of subscribed events
- * ## Retrieve a list of subscribed events Retrieves a list of events for your webhook server to receive payloads for. https://sendbird.com/docs/chat/v3/platform-api/guides/webhooks#2-retrieve-a-list-of-subscribed-events ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.displayAllWebhookCategories
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveListOfSubscribedEventsResponse} and HTTP response
- */
- }, {
- key: "retrieveListOfSubscribedEventsWithHttpInfo",
- value: function retrieveListOfSubscribedEventsWithHttpInfo(apiToken, opts) {
- opts = opts || {};
- var postBody = null;
- // verify the required parameter 'apiToken' is set
- if (apiToken === undefined || apiToken === null) {
- throw new Error("Missing the required parameter 'apiToken' when calling retrieveListOfSubscribedEvents");
- }
- var pathParams = {};
- var queryParams = {
- 'display_all_webhook_categories': opts['displayAllWebhookCategories']
- };
- var headerParams = {
- 'Api-Token': apiToken
- };
- var formParams = {};
- var authNames = [];
- var contentTypes = [];
- var accepts = ['application/json'];
- var returnType = _RetrieveListOfSubscribedEventsResponse["default"];
- return this.apiClient.callApi('/v3/applications/settings/webhook', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
- }
-
- /**
- * Retrieve a list of subscribed events
- * ## Retrieve a list of subscribed events Retrieves a list of events for your webhook server to receive payloads for. https://sendbird.com/docs/chat/v3/platform-api/guides/webhooks#2-retrieve-a-list-of-subscribed-events ----------------------------
- * @param {String} apiToken
- * @param {Object} opts Optional parameters
- * @param {Boolean} opts.displayAllWebhookCategories
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveListOfSubscribedEventsResponse}
- */
- }, {
- key: "retrieveListOfSubscribedEvents",
- value: function retrieveListOfSubscribedEvents(apiToken, opts) {
- return this.retrieveListOfSubscribedEventsWithHttpInfo(apiToken, opts).then(function (response_and_data) {
- return response_and_data.data;
- });
- }
- }]);
- return WebhookApi;
-}();
-exports["default"] = WebhookApi;
\ No newline at end of file
diff --git a/dist/index.js b/dist/index.js
index 766171d..d136870 100644
--- a/dist/index.js
+++ b/dist/index.js
@@ -3,1462 +3,598 @@
Object.defineProperty(exports, "__esModule", {
value: true
});
-Object.defineProperty(exports, "AddApnsPushConfigurationData", {
+Object.defineProperty(exports, "AcceptAnInvitationRequest", {
enumerable: true,
get: function get() {
- return _AddApnsPushConfigurationData["default"];
+ return _AcceptAnInvitationRequest["default"];
}
});
-Object.defineProperty(exports, "AddApnsPushConfigurationResponse", {
+Object.defineProperty(exports, "AddARegistrationOrDeviceTokenRequest", {
enumerable: true,
get: function get() {
- return _AddApnsPushConfigurationResponse["default"];
+ return _AddARegistrationOrDeviceTokenRequest["default"];
}
});
-Object.defineProperty(exports, "AddApnsPushConfigurationResponsePushConfigurationsInner", {
+Object.defineProperty(exports, "AddARegistrationOrDeviceTokenResponse", {
enumerable: true,
get: function get() {
- return _AddApnsPushConfigurationResponsePushConfigurationsInner["default"];
+ return _AddARegistrationOrDeviceTokenResponse["default"];
}
});
-Object.defineProperty(exports, "AddEmojiCategoriesResponse", {
+Object.defineProperty(exports, "AddExtraDataToAMessageRequest", {
enumerable: true,
get: function get() {
- return _AddEmojiCategoriesResponse["default"];
+ return _AddExtraDataToAMessageRequest["default"];
}
});
-Object.defineProperty(exports, "AddEmojiCategoriesResponseEmojiCategoriesInner", {
+Object.defineProperty(exports, "AddExtraDataToAMessageResponse", {
enumerable: true,
get: function get() {
- return _AddEmojiCategoriesResponseEmojiCategoriesInner["default"];
+ return _AddExtraDataToAMessageResponse["default"];
}
});
-Object.defineProperty(exports, "AddEmojisData", {
- enumerable: true,
- get: function get() {
- return _AddEmojisData["default"];
- }
-});
-Object.defineProperty(exports, "AddEmojisResponse", {
- enumerable: true,
- get: function get() {
- return _AddEmojisResponse["default"];
- }
-});
-Object.defineProperty(exports, "AddExtraDataToMessageData", {
- enumerable: true,
- get: function get() {
- return _AddExtraDataToMessageData["default"];
- }
-});
-Object.defineProperty(exports, "AddExtraDataToMessageResponse", {
- enumerable: true,
- get: function get() {
- return _AddExtraDataToMessageResponse["default"];
- }
-});
-Object.defineProperty(exports, "AddFcmPushConfigurationData", {
- enumerable: true,
- get: function get() {
- return _AddFcmPushConfigurationData["default"];
- }
-});
-Object.defineProperty(exports, "AddFcmPushConfigurationResponse", {
- enumerable: true,
- get: function get() {
- return _AddFcmPushConfigurationResponse["default"];
- }
-});
-Object.defineProperty(exports, "AddFcmPushConfigurationResponsePushConfigurationsInner", {
- enumerable: true,
- get: function get() {
- return _AddFcmPushConfigurationResponsePushConfigurationsInner["default"];
- }
-});
-Object.defineProperty(exports, "AddHmsPushConfigurationData", {
- enumerable: true,
- get: function get() {
- return _AddHmsPushConfigurationData["default"];
- }
-});
-Object.defineProperty(exports, "AddHmsPushConfigurationResponse", {
- enumerable: true,
- get: function get() {
- return _AddHmsPushConfigurationResponse["default"];
- }
-});
-Object.defineProperty(exports, "AddHmsPushConfigurationResponsePushConfigurationsInner", {
- enumerable: true,
- get: function get() {
- return _AddHmsPushConfigurationResponsePushConfigurationsInner["default"];
- }
-});
-Object.defineProperty(exports, "AddIpToWhitelistData", {
- enumerable: true,
- get: function get() {
- return _AddIpToWhitelistData["default"];
- }
-});
-Object.defineProperty(exports, "AddIpToWhitelistResponse", {
- enumerable: true,
- get: function get() {
- return _AddIpToWhitelistResponse["default"];
- }
-});
-Object.defineProperty(exports, "AddReactionToAMessageData", {
- enumerable: true,
- get: function get() {
- return _AddReactionToAMessageData["default"];
- }
-});
-Object.defineProperty(exports, "AddReactionToAMessageResponse", {
- enumerable: true,
- get: function get() {
- return _AddReactionToAMessageResponse["default"];
- }
-});
-Object.defineProperty(exports, "AddRegistrationOrDeviceTokenData", {
- enumerable: true,
- get: function get() {
- return _AddRegistrationOrDeviceTokenData["default"];
- }
-});
-Object.defineProperty(exports, "AddRegistrationOrDeviceTokenResponse", {
- enumerable: true,
- get: function get() {
- return _AddRegistrationOrDeviceTokenResponse["default"];
- }
-});
-Object.defineProperty(exports, "AnnouncementApi", {
- enumerable: true,
- get: function get() {
- return _AnnouncementApi["default"];
- }
-});
-Object.defineProperty(exports, "ApiClient", {
- enumerable: true,
- get: function get() {
- return _ApiClient["default"];
- }
-});
-Object.defineProperty(exports, "ApplicationApi", {
- enumerable: true,
- get: function get() {
- return _ApplicationApi["default"];
- }
-});
-Object.defineProperty(exports, "BanFromChannelsWithCustomChannelTypesData", {
- enumerable: true,
- get: function get() {
- return _BanFromChannelsWithCustomChannelTypesData["default"];
- }
-});
-Object.defineProperty(exports, "BanUsersInChannelsWithCustomChannelTypeData", {
- enumerable: true,
- get: function get() {
- return _BanUsersInChannelsWithCustomChannelTypeData["default"];
- }
-});
-Object.defineProperty(exports, "BanUsersInChannelsWithCustomChannelTypeDataBannedListInner", {
- enumerable: true,
- get: function get() {
- return _BanUsersInChannelsWithCustomChannelTypeDataBannedListInner["default"];
- }
-});
-Object.defineProperty(exports, "Blob", {
- enumerable: true,
- get: function get() {
- return _Blob["default"];
- }
-});
-Object.defineProperty(exports, "BlockUserData", {
- enumerable: true,
- get: function get() {
- return _BlockUserData["default"];
- }
-});
-Object.defineProperty(exports, "BlockUserResponse", {
- enumerable: true,
- get: function get() {
- return _BlockUserResponse["default"];
- }
-});
-Object.defineProperty(exports, "BotApi", {
- enumerable: true,
- get: function get() {
- return _BotApi["default"];
- }
-});
-Object.defineProperty(exports, "ChoosePushNotificationContentTemplateResponse", {
- enumerable: true,
- get: function get() {
- return _ChoosePushNotificationContentTemplateResponse["default"];
- }
-});
-Object.defineProperty(exports, "ChooseWhichEventsToSubscribeToData", {
- enumerable: true,
- get: function get() {
- return _ChooseWhichEventsToSubscribeToData["default"];
- }
-});
-Object.defineProperty(exports, "ChooseWhichEventsToSubscribeToResponse", {
- enumerable: true,
- get: function get() {
- return _ChooseWhichEventsToSubscribeToResponse["default"];
- }
-});
-Object.defineProperty(exports, "ChooseWhichEventsToSubscribeToResponseWebhook", {
- enumerable: true,
- get: function get() {
- return _ChooseWhichEventsToSubscribeToResponseWebhook["default"];
- }
-});
-Object.defineProperty(exports, "ConfigureAutoEventData", {
- enumerable: true,
- get: function get() {
- return _ConfigureAutoEventData["default"];
- }
-});
-Object.defineProperty(exports, "ConfigureAutoEventDataAutoEventMessage", {
- enumerable: true,
- get: function get() {
- return _ConfigureAutoEventDataAutoEventMessage["default"];
- }
-});
-Object.defineProperty(exports, "CreateBotData", {
- enumerable: true,
- get: function get() {
- return _CreateBotData["default"];
- }
-});
-Object.defineProperty(exports, "CreateBotResponse", {
- enumerable: true,
- get: function get() {
- return _CreateBotResponse["default"];
- }
-});
-Object.defineProperty(exports, "CreateBotResponseBot", {
- enumerable: true,
- get: function get() {
- return _CreateBotResponseBot["default"];
- }
-});
-Object.defineProperty(exports, "CreateChannelMetacounterData", {
- enumerable: true,
- get: function get() {
- return _CreateChannelMetacounterData["default"];
- }
-});
-Object.defineProperty(exports, "CreateChannelMetadataData", {
- enumerable: true,
- get: function get() {
- return _CreateChannelMetadataData["default"];
- }
-});
-Object.defineProperty(exports, "CreateChannelMetadataResponse", {
- enumerable: true,
- get: function get() {
- return _CreateChannelMetadataResponse["default"];
- }
-});
-Object.defineProperty(exports, "CreateUserData", {
- enumerable: true,
- get: function get() {
- return _CreateUserData["default"];
- }
-});
-Object.defineProperty(exports, "CreateUserMetadataData", {
- enumerable: true,
- get: function get() {
- return _CreateUserMetadataData["default"];
- }
-});
-Object.defineProperty(exports, "CreateUserMetadataResponse", {
- enumerable: true,
- get: function get() {
- return _CreateUserMetadataResponse["default"];
- }
-});
-Object.defineProperty(exports, "CreateUserTokenData", {
- enumerable: true,
- get: function get() {
- return _CreateUserTokenData["default"];
- }
-});
-Object.defineProperty(exports, "CreateUserTokenResponse", {
- enumerable: true,
- get: function get() {
- return _CreateUserTokenResponse["default"];
- }
-});
-Object.defineProperty(exports, "CustomTypeListBannedUsersResponse", {
- enumerable: true,
- get: function get() {
- return _CustomTypeListBannedUsersResponse["default"];
- }
-});
-Object.defineProperty(exports, "DataExportApi", {
- enumerable: true,
- get: function get() {
- return _DataExportApi["default"];
- }
-});
-Object.defineProperty(exports, "DeleteAllowedIpsFromWhitelistResponse", {
- enumerable: true,
- get: function get() {
- return _DeleteAllowedIpsFromWhitelistResponse["default"];
- }
-});
-Object.defineProperty(exports, "DeleteApnsCertificateByIdResponse", {
- enumerable: true,
- get: function get() {
- return _DeleteApnsCertificateByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "EnableReactionsData", {
- enumerable: true,
- get: function get() {
- return _EnableReactionsData["default"];
- }
-});
-Object.defineProperty(exports, "EnableReactionsResponse", {
- enumerable: true,
- get: function get() {
- return _EnableReactionsResponse["default"];
- }
-});
-Object.defineProperty(exports, "File", {
- enumerable: true,
- get: function get() {
- return _File["default"];
- }
-});
-Object.defineProperty(exports, "Function", {
- enumerable: true,
- get: function get() {
- return _Function["default"];
- }
-});
-Object.defineProperty(exports, "GcAcceptInvitationData", {
- enumerable: true,
- get: function get() {
- return _GcAcceptInvitationData["default"];
- }
-});
-Object.defineProperty(exports, "GcBanUserData", {
- enumerable: true,
- get: function get() {
- return _GcBanUserData["default"];
- }
-});
-Object.defineProperty(exports, "GcBanUserResponse", {
- enumerable: true,
- get: function get() {
- return _GcBanUserResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcCheckIfMemberByIdResponse", {
- enumerable: true,
- get: function get() {
- return _GcCheckIfMemberByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcCreateChannelData", {
- enumerable: true,
- get: function get() {
- return _GcCreateChannelData["default"];
- }
-});
-Object.defineProperty(exports, "GcDeclineInvitationData", {
- enumerable: true,
- get: function get() {
- return _GcDeclineInvitationData["default"];
- }
-});
-Object.defineProperty(exports, "GcFreezeChannelData", {
- enumerable: true,
- get: function get() {
- return _GcFreezeChannelData["default"];
- }
-});
-Object.defineProperty(exports, "GcHideOrArchiveChannelData", {
- enumerable: true,
- get: function get() {
- return _GcHideOrArchiveChannelData["default"];
- }
-});
-Object.defineProperty(exports, "GcInviteAsMembersData", {
- enumerable: true,
- get: function get() {
- return _GcInviteAsMembersData["default"];
- }
-});
-Object.defineProperty(exports, "GcJoinChannelData", {
- enumerable: true,
- get: function get() {
- return _GcJoinChannelData["default"];
- }
-});
-Object.defineProperty(exports, "GcLeaveChannelData", {
- enumerable: true,
- get: function get() {
- return _GcLeaveChannelData["default"];
- }
-});
-Object.defineProperty(exports, "GcListBannedUsersResponse", {
- enumerable: true,
- get: function get() {
- return _GcListBannedUsersResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcListChannelsResponse", {
- enumerable: true,
- get: function get() {
- return _GcListChannelsResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcListMembersResponse", {
- enumerable: true,
- get: function get() {
- return _GcListMembersResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcListMutedUsersResponse", {
- enumerable: true,
- get: function get() {
- return _GcListMutedUsersResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcListOperatorsResponse", {
- enumerable: true,
- get: function get() {
- return _GcListOperatorsResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcMarkAllMessagesAsDeliveredData", {
- enumerable: true,
- get: function get() {
- return _GcMarkAllMessagesAsDeliveredData["default"];
- }
-});
-Object.defineProperty(exports, "GcMarkAllMessagesAsDeliveredResponse", {
- enumerable: true,
- get: function get() {
- return _GcMarkAllMessagesAsDeliveredResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcMarkAllMessagesAsReadData", {
- enumerable: true,
- get: function get() {
- return _GcMarkAllMessagesAsReadData["default"];
- }
-});
-Object.defineProperty(exports, "GcMuteUserData", {
- enumerable: true,
- get: function get() {
- return _GcMuteUserData["default"];
- }
-});
-Object.defineProperty(exports, "GcRegisterOperatorsData", {
- enumerable: true,
- get: function get() {
- return _GcRegisterOperatorsData["default"];
- }
-});
-Object.defineProperty(exports, "GcRegisterOperatorsResponse", {
- enumerable: true,
- get: function get() {
- return _GcRegisterOperatorsResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcResetChatHistoryData", {
- enumerable: true,
- get: function get() {
- return _GcResetChatHistoryData["default"];
- }
-});
-Object.defineProperty(exports, "GcResetChatHistoryResponse", {
- enumerable: true,
- get: function get() {
- return _GcResetChatHistoryResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcUpdateBanByIdData", {
- enumerable: true,
- get: function get() {
- return _GcUpdateBanByIdData["default"];
- }
-});
-Object.defineProperty(exports, "GcUpdateBanByIdResponse", {
- enumerable: true,
- get: function get() {
- return _GcUpdateBanByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcUpdateChannelByUrlData", {
- enumerable: true,
- get: function get() {
- return _GcUpdateChannelByUrlData["default"];
- }
-});
-Object.defineProperty(exports, "GcViewBanByIdResponse", {
- enumerable: true,
- get: function get() {
- return _GcViewBanByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcViewMuteByIdResponse", {
- enumerable: true,
- get: function get() {
- return _GcViewMuteByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "GcViewNumberOfEachMembersUnreadMessagesResponse", {
- enumerable: true,
- get: function get() {
- return _GcViewNumberOfEachMembersUnreadMessagesResponse["default"];
- }
-});
-Object.defineProperty(exports, "GenerateSecondaryApiTokenData", {
- enumerable: true,
- get: function get() {
- return _GenerateSecondaryApiTokenData["default"];
- }
-});
-Object.defineProperty(exports, "GenerateSecondaryApiTokenResponse", {
- enumerable: true,
- get: function get() {
- return _GenerateSecondaryApiTokenResponse["default"];
- }
-});
-Object.defineProperty(exports, "GetDetailedOpenRateOfAnnouncementByIdResponse", {
- enumerable: true,
- get: function get() {
- return _GetDetailedOpenRateOfAnnouncementByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "GetDetailedOpenRateOfAnnouncementGroupResponse", {
- enumerable: true,
- get: function get() {
- return _GetDetailedOpenRateOfAnnouncementGroupResponse["default"];
- }
-});
-Object.defineProperty(exports, "GetDetailedOpenStatusOfAnnouncementByIdResponse", {
- enumerable: true,
- get: function get() {
- return _GetDetailedOpenStatusOfAnnouncementByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "GetDetailedOpenStatusOfAnnouncementByIdResponseOpenStatusInner", {
- enumerable: true,
- get: function get() {
- return _GetDetailedOpenStatusOfAnnouncementByIdResponseOpenStatusInner["default"];
- }
-});
-Object.defineProperty(exports, "GetStatisticsDailyResponse", {
- enumerable: true,
- get: function get() {
- return _GetStatisticsDailyResponse["default"];
- }
-});
-Object.defineProperty(exports, "GetStatisticsDailyResponseStatisticsInner", {
- enumerable: true,
- get: function get() {
- return _GetStatisticsDailyResponseStatisticsInner["default"];
- }
-});
-Object.defineProperty(exports, "GetStatisticsMonthlyResponse", {
- enumerable: true,
- get: function get() {
- return _GetStatisticsMonthlyResponse["default"];
- }
-});
-Object.defineProperty(exports, "GetStatisticsResponse", {
- enumerable: true,
- get: function get() {
- return _GetStatisticsResponse["default"];
- }
-});
-Object.defineProperty(exports, "GroupChannelApi", {
- enumerable: true,
- get: function get() {
- return _GroupChannelApi["default"];
- }
-});
-Object.defineProperty(exports, "JoinChannelsData", {
- enumerable: true,
- get: function get() {
- return _JoinChannelsData["default"];
- }
-});
-Object.defineProperty(exports, "JoinChannelsResponse", {
- enumerable: true,
- get: function get() {
- return _JoinChannelsResponse["default"];
- }
-});
-Object.defineProperty(exports, "LeaveMyGroupChannelsData", {
- enumerable: true,
- get: function get() {
- return _LeaveMyGroupChannelsData["default"];
- }
-});
-Object.defineProperty(exports, "ListAllEmojisAndEmojiCategoriesResponse", {
- enumerable: true,
- get: function get() {
- return _ListAllEmojisAndEmojiCategoriesResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInner", {
- enumerable: true,
- get: function get() {
- return _ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInner["default"];
- }
-});
-Object.defineProperty(exports, "ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner", {
- enumerable: true,
- get: function get() {
- return _ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner["default"];
- }
-});
-Object.defineProperty(exports, "ListAnnouncementGroupsResponse", {
- enumerable: true,
- get: function get() {
- return _ListAnnouncementGroupsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListAnnouncementsResponse", {
- enumerable: true,
- get: function get() {
- return _ListAnnouncementsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListAnnouncementsResponseAnnouncementsInner", {
- enumerable: true,
- get: function get() {
- return _ListAnnouncementsResponseAnnouncementsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListBannedChannelsResponse", {
- enumerable: true,
- get: function get() {
- return _ListBannedChannelsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListBannedChannelsResponseBannedChannelsInner", {
- enumerable: true,
- get: function get() {
- return _ListBannedChannelsResponseBannedChannelsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListBlockedUsersResponse", {
- enumerable: true,
- get: function get() {
- return _ListBlockedUsersResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListBotsResponse", {
- enumerable: true,
- get: function get() {
- return _ListBotsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListBotsResponseBotsInner", {
- enumerable: true,
- get: function get() {
- return _ListBotsResponseBotsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListDataExportsByMessageChannelOrUserResponse", {
- enumerable: true,
- get: function get() {
- return _ListDataExportsByMessageChannelOrUserResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListDataExportsByMessageChannelOrUserResponseExportedDataInner", {
- enumerable: true,
- get: function get() {
- return _ListDataExportsByMessageChannelOrUserResponseExportedDataInner["default"];
- }
-});
-Object.defineProperty(exports, "ListDataExportsByMessageChannelOrUserResponseExportedDataInnerFile", {
- enumerable: true,
- get: function get() {
- return _ListDataExportsByMessageChannelOrUserResponseExportedDataInnerFile["default"];
- }
-});
-Object.defineProperty(exports, "ListEmojisResponse", {
- enumerable: true,
- get: function get() {
- return _ListEmojisResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListGdprRequestsResponse", {
- enumerable: true,
- get: function get() {
- return _ListGdprRequestsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListGdprRequestsResponseRequestsInner", {
- enumerable: true,
- get: function get() {
- return _ListGdprRequestsResponseRequestsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListMessagesResponse", {
- enumerable: true,
- get: function get() {
- return _ListMessagesResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListMessagesResponseMessagesInner", {
- enumerable: true,
- get: function get() {
- return _ListMessagesResponseMessagesInner["default"];
- }
-});
-Object.defineProperty(exports, "ListMessagesResponseMessagesInnerOgTag", {
- enumerable: true,
- get: function get() {
- return _ListMessagesResponseMessagesInnerOgTag["default"];
- }
-});
-Object.defineProperty(exports, "ListMessagesResponseMessagesInnerOgTagOgImage", {
- enumerable: true,
- get: function get() {
- return _ListMessagesResponseMessagesInnerOgTagOgImage["default"];
- }
-});
-Object.defineProperty(exports, "ListMessagesResponseMessagesInnerSortedMetaarrayInner", {
- enumerable: true,
- get: function get() {
- return _ListMessagesResponseMessagesInnerSortedMetaarrayInner["default"];
- }
-});
-Object.defineProperty(exports, "ListMutedChannelsResponse", {
- enumerable: true,
- get: function get() {
- return _ListMutedChannelsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListMutedUsersInChannelsWithCustomChannelType200Response", {
- enumerable: true,
- get: function get() {
- return _ListMutedUsersInChannelsWithCustomChannelType200Response["default"];
- }
-});
-Object.defineProperty(exports, "ListMyGroupChannelsResponse", {
- enumerable: true,
- get: function get() {
- return _ListMyGroupChannelsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListPushConfigurationsResponse", {
- enumerable: true,
- get: function get() {
- return _ListPushConfigurationsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListPushConfigurationsResponsePushConfigurationsInner", {
- enumerable: true,
- get: function get() {
- return _ListPushConfigurationsResponsePushConfigurationsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListPushNotificationContentTemplatesResponse", {
- enumerable: true,
- get: function get() {
- return _ListPushNotificationContentTemplatesResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListPushNotificationContentTemplatesResponsePushMessageTemplatesInner", {
- enumerable: true,
- get: function get() {
- return _ListPushNotificationContentTemplatesResponsePushMessageTemplatesInner["default"];
- }
-});
-Object.defineProperty(exports, "ListPushNotificationContentTemplatesResponsePushMessageTemplatesInnerTemplate", {
- enumerable: true,
- get: function get() {
- return _ListPushNotificationContentTemplatesResponsePushMessageTemplatesInnerTemplate["default"];
- }
-});
-Object.defineProperty(exports, "ListReactionsOfMessageResponse", {
- enumerable: true,
- get: function get() {
- return _ListReactionsOfMessageResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListRegistrationOrDeviceTokensResponse", {
- enumerable: true,
- get: function get() {
- return _ListRegistrationOrDeviceTokensResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListReportsOnChannelByUrlResponse", {
- enumerable: true,
- get: function get() {
- return _ListReportsOnChannelByUrlResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListReportsOnMessageByIdResponse", {
- enumerable: true,
- get: function get() {
- return _ListReportsOnMessageByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListReportsOnMessageByIdResponseReportLogsInner", {
- enumerable: true,
- get: function get() {
- return _ListReportsOnMessageByIdResponseReportLogsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListReportsOnUserByIdResponse", {
- enumerable: true,
- get: function get() {
- return _ListReportsOnUserByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListReportsResponse", {
- enumerable: true,
- get: function get() {
- return _ListReportsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListReportsResponseReportLogsInner", {
- enumerable: true,
- get: function get() {
- return _ListReportsResponseReportLogsInner["default"];
- }
-});
-Object.defineProperty(exports, "ListSecondaryApiTokensResponse", {
- enumerable: true,
- get: function get() {
- return _ListSecondaryApiTokensResponse["default"];
- }
-});
-Object.defineProperty(exports, "ListSecondaryApiTokensResponseApiTokensInner", {
- enumerable: true,
- get: function get() {
- return _ListSecondaryApiTokensResponseApiTokensInner["default"];
- }
-});
-Object.defineProperty(exports, "ListUsersResponse", {
- enumerable: true,
- get: function get() {
- return _ListUsersResponse["default"];
- }
-});
-Object.defineProperty(exports, "MarkAllMessagesAsReadData", {
- enumerable: true,
- get: function get() {
- return _MarkAllMessagesAsReadData["default"];
- }
-});
-Object.defineProperty(exports, "MessageApi", {
- enumerable: true,
- get: function get() {
- return _MessageApi["default"];
- }
-});
-Object.defineProperty(exports, "MetadataApi", {
- enumerable: true,
- get: function get() {
- return _MetadataApi["default"];
- }
-});
-Object.defineProperty(exports, "ModerationApi", {
- enumerable: true,
- get: function get() {
- return _ModerationApi["default"];
- }
-});
-Object.defineProperty(exports, "MuteInChannelsWithCustomChannelTypesData", {
- enumerable: true,
- get: function get() {
- return _MuteInChannelsWithCustomChannelTypesData["default"];
- }
-});
-Object.defineProperty(exports, "MuteUsersInChannelsWithCustomChannelTypeData", {
- enumerable: true,
- get: function get() {
- return _MuteUsersInChannelsWithCustomChannelTypeData["default"];
- }
-});
-Object.defineProperty(exports, "OcBanUserData", {
- enumerable: true,
- get: function get() {
- return _OcBanUserData["default"];
- }
-});
-Object.defineProperty(exports, "OcBanUserResponse", {
- enumerable: true,
- get: function get() {
- return _OcBanUserResponse["default"];
- }
-});
-Object.defineProperty(exports, "OcCreateChannelData", {
+Object.defineProperty(exports, "AnnouncementApi", {
enumerable: true,
get: function get() {
- return _OcCreateChannelData["default"];
+ return _AnnouncementApi["default"];
}
});
-Object.defineProperty(exports, "OcDeleteChannelByUrl200Response", {
+Object.defineProperty(exports, "ApiClient", {
enumerable: true,
get: function get() {
- return _OcDeleteChannelByUrl200Response["default"];
+ return _ApiClient["default"];
}
});
-Object.defineProperty(exports, "OcFreezeChannelData", {
+Object.defineProperty(exports, "BlockAUserRequest", {
enumerable: true,
get: function get() {
- return _OcFreezeChannelData["default"];
+ return _BlockAUserRequest["default"];
}
});
-Object.defineProperty(exports, "OcListBannedUsersResponse", {
+Object.defineProperty(exports, "BlockAUserResponse", {
enumerable: true,
get: function get() {
- return _OcListBannedUsersResponse["default"];
+ return _BlockAUserResponse["default"];
}
});
-Object.defineProperty(exports, "OcListBannedUsersResponseBannedListInner", {
+Object.defineProperty(exports, "BotApi", {
enumerable: true,
get: function get() {
- return _OcListBannedUsersResponseBannedListInner["default"];
+ return _BotApi["default"];
}
});
-Object.defineProperty(exports, "OcListChannelsResponse", {
+Object.defineProperty(exports, "CheckIfMemberResponse", {
enumerable: true,
get: function get() {
- return _OcListChannelsResponse["default"];
+ return _CheckIfMemberResponse["default"];
}
});
-Object.defineProperty(exports, "OcListMutedUsersResponse", {
+Object.defineProperty(exports, "ChooseAPushNotificationContentTemplateRequest", {
enumerable: true,
get: function get() {
- return _OcListMutedUsersResponse["default"];
+ return _ChooseAPushNotificationContentTemplateRequest["default"];
}
});
-Object.defineProperty(exports, "OcListOperatorsResponse", {
+Object.defineProperty(exports, "ChooseAPushNotificationContentTemplateResponse", {
enumerable: true,
get: function get() {
- return _OcListOperatorsResponse["default"];
+ return _ChooseAPushNotificationContentTemplateResponse["default"];
}
});
-Object.defineProperty(exports, "OcListParticipantsResponse", {
+Object.defineProperty(exports, "CreateABotRequest", {
enumerable: true,
get: function get() {
- return _OcListParticipantsResponse["default"];
+ return _CreateABotRequest["default"];
}
});
-Object.defineProperty(exports, "OcMuteUserData", {
+Object.defineProperty(exports, "CreateABotResponse", {
enumerable: true,
get: function get() {
- return _OcMuteUserData["default"];
+ return _CreateABotResponse["default"];
}
});
-Object.defineProperty(exports, "OcRegisterOperatorsData", {
+Object.defineProperty(exports, "CreateABotResponseBot", {
enumerable: true,
get: function get() {
- return _OcRegisterOperatorsData["default"];
+ return _CreateABotResponseBot["default"];
}
});
-Object.defineProperty(exports, "OcUpdateBanByIdData", {
+Object.defineProperty(exports, "CreateABotResponseBotStyle", {
enumerable: true,
get: function get() {
- return _OcUpdateBanByIdData["default"];
+ return _CreateABotResponseBotStyle["default"];
}
});
-Object.defineProperty(exports, "OcUpdateBanByIdResponse", {
+Object.defineProperty(exports, "CreateAChannelMetadataRequest", {
enumerable: true,
get: function get() {
- return _OcUpdateBanByIdResponse["default"];
+ return _CreateAChannelMetadataRequest["default"];
}
});
-Object.defineProperty(exports, "OcUpdateChannelByUrlData", {
+Object.defineProperty(exports, "CreateAChannelMetadataResponse", {
enumerable: true,
get: function get() {
- return _OcUpdateChannelByUrlData["default"];
+ return _CreateAChannelMetadataResponse["default"];
}
});
-Object.defineProperty(exports, "OcViewBanByIdResponse", {
+Object.defineProperty(exports, "CreateAGroupChannelRequest", {
enumerable: true,
get: function get() {
- return _OcViewBanByIdResponse["default"];
+ return _CreateAGroupChannelRequest["default"];
}
});
-Object.defineProperty(exports, "OcViewMuteByIdResponse", {
+Object.defineProperty(exports, "CreateAUserRequest", {
enumerable: true,
get: function get() {
- return _OcViewMuteByIdResponse["default"];
+ return _CreateAUserRequest["default"];
}
});
-Object.defineProperty(exports, "OpenChannelApi", {
+Object.defineProperty(exports, "CreateAnOpenChannelRequest", {
enumerable: true,
get: function get() {
- return _OpenChannelApi["default"];
+ return _CreateAnOpenChannelRequest["default"];
}
});
-Object.defineProperty(exports, "PrivacyApi", {
+Object.defineProperty(exports, "CreateUserTokenRequest", {
enumerable: true,
get: function get() {
- return _PrivacyApi["default"];
+ return _CreateUserTokenRequest["default"];
}
});
-Object.defineProperty(exports, "RegisterAndScheduleDataExportData", {
+Object.defineProperty(exports, "CreateUserTokenResponse", {
enumerable: true,
get: function get() {
- return _RegisterAndScheduleDataExportData["default"];
+ return _CreateUserTokenResponse["default"];
}
});
-Object.defineProperty(exports, "RegisterAndScheduleDataExportResponse", {
+Object.defineProperty(exports, "FreezeAGroupChannelRequest", {
enumerable: true,
get: function get() {
- return _RegisterAndScheduleDataExportResponse["default"];
+ return _FreezeAGroupChannelRequest["default"];
}
});
-Object.defineProperty(exports, "RegisterAsOperatorToChannelsWithCustomChannelTypesData", {
+Object.defineProperty(exports, "FreezeAnOpenChannelRequest", {
enumerable: true,
get: function get() {
- return _RegisterAsOperatorToChannelsWithCustomChannelTypesData["default"];
+ return _FreezeAnOpenChannelRequest["default"];
}
});
-Object.defineProperty(exports, "RegisterGdprRequestData", {
+Object.defineProperty(exports, "GetAGroupChannelResponse", {
enumerable: true,
get: function get() {
- return _RegisterGdprRequestData["default"];
+ return _GetAGroupChannelResponse["default"];
}
});
-Object.defineProperty(exports, "RegisterGdprRequestResponse", {
+Object.defineProperty(exports, "GetAGroupChannelResponseAllOf", {
enumerable: true,
get: function get() {
- return _RegisterGdprRequestResponse["default"];
+ return _GetAGroupChannelResponseAllOf["default"];
}
});
-Object.defineProperty(exports, "RemovePushConfigurationByIdResponse", {
+Object.defineProperty(exports, "GetChannelInvitationPreferenceResponse", {
enumerable: true,
get: function get() {
- return _RemovePushConfigurationByIdResponse["default"];
+ return _GetChannelInvitationPreferenceResponse["default"];
}
});
-Object.defineProperty(exports, "RemoveReactionFromAMessageResponse", {
+Object.defineProperty(exports, "GetTotalNumberOfMessagesInAChannelResponse", {
enumerable: true,
get: function get() {
- return _RemoveReactionFromAMessageResponse["default"];
+ return _GetTotalNumberOfMessagesInAChannelResponse["default"];
}
});
-Object.defineProperty(exports, "RemoveRegistrationOrDeviceTokenByTokenResponse", {
+Object.defineProperty(exports, "GroupChannelApi", {
enumerable: true,
get: function get() {
- return _RemoveRegistrationOrDeviceTokenByTokenResponse["default"];
+ return _GroupChannelApi["default"];
}
});
-Object.defineProperty(exports, "RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse", {
+Object.defineProperty(exports, "GroupChannelListMembersResponse", {
enumerable: true,
get: function get() {
- return _RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse["default"];
+ return _GroupChannelListMembersResponse["default"];
}
});
-Object.defineProperty(exports, "RemoveRegistrationOrDeviceTokenResponse", {
+Object.defineProperty(exports, "GroupChatListChannelsResponse", {
enumerable: true,
get: function get() {
- return _RemoveRegistrationOrDeviceTokenResponse["default"];
+ return _GroupChatListChannelsResponse["default"];
}
});
-Object.defineProperty(exports, "ReportApi", {
+Object.defineProperty(exports, "HideAChannelRequest", {
enumerable: true,
get: function get() {
- return _ReportApi["default"];
+ return _HideAChannelRequest["default"];
}
});
-Object.defineProperty(exports, "ReportChannelByUrlData", {
+Object.defineProperty(exports, "InviteAsMembersRequest", {
enumerable: true,
get: function get() {
- return _ReportChannelByUrlData["default"];
+ return _InviteAsMembersRequest["default"];
}
});
-Object.defineProperty(exports, "ReportChannelByUrlResponse", {
+Object.defineProperty(exports, "InviteAsMembersResponse", {
enumerable: true,
get: function get() {
- return _ReportChannelByUrlResponse["default"];
+ return _InviteAsMembersResponse["default"];
}
});
-Object.defineProperty(exports, "ReportMessageByIdData", {
+Object.defineProperty(exports, "InviteAsMembersResponseAllOf", {
enumerable: true,
get: function get() {
- return _ReportMessageByIdData["default"];
+ return _InviteAsMembersResponseAllOf["default"];
}
});
-Object.defineProperty(exports, "ReportMessageByIdResponse", {
+Object.defineProperty(exports, "JoinAChannelRequest", {
enumerable: true,
get: function get() {
- return _ReportMessageByIdResponse["default"];
+ return _JoinAChannelRequest["default"];
}
});
-Object.defineProperty(exports, "ReportUserByIdData", {
+Object.defineProperty(exports, "JoinChannelsRequest", {
enumerable: true,
get: function get() {
- return _ReportUserByIdData["default"];
+ return _JoinChannelsRequest["default"];
}
});
-Object.defineProperty(exports, "ReportUserByIdResponse", {
+Object.defineProperty(exports, "LeaveAChannelRequest", {
enumerable: true,
get: function get() {
- return _ReportUserByIdResponse["default"];
+ return _LeaveAChannelRequest["default"];
}
});
-Object.defineProperty(exports, "ResetPushPreferencesResponse", {
+Object.defineProperty(exports, "LeaveMyGroupChannelsRequest", {
enumerable: true,
get: function get() {
- return _ResetPushPreferencesResponse["default"];
+ return _LeaveMyGroupChannelsRequest["default"];
}
});
-Object.defineProperty(exports, "RetrieveAdvancedAnalyticsMetricsResponse", {
+Object.defineProperty(exports, "ListBlockedUsersResponse", {
enumerable: true,
get: function get() {
- return _RetrieveAdvancedAnalyticsMetricsResponse["default"];
+ return _ListBlockedUsersResponse["default"];
}
});
-Object.defineProperty(exports, "RetrieveIpWhitelistResponse", {
+Object.defineProperty(exports, "ListBotsResponse", {
enumerable: true,
get: function get() {
- return _RetrieveIpWhitelistResponse["default"];
+ return _ListBotsResponse["default"];
}
});
-Object.defineProperty(exports, "RetrieveListOfSubscribedEventsResponse", {
+Object.defineProperty(exports, "ListBotsResponseBotsInner", {
enumerable: true,
get: function get() {
- return _RetrieveListOfSubscribedEventsResponse["default"];
+ return _ListBotsResponseBotsInner["default"];
}
});
-Object.defineProperty(exports, "RetrieveListOfSubscribedEventsResponseWebhook", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerAi", {
enumerable: true,
get: function get() {
- return _RetrieveListOfSubscribedEventsResponseWebhook["default"];
+ return _ListBotsResponseBotsInnerAi["default"];
}
});
-Object.defineProperty(exports, "RevokeSecondaryApiTokenByTokenResponse", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerBot", {
enumerable: true,
get: function get() {
- return _RevokeSecondaryApiTokenByTokenResponse["default"];
+ return _ListBotsResponseBotsInnerBot["default"];
}
});
-Object.defineProperty(exports, "SBObject", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerBotStyle", {
enumerable: true,
get: function get() {
- return _SBObject["default"];
+ return _ListBotsResponseBotsInnerBotStyle["default"];
}
});
-Object.defineProperty(exports, "ScheduleAnnouncementData", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerBotStyleColor", {
enumerable: true,
get: function get() {
- return _ScheduleAnnouncementData["default"];
+ return _ListBotsResponseBotsInnerBotStyleColor["default"];
}
});
-Object.defineProperty(exports, "ScheduleAnnouncementDataMessage", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerFirstMessagesInner", {
enumerable: true,
get: function get() {
- return _ScheduleAnnouncementDataMessage["default"];
+ return _ListBotsResponseBotsInnerFirstMessagesInner["default"];
}
});
-Object.defineProperty(exports, "ScheduleAnnouncementResponse", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerFirstMessagesInnerData", {
enumerable: true,
get: function get() {
- return _ScheduleAnnouncementResponse["default"];
+ return _ListBotsResponseBotsInnerFirstMessagesInnerData["default"];
}
});
-Object.defineProperty(exports, "ScheduleAnnouncementResponseCreateChannelOptions", {
+Object.defineProperty(exports, "ListBotsResponseBotsInnerSafeguard", {
enumerable: true,
get: function get() {
- return _ScheduleAnnouncementResponseCreateChannelOptions["default"];
+ return _ListBotsResponseBotsInnerSafeguard["default"];
}
});
-Object.defineProperty(exports, "ScheduleAnnouncementResponseMessage", {
+Object.defineProperty(exports, "ListMessagesResponse", {
enumerable: true,
get: function get() {
- return _ScheduleAnnouncementResponseMessage["default"];
+ return _ListMessagesResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdAdminMessage", {
+Object.defineProperty(exports, "ListMyGroupChannelsResponse", {
enumerable: true,
get: function get() {
- return _SendBirdAdminMessage["default"];
+ return _ListMyGroupChannelsResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdAppleCriticalAlertOptions", {
+Object.defineProperty(exports, "ListOpenChannelsResponse", {
enumerable: true,
get: function get() {
- return _SendBirdAppleCriticalAlertOptions["default"];
+ return _ListOpenChannelsResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdAutoEventMessageSettings", {
+Object.defineProperty(exports, "ListOperatorsResponse", {
enumerable: true,
get: function get() {
- return _SendBirdAutoEventMessageSettings["default"];
+ return _ListOperatorsResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdBaseChannel", {
+Object.defineProperty(exports, "ListRegistrationOrDeviceTokensResponse", {
enumerable: true,
get: function get() {
- return _SendBirdBaseChannel["default"];
+ return _ListRegistrationOrDeviceTokensResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdBaseMessageInstance", {
+Object.defineProperty(exports, "ListUsersResponse", {
enumerable: true,
get: function get() {
- return _SendBirdBaseMessageInstance["default"];
+ return _ListUsersResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdChannelResponse", {
+Object.defineProperty(exports, "MarkAllMessagesAsReadRequest", {
enumerable: true,
get: function get() {
- return _SendBirdChannelResponse["default"];
+ return _MarkAllMessagesAsReadRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdEmoji", {
+Object.defineProperty(exports, "MarkChannelMessagesAsReadRequest", {
enumerable: true,
get: function get() {
- return _SendBirdEmoji["default"];
+ return _MarkChannelMessagesAsReadRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdEmojiCategory", {
+Object.defineProperty(exports, "MessageApi", {
enumerable: true,
get: function get() {
- return _SendBirdEmojiCategory["default"];
+ return _MessageApi["default"];
}
});
-Object.defineProperty(exports, "SendBirdFileMessageParams", {
+Object.defineProperty(exports, "MetadataApi", {
enumerable: true,
get: function get() {
- return _SendBirdFileMessageParams["default"];
+ return _MetadataApi["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannel", {
+Object.defineProperty(exports, "ModerationApi", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannel["default"];
+ return _ModerationApi["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelChannel", {
+Object.defineProperty(exports, "OpenChannelApi", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelChannel["default"];
+ return _OpenChannelApi["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelCollection", {
+Object.defineProperty(exports, "RegisterOperatorsToAGroupChannelRequest", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelCollection["default"];
+ return _RegisterOperatorsToAGroupChannelRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelCreatedBy", {
+Object.defineProperty(exports, "RemoveARegistrationOrDeviceTokenResponse", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelCreatedBy["default"];
+ return _RemoveARegistrationOrDeviceTokenResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelDisappearingMessage", {
+Object.defineProperty(exports, "RemoveAllRegistrationOrDeviceTokenResponse", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelDisappearingMessage["default"];
+ return _RemoveAllRegistrationOrDeviceTokenResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelInviter", {
+Object.defineProperty(exports, "ResetChatHistoryRequest", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelInviter["default"];
+ return _ResetChatHistoryRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelLastMessage", {
+Object.defineProperty(exports, "ResetChatHistoryResponse", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelLastMessage["default"];
+ return _ResetChatHistoryResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdGroupChannelSmsFallback", {
+Object.defineProperty(exports, "ScheduleAnAnnouncementRequest", {
enumerable: true,
get: function get() {
- return _SendBirdGroupChannelSmsFallback["default"];
+ return _ScheduleAnAnnouncementRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdMember", {
+Object.defineProperty(exports, "ScheduleAnAnnouncementRequestCreateChannelOptions", {
enumerable: true,
get: function get() {
- return _SendBirdMember["default"];
+ return _ScheduleAnAnnouncementRequestCreateChannelOptions["default"];
}
});
-Object.defineProperty(exports, "SendBirdMessageMetaArray", {
+Object.defineProperty(exports, "ScheduleAnAnnouncementRequestMessage", {
enumerable: true,
get: function get() {
- return _SendBirdMessageMetaArray["default"];
+ return _ScheduleAnAnnouncementRequestMessage["default"];
}
});
-Object.defineProperty(exports, "SendBirdMessageResponse", {
+Object.defineProperty(exports, "ScheduleAnAnnouncementResponse", {
enumerable: true,
get: function get() {
- return _SendBirdMessageResponse["default"];
+ return _ScheduleAnAnnouncementResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdMessageResponseMentionedUsersInner", {
+Object.defineProperty(exports, "ScheduleAnAnnouncementResponseMessage", {
enumerable: true,
get: function get() {
- return _SendBirdMessageResponseMentionedUsersInner["default"];
+ return _ScheduleAnAnnouncementResponseMessage["default"];
}
});
-Object.defineProperty(exports, "SendBirdMessageResponseUser", {
+Object.defineProperty(exports, "SendABotMessageRequest", {
enumerable: true,
get: function get() {
- return _SendBirdMessageResponseUser["default"];
+ return _SendABotMessageRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdOGImage", {
+Object.defineProperty(exports, "SendAMessageRequest", {
enumerable: true,
get: function get() {
- return _SendBirdOGImage["default"];
+ return _SendAMessageRequest["default"];
}
});
-Object.defineProperty(exports, "SendBirdOGMetaData", {
+Object.defineProperty(exports, "SendAdminMessageRequestBody", {
enumerable: true,
get: function get() {
- return _SendBirdOGMetaData["default"];
+ return _SendAdminMessageRequestBody["default"];
}
});
-Object.defineProperty(exports, "SendBirdOpenChannel", {
+Object.defineProperty(exports, "SendFileMessageRequestBody", {
enumerable: true,
get: function get() {
- return _SendBirdOpenChannel["default"];
+ return _SendFileMessageRequestBody["default"];
}
});
-Object.defineProperty(exports, "SendBirdPlugin", {
+Object.defineProperty(exports, "SendTextMessageRequestBody", {
enumerable: true,
get: function get() {
- return _SendBirdPlugin["default"];
+ return _SendTextMessageRequestBody["default"];
}
});
-Object.defineProperty(exports, "SendBirdPoll", {
+Object.defineProperty(exports, "SendTextMessageRequestBodyPushMessageTemplate", {
enumerable: true,
get: function get() {
- return _SendBirdPoll["default"];
+ return _SendTextMessageRequestBodyPushMessageTemplate["default"];
}
});
-Object.defineProperty(exports, "SendBirdPollDetails", {
+Object.defineProperty(exports, "SendTextMessageRequestBodyPushMessageTemplateOneOf", {
enumerable: true,
get: function get() {
- return _SendBirdPollDetails["default"];
+ return _SendTextMessageRequestBodyPushMessageTemplateOneOf["default"];
}
});
-Object.defineProperty(exports, "SendBirdPollOption", {
+Object.defineProperty(exports, "SendbirdBasicUserInfo", {
enumerable: true,
get: function get() {
- return _SendBirdPollOption["default"];
+ return _SendbirdBasicUserInfo["default"];
}
});
-Object.defineProperty(exports, "SendBirdPollUpdatedVoteCount", {
+Object.defineProperty(exports, "SendbirdDisappearingMessage", {
enumerable: true,
get: function get() {
- return _SendBirdPollUpdatedVoteCount["default"];
+ return _SendbirdDisappearingMessage["default"];
}
});
-Object.defineProperty(exports, "SendBirdReaction", {
+Object.defineProperty(exports, "SendbirdExtendedMessagePayload", {
enumerable: true,
get: function get() {
- return _SendBirdReaction["default"];
+ return _SendbirdExtendedMessagePayload["default"];
}
});
-Object.defineProperty(exports, "SendBirdRestrictionInfo", {
+Object.defineProperty(exports, "SendbirdFile", {
enumerable: true,
get: function get() {
- return _SendBirdRestrictionInfo["default"];
+ return _SendbirdFile["default"];
}
});
-Object.defineProperty(exports, "SendBirdSender", {
+Object.defineProperty(exports, "SendbirdGroupChannel", {
enumerable: true,
get: function get() {
- return _SendBirdSender["default"];
+ return _SendbirdGroupChannel["default"];
}
});
-Object.defineProperty(exports, "SendBirdThreadInfo", {
+Object.defineProperty(exports, "SendbirdGroupChannelDetail", {
enumerable: true,
get: function get() {
- return _SendBirdThreadInfo["default"];
+ return _SendbirdGroupChannelDetail["default"];
}
});
-Object.defineProperty(exports, "SendBirdThumbnailSBObject", {
+Object.defineProperty(exports, "SendbirdGroupChannelDetailChannel", {
enumerable: true,
get: function get() {
- return _SendBirdThumbnailSBObject["default"];
+ return _SendbirdGroupChannelDetailChannel["default"];
}
});
-Object.defineProperty(exports, "SendBirdThumbnailSize", {
+Object.defineProperty(exports, "SendbirdMember", {
enumerable: true,
get: function get() {
- return _SendBirdThumbnailSize["default"];
+ return _SendbirdMember["default"];
}
});
-Object.defineProperty(exports, "SendBirdUser", {
+Object.defineProperty(exports, "SendbirdMessageResponse", {
enumerable: true,
get: function get() {
- return _SendBirdUser["default"];
+ return _SendbirdMessageResponse["default"];
}
});
-Object.defineProperty(exports, "SendBirdUserMessageParams", {
+Object.defineProperty(exports, "SendbirdMessageResponseMessageEvents", {
enumerable: true,
get: function get() {
- return _SendBirdUserMessageParams["default"];
+ return _SendbirdMessageResponseMessageEvents["default"];
}
});
-Object.defineProperty(exports, "SendBotSMessageData", {
+Object.defineProperty(exports, "SendbirdOpenChannel", {
enumerable: true,
get: function get() {
- return _SendBotSMessageData["default"];
+ return _SendbirdOpenChannel["default"];
}
});
-Object.defineProperty(exports, "SendMessageData", {
+Object.defineProperty(exports, "SendbirdParentMessageInfo", {
enumerable: true,
get: function get() {
- return _SendMessageData["default"];
+ return _SendbirdParentMessageInfo["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterData", {
+Object.defineProperty(exports, "SendbirdPushTriggerOption", {
enumerable: true,
get: function get() {
- return _SetDomainFilterData["default"];
+ return _SendbirdPushTriggerOption["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterDataDomainFilter", {
+Object.defineProperty(exports, "SendbirdReaction", {
enumerable: true,
get: function get() {
- return _SetDomainFilterDataDomainFilter["default"];
+ return _SendbirdReaction["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterDataImageModeration", {
+Object.defineProperty(exports, "SendbirdSmsFallback", {
enumerable: true,
get: function get() {
- return _SetDomainFilterDataImageModeration["default"];
+ return _SendbirdSmsFallback["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterDataImageModerationLimits", {
+Object.defineProperty(exports, "SendbirdSortedMetaarrayInner", {
enumerable: true,
get: function get() {
- return _SetDomainFilterDataImageModerationLimits["default"];
+ return _SendbirdSortedMetaarrayInner["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterDataProfanityFilter", {
+Object.defineProperty(exports, "SendbirdThumbnail", {
enumerable: true,
get: function get() {
- return _SetDomainFilterDataProfanityFilter["default"];
+ return _SendbirdThumbnail["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterDataProfanityFilterRegexFiltersInner", {
+Object.defineProperty(exports, "SendbirdUser", {
enumerable: true,
get: function get() {
- return _SetDomainFilterDataProfanityFilterRegexFiltersInner["default"];
+ return _SendbirdUser["default"];
}
});
-Object.defineProperty(exports, "SetDomainFilterDataProfanityTriggeredModeration", {
+Object.defineProperty(exports, "StartTypingIndicatorsRequest", {
enumerable: true,
get: function get() {
- return _SetDomainFilterDataProfanityTriggeredModeration["default"];
+ return _StartTypingIndicatorsRequest["default"];
}
});
Object.defineProperty(exports, "StatisticsApi", {
@@ -1467,58 +603,40 @@ Object.defineProperty(exports, "StatisticsApi", {
return _StatisticsApi["default"];
}
});
-Object.defineProperty(exports, "TranslateMessageIntoOtherLanguagesData", {
- enumerable: true,
- get: function get() {
- return _TranslateMessageIntoOtherLanguagesData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateAnnouncementByIdData", {
+Object.defineProperty(exports, "UpdateAChannelMetadataRequest", {
enumerable: true,
get: function get() {
- return _UpdateAnnouncementByIdData["default"];
+ return _UpdateAChannelMetadataRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateAnnouncementByIdResponse", {
+Object.defineProperty(exports, "UpdateAGroupChannelRequest", {
enumerable: true,
get: function get() {
- return _UpdateAnnouncementByIdResponse["default"];
+ return _UpdateAGroupChannelRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateAnnouncementByIdResponseMessage", {
+Object.defineProperty(exports, "UpdateAMessageRequest", {
enumerable: true,
get: function get() {
- return _UpdateAnnouncementByIdResponseMessage["default"];
+ return _UpdateAMessageRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateApnsPushConfigurationByIdData", {
+Object.defineProperty(exports, "UpdateAUserRequest", {
enumerable: true,
get: function get() {
- return _UpdateApnsPushConfigurationByIdData["default"];
+ return _UpdateAUserRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateApnsPushConfigurationByIdResponse", {
+Object.defineProperty(exports, "UpdateAnOpenChannelRequest", {
enumerable: true,
get: function get() {
- return _UpdateApnsPushConfigurationByIdResponse["default"];
+ return _UpdateAnOpenChannelRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateBotByIdData", {
+Object.defineProperty(exports, "UpdateChannelInvitationPreferenceRequest", {
enumerable: true,
get: function get() {
- return _UpdateBotByIdData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateBotByIdResponse", {
- enumerable: true,
- get: function get() {
- return _UpdateBotByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "UpdateChannelInvitationPreferenceData", {
- enumerable: true,
- get: function get() {
- return _UpdateChannelInvitationPreferenceData["default"];
+ return _UpdateChannelInvitationPreferenceRequest["default"];
}
});
Object.defineProperty(exports, "UpdateChannelInvitationPreferenceResponse", {
@@ -1527,22 +645,10 @@ Object.defineProperty(exports, "UpdateChannelInvitationPreferenceResponse", {
return _UpdateChannelInvitationPreferenceResponse["default"];
}
});
-Object.defineProperty(exports, "UpdateChannelMetacounterData", {
- enumerable: true,
- get: function get() {
- return _UpdateChannelMetacounterData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateChannelMetadataData", {
- enumerable: true,
- get: function get() {
- return _UpdateChannelMetadataData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateCountPreferenceOfChannelByUrlData", {
+Object.defineProperty(exports, "UpdateCountPreferenceOfAChannelRequest", {
enumerable: true,
get: function get() {
- return _UpdateCountPreferenceOfChannelByUrlData["default"];
+ return _UpdateCountPreferenceOfAChannelRequest["default"];
}
});
Object.defineProperty(exports, "UpdateCountPreferenceOfChannelByUrlResponse", {
@@ -1551,106 +657,34 @@ Object.defineProperty(exports, "UpdateCountPreferenceOfChannelByUrlResponse", {
return _UpdateCountPreferenceOfChannelByUrlResponse["default"];
}
});
-Object.defineProperty(exports, "UpdateDefaultChannelInvitationPreferenceData", {
- enumerable: true,
- get: function get() {
- return _UpdateDefaultChannelInvitationPreferenceData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateDefaultChannelInvitationPreferenceResponse", {
- enumerable: true,
- get: function get() {
- return _UpdateDefaultChannelInvitationPreferenceResponse["default"];
- }
-});
-Object.defineProperty(exports, "UpdateEmojiCategoryUrlByIdData", {
- enumerable: true,
- get: function get() {
- return _UpdateEmojiCategoryUrlByIdData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateEmojiUrlByKeyData", {
- enumerable: true,
- get: function get() {
- return _UpdateEmojiUrlByKeyData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateExtraDataInMessageData", {
+Object.defineProperty(exports, "UpdateExtraDataInAMessageRequest", {
enumerable: true,
get: function get() {
- return _UpdateExtraDataInMessageData["default"];
+ return _UpdateExtraDataInAMessageRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateExtraDataInMessageResponse", {
+Object.defineProperty(exports, "UpdateExtraDataInAMessageResponse", {
enumerable: true,
get: function get() {
- return _UpdateExtraDataInMessageResponse["default"];
+ return _UpdateExtraDataInAMessageResponse["default"];
}
});
-Object.defineProperty(exports, "UpdateExtraDataInMessageResponseSortedMetaarrayInner", {
+Object.defineProperty(exports, "UpdatePushPreferencesForAChannelRequest", {
enumerable: true,
get: function get() {
- return _UpdateExtraDataInMessageResponseSortedMetaarrayInner["default"];
+ return _UpdatePushPreferencesForAChannelRequest["default"];
}
});
-Object.defineProperty(exports, "UpdateFcmPushConfigurationByIdData", {
+Object.defineProperty(exports, "UpdatePushPreferencesForAChannelResponse", {
enumerable: true,
get: function get() {
- return _UpdateFcmPushConfigurationByIdData["default"];
+ return _UpdatePushPreferencesForAChannelResponse["default"];
}
});
-Object.defineProperty(exports, "UpdateFcmPushConfigurationByIdResponse", {
+Object.defineProperty(exports, "UpdatePushPreferencesRequest", {
enumerable: true,
get: function get() {
- return _UpdateFcmPushConfigurationByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "UpdateHmsPushConfigurationByIdData", {
- enumerable: true,
- get: function get() {
- return _UpdateHmsPushConfigurationByIdData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateHmsPushConfigurationByIdResponse", {
- enumerable: true,
- get: function get() {
- return _UpdateHmsPushConfigurationByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "UpdateMessageByIdData", {
- enumerable: true,
- get: function get() {
- return _UpdateMessageByIdData["default"];
- }
-});
-Object.defineProperty(exports, "UpdatePushNotificationContentTemplateData", {
- enumerable: true,
- get: function get() {
- return _UpdatePushNotificationContentTemplateData["default"];
- }
-});
-Object.defineProperty(exports, "UpdatePushNotificationContentTemplateResponse", {
- enumerable: true,
- get: function get() {
- return _UpdatePushNotificationContentTemplateResponse["default"];
- }
-});
-Object.defineProperty(exports, "UpdatePushPreferencesData", {
- enumerable: true,
- get: function get() {
- return _UpdatePushPreferencesData["default"];
- }
-});
-Object.defineProperty(exports, "UpdatePushPreferencesForChannelByUrlData", {
- enumerable: true,
- get: function get() {
- return _UpdatePushPreferencesForChannelByUrlData["default"];
- }
-});
-Object.defineProperty(exports, "UpdatePushPreferencesForChannelByUrlResponse", {
- enumerable: true,
- get: function get() {
- return _UpdatePushPreferencesForChannelByUrlResponse["default"];
+ return _UpdatePushPreferencesRequest["default"];
}
});
Object.defineProperty(exports, "UpdatePushPreferencesResponse", {
@@ -1659,88 +693,16 @@ Object.defineProperty(exports, "UpdatePushPreferencesResponse", {
return _UpdatePushPreferencesResponse["default"];
}
});
-Object.defineProperty(exports, "UpdateUserByIdData", {
- enumerable: true,
- get: function get() {
- return _UpdateUserByIdData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateUserMetadataData", {
- enumerable: true,
- get: function get() {
- return _UpdateUserMetadataData["default"];
- }
-});
-Object.defineProperty(exports, "UpdateUserMetadataResponse", {
- enumerable: true,
- get: function get() {
- return _UpdateUserMetadataResponse["default"];
- }
-});
-Object.defineProperty(exports, "UseDefaultEmojisData", {
- enumerable: true,
- get: function get() {
- return _UseDefaultEmojisData["default"];
- }
-});
-Object.defineProperty(exports, "UseDefaultEmojisResponse", {
- enumerable: true,
- get: function get() {
- return _UseDefaultEmojisResponse["default"];
- }
-});
Object.defineProperty(exports, "UserApi", {
enumerable: true,
get: function get() {
return _UserApi["default"];
}
});
-Object.defineProperty(exports, "ViewAnnouncementByIdResponse", {
- enumerable: true,
- get: function get() {
- return _ViewAnnouncementByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewBotByIdResponse", {
- enumerable: true,
- get: function get() {
- return _ViewBotByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewChannelInvitationPreferenceResponse", {
- enumerable: true,
- get: function get() {
- return _ViewChannelInvitationPreferenceResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewCountPreferenceOfChannelByUrlResponse", {
+Object.defineProperty(exports, "ViewCountPreferenceOfAChannelResponse", {
enumerable: true,
get: function get() {
- return _ViewCountPreferenceOfChannelByUrlResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewDataExportByIdResponse", {
- enumerable: true,
- get: function get() {
- return _ViewDataExportByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewDefaultChannelInvitationPreferenceResponse", {
- enumerable: true,
- get: function get() {
- return _ViewDefaultChannelInvitationPreferenceResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewGdprRequestByIdResponse", {
- enumerable: true,
- get: function get() {
- return _ViewGdprRequestByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewNumberOfChannelsByJoinStatusResponse", {
- enumerable: true,
- get: function get() {
- return _ViewNumberOfChannelsByJoinStatusResponse["default"];
+ return _ViewCountPreferenceOfAChannelResponse["default"];
}
});
Object.defineProperty(exports, "ViewNumberOfChannelsWithUnreadMessagesResponse", {
@@ -1749,12 +711,6 @@ Object.defineProperty(exports, "ViewNumberOfChannelsWithUnreadMessagesResponse",
return _ViewNumberOfChannelsWithUnreadMessagesResponse["default"];
}
});
-Object.defineProperty(exports, "ViewNumberOfConcurrentConnectionsResponse", {
- enumerable: true,
- get: function get() {
- return _ViewNumberOfConcurrentConnectionsResponse["default"];
- }
-});
Object.defineProperty(exports, "ViewNumberOfDailyActiveUsersResponse", {
enumerable: true,
get: function get() {
@@ -1767,52 +723,16 @@ Object.defineProperty(exports, "ViewNumberOfMonthlyActiveUsersResponse", {
return _ViewNumberOfMonthlyActiveUsersResponse["default"];
}
});
-Object.defineProperty(exports, "ViewNumberOfPeakConnectionsResponse", {
- enumerable: true,
- get: function get() {
- return _ViewNumberOfPeakConnectionsResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewNumberOfPeakConnectionsResponsePeakConnectionsInner", {
- enumerable: true,
- get: function get() {
- return _ViewNumberOfPeakConnectionsResponsePeakConnectionsInner["default"];
- }
-});
-Object.defineProperty(exports, "ViewNumberOfUnreadItemsResponse", {
- enumerable: true,
- get: function get() {
- return _ViewNumberOfUnreadItemsResponse["default"];
- }
-});
Object.defineProperty(exports, "ViewNumberOfUnreadMessagesResponse", {
enumerable: true,
get: function get() {
return _ViewNumberOfUnreadMessagesResponse["default"];
}
});
-Object.defineProperty(exports, "ViewPushConfigurationByIdResponse", {
+Object.defineProperty(exports, "ViewPushPreferencesForAChannelResponse", {
enumerable: true,
get: function get() {
- return _ViewPushConfigurationByIdResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewPushNotificationContentTemplateResponse", {
- enumerable: true,
- get: function get() {
- return _ViewPushNotificationContentTemplateResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewPushNotificationContentTemplateResponsePushMessageTemplatesInner", {
- enumerable: true,
- get: function get() {
- return _ViewPushNotificationContentTemplateResponsePushMessageTemplatesInner["default"];
- }
-});
-Object.defineProperty(exports, "ViewPushPreferencesForChannelByUrlResponse", {
- enumerable: true,
- get: function get() {
- return _ViewPushPreferencesForChannelByUrlResponse["default"];
+ return _ViewPushPreferencesForAChannelResponse["default"];
}
});
Object.defineProperty(exports, "ViewPushPreferencesResponse", {
@@ -1821,342 +741,127 @@ Object.defineProperty(exports, "ViewPushPreferencesResponse", {
return _ViewPushPreferencesResponse["default"];
}
});
-Object.defineProperty(exports, "ViewSecondaryApiTokenByTokenResponse", {
- enumerable: true,
- get: function get() {
- return _ViewSecondaryApiTokenByTokenResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewTotalNumberOfMessagesInChannelResponse", {
- enumerable: true,
- get: function get() {
- return _ViewTotalNumberOfMessagesInChannelResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewUserMetadataResponse", {
- enumerable: true,
- get: function get() {
- return _ViewUserMetadataResponse["default"];
- }
-});
-Object.defineProperty(exports, "ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner", {
- enumerable: true,
- get: function get() {
- return _ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner["default"];
- }
-});
-Object.defineProperty(exports, "WebhookApi", {
- enumerable: true,
- get: function get() {
- return _WebhookApi["default"];
- }
-});
var _ApiClient = _interopRequireDefault(require("./ApiClient"));
-var _AddApnsPushConfigurationData = _interopRequireDefault(require("./model/AddApnsPushConfigurationData"));
-var _AddApnsPushConfigurationResponse = _interopRequireDefault(require("./model/AddApnsPushConfigurationResponse"));
-var _AddApnsPushConfigurationResponsePushConfigurationsInner = _interopRequireDefault(require("./model/AddApnsPushConfigurationResponsePushConfigurationsInner"));
-var _AddEmojiCategoriesResponse = _interopRequireDefault(require("./model/AddEmojiCategoriesResponse"));
-var _AddEmojiCategoriesResponseEmojiCategoriesInner = _interopRequireDefault(require("./model/AddEmojiCategoriesResponseEmojiCategoriesInner"));
-var _AddEmojisData = _interopRequireDefault(require("./model/AddEmojisData"));
-var _AddEmojisResponse = _interopRequireDefault(require("./model/AddEmojisResponse"));
-var _AddExtraDataToMessageData = _interopRequireDefault(require("./model/AddExtraDataToMessageData"));
-var _AddExtraDataToMessageResponse = _interopRequireDefault(require("./model/AddExtraDataToMessageResponse"));
-var _AddFcmPushConfigurationData = _interopRequireDefault(require("./model/AddFcmPushConfigurationData"));
-var _AddFcmPushConfigurationResponse = _interopRequireDefault(require("./model/AddFcmPushConfigurationResponse"));
-var _AddFcmPushConfigurationResponsePushConfigurationsInner = _interopRequireDefault(require("./model/AddFcmPushConfigurationResponsePushConfigurationsInner"));
-var _AddHmsPushConfigurationData = _interopRequireDefault(require("./model/AddHmsPushConfigurationData"));
-var _AddHmsPushConfigurationResponse = _interopRequireDefault(require("./model/AddHmsPushConfigurationResponse"));
-var _AddHmsPushConfigurationResponsePushConfigurationsInner = _interopRequireDefault(require("./model/AddHmsPushConfigurationResponsePushConfigurationsInner"));
-var _AddIpToWhitelistData = _interopRequireDefault(require("./model/AddIpToWhitelistData"));
-var _AddIpToWhitelistResponse = _interopRequireDefault(require("./model/AddIpToWhitelistResponse"));
-var _AddReactionToAMessageData = _interopRequireDefault(require("./model/AddReactionToAMessageData"));
-var _AddReactionToAMessageResponse = _interopRequireDefault(require("./model/AddReactionToAMessageResponse"));
-var _AddRegistrationOrDeviceTokenData = _interopRequireDefault(require("./model/AddRegistrationOrDeviceTokenData"));
-var _AddRegistrationOrDeviceTokenResponse = _interopRequireDefault(require("./model/AddRegistrationOrDeviceTokenResponse"));
-var _BanFromChannelsWithCustomChannelTypesData = _interopRequireDefault(require("./model/BanFromChannelsWithCustomChannelTypesData"));
-var _BanUsersInChannelsWithCustomChannelTypeData = _interopRequireDefault(require("./model/BanUsersInChannelsWithCustomChannelTypeData"));
-var _BanUsersInChannelsWithCustomChannelTypeDataBannedListInner = _interopRequireDefault(require("./model/BanUsersInChannelsWithCustomChannelTypeDataBannedListInner"));
-var _Blob = _interopRequireDefault(require("./model/Blob"));
-var _BlockUserData = _interopRequireDefault(require("./model/BlockUserData"));
-var _BlockUserResponse = _interopRequireDefault(require("./model/BlockUserResponse"));
-var _ChoosePushNotificationContentTemplateResponse = _interopRequireDefault(require("./model/ChoosePushNotificationContentTemplateResponse"));
-var _ChooseWhichEventsToSubscribeToData = _interopRequireDefault(require("./model/ChooseWhichEventsToSubscribeToData"));
-var _ChooseWhichEventsToSubscribeToResponse = _interopRequireDefault(require("./model/ChooseWhichEventsToSubscribeToResponse"));
-var _ChooseWhichEventsToSubscribeToResponseWebhook = _interopRequireDefault(require("./model/ChooseWhichEventsToSubscribeToResponseWebhook"));
-var _ConfigureAutoEventData = _interopRequireDefault(require("./model/ConfigureAutoEventData"));
-var _ConfigureAutoEventDataAutoEventMessage = _interopRequireDefault(require("./model/ConfigureAutoEventDataAutoEventMessage"));
-var _CreateBotData = _interopRequireDefault(require("./model/CreateBotData"));
-var _CreateBotResponse = _interopRequireDefault(require("./model/CreateBotResponse"));
-var _CreateBotResponseBot = _interopRequireDefault(require("./model/CreateBotResponseBot"));
-var _CreateChannelMetacounterData = _interopRequireDefault(require("./model/CreateChannelMetacounterData"));
-var _CreateChannelMetadataData = _interopRequireDefault(require("./model/CreateChannelMetadataData"));
-var _CreateChannelMetadataResponse = _interopRequireDefault(require("./model/CreateChannelMetadataResponse"));
-var _CreateUserData = _interopRequireDefault(require("./model/CreateUserData"));
-var _CreateUserMetadataData = _interopRequireDefault(require("./model/CreateUserMetadataData"));
-var _CreateUserMetadataResponse = _interopRequireDefault(require("./model/CreateUserMetadataResponse"));
-var _CreateUserTokenData = _interopRequireDefault(require("./model/CreateUserTokenData"));
+var _AcceptAnInvitationRequest = _interopRequireDefault(require("./model/AcceptAnInvitationRequest"));
+var _AddARegistrationOrDeviceTokenRequest = _interopRequireDefault(require("./model/AddARegistrationOrDeviceTokenRequest"));
+var _AddARegistrationOrDeviceTokenResponse = _interopRequireDefault(require("./model/AddARegistrationOrDeviceTokenResponse"));
+var _AddExtraDataToAMessageRequest = _interopRequireDefault(require("./model/AddExtraDataToAMessageRequest"));
+var _AddExtraDataToAMessageResponse = _interopRequireDefault(require("./model/AddExtraDataToAMessageResponse"));
+var _BlockAUserRequest = _interopRequireDefault(require("./model/BlockAUserRequest"));
+var _BlockAUserResponse = _interopRequireDefault(require("./model/BlockAUserResponse"));
+var _CheckIfMemberResponse = _interopRequireDefault(require("./model/CheckIfMemberResponse"));
+var _ChooseAPushNotificationContentTemplateRequest = _interopRequireDefault(require("./model/ChooseAPushNotificationContentTemplateRequest"));
+var _ChooseAPushNotificationContentTemplateResponse = _interopRequireDefault(require("./model/ChooseAPushNotificationContentTemplateResponse"));
+var _CreateABotRequest = _interopRequireDefault(require("./model/CreateABotRequest"));
+var _CreateABotResponse = _interopRequireDefault(require("./model/CreateABotResponse"));
+var _CreateABotResponseBot = _interopRequireDefault(require("./model/CreateABotResponseBot"));
+var _CreateABotResponseBotStyle = _interopRequireDefault(require("./model/CreateABotResponseBotStyle"));
+var _CreateAChannelMetadataRequest = _interopRequireDefault(require("./model/CreateAChannelMetadataRequest"));
+var _CreateAChannelMetadataResponse = _interopRequireDefault(require("./model/CreateAChannelMetadataResponse"));
+var _CreateAGroupChannelRequest = _interopRequireDefault(require("./model/CreateAGroupChannelRequest"));
+var _CreateAUserRequest = _interopRequireDefault(require("./model/CreateAUserRequest"));
+var _CreateAnOpenChannelRequest = _interopRequireDefault(require("./model/CreateAnOpenChannelRequest"));
+var _CreateUserTokenRequest = _interopRequireDefault(require("./model/CreateUserTokenRequest"));
var _CreateUserTokenResponse = _interopRequireDefault(require("./model/CreateUserTokenResponse"));
-var _CustomTypeListBannedUsersResponse = _interopRequireDefault(require("./model/CustomTypeListBannedUsersResponse"));
-var _DeleteAllowedIpsFromWhitelistResponse = _interopRequireDefault(require("./model/DeleteAllowedIpsFromWhitelistResponse"));
-var _DeleteApnsCertificateByIdResponse = _interopRequireDefault(require("./model/DeleteApnsCertificateByIdResponse"));
-var _EnableReactionsData = _interopRequireDefault(require("./model/EnableReactionsData"));
-var _EnableReactionsResponse = _interopRequireDefault(require("./model/EnableReactionsResponse"));
-var _File = _interopRequireDefault(require("./model/File"));
-var _Function = _interopRequireDefault(require("./model/Function"));
-var _GcAcceptInvitationData = _interopRequireDefault(require("./model/GcAcceptInvitationData"));
-var _GcBanUserData = _interopRequireDefault(require("./model/GcBanUserData"));
-var _GcBanUserResponse = _interopRequireDefault(require("./model/GcBanUserResponse"));
-var _GcCheckIfMemberByIdResponse = _interopRequireDefault(require("./model/GcCheckIfMemberByIdResponse"));
-var _GcCreateChannelData = _interopRequireDefault(require("./model/GcCreateChannelData"));
-var _GcDeclineInvitationData = _interopRequireDefault(require("./model/GcDeclineInvitationData"));
-var _GcFreezeChannelData = _interopRequireDefault(require("./model/GcFreezeChannelData"));
-var _GcHideOrArchiveChannelData = _interopRequireDefault(require("./model/GcHideOrArchiveChannelData"));
-var _GcInviteAsMembersData = _interopRequireDefault(require("./model/GcInviteAsMembersData"));
-var _GcJoinChannelData = _interopRequireDefault(require("./model/GcJoinChannelData"));
-var _GcLeaveChannelData = _interopRequireDefault(require("./model/GcLeaveChannelData"));
-var _GcListBannedUsersResponse = _interopRequireDefault(require("./model/GcListBannedUsersResponse"));
-var _GcListChannelsResponse = _interopRequireDefault(require("./model/GcListChannelsResponse"));
-var _GcListMembersResponse = _interopRequireDefault(require("./model/GcListMembersResponse"));
-var _GcListMutedUsersResponse = _interopRequireDefault(require("./model/GcListMutedUsersResponse"));
-var _GcListOperatorsResponse = _interopRequireDefault(require("./model/GcListOperatorsResponse"));
-var _GcMarkAllMessagesAsDeliveredData = _interopRequireDefault(require("./model/GcMarkAllMessagesAsDeliveredData"));
-var _GcMarkAllMessagesAsDeliveredResponse = _interopRequireDefault(require("./model/GcMarkAllMessagesAsDeliveredResponse"));
-var _GcMarkAllMessagesAsReadData = _interopRequireDefault(require("./model/GcMarkAllMessagesAsReadData"));
-var _GcMuteUserData = _interopRequireDefault(require("./model/GcMuteUserData"));
-var _GcRegisterOperatorsData = _interopRequireDefault(require("./model/GcRegisterOperatorsData"));
-var _GcRegisterOperatorsResponse = _interopRequireDefault(require("./model/GcRegisterOperatorsResponse"));
-var _GcResetChatHistoryData = _interopRequireDefault(require("./model/GcResetChatHistoryData"));
-var _GcResetChatHistoryResponse = _interopRequireDefault(require("./model/GcResetChatHistoryResponse"));
-var _GcUpdateBanByIdData = _interopRequireDefault(require("./model/GcUpdateBanByIdData"));
-var _GcUpdateBanByIdResponse = _interopRequireDefault(require("./model/GcUpdateBanByIdResponse"));
-var _GcUpdateChannelByUrlData = _interopRequireDefault(require("./model/GcUpdateChannelByUrlData"));
-var _GcViewBanByIdResponse = _interopRequireDefault(require("./model/GcViewBanByIdResponse"));
-var _GcViewMuteByIdResponse = _interopRequireDefault(require("./model/GcViewMuteByIdResponse"));
-var _GcViewNumberOfEachMembersUnreadMessagesResponse = _interopRequireDefault(require("./model/GcViewNumberOfEachMembersUnreadMessagesResponse"));
-var _GenerateSecondaryApiTokenData = _interopRequireDefault(require("./model/GenerateSecondaryApiTokenData"));
-var _GenerateSecondaryApiTokenResponse = _interopRequireDefault(require("./model/GenerateSecondaryApiTokenResponse"));
-var _GetDetailedOpenRateOfAnnouncementByIdResponse = _interopRequireDefault(require("./model/GetDetailedOpenRateOfAnnouncementByIdResponse"));
-var _GetDetailedOpenRateOfAnnouncementGroupResponse = _interopRequireDefault(require("./model/GetDetailedOpenRateOfAnnouncementGroupResponse"));
-var _GetDetailedOpenStatusOfAnnouncementByIdResponse = _interopRequireDefault(require("./model/GetDetailedOpenStatusOfAnnouncementByIdResponse"));
-var _GetDetailedOpenStatusOfAnnouncementByIdResponseOpenStatusInner = _interopRequireDefault(require("./model/GetDetailedOpenStatusOfAnnouncementByIdResponseOpenStatusInner"));
-var _GetStatisticsDailyResponse = _interopRequireDefault(require("./model/GetStatisticsDailyResponse"));
-var _GetStatisticsDailyResponseStatisticsInner = _interopRequireDefault(require("./model/GetStatisticsDailyResponseStatisticsInner"));
-var _GetStatisticsMonthlyResponse = _interopRequireDefault(require("./model/GetStatisticsMonthlyResponse"));
-var _GetStatisticsResponse = _interopRequireDefault(require("./model/GetStatisticsResponse"));
-var _JoinChannelsData = _interopRequireDefault(require("./model/JoinChannelsData"));
-var _JoinChannelsResponse = _interopRequireDefault(require("./model/JoinChannelsResponse"));
-var _LeaveMyGroupChannelsData = _interopRequireDefault(require("./model/LeaveMyGroupChannelsData"));
-var _ListAllEmojisAndEmojiCategoriesResponse = _interopRequireDefault(require("./model/ListAllEmojisAndEmojiCategoriesResponse"));
-var _ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInner = _interopRequireDefault(require("./model/ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInner"));
-var _ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner = _interopRequireDefault(require("./model/ListAllEmojisAndEmojiCategoriesResponseEmojiCategoriesInnerEmojisInner"));
-var _ListAnnouncementGroupsResponse = _interopRequireDefault(require("./model/ListAnnouncementGroupsResponse"));
-var _ListAnnouncementsResponse = _interopRequireDefault(require("./model/ListAnnouncementsResponse"));
-var _ListAnnouncementsResponseAnnouncementsInner = _interopRequireDefault(require("./model/ListAnnouncementsResponseAnnouncementsInner"));
-var _ListBannedChannelsResponse = _interopRequireDefault(require("./model/ListBannedChannelsResponse"));
-var _ListBannedChannelsResponseBannedChannelsInner = _interopRequireDefault(require("./model/ListBannedChannelsResponseBannedChannelsInner"));
+var _FreezeAGroupChannelRequest = _interopRequireDefault(require("./model/FreezeAGroupChannelRequest"));
+var _FreezeAnOpenChannelRequest = _interopRequireDefault(require("./model/FreezeAnOpenChannelRequest"));
+var _GetAGroupChannelResponse = _interopRequireDefault(require("./model/GetAGroupChannelResponse"));
+var _GetAGroupChannelResponseAllOf = _interopRequireDefault(require("./model/GetAGroupChannelResponseAllOf"));
+var _GetChannelInvitationPreferenceResponse = _interopRequireDefault(require("./model/GetChannelInvitationPreferenceResponse"));
+var _GetTotalNumberOfMessagesInAChannelResponse = _interopRequireDefault(require("./model/GetTotalNumberOfMessagesInAChannelResponse"));
+var _GroupChannelListMembersResponse = _interopRequireDefault(require("./model/GroupChannelListMembersResponse"));
+var _GroupChatListChannelsResponse = _interopRequireDefault(require("./model/GroupChatListChannelsResponse"));
+var _HideAChannelRequest = _interopRequireDefault(require("./model/HideAChannelRequest"));
+var _InviteAsMembersRequest = _interopRequireDefault(require("./model/InviteAsMembersRequest"));
+var _InviteAsMembersResponse = _interopRequireDefault(require("./model/InviteAsMembersResponse"));
+var _InviteAsMembersResponseAllOf = _interopRequireDefault(require("./model/InviteAsMembersResponseAllOf"));
+var _JoinAChannelRequest = _interopRequireDefault(require("./model/JoinAChannelRequest"));
+var _JoinChannelsRequest = _interopRequireDefault(require("./model/JoinChannelsRequest"));
+var _LeaveAChannelRequest = _interopRequireDefault(require("./model/LeaveAChannelRequest"));
+var _LeaveMyGroupChannelsRequest = _interopRequireDefault(require("./model/LeaveMyGroupChannelsRequest"));
var _ListBlockedUsersResponse = _interopRequireDefault(require("./model/ListBlockedUsersResponse"));
var _ListBotsResponse = _interopRequireDefault(require("./model/ListBotsResponse"));
var _ListBotsResponseBotsInner = _interopRequireDefault(require("./model/ListBotsResponseBotsInner"));
-var _ListDataExportsByMessageChannelOrUserResponse = _interopRequireDefault(require("./model/ListDataExportsByMessageChannelOrUserResponse"));
-var _ListDataExportsByMessageChannelOrUserResponseExportedDataInner = _interopRequireDefault(require("./model/ListDataExportsByMessageChannelOrUserResponseExportedDataInner"));
-var _ListDataExportsByMessageChannelOrUserResponseExportedDataInnerFile = _interopRequireDefault(require("./model/ListDataExportsByMessageChannelOrUserResponseExportedDataInnerFile"));
-var _ListEmojisResponse = _interopRequireDefault(require("./model/ListEmojisResponse"));
-var _ListGdprRequestsResponse = _interopRequireDefault(require("./model/ListGdprRequestsResponse"));
-var _ListGdprRequestsResponseRequestsInner = _interopRequireDefault(require("./model/ListGdprRequestsResponseRequestsInner"));
+var _ListBotsResponseBotsInnerAi = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerAi"));
+var _ListBotsResponseBotsInnerBot = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerBot"));
+var _ListBotsResponseBotsInnerBotStyle = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerBotStyle"));
+var _ListBotsResponseBotsInnerBotStyleColor = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerBotStyleColor"));
+var _ListBotsResponseBotsInnerFirstMessagesInner = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerFirstMessagesInner"));
+var _ListBotsResponseBotsInnerFirstMessagesInnerData = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerFirstMessagesInnerData"));
+var _ListBotsResponseBotsInnerSafeguard = _interopRequireDefault(require("./model/ListBotsResponseBotsInnerSafeguard"));
var _ListMessagesResponse = _interopRequireDefault(require("./model/ListMessagesResponse"));
-var _ListMessagesResponseMessagesInner = _interopRequireDefault(require("./model/ListMessagesResponseMessagesInner"));
-var _ListMessagesResponseMessagesInnerOgTag = _interopRequireDefault(require("./model/ListMessagesResponseMessagesInnerOgTag"));
-var _ListMessagesResponseMessagesInnerOgTagOgImage = _interopRequireDefault(require("./model/ListMessagesResponseMessagesInnerOgTagOgImage"));
-var _ListMessagesResponseMessagesInnerSortedMetaarrayInner = _interopRequireDefault(require("./model/ListMessagesResponseMessagesInnerSortedMetaarrayInner"));
-var _ListMutedChannelsResponse = _interopRequireDefault(require("./model/ListMutedChannelsResponse"));
-var _ListMutedUsersInChannelsWithCustomChannelType200Response = _interopRequireDefault(require("./model/ListMutedUsersInChannelsWithCustomChannelType200Response"));
var _ListMyGroupChannelsResponse = _interopRequireDefault(require("./model/ListMyGroupChannelsResponse"));
-var _ListPushConfigurationsResponse = _interopRequireDefault(require("./model/ListPushConfigurationsResponse"));
-var _ListPushConfigurationsResponsePushConfigurationsInner = _interopRequireDefault(require("./model/ListPushConfigurationsResponsePushConfigurationsInner"));
-var _ListPushNotificationContentTemplatesResponse = _interopRequireDefault(require("./model/ListPushNotificationContentTemplatesResponse"));
-var _ListPushNotificationContentTemplatesResponsePushMessageTemplatesInner = _interopRequireDefault(require("./model/ListPushNotificationContentTemplatesResponsePushMessageTemplatesInner"));
-var _ListPushNotificationContentTemplatesResponsePushMessageTemplatesInnerTemplate = _interopRequireDefault(require("./model/ListPushNotificationContentTemplatesResponsePushMessageTemplatesInnerTemplate"));
-var _ListReactionsOfMessageResponse = _interopRequireDefault(require("./model/ListReactionsOfMessageResponse"));
+var _ListOpenChannelsResponse = _interopRequireDefault(require("./model/ListOpenChannelsResponse"));
+var _ListOperatorsResponse = _interopRequireDefault(require("./model/ListOperatorsResponse"));
var _ListRegistrationOrDeviceTokensResponse = _interopRequireDefault(require("./model/ListRegistrationOrDeviceTokensResponse"));
-var _ListReportsOnChannelByUrlResponse = _interopRequireDefault(require("./model/ListReportsOnChannelByUrlResponse"));
-var _ListReportsOnMessageByIdResponse = _interopRequireDefault(require("./model/ListReportsOnMessageByIdResponse"));
-var _ListReportsOnMessageByIdResponseReportLogsInner = _interopRequireDefault(require("./model/ListReportsOnMessageByIdResponseReportLogsInner"));
-var _ListReportsOnUserByIdResponse = _interopRequireDefault(require("./model/ListReportsOnUserByIdResponse"));
-var _ListReportsResponse = _interopRequireDefault(require("./model/ListReportsResponse"));
-var _ListReportsResponseReportLogsInner = _interopRequireDefault(require("./model/ListReportsResponseReportLogsInner"));
-var _ListSecondaryApiTokensResponse = _interopRequireDefault(require("./model/ListSecondaryApiTokensResponse"));
-var _ListSecondaryApiTokensResponseApiTokensInner = _interopRequireDefault(require("./model/ListSecondaryApiTokensResponseApiTokensInner"));
var _ListUsersResponse = _interopRequireDefault(require("./model/ListUsersResponse"));
-var _MarkAllMessagesAsReadData = _interopRequireDefault(require("./model/MarkAllMessagesAsReadData"));
-var _MuteInChannelsWithCustomChannelTypesData = _interopRequireDefault(require("./model/MuteInChannelsWithCustomChannelTypesData"));
-var _MuteUsersInChannelsWithCustomChannelTypeData = _interopRequireDefault(require("./model/MuteUsersInChannelsWithCustomChannelTypeData"));
-var _OcBanUserData = _interopRequireDefault(require("./model/OcBanUserData"));
-var _OcBanUserResponse = _interopRequireDefault(require("./model/OcBanUserResponse"));
-var _OcCreateChannelData = _interopRequireDefault(require("./model/OcCreateChannelData"));
-var _OcDeleteChannelByUrl200Response = _interopRequireDefault(require("./model/OcDeleteChannelByUrl200Response"));
-var _OcFreezeChannelData = _interopRequireDefault(require("./model/OcFreezeChannelData"));
-var _OcListBannedUsersResponse = _interopRequireDefault(require("./model/OcListBannedUsersResponse"));
-var _OcListBannedUsersResponseBannedListInner = _interopRequireDefault(require("./model/OcListBannedUsersResponseBannedListInner"));
-var _OcListChannelsResponse = _interopRequireDefault(require("./model/OcListChannelsResponse"));
-var _OcListMutedUsersResponse = _interopRequireDefault(require("./model/OcListMutedUsersResponse"));
-var _OcListOperatorsResponse = _interopRequireDefault(require("./model/OcListOperatorsResponse"));
-var _OcListParticipantsResponse = _interopRequireDefault(require("./model/OcListParticipantsResponse"));
-var _OcMuteUserData = _interopRequireDefault(require("./model/OcMuteUserData"));
-var _OcRegisterOperatorsData = _interopRequireDefault(require("./model/OcRegisterOperatorsData"));
-var _OcUpdateBanByIdData = _interopRequireDefault(require("./model/OcUpdateBanByIdData"));
-var _OcUpdateBanByIdResponse = _interopRequireDefault(require("./model/OcUpdateBanByIdResponse"));
-var _OcUpdateChannelByUrlData = _interopRequireDefault(require("./model/OcUpdateChannelByUrlData"));
-var _OcViewBanByIdResponse = _interopRequireDefault(require("./model/OcViewBanByIdResponse"));
-var _OcViewMuteByIdResponse = _interopRequireDefault(require("./model/OcViewMuteByIdResponse"));
-var _RegisterAndScheduleDataExportData = _interopRequireDefault(require("./model/RegisterAndScheduleDataExportData"));
-var _RegisterAndScheduleDataExportResponse = _interopRequireDefault(require("./model/RegisterAndScheduleDataExportResponse"));
-var _RegisterAsOperatorToChannelsWithCustomChannelTypesData = _interopRequireDefault(require("./model/RegisterAsOperatorToChannelsWithCustomChannelTypesData"));
-var _RegisterGdprRequestData = _interopRequireDefault(require("./model/RegisterGdprRequestData"));
-var _RegisterGdprRequestResponse = _interopRequireDefault(require("./model/RegisterGdprRequestResponse"));
-var _RemovePushConfigurationByIdResponse = _interopRequireDefault(require("./model/RemovePushConfigurationByIdResponse"));
-var _RemoveReactionFromAMessageResponse = _interopRequireDefault(require("./model/RemoveReactionFromAMessageResponse"));
-var _RemoveRegistrationOrDeviceTokenByTokenResponse = _interopRequireDefault(require("./model/RemoveRegistrationOrDeviceTokenByTokenResponse"));
-var _RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse = _interopRequireDefault(require("./model/RemoveRegistrationOrDeviceTokenFromOwnerByTokenResponse"));
-var _RemoveRegistrationOrDeviceTokenResponse = _interopRequireDefault(require("./model/RemoveRegistrationOrDeviceTokenResponse"));
-var _ReportChannelByUrlData = _interopRequireDefault(require("./model/ReportChannelByUrlData"));
-var _ReportChannelByUrlResponse = _interopRequireDefault(require("./model/ReportChannelByUrlResponse"));
-var _ReportMessageByIdData = _interopRequireDefault(require("./model/ReportMessageByIdData"));
-var _ReportMessageByIdResponse = _interopRequireDefault(require("./model/ReportMessageByIdResponse"));
-var _ReportUserByIdData = _interopRequireDefault(require("./model/ReportUserByIdData"));
-var _ReportUserByIdResponse = _interopRequireDefault(require("./model/ReportUserByIdResponse"));
-var _ResetPushPreferencesResponse = _interopRequireDefault(require("./model/ResetPushPreferencesResponse"));
-var _RetrieveAdvancedAnalyticsMetricsResponse = _interopRequireDefault(require("./model/RetrieveAdvancedAnalyticsMetricsResponse"));
-var _RetrieveIpWhitelistResponse = _interopRequireDefault(require("./model/RetrieveIpWhitelistResponse"));
-var _RetrieveListOfSubscribedEventsResponse = _interopRequireDefault(require("./model/RetrieveListOfSubscribedEventsResponse"));
-var _RetrieveListOfSubscribedEventsResponseWebhook = _interopRequireDefault(require("./model/RetrieveListOfSubscribedEventsResponseWebhook"));
-var _RevokeSecondaryApiTokenByTokenResponse = _interopRequireDefault(require("./model/RevokeSecondaryApiTokenByTokenResponse"));
-var _SBObject = _interopRequireDefault(require("./model/SBObject"));
-var _ScheduleAnnouncementData = _interopRequireDefault(require("./model/ScheduleAnnouncementData"));
-var _ScheduleAnnouncementDataMessage = _interopRequireDefault(require("./model/ScheduleAnnouncementDataMessage"));
-var _ScheduleAnnouncementResponse = _interopRequireDefault(require("./model/ScheduleAnnouncementResponse"));
-var _ScheduleAnnouncementResponseCreateChannelOptions = _interopRequireDefault(require("./model/ScheduleAnnouncementResponseCreateChannelOptions"));
-var _ScheduleAnnouncementResponseMessage = _interopRequireDefault(require("./model/ScheduleAnnouncementResponseMessage"));
-var _SendBirdAdminMessage = _interopRequireDefault(require("./model/SendBirdAdminMessage"));
-var _SendBirdAppleCriticalAlertOptions = _interopRequireDefault(require("./model/SendBirdAppleCriticalAlertOptions"));
-var _SendBirdAutoEventMessageSettings = _interopRequireDefault(require("./model/SendBirdAutoEventMessageSettings"));
-var _SendBirdBaseChannel = _interopRequireDefault(require("./model/SendBirdBaseChannel"));
-var _SendBirdBaseMessageInstance = _interopRequireDefault(require("./model/SendBirdBaseMessageInstance"));
-var _SendBirdChannelResponse = _interopRequireDefault(require("./model/SendBirdChannelResponse"));
-var _SendBirdEmoji = _interopRequireDefault(require("./model/SendBirdEmoji"));
-var _SendBirdEmojiCategory = _interopRequireDefault(require("./model/SendBirdEmojiCategory"));
-var _SendBirdFileMessageParams = _interopRequireDefault(require("./model/SendBirdFileMessageParams"));
-var _SendBirdGroupChannel = _interopRequireDefault(require("./model/SendBirdGroupChannel"));
-var _SendBirdGroupChannelChannel = _interopRequireDefault(require("./model/SendBirdGroupChannelChannel"));
-var _SendBirdGroupChannelCollection = _interopRequireDefault(require("./model/SendBirdGroupChannelCollection"));
-var _SendBirdGroupChannelCreatedBy = _interopRequireDefault(require("./model/SendBirdGroupChannelCreatedBy"));
-var _SendBirdGroupChannelDisappearingMessage = _interopRequireDefault(require("./model/SendBirdGroupChannelDisappearingMessage"));
-var _SendBirdGroupChannelInviter = _interopRequireDefault(require("./model/SendBirdGroupChannelInviter"));
-var _SendBirdGroupChannelLastMessage = _interopRequireDefault(require("./model/SendBirdGroupChannelLastMessage"));
-var _SendBirdGroupChannelSmsFallback = _interopRequireDefault(require("./model/SendBirdGroupChannelSmsFallback"));
-var _SendBirdMember = _interopRequireDefault(require("./model/SendBirdMember"));
-var _SendBirdMessageMetaArray = _interopRequireDefault(require("./model/SendBirdMessageMetaArray"));
-var _SendBirdMessageResponse = _interopRequireDefault(require("./model/SendBirdMessageResponse"));
-var _SendBirdMessageResponseMentionedUsersInner = _interopRequireDefault(require("./model/SendBirdMessageResponseMentionedUsersInner"));
-var _SendBirdMessageResponseUser = _interopRequireDefault(require("./model/SendBirdMessageResponseUser"));
-var _SendBirdOGImage = _interopRequireDefault(require("./model/SendBirdOGImage"));
-var _SendBirdOGMetaData = _interopRequireDefault(require("./model/SendBirdOGMetaData"));
-var _SendBirdOpenChannel = _interopRequireDefault(require("./model/SendBirdOpenChannel"));
-var _SendBirdPlugin = _interopRequireDefault(require("./model/SendBirdPlugin"));
-var _SendBirdPoll = _interopRequireDefault(require("./model/SendBirdPoll"));
-var _SendBirdPollDetails = _interopRequireDefault(require("./model/SendBirdPollDetails"));
-var _SendBirdPollOption = _interopRequireDefault(require("./model/SendBirdPollOption"));
-var _SendBirdPollUpdatedVoteCount = _interopRequireDefault(require("./model/SendBirdPollUpdatedVoteCount"));
-var _SendBirdReaction = _interopRequireDefault(require("./model/SendBirdReaction"));
-var _SendBirdRestrictionInfo = _interopRequireDefault(require("./model/SendBirdRestrictionInfo"));
-var _SendBirdSender = _interopRequireDefault(require("./model/SendBirdSender"));
-var _SendBirdThreadInfo = _interopRequireDefault(require("./model/SendBirdThreadInfo"));
-var _SendBirdThumbnailSBObject = _interopRequireDefault(require("./model/SendBirdThumbnailSBObject"));
-var _SendBirdThumbnailSize = _interopRequireDefault(require("./model/SendBirdThumbnailSize"));
-var _SendBirdUser = _interopRequireDefault(require("./model/SendBirdUser"));
-var _SendBirdUserMessageParams = _interopRequireDefault(require("./model/SendBirdUserMessageParams"));
-var _SendBotSMessageData = _interopRequireDefault(require("./model/SendBotSMessageData"));
-var _SendMessageData = _interopRequireDefault(require("./model/SendMessageData"));
-var _SetDomainFilterData = _interopRequireDefault(require("./model/SetDomainFilterData"));
-var _SetDomainFilterDataDomainFilter = _interopRequireDefault(require("./model/SetDomainFilterDataDomainFilter"));
-var _SetDomainFilterDataImageModeration = _interopRequireDefault(require("./model/SetDomainFilterDataImageModeration"));
-var _SetDomainFilterDataImageModerationLimits = _interopRequireDefault(require("./model/SetDomainFilterDataImageModerationLimits"));
-var _SetDomainFilterDataProfanityFilter = _interopRequireDefault(require("./model/SetDomainFilterDataProfanityFilter"));
-var _SetDomainFilterDataProfanityFilterRegexFiltersInner = _interopRequireDefault(require("./model/SetDomainFilterDataProfanityFilterRegexFiltersInner"));
-var _SetDomainFilterDataProfanityTriggeredModeration = _interopRequireDefault(require("./model/SetDomainFilterDataProfanityTriggeredModeration"));
-var _TranslateMessageIntoOtherLanguagesData = _interopRequireDefault(require("./model/TranslateMessageIntoOtherLanguagesData"));
-var _UpdateAnnouncementByIdData = _interopRequireDefault(require("./model/UpdateAnnouncementByIdData"));
-var _UpdateAnnouncementByIdResponse = _interopRequireDefault(require("./model/UpdateAnnouncementByIdResponse"));
-var _UpdateAnnouncementByIdResponseMessage = _interopRequireDefault(require("./model/UpdateAnnouncementByIdResponseMessage"));
-var _UpdateApnsPushConfigurationByIdData = _interopRequireDefault(require("./model/UpdateApnsPushConfigurationByIdData"));
-var _UpdateApnsPushConfigurationByIdResponse = _interopRequireDefault(require("./model/UpdateApnsPushConfigurationByIdResponse"));
-var _UpdateBotByIdData = _interopRequireDefault(require("./model/UpdateBotByIdData"));
-var _UpdateBotByIdResponse = _interopRequireDefault(require("./model/UpdateBotByIdResponse"));
-var _UpdateChannelInvitationPreferenceData = _interopRequireDefault(require("./model/UpdateChannelInvitationPreferenceData"));
+var _MarkAllMessagesAsReadRequest = _interopRequireDefault(require("./model/MarkAllMessagesAsReadRequest"));
+var _MarkChannelMessagesAsReadRequest = _interopRequireDefault(require("./model/MarkChannelMessagesAsReadRequest"));
+var _RegisterOperatorsToAGroupChannelRequest = _interopRequireDefault(require("./model/RegisterOperatorsToAGroupChannelRequest"));
+var _RemoveARegistrationOrDeviceTokenResponse = _interopRequireDefault(require("./model/RemoveARegistrationOrDeviceTokenResponse"));
+var _RemoveAllRegistrationOrDeviceTokenResponse = _interopRequireDefault(require("./model/RemoveAllRegistrationOrDeviceTokenResponse"));
+var _ResetChatHistoryRequest = _interopRequireDefault(require("./model/ResetChatHistoryRequest"));
+var _ResetChatHistoryResponse = _interopRequireDefault(require("./model/ResetChatHistoryResponse"));
+var _ScheduleAnAnnouncementRequest = _interopRequireDefault(require("./model/ScheduleAnAnnouncementRequest"));
+var _ScheduleAnAnnouncementRequestCreateChannelOptions = _interopRequireDefault(require("./model/ScheduleAnAnnouncementRequestCreateChannelOptions"));
+var _ScheduleAnAnnouncementRequestMessage = _interopRequireDefault(require("./model/ScheduleAnAnnouncementRequestMessage"));
+var _ScheduleAnAnnouncementResponse = _interopRequireDefault(require("./model/ScheduleAnAnnouncementResponse"));
+var _ScheduleAnAnnouncementResponseMessage = _interopRequireDefault(require("./model/ScheduleAnAnnouncementResponseMessage"));
+var _SendABotMessageRequest = _interopRequireDefault(require("./model/SendABotMessageRequest"));
+var _SendAMessageRequest = _interopRequireDefault(require("./model/SendAMessageRequest"));
+var _SendAdminMessageRequestBody = _interopRequireDefault(require("./model/SendAdminMessageRequestBody"));
+var _SendFileMessageRequestBody = _interopRequireDefault(require("./model/SendFileMessageRequestBody"));
+var _SendTextMessageRequestBody = _interopRequireDefault(require("./model/SendTextMessageRequestBody"));
+var _SendTextMessageRequestBodyPushMessageTemplate = _interopRequireDefault(require("./model/SendTextMessageRequestBodyPushMessageTemplate"));
+var _SendTextMessageRequestBodyPushMessageTemplateOneOf = _interopRequireDefault(require("./model/SendTextMessageRequestBodyPushMessageTemplateOneOf"));
+var _SendbirdBasicUserInfo = _interopRequireDefault(require("./model/SendbirdBasicUserInfo"));
+var _SendbirdDisappearingMessage = _interopRequireDefault(require("./model/SendbirdDisappearingMessage"));
+var _SendbirdExtendedMessagePayload = _interopRequireDefault(require("./model/SendbirdExtendedMessagePayload"));
+var _SendbirdFile = _interopRequireDefault(require("./model/SendbirdFile"));
+var _SendbirdGroupChannel = _interopRequireDefault(require("./model/SendbirdGroupChannel"));
+var _SendbirdGroupChannelDetail = _interopRequireDefault(require("./model/SendbirdGroupChannelDetail"));
+var _SendbirdGroupChannelDetailChannel = _interopRequireDefault(require("./model/SendbirdGroupChannelDetailChannel"));
+var _SendbirdMember = _interopRequireDefault(require("./model/SendbirdMember"));
+var _SendbirdMessageResponse = _interopRequireDefault(require("./model/SendbirdMessageResponse"));
+var _SendbirdMessageResponseMessageEvents = _interopRequireDefault(require("./model/SendbirdMessageResponseMessageEvents"));
+var _SendbirdOpenChannel = _interopRequireDefault(require("./model/SendbirdOpenChannel"));
+var _SendbirdParentMessageInfo = _interopRequireDefault(require("./model/SendbirdParentMessageInfo"));
+var _SendbirdPushTriggerOption = _interopRequireDefault(require("./model/SendbirdPushTriggerOption"));
+var _SendbirdReaction = _interopRequireDefault(require("./model/SendbirdReaction"));
+var _SendbirdSmsFallback = _interopRequireDefault(require("./model/SendbirdSmsFallback"));
+var _SendbirdSortedMetaarrayInner = _interopRequireDefault(require("./model/SendbirdSortedMetaarrayInner"));
+var _SendbirdThumbnail = _interopRequireDefault(require("./model/SendbirdThumbnail"));
+var _SendbirdUser = _interopRequireDefault(require("./model/SendbirdUser"));
+var _StartTypingIndicatorsRequest = _interopRequireDefault(require("./model/StartTypingIndicatorsRequest"));
+var _UpdateAChannelMetadataRequest = _interopRequireDefault(require("./model/UpdateAChannelMetadataRequest"));
+var _UpdateAGroupChannelRequest = _interopRequireDefault(require("./model/UpdateAGroupChannelRequest"));
+var _UpdateAMessageRequest = _interopRequireDefault(require("./model/UpdateAMessageRequest"));
+var _UpdateAUserRequest = _interopRequireDefault(require("./model/UpdateAUserRequest"));
+var _UpdateAnOpenChannelRequest = _interopRequireDefault(require("./model/UpdateAnOpenChannelRequest"));
+var _UpdateChannelInvitationPreferenceRequest = _interopRequireDefault(require("./model/UpdateChannelInvitationPreferenceRequest"));
var _UpdateChannelInvitationPreferenceResponse = _interopRequireDefault(require("./model/UpdateChannelInvitationPreferenceResponse"));
-var _UpdateChannelMetacounterData = _interopRequireDefault(require("./model/UpdateChannelMetacounterData"));
-var _UpdateChannelMetadataData = _interopRequireDefault(require("./model/UpdateChannelMetadataData"));
-var _UpdateCountPreferenceOfChannelByUrlData = _interopRequireDefault(require("./model/UpdateCountPreferenceOfChannelByUrlData"));
+var _UpdateCountPreferenceOfAChannelRequest = _interopRequireDefault(require("./model/UpdateCountPreferenceOfAChannelRequest"));
var _UpdateCountPreferenceOfChannelByUrlResponse = _interopRequireDefault(require("./model/UpdateCountPreferenceOfChannelByUrlResponse"));
-var _UpdateDefaultChannelInvitationPreferenceData = _interopRequireDefault(require("./model/UpdateDefaultChannelInvitationPreferenceData"));
-var _UpdateDefaultChannelInvitationPreferenceResponse = _interopRequireDefault(require("./model/UpdateDefaultChannelInvitationPreferenceResponse"));
-var _UpdateEmojiCategoryUrlByIdData = _interopRequireDefault(require("./model/UpdateEmojiCategoryUrlByIdData"));
-var _UpdateEmojiUrlByKeyData = _interopRequireDefault(require("./model/UpdateEmojiUrlByKeyData"));
-var _UpdateExtraDataInMessageData = _interopRequireDefault(require("./model/UpdateExtraDataInMessageData"));
-var _UpdateExtraDataInMessageResponse = _interopRequireDefault(require("./model/UpdateExtraDataInMessageResponse"));
-var _UpdateExtraDataInMessageResponseSortedMetaarrayInner = _interopRequireDefault(require("./model/UpdateExtraDataInMessageResponseSortedMetaarrayInner"));
-var _UpdateFcmPushConfigurationByIdData = _interopRequireDefault(require("./model/UpdateFcmPushConfigurationByIdData"));
-var _UpdateFcmPushConfigurationByIdResponse = _interopRequireDefault(require("./model/UpdateFcmPushConfigurationByIdResponse"));
-var _UpdateHmsPushConfigurationByIdData = _interopRequireDefault(require("./model/UpdateHmsPushConfigurationByIdData"));
-var _UpdateHmsPushConfigurationByIdResponse = _interopRequireDefault(require("./model/UpdateHmsPushConfigurationByIdResponse"));
-var _UpdateMessageByIdData = _interopRequireDefault(require("./model/UpdateMessageByIdData"));
-var _UpdatePushNotificationContentTemplateData = _interopRequireDefault(require("./model/UpdatePushNotificationContentTemplateData"));
-var _UpdatePushNotificationContentTemplateResponse = _interopRequireDefault(require("./model/UpdatePushNotificationContentTemplateResponse"));
-var _UpdatePushPreferencesData = _interopRequireDefault(require("./model/UpdatePushPreferencesData"));
-var _UpdatePushPreferencesForChannelByUrlData = _interopRequireDefault(require("./model/UpdatePushPreferencesForChannelByUrlData"));
-var _UpdatePushPreferencesForChannelByUrlResponse = _interopRequireDefault(require("./model/UpdatePushPreferencesForChannelByUrlResponse"));
+var _UpdateExtraDataInAMessageRequest = _interopRequireDefault(require("./model/UpdateExtraDataInAMessageRequest"));
+var _UpdateExtraDataInAMessageResponse = _interopRequireDefault(require("./model/UpdateExtraDataInAMessageResponse"));
+var _UpdatePushPreferencesForAChannelRequest = _interopRequireDefault(require("./model/UpdatePushPreferencesForAChannelRequest"));
+var _UpdatePushPreferencesForAChannelResponse = _interopRequireDefault(require("./model/UpdatePushPreferencesForAChannelResponse"));
+var _UpdatePushPreferencesRequest = _interopRequireDefault(require("./model/UpdatePushPreferencesRequest"));
var _UpdatePushPreferencesResponse = _interopRequireDefault(require("./model/UpdatePushPreferencesResponse"));
-var _UpdateUserByIdData = _interopRequireDefault(require("./model/UpdateUserByIdData"));
-var _UpdateUserMetadataData = _interopRequireDefault(require("./model/UpdateUserMetadataData"));
-var _UpdateUserMetadataResponse = _interopRequireDefault(require("./model/UpdateUserMetadataResponse"));
-var _UseDefaultEmojisData = _interopRequireDefault(require("./model/UseDefaultEmojisData"));
-var _UseDefaultEmojisResponse = _interopRequireDefault(require("./model/UseDefaultEmojisResponse"));
-var _ViewAnnouncementByIdResponse = _interopRequireDefault(require("./model/ViewAnnouncementByIdResponse"));
-var _ViewBotByIdResponse = _interopRequireDefault(require("./model/ViewBotByIdResponse"));
-var _ViewChannelInvitationPreferenceResponse = _interopRequireDefault(require("./model/ViewChannelInvitationPreferenceResponse"));
-var _ViewCountPreferenceOfChannelByUrlResponse = _interopRequireDefault(require("./model/ViewCountPreferenceOfChannelByUrlResponse"));
-var _ViewDataExportByIdResponse = _interopRequireDefault(require("./model/ViewDataExportByIdResponse"));
-var _ViewDefaultChannelInvitationPreferenceResponse = _interopRequireDefault(require("./model/ViewDefaultChannelInvitationPreferenceResponse"));
-var _ViewGdprRequestByIdResponse = _interopRequireDefault(require("./model/ViewGdprRequestByIdResponse"));
-var _ViewNumberOfChannelsByJoinStatusResponse = _interopRequireDefault(require("./model/ViewNumberOfChannelsByJoinStatusResponse"));
+var _ViewCountPreferenceOfAChannelResponse = _interopRequireDefault(require("./model/ViewCountPreferenceOfAChannelResponse"));
var _ViewNumberOfChannelsWithUnreadMessagesResponse = _interopRequireDefault(require("./model/ViewNumberOfChannelsWithUnreadMessagesResponse"));
-var _ViewNumberOfConcurrentConnectionsResponse = _interopRequireDefault(require("./model/ViewNumberOfConcurrentConnectionsResponse"));
var _ViewNumberOfDailyActiveUsersResponse = _interopRequireDefault(require("./model/ViewNumberOfDailyActiveUsersResponse"));
var _ViewNumberOfMonthlyActiveUsersResponse = _interopRequireDefault(require("./model/ViewNumberOfMonthlyActiveUsersResponse"));
-var _ViewNumberOfPeakConnectionsResponse = _interopRequireDefault(require("./model/ViewNumberOfPeakConnectionsResponse"));
-var _ViewNumberOfPeakConnectionsResponsePeakConnectionsInner = _interopRequireDefault(require("./model/ViewNumberOfPeakConnectionsResponsePeakConnectionsInner"));
-var _ViewNumberOfUnreadItemsResponse = _interopRequireDefault(require("./model/ViewNumberOfUnreadItemsResponse"));
var _ViewNumberOfUnreadMessagesResponse = _interopRequireDefault(require("./model/ViewNumberOfUnreadMessagesResponse"));
-var _ViewPushConfigurationByIdResponse = _interopRequireDefault(require("./model/ViewPushConfigurationByIdResponse"));
-var _ViewPushNotificationContentTemplateResponse = _interopRequireDefault(require("./model/ViewPushNotificationContentTemplateResponse"));
-var _ViewPushNotificationContentTemplateResponsePushMessageTemplatesInner = _interopRequireDefault(require("./model/ViewPushNotificationContentTemplateResponsePushMessageTemplatesInner"));
-var _ViewPushPreferencesForChannelByUrlResponse = _interopRequireDefault(require("./model/ViewPushPreferencesForChannelByUrlResponse"));
+var _ViewPushPreferencesForAChannelResponse = _interopRequireDefault(require("./model/ViewPushPreferencesForAChannelResponse"));
var _ViewPushPreferencesResponse = _interopRequireDefault(require("./model/ViewPushPreferencesResponse"));
-var _ViewSecondaryApiTokenByTokenResponse = _interopRequireDefault(require("./model/ViewSecondaryApiTokenByTokenResponse"));
-var _ViewTotalNumberOfMessagesInChannelResponse = _interopRequireDefault(require("./model/ViewTotalNumberOfMessagesInChannelResponse"));
-var _ViewUserMetadataResponse = _interopRequireDefault(require("./model/ViewUserMetadataResponse"));
-var _ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner = _interopRequireDefault(require("./model/ViewWhoOwnsRegistrationOrDeviceTokenByTokenResponseInner"));
var _AnnouncementApi = _interopRequireDefault(require("./api/AnnouncementApi"));
-var _ApplicationApi = _interopRequireDefault(require("./api/ApplicationApi"));
var _BotApi = _interopRequireDefault(require("./api/BotApi"));
-var _DataExportApi = _interopRequireDefault(require("./api/DataExportApi"));
var _GroupChannelApi = _interopRequireDefault(require("./api/GroupChannelApi"));
var _MessageApi = _interopRequireDefault(require("./api/MessageApi"));
var _MetadataApi = _interopRequireDefault(require("./api/MetadataApi"));
var _ModerationApi = _interopRequireDefault(require("./api/ModerationApi"));
var _OpenChannelApi = _interopRequireDefault(require("./api/OpenChannelApi"));
-var _PrivacyApi = _interopRequireDefault(require("./api/PrivacyApi"));
-var _ReportApi = _interopRequireDefault(require("./api/ReportApi"));
var _StatisticsApi = _interopRequireDefault(require("./api/StatisticsApi"));
var _UserApi = _interopRequireDefault(require("./api/UserApi"));
-var _WebhookApi = _interopRequireDefault(require("./api/WebhookApi"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
\ No newline at end of file
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
\ No newline at end of file
diff --git a/dist/model/AcceptAnInvitationRequest.js b/dist/model/AcceptAnInvitationRequest.js
new file mode 100644
index 0000000..7243d18
--- /dev/null
+++ b/dist/model/AcceptAnInvitationRequest.js
@@ -0,0 +1,85 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+ value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The AcceptAnInvitationRequest model module.
+ * @module model/AcceptAnInvitationRequest
+ * @version 2.0.0
+ */
+var AcceptAnInvitationRequest = /*#__PURE__*/function () {
+ /**
+ * Constructs a new AcceptAnInvitationRequest.
+ * @alias module:model/AcceptAnInvitationRequest
+ * @param userId {String}
+ */
+ function AcceptAnInvitationRequest(userId) {
+ _classCallCheck(this, AcceptAnInvitationRequest);
+ AcceptAnInvitationRequest.initialize(this, userId);
+ }
+
+ /**
+ * Initializes the fields of this object.
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+ * Only for internal use.
+ */
+ return _createClass(AcceptAnInvitationRequest, null, [{
+ key: "initialize",
+ value: function initialize(obj, userId) {
+ obj['user_id'] = userId;
+ }
+
+ /**
+ * Constructs a AcceptAnInvitationRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/AcceptAnInvitationRequest} obj Optional instance to populate.
+ * @return {module:model/AcceptAnInvitationRequest} The populated AcceptAnInvitationRequest instance.
+ */
+ }, {
+ key: "constructFromObject",
+ value: function constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new AcceptAnInvitationRequest();
+ if (data.hasOwnProperty('access_code')) {
+ obj['access_code'] = _ApiClient["default"].convertToType(data['access_code'], 'String');
+ }
+ if (data.hasOwnProperty('user_id')) {
+ obj['user_id'] = _ApiClient["default"].convertToType(data['user_id'], 'String');
+ }
+ }
+ return obj;
+ }
+ }]);
+}();
+/**
+ * @member {String} access_code
+ */
+AcceptAnInvitationRequest.prototype['access_code'] = undefined;
+
+/**
+ * @member {String} user_id
+ */
+AcceptAnInvitationRequest.prototype['user_id'] = undefined;
+var _default = exports["default"] = AcceptAnInvitationRequest;
\ No newline at end of file
diff --git a/dist/model/AddARegistrationOrDeviceTokenRequest.js b/dist/model/AddARegistrationOrDeviceTokenRequest.js
new file mode 100644
index 0000000..a823cd7
--- /dev/null
+++ b/dist/model/AddARegistrationOrDeviceTokenRequest.js
@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+ value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The AddARegistrationOrDeviceTokenRequest model module.
+ * @module model/AddARegistrationOrDeviceTokenRequest
+ * @version 2.0.0
+ */
+var AddARegistrationOrDeviceTokenRequest = /*#__PURE__*/function () {
+ /**
+ * Constructs a new AddARegistrationOrDeviceTokenRequest.
+ * @alias module:model/AddARegistrationOrDeviceTokenRequest
+ */
+ function AddARegistrationOrDeviceTokenRequest() {
+ _classCallCheck(this, AddARegistrationOrDeviceTokenRequest);
+ AddARegistrationOrDeviceTokenRequest.initialize(this);
+ }
+
+ /**
+ * Initializes the fields of this object.
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+ * Only for internal use.
+ */
+ return _createClass(AddARegistrationOrDeviceTokenRequest, null, [{
+ key: "initialize",
+ value: function initialize(obj) {}
+
+ /**
+ * Constructs a AddARegistrationOrDeviceTokenRequest from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/AddARegistrationOrDeviceTokenRequest} obj Optional instance to populate.
+ * @return {module:model/AddARegistrationOrDeviceTokenRequest} The populated AddARegistrationOrDeviceTokenRequest instance.
+ */
+ }, {
+ key: "constructFromObject",
+ value: function constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new AddARegistrationOrDeviceTokenRequest();
+ if (data.hasOwnProperty('apns_device_token')) {
+ obj['apns_device_token'] = _ApiClient["default"].convertToType(data['apns_device_token'], 'String');
+ }
+ if (data.hasOwnProperty('gcm_reg_token')) {
+ obj['gcm_reg_token'] = _ApiClient["default"].convertToType(data['gcm_reg_token'], 'String');
+ }
+ if (data.hasOwnProperty('huawei_device_token')) {
+ obj['huawei_device_token'] = _ApiClient["default"].convertToType(data['huawei_device_token'], 'String');
+ }
+ }
+ return obj;
+ }
+ }]);
+}();
+/**
+ * @member {String} apns_device_token
+ */
+AddARegistrationOrDeviceTokenRequest.prototype['apns_device_token'] = undefined;
+
+/**
+ * @member {String} gcm_reg_token
+ */
+AddARegistrationOrDeviceTokenRequest.prototype['gcm_reg_token'] = undefined;
+
+/**
+ * @member {String} huawei_device_token
+ */
+AddARegistrationOrDeviceTokenRequest.prototype['huawei_device_token'] = undefined;
+var _default = exports["default"] = AddARegistrationOrDeviceTokenRequest;
\ No newline at end of file
diff --git a/dist/model/AddARegistrationOrDeviceTokenResponse.js b/dist/model/AddARegistrationOrDeviceTokenResponse.js
new file mode 100644
index 0000000..4006c37
--- /dev/null
+++ b/dist/model/AddARegistrationOrDeviceTokenResponse.js
@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+ value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _SendbirdBasicUserInfo = _interopRequireDefault(require("./SendbirdBasicUserInfo"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) Contact Support: Name: Sendbird Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The AddARegistrationOrDeviceTokenResponse model module.
+ * @module model/AddARegistrationOrDeviceTokenResponse
+ * @version 2.0.0
+ */
+var AddARegistrationOrDeviceTokenResponse = /*#__PURE__*/function () {
+ /**
+ * Constructs a new AddARegistrationOrDeviceTokenResponse.
+ * @alias module:model/AddARegistrationOrDeviceTokenResponse
+ */
+ function AddARegistrationOrDeviceTokenResponse() {
+ _classCallCheck(this, AddARegistrationOrDeviceTokenResponse);
+ AddARegistrationOrDeviceTokenResponse.initialize(this);
+ }
+
+ /**
+ * Initializes the fields of this object.
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+ * Only for internal use.
+ */
+ return _createClass(AddARegistrationOrDeviceTokenResponse, null, [{
+ key: "initialize",
+ value: function initialize(obj) {}
+
+ /**
+ * Constructs a AddARegistrationOrDeviceTokenResponse from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/AddARegistrationOrDeviceTokenResponse} obj Optional instance to populate.
+ * @return {module:model/AddARegistrationOrDeviceTokenResponse} The populated AddARegistrationOrDeviceTokenResponse instance.
+ */
+ }, {
+ key: "constructFromObject",
+ value: function constructFromObject(data, obj) {
+ if (data) {
+ obj = obj || new AddARegistrationOrDeviceTokenResponse();
+ if (data.hasOwnProperty('token')) {
+ obj['token'] = _ApiClient["default"].convertToType(data['token'], 'String');
+ }
+ if (data.hasOwnProperty('type')) {
+ obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
+ }
+ if (data.hasOwnProperty('user')) {
+ obj['user'] = _SendbirdBasicUserInfo["default"].constructFromObject(data['user']);
+ }
+ }
+ return obj;
+ }
+ }]);
+}();
+/**
+ * @member {String} token
+ */
+AddARegistrationOrDeviceTokenResponse.prototype['token'] = undefined;
+
+/**
+ * @member {String} type
+ */
+AddARegistrationOrDeviceTokenResponse.prototype['type'] = undefined;
+
+/**
+ * @member {module:model/SendbirdBasicUserInfo} user
+ */
+AddARegistrationOrDeviceTokenResponse.prototype['user'] = undefined;
+var _default = exports["default"] = AddARegistrationOrDeviceTokenResponse;
\ No newline at end of file
diff --git a/dist/model/AddApnsPushConfigurationData.js b/dist/model/AddApnsPushConfigurationData.js
deleted file mode 100644
index a8a5d37..0000000
--- a/dist/model/AddApnsPushConfigurationData.js
+++ /dev/null
@@ -1,143 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
- * The AddApnsPushConfigurationData model module.
- * @module model/AddApnsPushConfigurationData
- * @version 0.0.16
- */
-var AddApnsPushConfigurationData = /*#__PURE__*/function () {
- /**
- * Constructs a new AddApnsPushConfigurationData.
- * @alias module:model/AddApnsPushConfigurationData
- * @param apnsCert {File} In a form of the `multipart/form-data` content type, specifies a [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) file of which type is either development or production. Sendbird server scans the content of the file, finds out the certificate type, and then registers the file as the corresponding type. If you upload a wrong file, you will receive an error.
- * @param apnsCertEnvType {String} Specifies the certificate type of the [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) file. Acceptable values are development and production. There is no need to specify this property when the apns_cert above is specified.
- * @param apnsCertPassword {String} Specifies the password of the cerfificate file which has been set during the [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) export.
- * @param hasUnreadCountBadge {Boolean} Determines whether to badge your client app's icon with the number of a user's unread messages. (Default: true)
- * @param contentAvailable {Boolean} Determines for your client app whether to perform a silent background update on a user's device. For more information, see the Apple Developer Documentation's [Pushing Updates to Your App Silently](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_updates_to_your_app_silently). (Default: false)
- * @param mutableContent {Boolean} Determines for your client app whether or not to modify the payload of a push notification before it is displayed on a user's device. For more information, see the Apple Developer Documentation's [Modifying Content in Newly Delivered Notifications](https://developer.apple.com/documentation/usernotifications/modifying_content_in_newly_delivered_notifications). (Default: false)
- * @param pushSound {String} Specifies the name of a sound file to be played when a push notification is delivered to your client app. The file can be in the app's main bundle or in the `Library/Sounds` folder of the app's data container.
- * @param apnsType {String} (Deprecated) Specifies the certificate type of the [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) file. Acceptable values are development and production. You should specify either this property or the apns_cert above to inform the server of which certificate type to update.
- */
- function AddApnsPushConfigurationData(apnsCert, apnsCertEnvType, apnsCertPassword, hasUnreadCountBadge, contentAvailable, mutableContent, pushSound, apnsType) {
- _classCallCheck(this, AddApnsPushConfigurationData);
- AddApnsPushConfigurationData.initialize(this, apnsCert, apnsCertEnvType, apnsCertPassword, hasUnreadCountBadge, contentAvailable, mutableContent, pushSound, apnsType);
- }
-
- /**
- * Initializes the fields of this object.
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
- * Only for internal use.
- */
- _createClass(AddApnsPushConfigurationData, null, [{
- key: "initialize",
- value: function initialize(obj, apnsCert, apnsCertEnvType, apnsCertPassword, hasUnreadCountBadge, contentAvailable, mutableContent, pushSound, apnsType) {
- obj['apns_cert'] = apnsCert;
- obj['apns_cert_env_type'] = apnsCertEnvType;
- obj['apns_cert_password'] = apnsCertPassword;
- obj['has_unread_count_badge'] = hasUnreadCountBadge;
- obj['content_available'] = contentAvailable;
- obj['mutable_content'] = mutableContent;
- obj['push_sound'] = pushSound;
- obj['apns_type'] = apnsType;
- }
-
- /**
- * Constructs a AddApnsPushConfigurationData from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AddApnsPushConfigurationData} obj Optional instance to populate.
- * @return {module:model/AddApnsPushConfigurationData} The populated AddApnsPushConfigurationData instance.
- */
- }, {
- key: "constructFromObject",
- value: function constructFromObject(data, obj) {
- if (data) {
- obj = obj || new AddApnsPushConfigurationData();
- if (data.hasOwnProperty('apns_cert')) {
- obj['apns_cert'] = _ApiClient["default"].convertToType(data['apns_cert'], File);
- }
- if (data.hasOwnProperty('apns_cert_env_type')) {
- obj['apns_cert_env_type'] = _ApiClient["default"].convertToType(data['apns_cert_env_type'], 'String');
- }
- if (data.hasOwnProperty('apns_cert_password')) {
- obj['apns_cert_password'] = _ApiClient["default"].convertToType(data['apns_cert_password'], 'String');
- }
- if (data.hasOwnProperty('has_unread_count_badge')) {
- obj['has_unread_count_badge'] = _ApiClient["default"].convertToType(data['has_unread_count_badge'], 'Boolean');
- }
- if (data.hasOwnProperty('content_available')) {
- obj['content_available'] = _ApiClient["default"].convertToType(data['content_available'], 'Boolean');
- }
- if (data.hasOwnProperty('mutable_content')) {
- obj['mutable_content'] = _ApiClient["default"].convertToType(data['mutable_content'], 'Boolean');
- }
- if (data.hasOwnProperty('push_sound')) {
- obj['push_sound'] = _ApiClient["default"].convertToType(data['push_sound'], 'String');
- }
- if (data.hasOwnProperty('apns_type')) {
- obj['apns_type'] = _ApiClient["default"].convertToType(data['apns_type'], 'String');
- }
- }
- return obj;
- }
- }]);
- return AddApnsPushConfigurationData;
-}();
-/**
- * In a form of the `multipart/form-data` content type, specifies a [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) file of which type is either development or production. Sendbird server scans the content of the file, finds out the certificate type, and then registers the file as the corresponding type. If you upload a wrong file, you will receive an error.
- * @member {File} apns_cert
- */
-AddApnsPushConfigurationData.prototype['apns_cert'] = undefined;
-
-/**
- * Specifies the certificate type of the [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) file. Acceptable values are development and production. There is no need to specify this property when the apns_cert above is specified.
- * @member {String} apns_cert_env_type
- */
-AddApnsPushConfigurationData.prototype['apns_cert_env_type'] = undefined;
-
-/**
- * Specifies the password of the cerfificate file which has been set during the [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) export.
- * @member {String} apns_cert_password
- */
-AddApnsPushConfigurationData.prototype['apns_cert_password'] = undefined;
-
-/**
- * Determines whether to badge your client app's icon with the number of a user's unread messages. (Default: true)
- * @member {Boolean} has_unread_count_badge
- */
-AddApnsPushConfigurationData.prototype['has_unread_count_badge'] = undefined;
-
-/**
- * Determines for your client app whether to perform a silent background update on a user's device. For more information, see the Apple Developer Documentation's [Pushing Updates to Your App Silently](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_updates_to_your_app_silently). (Default: false)
- * @member {Boolean} content_available
- */
-AddApnsPushConfigurationData.prototype['content_available'] = undefined;
-
-/**
- * Determines for your client app whether or not to modify the payload of a push notification before it is displayed on a user's device. For more information, see the Apple Developer Documentation's [Modifying Content in Newly Delivered Notifications](https://developer.apple.com/documentation/usernotifications/modifying_content_in_newly_delivered_notifications). (Default: false)
- * @member {Boolean} mutable_content
- */
-AddApnsPushConfigurationData.prototype['mutable_content'] = undefined;
-
-/**
- * Specifies the name of a sound file to be played when a push notification is delivered to your client app. The file can be in the app's main bundle or in the `Library/Sounds` folder of the app's data container.
- * @member {String} push_sound
- */
-AddApnsPushConfigurationData.prototype['push_sound'] = undefined;
-
-/**
- * (Deprecated) Specifies the certificate type of the [.p12](/docs/chat/v3/ios/guides/push-notifications#2-step-3-export-a-p12-file-and-upload-to-sendbird-dashboard) file. Acceptable values are development and production. You should specify either this property or the apns_cert above to inform the server of which certificate type to update.
- * @member {String} apns_type
- */
-AddApnsPushConfigurationData.prototype['apns_type'] = undefined;
-var _default = AddApnsPushConfigurationData;
-exports["default"] = _default;
\ No newline at end of file
diff --git a/dist/model/AddApnsPushConfigurationResponse.js b/dist/model/AddApnsPushConfigurationResponse.js
deleted file mode 100644
index 00b0b1e..0000000
--- a/dist/model/AddApnsPushConfigurationResponse.js
+++ /dev/null
@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AddApnsPushConfigurationResponsePushConfigurationsInner = _interopRequireDefault(require("./AddApnsPushConfigurationResponsePushConfigurationsInner"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
- * The AddApnsPushConfigurationResponse model module.
- * @module model/AddApnsPushConfigurationResponse
- * @version 0.0.16
- */
-var AddApnsPushConfigurationResponse = /*#__PURE__*/function () {
- /**
- * Constructs a new AddApnsPushConfigurationResponse.
- * @alias module:model/AddApnsPushConfigurationResponse
- */
- function AddApnsPushConfigurationResponse() {
- _classCallCheck(this, AddApnsPushConfigurationResponse);
- AddApnsPushConfigurationResponse.initialize(this);
- }
-
- /**
- * Initializes the fields of this object.
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
- * Only for internal use.
- */
- _createClass(AddApnsPushConfigurationResponse, null, [{
- key: "initialize",
- value: function initialize(obj) {}
-
- /**
- * Constructs a AddApnsPushConfigurationResponse from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AddApnsPushConfigurationResponse} obj Optional instance to populate.
- * @return {module:model/AddApnsPushConfigurationResponse} The populated AddApnsPushConfigurationResponse instance.
- */
- }, {
- key: "constructFromObject",
- value: function constructFromObject(data, obj) {
- if (data) {
- obj = obj || new AddApnsPushConfigurationResponse();
- if (data.hasOwnProperty('push_configurations')) {
- obj['push_configurations'] = _ApiClient["default"].convertToType(data['push_configurations'], [_AddApnsPushConfigurationResponsePushConfigurationsInner["default"]]);
- }
- }
- return obj;
- }
- }]);
- return AddApnsPushConfigurationResponse;
-}();
-/**
- * @member {Array.} push_configurations
- */
-AddApnsPushConfigurationResponse.prototype['push_configurations'] = undefined;
-var _default = AddApnsPushConfigurationResponse;
-exports["default"] = _default;
\ No newline at end of file
diff --git a/dist/model/AddApnsPushConfigurationResponsePushConfigurationsInner.js b/dist/model/AddApnsPushConfigurationResponsePushConfigurationsInner.js
deleted file mode 100644
index 89ee7fe..0000000
--- a/dist/model/AddApnsPushConfigurationResponsePushConfigurationsInner.js
+++ /dev/null
@@ -1,134 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
- * The AddApnsPushConfigurationResponsePushConfigurationsInner model module.
- * @module model/AddApnsPushConfigurationResponsePushConfigurationsInner
- * @version 0.0.16
- */
-var AddApnsPushConfigurationResponsePushConfigurationsInner = /*#__PURE__*/function () {
- /**
- * Constructs a new AddApnsPushConfigurationResponsePushConfigurationsInner.
- * @alias module:model/AddApnsPushConfigurationResponsePushConfigurationsInner
- */
- function AddApnsPushConfigurationResponsePushConfigurationsInner() {
- _classCallCheck(this, AddApnsPushConfigurationResponsePushConfigurationsInner);
- AddApnsPushConfigurationResponsePushConfigurationsInner.initialize(this);
- }
-
- /**
- * Initializes the fields of this object.
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
- * Only for internal use.
- */
- _createClass(AddApnsPushConfigurationResponsePushConfigurationsInner, null, [{
- key: "initialize",
- value: function initialize(obj) {}
-
- /**
- * Constructs a AddApnsPushConfigurationResponsePushConfigurationsInner from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AddApnsPushConfigurationResponsePushConfigurationsInner} obj Optional instance to populate.
- * @return {module:model/AddApnsPushConfigurationResponsePushConfigurationsInner} The populated AddApnsPushConfigurationResponsePushConfigurationsInner instance.
- */
- }, {
- key: "constructFromObject",
- value: function constructFromObject(data, obj) {
- if (data) {
- obj = obj || new AddApnsPushConfigurationResponsePushConfigurationsInner();
- if (data.hasOwnProperty('id')) {
- obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
- }
- if (data.hasOwnProperty('push_type')) {
- obj['push_type'] = _ApiClient["default"].convertToType(data['push_type'], 'String');
- }
- if (data.hasOwnProperty('created_at')) {
- obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Number');
- }
- if (data.hasOwnProperty('apns_cer_env_type')) {
- obj['apns_cer_env_type'] = _ApiClient["default"].convertToType(data['apns_cer_env_type'], 'String');
- }
- if (data.hasOwnProperty('apns_expiration')) {
- obj['apns_expiration'] = _ApiClient["default"].convertToType(data['apns_expiration'], 'Number');
- }
- if (data.hasOwnProperty('apns_name')) {
- obj['apns_name'] = _ApiClient["default"].convertToType(data['apns_name'], 'String');
- }
- if (data.hasOwnProperty('has_unread_count_badge')) {
- obj['has_unread_count_badge'] = _ApiClient["default"].convertToType(data['has_unread_count_badge'], 'Number');
- }
- if (data.hasOwnProperty('content_available')) {
- obj['content_available'] = _ApiClient["default"].convertToType(data['content_available'], 'Boolean');
- }
- if (data.hasOwnProperty('mutable_content')) {
- obj['mutable_content'] = _ApiClient["default"].convertToType(data['mutable_content'], 'Boolean');
- }
- if (data.hasOwnProperty('push_sound')) {
- obj['push_sound'] = _ApiClient["default"].convertToType(data['push_sound'], 'String');
- }
- }
- return obj;
- }
- }]);
- return AddApnsPushConfigurationResponsePushConfigurationsInner;
-}();
-/**
- * @member {String} id
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['id'] = undefined;
-
-/**
- * @member {String} push_type
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['push_type'] = undefined;
-
-/**
- * @member {Number} created_at
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['created_at'] = undefined;
-
-/**
- * @member {String} apns_cer_env_type
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['apns_cer_env_type'] = undefined;
-
-/**
- * @member {Number} apns_expiration
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['apns_expiration'] = undefined;
-
-/**
- * @member {String} apns_name
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['apns_name'] = undefined;
-
-/**
- * @member {Number} has_unread_count_badge
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['has_unread_count_badge'] = undefined;
-
-/**
- * @member {Boolean} content_available
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['content_available'] = undefined;
-
-/**
- * @member {Boolean} mutable_content
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['mutable_content'] = undefined;
-
-/**
- * @member {String} push_sound
- */
-AddApnsPushConfigurationResponsePushConfigurationsInner.prototype['push_sound'] = undefined;
-var _default = AddApnsPushConfigurationResponsePushConfigurationsInner;
-exports["default"] = _default;
\ No newline at end of file
diff --git a/dist/model/AddEmojiCategoriesResponse.js b/dist/model/AddEmojiCategoriesResponse.js
deleted file mode 100644
index 739de3e..0000000
--- a/dist/model/AddEmojiCategoriesResponse.js
+++ /dev/null
@@ -1,63 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _AddEmojiCategoriesResponseEmojiCategoriesInner = _interopRequireDefault(require("./AddEmojiCategoriesResponseEmojiCategoriesInner"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
- * The AddEmojiCategoriesResponse model module.
- * @module model/AddEmojiCategoriesResponse
- * @version 0.0.16
- */
-var AddEmojiCategoriesResponse = /*#__PURE__*/function () {
- /**
- * Constructs a new AddEmojiCategoriesResponse.
- * @alias module:model/AddEmojiCategoriesResponse
- */
- function AddEmojiCategoriesResponse() {
- _classCallCheck(this, AddEmojiCategoriesResponse);
- AddEmojiCategoriesResponse.initialize(this);
- }
-
- /**
- * Initializes the fields of this object.
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
- * Only for internal use.
- */
- _createClass(AddEmojiCategoriesResponse, null, [{
- key: "initialize",
- value: function initialize(obj) {}
-
- /**
- * Constructs a AddEmojiCategoriesResponse from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AddEmojiCategoriesResponse} obj Optional instance to populate.
- * @return {module:model/AddEmojiCategoriesResponse} The populated AddEmojiCategoriesResponse instance.
- */
- }, {
- key: "constructFromObject",
- value: function constructFromObject(data, obj) {
- if (data) {
- obj = obj || new AddEmojiCategoriesResponse();
- if (data.hasOwnProperty('emoji_categories')) {
- obj['emoji_categories'] = _ApiClient["default"].convertToType(data['emoji_categories'], [_AddEmojiCategoriesResponseEmojiCategoriesInner["default"]]);
- }
- }
- return obj;
- }
- }]);
- return AddEmojiCategoriesResponse;
-}();
-/**
- * @member {Array.} emoji_categories
- */
-AddEmojiCategoriesResponse.prototype['emoji_categories'] = undefined;
-var _default = AddEmojiCategoriesResponse;
-exports["default"] = _default;
\ No newline at end of file
diff --git a/dist/model/AddEmojiCategoriesResponseEmojiCategoriesInner.js b/dist/model/AddEmojiCategoriesResponseEmojiCategoriesInner.js
deleted file mode 100644
index a944564..0000000
--- a/dist/model/AddEmojiCategoriesResponseEmojiCategoriesInner.js
+++ /dev/null
@@ -1,78 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
- * The AddEmojiCategoriesResponseEmojiCategoriesInner model module.
- * @module model/AddEmojiCategoriesResponseEmojiCategoriesInner
- * @version 0.0.16
- */
-var AddEmojiCategoriesResponseEmojiCategoriesInner = /*#__PURE__*/function () {
- /**
- * Constructs a new AddEmojiCategoriesResponseEmojiCategoriesInner.
- * @alias module:model/AddEmojiCategoriesResponseEmojiCategoriesInner
- */
- function AddEmojiCategoriesResponseEmojiCategoriesInner() {
- _classCallCheck(this, AddEmojiCategoriesResponseEmojiCategoriesInner);
- AddEmojiCategoriesResponseEmojiCategoriesInner.initialize(this);
- }
-
- /**
- * Initializes the fields of this object.
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
- * Only for internal use.
- */
- _createClass(AddEmojiCategoriesResponseEmojiCategoriesInner, null, [{
- key: "initialize",
- value: function initialize(obj) {}
-
- /**
- * Constructs a AddEmojiCategoriesResponseEmojiCategoriesInner from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data to obj if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AddEmojiCategoriesResponseEmojiCategoriesInner} obj Optional instance to populate.
- * @return {module:model/AddEmojiCategoriesResponseEmojiCategoriesInner} The populated AddEmojiCategoriesResponseEmojiCategoriesInner instance.
- */
- }, {
- key: "constructFromObject",
- value: function constructFromObject(data, obj) {
- if (data) {
- obj = obj || new AddEmojiCategoriesResponseEmojiCategoriesInner();
- if (data.hasOwnProperty('id')) {
- obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
- }
- if (data.hasOwnProperty('name')) {
- obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
- }
- if (data.hasOwnProperty('url')) {
- obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
- }
- }
- return obj;
- }
- }]);
- return AddEmojiCategoriesResponseEmojiCategoriesInner;
-}();
-/**
- * @member {Number} id
- */
-AddEmojiCategoriesResponseEmojiCategoriesInner.prototype['id'] = undefined;
-
-/**
- * @member {String} name
- */
-AddEmojiCategoriesResponseEmojiCategoriesInner.prototype['name'] = undefined;
-
-/**
- * @member {String} url
- */
-AddEmojiCategoriesResponseEmojiCategoriesInner.prototype['url'] = undefined;
-var _default = AddEmojiCategoriesResponseEmojiCategoriesInner;
-exports["default"] = _default;
\ No newline at end of file
diff --git a/dist/model/AddEmojisData.js b/dist/model/AddEmojisData.js
deleted file mode 100644
index 2648861..0000000
--- a/dist/model/AddEmojisData.js
+++ /dev/null
@@ -1,77 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
- value: true
-});
-exports["default"] = void 0;
-var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-/**
- * The AddEmojisData model module.
- * @module model/AddEmojisData
- * @version 0.0.16
- */
-var AddEmojisData = /*#__PURE__*/function () {
- /**
- * Constructs a new AddEmojisData.
- * @alias module:model/AddEmojisData
- * @param emojiCategoryId {Number} Specifies the unique ID of the emoji category that a list of new emojis belong to.
- * @param emojis {Array.