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

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