@sendbird/sendbird-platform-sdk-typescript 2.1.5 → 2.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (821) hide show
  1. package/CHANGELOG +27 -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 +25 -0
  106. package/models/CreateAUserRequest.js +63 -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 -156
  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 -647
  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/SendBirdFile.ts +0 -71
  592. package/models/SendBirdGroupChannel.ts +0 -355
  593. package/models/SendBirdMember.ts +0 -187
  594. package/models/SendBirdMessageResponse.ts +0 -245
  595. package/models/SendBirdParentMessageInfo.ts +0 -79
  596. package/models/SendBirdUser.ts +0 -181
  597. package/models/SendFileMessageRequestBody.ts +0 -187
  598. package/models/SendTextMessageRequestBody.ts +0 -170
  599. package/models/SendTextMessageRequestBodyPushMessageTemplate.ts +0 -52
  600. package/models/SendbirdBasicUserInfo.ts +0 -87
  601. package/models/SendbirdDisappearingMessage.ts +0 -42
  602. package/models/SendbirdExtendedMessagePayload.ts +0 -51
  603. package/models/SendbirdGroupChannelDetail.ts +0 -266
  604. package/models/SendbirdGroupChannelDetailChannel.ts +0 -84
  605. package/models/SendbirdGroupChannelLastMessage.ts +0 -246
  606. package/models/SendbirdMessageResponseExtendedMessagePayload.ts +0 -49
  607. package/models/SendbirdMessageResponseMessageEvents.ts +0 -56
  608. package/models/SendbirdOpenChannel.ts +0 -120
  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 -135
  631. package/models/UpdatePushPreferencesRequestDndSchedulesInner.ts +0 -46
  632. package/models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.ts +0 -56
  633. package/models/UpdatePushPreferencesResponse.ts +0 -135
  634. package/models/UpdateSpecificUserMetadataRequest.ts +0 -35
  635. package/models/UpdateUserMetadataRequest.ts +0 -42
  636. package/models/ViewBotByIdResponse.ts +0 -71
  637. package/models/ViewBotByIdResponseBot.ts +0 -70
  638. package/models/ViewCountPreferenceOfAChannelResponse.ts +0 -38
  639. package/models/ViewNumberOfChannelsWithUnreadMessagesResponse.ts +0 -35
  640. package/models/ViewNumberOfDailyActiveUsersResponse.ts +0 -35
  641. package/models/ViewNumberOfMonthlyActiveUsersResponse.ts +0 -35
  642. package/models/ViewNumberOfUnreadMessagesResponse.ts +0 -35
  643. package/models/ViewPushPreferencesForAChannelResponse.ts +0 -50
  644. package/models/ViewPushPreferencesResponse.ts +0 -135
  645. package/models/all.ts +0 -130
  646. package/package.json-e +0 -40
  647. package/rxjsStub.ts +0 -27
  648. package/servers.ts +0 -53
  649. package/src/api/generated/.openapi-generator/FILES +0 -151
  650. package/src/api/generated/.openapi-generator/VERSION +0 -1
  651. package/src/api/generated/README.md +0 -30
  652. package/src/api/generated/apis/AnnouncementApi.ts +0 -96
  653. package/src/api/generated/apis/BotApi.ts +0 -471
  654. package/src/api/generated/apis/GroupChannelApi.ts +0 -1865
  655. package/src/api/generated/apis/MessageApi.ts +0 -1150
  656. package/src/api/generated/apis/MetadataApi.ts +0 -365
  657. package/src/api/generated/apis/ModerationApi.ts +0 -449
  658. package/src/api/generated/apis/OpenChannelApi.ts +0 -676
  659. package/src/api/generated/apis/StatisticsApi.ts +0 -155
  660. package/src/api/generated/apis/UserApi.ts +0 -2454
  661. package/src/api/generated/apis/baseapi.ts +0 -37
  662. package/src/api/generated/apis/exception.ts +0 -15
  663. package/src/api/generated/auth/auth.ts +0 -54
  664. package/src/api/generated/configuration.ts +0 -66
  665. package/src/api/generated/git_push.sh +0 -51
  666. package/src/api/generated/http/http.ts +0 -231
  667. package/src/api/generated/http/isomorphic-fetch.ts +0 -32
  668. package/src/api/generated/index.ts +0 -12
  669. package/src/api/generated/middleware.ts +0 -66
  670. package/src/api/generated/models/AcceptAnInvitationRequest.ts +0 -42
  671. package/src/api/generated/models/AddARegistrationOrDeviceTokenRequest.ts +0 -49
  672. package/src/api/generated/models/AddARegistrationOrDeviceTokenResponse.ts +0 -50
  673. package/src/api/generated/models/AddExtraDataToAMessageRequest.ts +0 -36
  674. package/src/api/generated/models/AddExtraDataToAMessageResponse.ts +0 -36
  675. package/src/api/generated/models/BlockAUserRequest.ts +0 -45
  676. package/src/api/generated/models/BlockAUserResponse.ts +0 -43
  677. package/src/api/generated/models/CheckIfMemberResponse.ts +0 -45
  678. package/src/api/generated/models/ChooseAPushNotificationContentTemplateRequest.ts +0 -41
  679. package/src/api/generated/models/ChooseAPushNotificationContentTemplateResponse.ts +0 -35
  680. package/src/api/generated/models/CreateABotRequest.ts +0 -100
  681. package/src/api/generated/models/CreateABotResponse.ts +0 -86
  682. package/src/api/generated/models/CreateABotResponseBot.ts +0 -91
  683. package/src/api/generated/models/CreateABotResponseBotStyle.ts +0 -57
  684. package/src/api/generated/models/CreateAChannelMetadataRequest.ts +0 -42
  685. package/src/api/generated/models/CreateAChannelMetadataResponse.ts +0 -42
  686. package/src/api/generated/models/CreateAGroupChannelRequest.ts +0 -171
  687. package/src/api/generated/models/CreateAUserRequest.ts +0 -80
  688. package/src/api/generated/models/CreateAnOpenChannelRequest.ts +0 -91
  689. package/src/api/generated/models/CreateUserTokenRequest.ts +0 -35
  690. package/src/api/generated/models/CreateUserTokenResponse.ts +0 -42
  691. package/src/api/generated/models/FreezeAGroupChannelRequest.ts +0 -35
  692. package/src/api/generated/models/FreezeAnOpenChannelRequest.ts +0 -38
  693. package/src/api/generated/models/GetAGroupChannelResponse.ts +0 -365
  694. package/src/api/generated/models/GetAGroupChannelResponseAllOf.ts +0 -36
  695. package/src/api/generated/models/GetAGroupChannelResponseAllOfChannel.ts +0 -84
  696. package/src/api/generated/models/GetChannelInvitationPreferenceResponse.ts +0 -35
  697. package/src/api/generated/models/GetTotalNumberOfMessagesInAChannelResponse.ts +0 -35
  698. package/src/api/generated/models/GroupChannelListMembersResponse.ts +0 -43
  699. package/src/api/generated/models/GroupChatListChannelsResponse.ts +0 -50
  700. package/src/api/generated/models/HideAChannelRequest.ts +0 -68
  701. package/src/api/generated/models/InviteAsMembersRequest.ts +0 -62
  702. package/src/api/generated/models/InviteAsMembersResponse.ts +0 -365
  703. package/src/api/generated/models/InviteAsMembersResponseAllOf.ts +0 -36
  704. package/src/api/generated/models/JoinAChannelRequest.ts +0 -48
  705. package/src/api/generated/models/JoinChannelsRequest.ts +0 -35
  706. package/src/api/generated/models/LeaveAChannelRequest.ts +0 -71
  707. package/src/api/generated/models/LeaveMyGroupChannelsRequest.ts +0 -35
  708. package/src/api/generated/models/ListBlockedUsersResponse.ts +0 -43
  709. package/src/api/generated/models/ListBotsResponse.ts +0 -43
  710. package/src/api/generated/models/ListBotsResponseBotsInner.ts +0 -110
  711. package/src/api/generated/models/ListBotsResponseBotsInnerAi.ts +0 -112
  712. package/src/api/generated/models/ListBotsResponseBotsInnerBot.ts +0 -84
  713. package/src/api/generated/models/ListBotsResponseBotsInnerBotStyle.ts +0 -57
  714. package/src/api/generated/models/ListBotsResponseBotsInnerBotStyleColor.ts +0 -49
  715. package/src/api/generated/models/ListBotsResponseBotsInnerFirstMessagesInner.ts +0 -43
  716. package/src/api/generated/models/ListBotsResponseBotsInnerFirstMessagesInnerData.ts +0 -35
  717. package/src/api/generated/models/ListBotsResponseBotsInnerSafeguard.ts +0 -56
  718. package/src/api/generated/models/ListMessagesResponse.ts +0 -36
  719. package/src/api/generated/models/ListMyGroupChannelsResponse.ts +0 -50
  720. package/src/api/generated/models/ListOpenChannelsResponse.ts +0 -50
  721. package/src/api/generated/models/ListOperatorsResponse.ts +0 -43
  722. package/src/api/generated/models/ListRegistrationOrDeviceTokensResponse.ts +0 -57
  723. package/src/api/generated/models/ListUsersResponse.ts +0 -43
  724. package/src/api/generated/models/MarkAllMessagesAsReadRequest.ts +0 -38
  725. package/src/api/generated/models/MarkChannelMessagesAsReadRequest.ts +0 -35
  726. package/src/api/generated/models/MigrateMessagesAdminMessageRequest.ts +0 -94
  727. package/src/api/generated/models/MigrateMessagesFileMessageRequest.ts +0 -130
  728. package/src/api/generated/models/MigrateMessagesFileMessageRequestThumbnailsInner.ts +0 -29
  729. package/src/api/generated/models/MigrateMessagesRequest.ts +0 -50
  730. package/src/api/generated/models/MigrateMessagesRequestMessagesInner.ts +0 -154
  731. package/src/api/generated/models/MigrateMessagesTextMessageRequest.ts +0 -94
  732. package/src/api/generated/models/ObjectSerializer.ts +0 -619
  733. package/src/api/generated/models/RegisterOperatorsToAGroupChannelRequest.ts +0 -35
  734. package/src/api/generated/models/RemoveARegistrationOrDeviceTokenResponse.ts +0 -43
  735. package/src/api/generated/models/RemoveAllRegistrationOrDeviceTokenResponse.ts +0 -43
  736. package/src/api/generated/models/ResetChatHistoryRequest.ts +0 -42
  737. package/src/api/generated/models/ResetChatHistoryResponse.ts +0 -38
  738. package/src/api/generated/models/ScheduleAnAnnouncementRequest.ts +0 -156
  739. package/src/api/generated/models/ScheduleAnAnnouncementRequestCreateChannelOptions.ts +0 -63
  740. package/src/api/generated/models/ScheduleAnAnnouncementRequestMessage.ts +0 -63
  741. package/src/api/generated/models/ScheduleAnAnnouncementResponse.ts +0 -198
  742. package/src/api/generated/models/ScheduleAnAnnouncementResponseMessage.ts +0 -70
  743. package/src/api/generated/models/SendABotMessageRequest.ts +0 -214
  744. package/src/api/generated/models/SendABotMessageResponse.ts +0 -36
  745. package/src/api/generated/models/SendAMessageRequest.ts +0 -238
  746. package/src/api/generated/models/SendAMessageRequestPushMessageTemplate.ts +0 -52
  747. package/src/api/generated/models/SendAMessageRequestPushMessageTemplateOneOf.ts +0 -48
  748. package/src/api/generated/models/SendAdminMessageRequestBody.ts +0 -121
  749. package/src/api/generated/models/SendFileMessageRequestBody.ts +0 -187
  750. package/src/api/generated/models/SendTextMessageRequestBody.ts +0 -170
  751. package/src/api/generated/models/SendTextMessageRequestBodyPushMessageTemplate.ts +0 -52
  752. package/src/api/generated/models/SendbirdBasicUserInfo.ts +0 -87
  753. package/src/api/generated/models/SendbirdDisappearingMessage.ts +0 -42
  754. package/src/api/generated/models/SendbirdExtendedMessagePayload.ts +0 -51
  755. package/src/api/generated/models/SendbirdFile.ts +0 -71
  756. package/src/api/generated/models/SendbirdGroupChannel.ts +0 -355
  757. package/src/api/generated/models/SendbirdGroupChannelDetail.ts +0 -266
  758. package/src/api/generated/models/SendbirdGroupChannelDetailChannel.ts +0 -84
  759. package/src/api/generated/models/SendbirdMember.ts +0 -187
  760. package/src/api/generated/models/SendbirdMessageResponse.ts +0 -245
  761. package/src/api/generated/models/SendbirdMessageResponseMessageEvents.ts +0 -56
  762. package/src/api/generated/models/SendbirdOpenChannel.ts +0 -120
  763. package/src/api/generated/models/SendbirdParentMessageInfo.ts +0 -79
  764. package/src/api/generated/models/SendbirdPushTriggerOption.ts +0 -15
  765. package/src/api/generated/models/SendbirdReaction.ts +0 -49
  766. package/src/api/generated/models/SendbirdSmsFallback.ts +0 -42
  767. package/src/api/generated/models/SendbirdSortedMetaarrayInner.ts +0 -42
  768. package/src/api/generated/models/SendbirdThumbnail.ts +0 -70
  769. package/src/api/generated/models/SendbirdUser.ts +0 -188
  770. package/src/api/generated/models/StartTypingIndicatorsRequest.ts +0 -35
  771. package/src/api/generated/models/UpdateAChannelMetadataRequest.ts +0 -42
  772. package/src/api/generated/models/UpdateAGroupChannelRequest.ts +0 -98
  773. package/src/api/generated/models/UpdateAMessageRequest.ts +0 -80
  774. package/src/api/generated/models/UpdateAUserRequest.ts +0 -91
  775. package/src/api/generated/models/UpdateAnOpenChannelRequest.ts +0 -70
  776. package/src/api/generated/models/UpdateChannelInvitationPreferenceRequest.ts +0 -35
  777. package/src/api/generated/models/UpdateChannelInvitationPreferenceResponse.ts +0 -35
  778. package/src/api/generated/models/UpdateCountPreferenceOfAChannelRequest.ts +0 -38
  779. package/src/api/generated/models/UpdateCountPreferenceOfChannelByUrlResponse.ts +0 -38
  780. package/src/api/generated/models/UpdateExtraDataInAMessageRequest.ts +0 -50
  781. package/src/api/generated/models/UpdateExtraDataInAMessageResponse.ts +0 -36
  782. package/src/api/generated/models/UpdatePushPreferencesForAChannelRequest.ts +0 -48
  783. package/src/api/generated/models/UpdatePushPreferencesForAChannelResponse.ts +0 -50
  784. package/src/api/generated/models/UpdatePushPreferencesRequest.ts +0 -127
  785. package/src/api/generated/models/UpdatePushPreferencesResponse.ts +0 -127
  786. package/src/api/generated/models/ViewCountPreferenceOfAChannelResponse.ts +0 -38
  787. package/src/api/generated/models/ViewNumberOfChannelsWithUnreadMessagesResponse.ts +0 -35
  788. package/src/api/generated/models/ViewNumberOfDailyActiveUsersResponse.ts +0 -35
  789. package/src/api/generated/models/ViewNumberOfMonthlyActiveUsersResponse.ts +0 -35
  790. package/src/api/generated/models/ViewNumberOfUnreadMessagesResponse.ts +0 -35
  791. package/src/api/generated/models/ViewPushPreferencesForAChannelResponse.ts +0 -50
  792. package/src/api/generated/models/ViewPushPreferencesResponse.ts +0 -127
  793. package/src/api/generated/models/all.ts +0 -121
  794. package/src/api/generated/package.json +0 -40
  795. package/src/api/generated/rxjsStub.ts +0 -27
  796. package/src/api/generated/servers.ts +0 -53
  797. package/src/api/generated/tsconfig.json +0 -28
  798. package/src/api/generated/types/ObjectParamAPI.ts +0 -3611
  799. package/src/api/generated/types/ObservableAPI.ts +0 -2594
  800. package/src/api/generated/types/PromiseAPI.ts +0 -1440
  801. package/src/api/generated/util.ts +0 -37
  802. package/src/types/FileCompat.ts +0 -7
  803. package/tests/asset/image/test_20kb.jpg +0 -0
  804. package/tests/asset/image/test_25mb.bmp +0 -0
  805. package/tests/asset/image/test_5mb.jpg +0 -0
  806. package/tests/asset/image/test_75kb.jpg +0 -0
  807. package/tests/integration/bot.test.ts +0 -548
  808. package/tests/integration/constants.ts +0 -10
  809. package/tests/integration/groupChannel.test.ts +0 -1624
  810. package/tests/integration/helper.ts +0 -8
  811. package/tests/integration/metadata.test.ts +0 -22
  812. package/tests/integration/moderation.test.ts +0 -172
  813. package/tests/integration/openChannel.test.ts +0 -239
  814. package/tests/integration/statistics.test.ts +0 -44
  815. package/tests/integration/user.test.ts +0 -957
  816. package/tests/utils/fileLoader.ts +0 -46
  817. package/tsconfig.json +0 -29
  818. package/types/ObjectParamAPI.ts +0 -3998
  819. package/types/ObservableAPI.ts +0 -2855
  820. package/types/PromiseAPI.ts +0 -1575
  821. package/util.ts +0 -37
@@ -1,3998 +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 { UpdatePushPreferencesRequestDndSchedulesInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInner';
122
- import { UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
123
- import { UpdatePushPreferencesResponse } from '../models/UpdatePushPreferencesResponse';
124
- import { UpdateSpecificUserMetadataRequest } from '../models/UpdateSpecificUserMetadataRequest';
125
- import { UpdateUserMetadataRequest } from '../models/UpdateUserMetadataRequest';
126
- import { ViewBotByIdResponse } from '../models/ViewBotByIdResponse';
127
- import { ViewBotByIdResponseBot } from '../models/ViewBotByIdResponseBot';
128
- import { ViewCountPreferenceOfAChannelResponse } from '../models/ViewCountPreferenceOfAChannelResponse';
129
- import { ViewNumberOfChannelsWithUnreadMessagesResponse } from '../models/ViewNumberOfChannelsWithUnreadMessagesResponse';
130
- import { ViewNumberOfDailyActiveUsersResponse } from '../models/ViewNumberOfDailyActiveUsersResponse';
131
- import { ViewNumberOfMonthlyActiveUsersResponse } from '../models/ViewNumberOfMonthlyActiveUsersResponse';
132
- import { ViewNumberOfUnreadMessagesResponse } from '../models/ViewNumberOfUnreadMessagesResponse';
133
- import { ViewPushPreferencesForAChannelResponse } from '../models/ViewPushPreferencesForAChannelResponse';
134
- import { ViewPushPreferencesResponse } from '../models/ViewPushPreferencesResponse';
135
-
136
- import { ObservableAnnouncementApi } from "./ObservableAPI";
137
- import { AnnouncementApiRequestFactory, AnnouncementApiResponseProcessor} from "../apis/AnnouncementApi";
138
-
139
- export interface AnnouncementApiScheduleAnAnnouncementRequest {
140
- /**
141
- *
142
- * @type string
143
- * @memberof AnnouncementApischeduleAnAnnouncement
144
- */
145
- apiToken?: string
146
- /**
147
- *
148
- * @type ScheduleAnAnnouncementRequest
149
- * @memberof AnnouncementApischeduleAnAnnouncement
150
- */
151
- scheduleAnAnnouncementRequest?: ScheduleAnAnnouncementRequest
152
- }
153
-
154
- export class ObjectAnnouncementApi {
155
- private api: ObservableAnnouncementApi
156
-
157
- public constructor(configuration: Configuration, requestFactory?: AnnouncementApiRequestFactory, responseProcessor?: AnnouncementApiResponseProcessor) {
158
- this.api = new ObservableAnnouncementApi(configuration, requestFactory, responseProcessor);
159
- }
160
-
161
- /**
162
- * ## 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)
163
- * Schedule an announcement
164
- * @param param the request object
165
- */
166
- public scheduleAnAnnouncement(param: AnnouncementApiScheduleAnAnnouncementRequest = {}, options?: Configuration): Promise<ScheduleAnAnnouncementResponse> {
167
- return this.api.scheduleAnAnnouncement(param.apiToken, param.scheduleAnAnnouncementRequest, options).toPromise();
168
- }
169
-
170
- }
171
-
172
- import { ObservableBotApi } from "./ObservableAPI";
173
- import { BotApiRequestFactory, BotApiResponseProcessor} from "../apis/BotApi";
174
-
175
- export interface BotApiCreateABotRequest {
176
- /**
177
- *
178
- * @type string
179
- * @memberof BotApicreateABot
180
- */
181
- apiToken?: string
182
- /**
183
- *
184
- * @type CreateABotRequest
185
- * @memberof BotApicreateABot
186
- */
187
- createABotRequest?: CreateABotRequest
188
- }
189
-
190
- export interface BotApiDeleteBotByIdRequest {
191
- /**
192
- *
193
- * @type string
194
- * @memberof BotApideleteBotById
195
- */
196
- botUserid: string
197
- /**
198
- *
199
- * @type string
200
- * @memberof BotApideleteBotById
201
- */
202
- apiToken?: string
203
- }
204
-
205
- export interface BotApiJoinChannelsRequest {
206
- /**
207
- * (Required)
208
- * @type string
209
- * @memberof BotApijoinChannels
210
- */
211
- botUserid: string
212
- /**
213
- *
214
- * @type string
215
- * @memberof BotApijoinChannels
216
- */
217
- apiToken?: string
218
- /**
219
- *
220
- * @type JoinChannelsRequest
221
- * @memberof BotApijoinChannels
222
- */
223
- joinChannelsRequest?: JoinChannelsRequest
224
- }
225
-
226
- export interface BotApiLeaveAGroupChannelRequest {
227
- /**
228
- *
229
- * @type string
230
- * @memberof BotApileaveAGroupChannel
231
- */
232
- channelUrl: string
233
- /**
234
- * (Required)
235
- * @type string
236
- * @memberof BotApileaveAGroupChannel
237
- */
238
- botUserid: string
239
- /**
240
- *
241
- * @type string
242
- * @memberof BotApileaveAGroupChannel
243
- */
244
- apiToken?: string
245
- }
246
-
247
- export interface BotApiLeaveGroupChannelsRequest {
248
- /**
249
- * (Required)
250
- * @type string
251
- * @memberof BotApileaveGroupChannels
252
- */
253
- botUserid: string
254
- /**
255
- *
256
- * @type string
257
- * @memberof BotApileaveGroupChannels
258
- */
259
- apiToken?: string
260
- }
261
-
262
- export interface BotApiListBotsRequest {
263
- /**
264
- *
265
- * @type string
266
- * @memberof BotApilistBots
267
- */
268
- token?: string
269
- /**
270
- *
271
- * @type number
272
- * @memberof BotApilistBots
273
- */
274
- limit?: number
275
- /**
276
- *
277
- * @type string
278
- * @memberof BotApilistBots
279
- */
280
- apiToken?: string
281
- }
282
-
283
- export interface BotApiSendABotMessageRequest {
284
- /**
285
- * (Required)
286
- * @type string
287
- * @memberof BotApisendABotMessage
288
- */
289
- botUserid: string
290
- /**
291
- * Specifies the type of message to send. MESG for text message, FILE for file message.
292
- * @type string
293
- * @memberof BotApisendABotMessage
294
- */
295
- messageType: string
296
- /**
297
- * Specifies the URL of the channel to send the message to.
298
- * @type string
299
- * @memberof BotApisendABotMessage
300
- */
301
- channelUrl: string
302
- /**
303
- *
304
- * @type string
305
- * @memberof BotApisendABotMessage
306
- */
307
- apiToken?: string
308
- /**
309
- * Specifies the content of the message. * This property is required when message_type is MESG.
310
- * @type string
311
- * @memberof BotApisendABotMessage
312
- */
313
- message?: string
314
- /**
315
- * * This property is available when message_type is MESG.
316
- * @type Array&lt;string&gt;
317
- * @memberof BotApisendABotMessage
318
- */
319
- mentioned?: Array<string>
320
- /**
321
- *
322
- * @type SendbirdExtendedMessagePayload
323
- * @memberof BotApisendABotMessage
324
- */
325
- extendedMessagePayload?: SendbirdExtendedMessagePayload
326
- /**
327
- * 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.
328
- * @type HttpFile
329
- * @memberof BotApisendABotMessage
330
- */
331
- file?: HttpFile
332
- /**
333
- * 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.
334
- * @type boolean
335
- * @memberof BotApisendABotMessage
336
- */
337
- requireAuth?: boolean
338
- /**
339
- * * This property is available when message_type is FILE.
340
- * @type string
341
- * @memberof BotApisendABotMessage
342
- */
343
- mentionType?: string
344
- /**
345
- * * This property is available when message_type is FILE.
346
- * @type Array&lt;string&gt;
347
- * @memberof BotApisendABotMessage
348
- */
349
- mentionedUserIds?: Array<string>
350
- /**
351
- * * This property is available when message_type is FILE.
352
- * @type boolean
353
- * @memberof BotApisendABotMessage
354
- */
355
- isSilent?: boolean
356
- /**
357
- *
358
- * @type Array&lt;SendbirdSortedMetaarrayInner&gt;
359
- * @memberof BotApisendABotMessage
360
- */
361
- sortedMetaarray?: Array<SendbirdSortedMetaarrayInner>
362
- /**
363
- * * This property is available when message_type is FILE.
364
- * @type string
365
- * @memberof BotApisendABotMessage
366
- */
367
- apnsBundleId?: string
368
- /**
369
- * * This property is available when message_type is FILE.
370
- * @type any
371
- * @memberof BotApisendABotMessage
372
- */
373
- appleCriticalAlertOptions?: any
374
- /**
375
- * * This property is available when message_type is FILE.
376
- * @type string
377
- * @memberof BotApisendABotMessage
378
- */
379
- sound?: string
380
- /**
381
- * * This property is available when message_type is FILE.
382
- * @type number
383
- * @memberof BotApisendABotMessage
384
- */
385
- volume?: number
386
- /**
387
- *
388
- * @type number
389
- * @memberof BotApisendABotMessage
390
- */
391
- createdAt?: number
392
- /**
393
- *
394
- * @type string
395
- * @memberof BotApisendABotMessage
396
- */
397
- customType?: string
398
- /**
399
- *
400
- * @type string
401
- * @memberof BotApisendABotMessage
402
- */
403
- data?: string
404
- /**
405
- *
406
- * @type string
407
- * @memberof BotApisendABotMessage
408
- */
409
- dedupId?: string
410
- /**
411
- *
412
- * @type boolean
413
- * @memberof BotApisendABotMessage
414
- */
415
- markAsRead?: boolean
416
- /**
417
- *
418
- * @type boolean
419
- * @memberof BotApisendABotMessage
420
- */
421
- sendPush?: boolean
422
- }
423
-
424
- export interface BotApiUpdateBotByIdRequest {
425
- /**
426
- *
427
- * @type string
428
- * @memberof BotApiupdateBotById
429
- */
430
- botUserid: string
431
- /**
432
- *
433
- * @type string
434
- * @memberof BotApiupdateBotById
435
- */
436
- apiToken?: string
437
- /**
438
- *
439
- * @type UpdateBotByIdData
440
- * @memberof BotApiupdateBotById
441
- */
442
- updateBotByIdData?: UpdateBotByIdData
443
- }
444
-
445
- export interface BotApiViewBotByIdRequest {
446
- /**
447
- *
448
- * @type string
449
- * @memberof BotApiviewBotById
450
- */
451
- botUserid: string
452
- /**
453
- *
454
- * @type string
455
- * @memberof BotApiviewBotById
456
- */
457
- apiToken?: string
458
- }
459
-
460
- export class ObjectBotApi {
461
- private api: ObservableBotApi
462
-
463
- public constructor(configuration: Configuration, requestFactory?: BotApiRequestFactory, responseProcessor?: BotApiResponseProcessor) {
464
- this.api = new ObservableBotApi(configuration, requestFactory, responseProcessor);
465
- }
466
-
467
- /**
468
- * ## 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)
469
- * Create a bot
470
- * @param param the request object
471
- */
472
- public createABot(param: BotApiCreateABotRequest = {}, options?: Configuration): Promise<CreateABotResponse> {
473
- return this.api.createABot(param.apiToken, param.createABotRequest, options).toPromise();
474
- }
475
-
476
- /**
477
- * ## Delete a bot Deletes a bot from an application. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-delete-a-bot ----------------------------
478
- * Delete a bot
479
- * @param param the request object
480
- */
481
- public deleteBotById(param: BotApiDeleteBotByIdRequest, options?: Configuration): Promise<any> {
482
- return this.api.deleteBotById(param.botUserid, param.apiToken, options).toPromise();
483
- }
484
-
485
- /**
486
- * ## 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)
487
- * Join channels
488
- * @param param the request object
489
- */
490
- public joinChannels(param: BotApiJoinChannelsRequest, options?: Configuration): Promise<SendbirdGroupChannelDetail> {
491
- return this.api.joinChannels(param.botUserid, param.apiToken, param.joinChannelsRequest, options).toPromise();
492
- }
493
-
494
- /**
495
- * ## 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)
496
- * Leave channels - When leaving a specific channel
497
- * @param param the request object
498
- */
499
- public leaveAGroupChannel(param: BotApiLeaveAGroupChannelRequest, options?: Configuration): Promise<any> {
500
- return this.api.leaveAGroupChannel(param.channelUrl, param.botUserid, param.apiToken, options).toPromise();
501
- }
502
-
503
- /**
504
- * ## 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)
505
- * Leave channels - When leaving all channels
506
- * @param param the request object
507
- */
508
- public leaveGroupChannels(param: BotApiLeaveGroupChannelsRequest, options?: Configuration): Promise<any> {
509
- return this.api.leaveGroupChannels(param.botUserid, param.apiToken, options).toPromise();
510
- }
511
-
512
- /**
513
- * ## 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
514
- * List bots
515
- * @param param the request object
516
- */
517
- public listBots(param: BotApiListBotsRequest = {}, options?: Configuration): Promise<ListBotsResponse> {
518
- return this.api.listBots(param.token, param.limit, param.apiToken, options).toPromise();
519
- }
520
-
521
- /**
522
- * ## 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.
523
- * Send a bot's message
524
- * @param param the request object
525
- */
526
- public sendABotMessage(param: BotApiSendABotMessageRequest, options?: Configuration): Promise<SendABotMessageResponse> {
527
- return this.api.sendABotMessage(param.botUserid, param.messageType, param.channelUrl, param.apiToken, param.message, param.mentioned, param.extendedMessagePayload, param.file, param.requireAuth, param.mentionType, param.mentionedUserIds, param.isSilent, param.sortedMetaarray, param.apnsBundleId, param.appleCriticalAlertOptions, param.sound, param.volume, param.createdAt, param.customType, param.data, param.dedupId, param.markAsRead, param.sendPush, options).toPromise();
528
- }
529
-
530
- /**
531
- * ## Update a bot Updates information on a bot. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-update-a-bot ----------------------------
532
- * Update a bot
533
- * @param param the request object
534
- */
535
- public updateBotById(param: BotApiUpdateBotByIdRequest, options?: Configuration): Promise<UpdateBotByIdResponse> {
536
- return this.api.updateBotById(param.botUserid, param.apiToken, param.updateBotByIdData, options).toPromise();
537
- }
538
-
539
- /**
540
- * ## View a bot Retrieves information on a bot. https://sendbird.com/docs/chat/v3/platform-api/guides/bot-interface#2-view-a-bot ----------------------------
541
- * View a bot
542
- * @param param the request object
543
- */
544
- public viewBotById(param: BotApiViewBotByIdRequest, options?: Configuration): Promise<ViewBotByIdResponse> {
545
- return this.api.viewBotById(param.botUserid, param.apiToken, options).toPromise();
546
- }
547
-
548
- }
549
-
550
- import { ObservableGroupChannelApi } from "./ObservableAPI";
551
- import { GroupChannelApiRequestFactory, GroupChannelApiResponseProcessor} from "../apis/GroupChannelApi";
552
-
553
- export interface GroupChannelApiAcceptAnInvitationRequest {
554
- /**
555
- * (Required)
556
- * @type string
557
- * @memberof GroupChannelApiacceptAnInvitation
558
- */
559
- channelUrl: string
560
- /**
561
- *
562
- * @type string
563
- * @memberof GroupChannelApiacceptAnInvitation
564
- */
565
- apiToken?: string
566
- /**
567
- *
568
- * @type AcceptAnInvitationRequest
569
- * @memberof GroupChannelApiacceptAnInvitation
570
- */
571
- acceptAnInvitationRequest?: AcceptAnInvitationRequest
572
- }
573
-
574
- export interface GroupChannelApiCancelTheRegistrationOfOperatorsRequest {
575
- /**
576
- * (Required)
577
- * @type string
578
- * @memberof GroupChannelApicancelTheRegistrationOfOperators
579
- */
580
- channelUrl: string
581
- /**
582
- * 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.
583
- * @type string
584
- * @memberof GroupChannelApicancelTheRegistrationOfOperators
585
- */
586
- operatorIds: string
587
- /**
588
- *
589
- * @type boolean
590
- * @memberof GroupChannelApicancelTheRegistrationOfOperators
591
- */
592
- deleteAll?: boolean
593
- /**
594
- *
595
- * @type string
596
- * @memberof GroupChannelApicancelTheRegistrationOfOperators
597
- */
598
- apiToken?: string
599
- }
600
-
601
- export interface GroupChannelApiCheckIfMemberRequest {
602
- /**
603
- * (Required)
604
- * @type string
605
- * @memberof GroupChannelApicheckIfMember
606
- */
607
- channelUrl: string
608
- /**
609
- * (Required)
610
- * @type string
611
- * @memberof GroupChannelApicheckIfMember
612
- */
613
- userId: string
614
- /**
615
- *
616
- * @type string
617
- * @memberof GroupChannelApicheckIfMember
618
- */
619
- apiToken?: string
620
- }
621
-
622
- export interface GroupChannelApiCreateAGroupChannelRequest {
623
- /**
624
- *
625
- * @type string
626
- * @memberof GroupChannelApicreateAGroupChannel
627
- */
628
- apiToken?: string
629
- /**
630
- *
631
- * @type CreateAGroupChannelRequest
632
- * @memberof GroupChannelApicreateAGroupChannel
633
- */
634
- createAGroupChannelRequest?: CreateAGroupChannelRequest
635
- }
636
-
637
- export interface GroupChannelApiDeleteAGroupChannelRequest {
638
- /**
639
- *
640
- * @type string
641
- * @memberof GroupChannelApideleteAGroupChannel
642
- */
643
- channelUrl: string
644
- /**
645
- *
646
- * @type string
647
- * @memberof GroupChannelApideleteAGroupChannel
648
- */
649
- apiToken?: string
650
- }
651
-
652
- export interface GroupChannelApiGetAGroupChannelRequest {
653
- /**
654
- *
655
- * @type string
656
- * @memberof GroupChannelApigetAGroupChannel
657
- */
658
- channelUrl: string
659
- /**
660
- *
661
- * @type boolean
662
- * @memberof GroupChannelApigetAGroupChannel
663
- */
664
- showDeliveryReceipt?: boolean
665
- /**
666
- *
667
- * @type boolean
668
- * @memberof GroupChannelApigetAGroupChannel
669
- */
670
- showReadReceipt?: boolean
671
- /**
672
- *
673
- * @type boolean
674
- * @memberof GroupChannelApigetAGroupChannel
675
- */
676
- showMember?: boolean
677
- /**
678
- * 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)
679
- * @type &#39;all&#39; | &#39;activated&#39; | &#39;deactivated&#39;
680
- * @memberof GroupChannelApigetAGroupChannel
681
- */
682
- memberActiveMode?: 'all' | 'activated' | 'deactivated'
683
- /**
684
- *
685
- * @type string
686
- * @memberof GroupChannelApigetAGroupChannel
687
- */
688
- userId?: string
689
- /**
690
- *
691
- * @type string
692
- * @memberof GroupChannelApigetAGroupChannel
693
- */
694
- apiToken?: string
695
- }
696
-
697
- export interface GroupChannelApiHideAChannelRequest {
698
- /**
699
- * (Required)
700
- * @type string
701
- * @memberof GroupChannelApihideAChannel
702
- */
703
- channelUrl: string
704
- /**
705
- *
706
- * @type string
707
- * @memberof GroupChannelApihideAChannel
708
- */
709
- apiToken?: string
710
- /**
711
- *
712
- * @type HideAChannelRequest
713
- * @memberof GroupChannelApihideAChannel
714
- */
715
- hideAChannelRequest?: HideAChannelRequest
716
- }
717
-
718
- export interface GroupChannelApiInviteAsMembersRequest {
719
- /**
720
- * (Required)
721
- * @type string
722
- * @memberof GroupChannelApiinviteAsMembers
723
- */
724
- channelUrl: string
725
- /**
726
- *
727
- * @type string
728
- * @memberof GroupChannelApiinviteAsMembers
729
- */
730
- apiToken?: string
731
- /**
732
- *
733
- * @type InviteAsMembersRequest
734
- * @memberof GroupChannelApiinviteAsMembers
735
- */
736
- inviteAsMembersRequest?: InviteAsMembersRequest
737
- }
738
-
739
- export interface GroupChannelApiJoinAChannelRequest {
740
- /**
741
- * (Required)
742
- * @type string
743
- * @memberof GroupChannelApijoinAChannel
744
- */
745
- channelUrl: string
746
- /**
747
- *
748
- * @type string
749
- * @memberof GroupChannelApijoinAChannel
750
- */
751
- apiToken?: string
752
- /**
753
- *
754
- * @type JoinAChannelRequest
755
- * @memberof GroupChannelApijoinAChannel
756
- */
757
- joinAChannelRequest?: JoinAChannelRequest
758
- }
759
-
760
- export interface GroupChannelApiLeaveAChannelRequest {
761
- /**
762
- *
763
- * @type string
764
- * @memberof GroupChannelApileaveAChannel
765
- */
766
- channelUrl: string
767
- /**
768
- *
769
- * @type string
770
- * @memberof GroupChannelApileaveAChannel
771
- */
772
- apiToken?: string
773
- /**
774
- *
775
- * @type LeaveAChannelRequest
776
- * @memberof GroupChannelApileaveAChannel
777
- */
778
- leaveAChannelRequest?: LeaveAChannelRequest
779
- }
780
-
781
- export interface GroupChannelApiListChannelsRequest {
782
- /**
783
- *
784
- * @type string
785
- * @memberof GroupChannelApilistChannels
786
- */
787
- apiToken: string
788
- /**
789
- * Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
790
- * @type string
791
- * @memberof GroupChannelApilistChannels
792
- */
793
- token?: string
794
- /**
795
- * Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
796
- * @type number
797
- * @memberof GroupChannelApilistChannels
798
- */
799
- limit?: number
800
- /**
801
- *
802
- * @type &#39;all&#39; | &#39;distinct&#39; | &#39;nondistinct&#39;
803
- * @memberof GroupChannelApilistChannels
804
- */
805
- distinctMode?: 'all' | 'distinct' | 'nondistinct'
806
- /**
807
- *
808
- * @type &#39;all&#39; | &#39;private&#39; | &#39;public&#39;
809
- * @memberof GroupChannelApilistChannels
810
- */
811
- publicMode?: 'all' | 'private' | 'public'
812
- /**
813
- *
814
- * @type &#39;all&#39; | &#39;super&#39; | &#39;nonsuper&#39;
815
- * @memberof GroupChannelApilistChannels
816
- */
817
- superMode?: 'all' | 'super' | 'nonsuper'
818
- /**
819
- * Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
820
- * @type number
821
- * @memberof GroupChannelApilistChannels
822
- */
823
- createdAfter?: number
824
- /**
825
- * Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
826
- * @type number
827
- * @memberof GroupChannelApilistChannels
828
- */
829
- createdBefore?: number
830
- /**
831
- *
832
- * @type boolean
833
- * @memberof GroupChannelApilistChannels
834
- */
835
- showEmpty?: boolean
836
- /**
837
- *
838
- * @type boolean
839
- * @memberof GroupChannelApilistChannels
840
- */
841
- showMember?: boolean
842
- /**
843
- *
844
- * @type boolean
845
- * @memberof GroupChannelApilistChannels
846
- */
847
- showDeliveryReceipt?: boolean
848
- /**
849
- *
850
- * @type boolean
851
- * @memberof GroupChannelApilistChannels
852
- */
853
- showReadReceipt?: boolean
854
- /**
855
- *
856
- * @type boolean
857
- * @memberof GroupChannelApilistChannels
858
- */
859
- showMetadata?: boolean
860
- /**
861
- *
862
- * @type boolean
863
- * @memberof GroupChannelApilistChannels
864
- */
865
- showFrozen?: boolean
866
- /**
867
- *
868
- * @type &#39;chronological&#39; | &#39;latest_last_message&#39; | &#39;channel_name_alphabetical&#39; | &#39;metadata_value_alphabetical&#39;
869
- * @memberof GroupChannelApilistChannels
870
- */
871
- order?: 'chronological' | 'latest_last_message' | 'channel_name_alphabetical' | 'metadata_value_alphabetical'
872
- /**
873
- * 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.
874
- * @type string
875
- * @memberof GroupChannelApilistChannels
876
- */
877
- metadataOrderKey?: string
878
- /**
879
- * 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.
880
- * @type string
881
- * @memberof GroupChannelApilistChannels
882
- */
883
- customTypes?: string
884
- /**
885
- * Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
886
- * @type string
887
- * @memberof GroupChannelApilistChannels
888
- */
889
- customTypeStartswith?: string
890
- /**
891
- * Specifies a comma-separated string of one or more group channel URLs to restrict the search scope. URL encoding each channel URL is recommended.
892
- * @type string
893
- * @memberof GroupChannelApilistChannels
894
- */
895
- channelUrls?: string
896
- /**
897
- * Specifies one or more group channel names.
898
- * @type string
899
- * @memberof GroupChannelApilistChannels
900
- */
901
- name?: string
902
- /**
903
- * Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
904
- * @type string
905
- * @memberof GroupChannelApilistChannels
906
- */
907
- nameContains?: string
908
- /**
909
- * Searches for group channels whose names start with the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
910
- * @type string
911
- * @memberof GroupChannelApilistChannels
912
- */
913
- nameStartswith?: string
914
- /**
915
- * 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.
916
- * @type string
917
- * @memberof GroupChannelApilistChannels
918
- */
919
- membersExactlyIn?: string
920
- /**
921
- * 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.
922
- * @type string
923
- * @memberof GroupChannelApilistChannels
924
- */
925
- membersIncludeIn?: string
926
- /**
927
- * 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)
928
- * @type string
929
- * @memberof GroupChannelApilistChannels
930
- */
931
- queryType?: string
932
- /**
933
- * Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
934
- * @type string
935
- * @memberof GroupChannelApilistChannels
936
- */
937
- membersNickname?: string
938
- /**
939
- * 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.
940
- * @type string
941
- * @memberof GroupChannelApilistChannels
942
- */
943
- membersNicknameContains?: string
944
- /**
945
- * 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.
946
- * @type string
947
- * @memberof GroupChannelApilistChannels
948
- */
949
- metadataKey?: string
950
- /**
951
- * 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.
952
- * @type string
953
- * @memberof GroupChannelApilistChannels
954
- */
955
- metadataValues?: string
956
- /**
957
- * 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.
958
- * @type string
959
- * @memberof GroupChannelApilistChannels
960
- */
961
- metadataValueStartswith?: string
962
- /**
963
- * 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.
964
- * @type string
965
- * @memberof GroupChannelApilistChannels
966
- */
967
- metacounterKey?: string
968
- /**
969
- * 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.
970
- * @type string
971
- * @memberof GroupChannelApilistChannels
972
- */
973
- metacounterValues?: string
974
- /**
975
- * 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.
976
- * @type string
977
- * @memberof GroupChannelApilistChannels
978
- */
979
- metacounterValueGt?: string
980
- /**
981
- * 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.
982
- * @type string
983
- * @memberof GroupChannelApilistChannels
984
- */
985
- metacounterValueGte?: string
986
- /**
987
- * 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.
988
- * @type string
989
- * @memberof GroupChannelApilistChannels
990
- */
991
- metacounterValueLt?: string
992
- /**
993
- * 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.
994
- * @type string
995
- * @memberof GroupChannelApilistChannels
996
- */
997
- metacounterValueLte?: string
998
- /**
999
- * Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
1000
- * @type boolean
1001
- * @memberof GroupChannelApilistChannels
1002
- */
1003
- includeSortedMetaarrayInLastMessage?: boolean
1004
- }
1005
-
1006
- export interface GroupChannelApiListMembersRequest {
1007
- /**
1008
- * (Required)
1009
- * @type string
1010
- * @memberof GroupChannelApilistMembers
1011
- */
1012
- channelUrl: string
1013
- /**
1014
- *
1015
- * @type string
1016
- * @memberof GroupChannelApilistMembers
1017
- */
1018
- token?: string
1019
- /**
1020
- * Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
1021
- * @type number
1022
- * @memberof GroupChannelApilistMembers
1023
- */
1024
- limit?: number
1025
- /**
1026
- * 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.
1027
- * @type string
1028
- * @memberof GroupChannelApilistMembers
1029
- */
1030
- userId?: string
1031
- /**
1032
- *
1033
- * @type boolean
1034
- * @memberof GroupChannelApilistMembers
1035
- */
1036
- showDeliveryReceipt?: boolean
1037
- /**
1038
- *
1039
- * @type boolean
1040
- * @memberof GroupChannelApilistMembers
1041
- */
1042
- showReadReceipt?: boolean
1043
- /**
1044
- *
1045
- * @type boolean
1046
- * @memberof GroupChannelApilistMembers
1047
- */
1048
- showMemberIsMuted?: boolean
1049
- /**
1050
- * 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.
1051
- * @type &#39;member_nickname_alphabetical&#39; | &#39;operator_then_member_alphabetical&#39;
1052
- * @memberof GroupChannelApilistMembers
1053
- */
1054
- order?: 'member_nickname_alphabetical' | 'operator_then_member_alphabetical'
1055
- /**
1056
- * 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.
1057
- * @type &#39;all&#39; | &#39;operator&#39; | &#39;nonoperator&#39;
1058
- * @memberof GroupChannelApilistMembers
1059
- */
1060
- operatorFilter?: 'all' | 'operator' | 'nonoperator'
1061
- /**
1062
- * 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;)
1063
- * @type &#39;all&#39; | &#39;invited_only&#39; | &#39;joined_only&#39; | &#39;invited_by_friend&#39; | &#39;invited_by_non_friend&#39;
1064
- * @memberof GroupChannelApilistMembers
1065
- */
1066
- memberStateFilter?: 'all' | 'invited_only' | 'joined_only' | 'invited_by_friend' | 'invited_by_non_friend'
1067
- /**
1068
- * 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;)
1069
- * @type &#39;all&#39; | &#39;muted&#39; | &#39;unmuted&#39;
1070
- * @memberof GroupChannelApilistMembers
1071
- */
1072
- mutedMemberFilter?: 'all' | 'muted' | 'unmuted'
1073
- /**
1074
- * 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;)
1075
- * @type &#39;activated&#39; | &#39;deactivated&#39;
1076
- * @memberof GroupChannelApilistMembers
1077
- */
1078
- memberActiveModeFilter?: 'activated' | 'deactivated'
1079
- /**
1080
- * Searches for members whose nicknames start with the specified value. Urlencoding the value is recommended.
1081
- * @type string
1082
- * @memberof GroupChannelApilistMembers
1083
- */
1084
- nicknameStartswith?: string
1085
- /**
1086
- * 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;)
1087
- * @type boolean
1088
- * @memberof GroupChannelApilistMembers
1089
- */
1090
- includePushPreference?: boolean
1091
- /**
1092
- *
1093
- * @type string
1094
- * @memberof GroupChannelApilistMembers
1095
- */
1096
- apiToken?: string
1097
- }
1098
-
1099
- export interface GroupChannelApiListOperatorsRequest {
1100
- /**
1101
- * (Required)
1102
- * @type string
1103
- * @memberof GroupChannelApilistOperators
1104
- */
1105
- channelUrl: string
1106
- /**
1107
- *
1108
- * @type string
1109
- * @memberof GroupChannelApilistOperators
1110
- */
1111
- token?: string
1112
- /**
1113
- * Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
1114
- * @type number
1115
- * @memberof GroupChannelApilistOperators
1116
- */
1117
- limit?: number
1118
- /**
1119
- *
1120
- * @type string
1121
- * @memberof GroupChannelApilistOperators
1122
- */
1123
- apiToken?: string
1124
- }
1125
-
1126
- export interface GroupChannelApiRegisterOperatorsToAGroupChannelRequest {
1127
- /**
1128
- * (Required)
1129
- * @type string
1130
- * @memberof GroupChannelApiregisterOperatorsToAGroupChannel
1131
- */
1132
- channelUrl: string
1133
- /**
1134
- *
1135
- * @type string
1136
- * @memberof GroupChannelApiregisterOperatorsToAGroupChannel
1137
- */
1138
- apiToken?: string
1139
- /**
1140
- *
1141
- * @type RegisterOperatorsToAGroupChannelRequest
1142
- * @memberof GroupChannelApiregisterOperatorsToAGroupChannel
1143
- */
1144
- registerOperatorsToAGroupChannelRequest?: RegisterOperatorsToAGroupChannelRequest
1145
- }
1146
-
1147
- export interface GroupChannelApiResetChatHistoryRequest {
1148
- /**
1149
- * (Required)
1150
- * @type string
1151
- * @memberof GroupChannelApiresetChatHistory
1152
- */
1153
- channelUrl: string
1154
- /**
1155
- *
1156
- * @type string
1157
- * @memberof GroupChannelApiresetChatHistory
1158
- */
1159
- apiToken?: string
1160
- /**
1161
- *
1162
- * @type ResetChatHistoryRequest
1163
- * @memberof GroupChannelApiresetChatHistory
1164
- */
1165
- resetChatHistoryRequest?: ResetChatHistoryRequest
1166
- }
1167
-
1168
- export interface GroupChannelApiStartTypingIndicatorsRequest {
1169
- /**
1170
- * (Required)
1171
- * @type string
1172
- * @memberof GroupChannelApistartTypingIndicators
1173
- */
1174
- channelUrl: string
1175
- /**
1176
- *
1177
- * @type string
1178
- * @memberof GroupChannelApistartTypingIndicators
1179
- */
1180
- apiToken?: string
1181
- /**
1182
- *
1183
- * @type StartTypingIndicatorsRequest
1184
- * @memberof GroupChannelApistartTypingIndicators
1185
- */
1186
- startTypingIndicatorsRequest?: StartTypingIndicatorsRequest
1187
- }
1188
-
1189
- export interface GroupChannelApiStopTypingIndicatorsRequest {
1190
- /**
1191
- * (Required)
1192
- * @type string
1193
- * @memberof GroupChannelApistopTypingIndicators
1194
- */
1195
- channelUrl: string
1196
- /**
1197
- *
1198
- * @type string
1199
- * @memberof GroupChannelApistopTypingIndicators
1200
- */
1201
- apiToken?: string
1202
- /**
1203
- *
1204
- * @type StartTypingIndicatorsRequest
1205
- * @memberof GroupChannelApistopTypingIndicators
1206
- */
1207
- startTypingIndicatorsRequest?: StartTypingIndicatorsRequest
1208
- }
1209
-
1210
- export interface GroupChannelApiUnhideAChannelRequest {
1211
- /**
1212
- * (Required)
1213
- * @type string
1214
- * @memberof GroupChannelApiunhideAChannel
1215
- */
1216
- channelUrl: string
1217
- /**
1218
- * (Required)
1219
- * @type string
1220
- * @memberof GroupChannelApiunhideAChannel
1221
- */
1222
- userId: string
1223
- /**
1224
- *
1225
- * @type boolean
1226
- * @memberof GroupChannelApiunhideAChannel
1227
- */
1228
- shouldUnhideAll?: boolean
1229
- /**
1230
- *
1231
- * @type string
1232
- * @memberof GroupChannelApiunhideAChannel
1233
- */
1234
- apiToken?: string
1235
- }
1236
-
1237
- export interface GroupChannelApiUpdateAGroupChannelRequest {
1238
- /**
1239
- *
1240
- * @type string
1241
- * @memberof GroupChannelApiupdateAGroupChannel
1242
- */
1243
- channelUrl: string
1244
- /**
1245
- *
1246
- * @type string
1247
- * @memberof GroupChannelApiupdateAGroupChannel
1248
- */
1249
- apiToken?: string
1250
- /**
1251
- *
1252
- * @type UpdateAGroupChannelRequest
1253
- * @memberof GroupChannelApiupdateAGroupChannel
1254
- */
1255
- updateAGroupChannelRequest?: UpdateAGroupChannelRequest
1256
- }
1257
-
1258
- export class ObjectGroupChannelApi {
1259
- private api: ObservableGroupChannelApi
1260
-
1261
- public constructor(configuration: Configuration, requestFactory?: GroupChannelApiRequestFactory, responseProcessor?: GroupChannelApiResponseProcessor) {
1262
- this.api = new ObservableGroupChannelApi(configuration, requestFactory, responseProcessor);
1263
- }
1264
-
1265
- /**
1266
- * ## 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)
1267
- * Accept an invitation
1268
- * @param param the request object
1269
- */
1270
- public acceptAnInvitation(param: GroupChannelApiAcceptAnInvitationRequest, options?: Configuration): Promise<SendbirdGroupChannelDetail> {
1271
- return this.api.acceptAnInvitation(param.channelUrl, param.apiToken, param.acceptAnInvitationRequest, options).toPromise();
1272
- }
1273
-
1274
- /**
1275
- * ## 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.
1276
- * Cancel the registration of operators
1277
- * @param param the request object
1278
- */
1279
- public cancelTheRegistrationOfOperators(param: GroupChannelApiCancelTheRegistrationOfOperatorsRequest, options?: Configuration): Promise<any> {
1280
- return this.api.cancelTheRegistrationOfOperators(param.channelUrl, param.operatorIds, param.deleteAll, param.apiToken, options).toPromise();
1281
- }
1282
-
1283
- /**
1284
- * ## 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)
1285
- * Check if member
1286
- * @param param the request object
1287
- */
1288
- public checkIfMember(param: GroupChannelApiCheckIfMemberRequest, options?: Configuration): Promise<CheckIfMemberResponse> {
1289
- return this.api.checkIfMember(param.channelUrl, param.userId, param.apiToken, options).toPromise();
1290
- }
1291
-
1292
- /**
1293
- * ## 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
1294
- * Create a group channel
1295
- * @param param the request object
1296
- */
1297
- public createAGroupChannel(param: GroupChannelApiCreateAGroupChannelRequest = {}, options?: Configuration): Promise<SendbirdGroupChannelDetail> {
1298
- return this.api.createAGroupChannel(param.apiToken, param.createAGroupChannelRequest, options).toPromise();
1299
- }
1300
-
1301
- /**
1302
- * ## 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)
1303
- * Delete a group channel
1304
- * @param param the request object
1305
- */
1306
- public deleteAGroupChannel(param: GroupChannelApiDeleteAGroupChannelRequest, options?: Configuration): Promise<any> {
1307
- return this.api.deleteAGroupChannel(param.channelUrl, param.apiToken, options).toPromise();
1308
- }
1309
-
1310
- /**
1311
- * ## 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.
1312
- * Get a group channel
1313
- * @param param the request object
1314
- */
1315
- public getAGroupChannel(param: GroupChannelApiGetAGroupChannelRequest, options?: Configuration): Promise<GetAGroupChannelResponse> {
1316
- return this.api.getAGroupChannel(param.channelUrl, param.showDeliveryReceipt, param.showReadReceipt, param.showMember, param.memberActiveMode, param.userId, param.apiToken, options).toPromise();
1317
- }
1318
-
1319
- /**
1320
- * ## 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)
1321
- * Hide a channel
1322
- * @param param the request object
1323
- */
1324
- public hideAChannel(param: GroupChannelApiHideAChannelRequest, options?: Configuration): Promise<any> {
1325
- return this.api.hideAChannel(param.channelUrl, param.apiToken, param.hideAChannelRequest, options).toPromise();
1326
- }
1327
-
1328
- /**
1329
- * ## 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)
1330
- * Invite as members
1331
- * @param param the request object
1332
- */
1333
- public inviteAsMembers(param: GroupChannelApiInviteAsMembersRequest, options?: Configuration): Promise<InviteAsMembersResponse> {
1334
- return this.api.inviteAsMembers(param.channelUrl, param.apiToken, param.inviteAsMembersRequest, options).toPromise();
1335
- }
1336
-
1337
- /**
1338
- * ## 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)
1339
- * Join a channel
1340
- * @param param the request object
1341
- */
1342
- public joinAChannel(param: GroupChannelApiJoinAChannelRequest, options?: Configuration): Promise<SendbirdGroupChannelDetail> {
1343
- return this.api.joinAChannel(param.channelUrl, param.apiToken, param.joinAChannelRequest, options).toPromise();
1344
- }
1345
-
1346
- /**
1347
- * ## 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 ----------------------------
1348
- * Leave a channel
1349
- * @param param the request object
1350
- */
1351
- public leaveAChannel(param: GroupChannelApiLeaveAChannelRequest, options?: Configuration): Promise<any> {
1352
- return this.api.leaveAChannel(param.channelUrl, param.apiToken, param.leaveAChannelRequest, options).toPromise();
1353
- }
1354
-
1355
- /**
1356
- * ## 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
1357
- * List channels
1358
- * @param param the request object
1359
- */
1360
- public listChannels(param: GroupChannelApiListChannelsRequest, options?: Configuration): Promise<GroupChatListChannelsResponse> {
1361
- return this.api.listChannels(param.apiToken, param.token, param.limit, param.distinctMode, param.publicMode, param.superMode, param.createdAfter, param.createdBefore, param.showEmpty, param.showMember, param.showDeliveryReceipt, param.showReadReceipt, param.showMetadata, param.showFrozen, param.order, param.metadataOrderKey, param.customTypes, param.customTypeStartswith, param.channelUrls, param.name, param.nameContains, param.nameStartswith, param.membersExactlyIn, param.membersIncludeIn, param.queryType, param.membersNickname, param.membersNicknameContains, param.metadataKey, param.metadataValues, param.metadataValueStartswith, param.metacounterKey, param.metacounterValues, param.metacounterValueGt, param.metacounterValueGte, param.metacounterValueLt, param.metacounterValueLte, param.includeSortedMetaarrayInLastMessage, options).toPromise();
1362
- }
1363
-
1364
- /**
1365
- * ## 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.
1366
- * List members
1367
- * @param param the request object
1368
- */
1369
- public listMembers(param: GroupChannelApiListMembersRequest, options?: Configuration): Promise<GroupChannelListMembersResponse> {
1370
- return this.api.listMembers(param.channelUrl, param.token, param.limit, param.userId, param.showDeliveryReceipt, param.showReadReceipt, param.showMemberIsMuted, param.order, param.operatorFilter, param.memberStateFilter, param.mutedMemberFilter, param.memberActiveModeFilter, param.nicknameStartswith, param.includePushPreference, param.apiToken, options).toPromise();
1371
- }
1372
-
1373
- /**
1374
- * ## 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.
1375
- * List operators
1376
- * @param param the request object
1377
- */
1378
- public listOperators(param: GroupChannelApiListOperatorsRequest, options?: Configuration): Promise<ListOperatorsResponse> {
1379
- return this.api.listOperators(param.channelUrl, param.token, param.limit, param.apiToken, options).toPromise();
1380
- }
1381
-
1382
- /**
1383
- * ## 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
1384
- * Register operators to a group channel
1385
- * @param param the request object
1386
- */
1387
- public registerOperatorsToAGroupChannel(param: GroupChannelApiRegisterOperatorsToAGroupChannelRequest, options?: Configuration): Promise<any> {
1388
- return this.api.registerOperatorsToAGroupChannel(param.channelUrl, param.apiToken, param.registerOperatorsToAGroupChannelRequest, options).toPromise();
1389
- }
1390
-
1391
- /**
1392
- * ## 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
1393
- * Reset chat history
1394
- * @param param the request object
1395
- */
1396
- public resetChatHistory(param: GroupChannelApiResetChatHistoryRequest, options?: Configuration): Promise<ResetChatHistoryResponse> {
1397
- return this.api.resetChatHistory(param.channelUrl, param.apiToken, param.resetChatHistoryRequest, options).toPromise();
1398
- }
1399
-
1400
- /**
1401
- * ## 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.
1402
- * Start typing indicators
1403
- * @param param the request object
1404
- */
1405
- public startTypingIndicators(param: GroupChannelApiStartTypingIndicatorsRequest, options?: Configuration): Promise<any> {
1406
- return this.api.startTypingIndicators(param.channelUrl, param.apiToken, param.startTypingIndicatorsRequest, options).toPromise();
1407
- }
1408
-
1409
- /**
1410
- * ## 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.
1411
- * Stop typing indicators
1412
- * @param param the request object
1413
- */
1414
- public stopTypingIndicators(param: GroupChannelApiStopTypingIndicatorsRequest, options?: Configuration): Promise<any> {
1415
- return this.api.stopTypingIndicators(param.channelUrl, param.apiToken, param.startTypingIndicatorsRequest, options).toPromise();
1416
- }
1417
-
1418
- /**
1419
- * ## 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.
1420
- * Unhide a channel
1421
- * @param param the request object
1422
- */
1423
- public unhideAChannel(param: GroupChannelApiUnhideAChannelRequest, options?: Configuration): Promise<any> {
1424
- return this.api.unhideAChannel(param.channelUrl, param.userId, param.shouldUnhideAll, param.apiToken, options).toPromise();
1425
- }
1426
-
1427
- /**
1428
- * ## 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
1429
- * Update a group channel
1430
- * @param param the request object
1431
- */
1432
- public updateAGroupChannel(param: GroupChannelApiUpdateAGroupChannelRequest, options?: Configuration): Promise<SendbirdGroupChannelDetail> {
1433
- return this.api.updateAGroupChannel(param.channelUrl, param.apiToken, param.updateAGroupChannelRequest, options).toPromise();
1434
- }
1435
-
1436
- }
1437
-
1438
- import { ObservableMessageApi } from "./ObservableAPI";
1439
- import { MessageApiRequestFactory, MessageApiResponseProcessor} from "../apis/MessageApi";
1440
-
1441
- export interface MessageApiAddExtraDataToAMessageRequest {
1442
- /**
1443
- * (Required)
1444
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1445
- * @memberof MessageApiaddExtraDataToAMessage
1446
- */
1447
- channelType: 'open_channels' | 'group_channels'
1448
- /**
1449
- * (Required)
1450
- * @type string
1451
- * @memberof MessageApiaddExtraDataToAMessage
1452
- */
1453
- channelUrl: string
1454
- /**
1455
- * (Required)
1456
- * @type number
1457
- * @memberof MessageApiaddExtraDataToAMessage
1458
- */
1459
- messageId: number
1460
- /**
1461
- *
1462
- * @type string
1463
- * @memberof MessageApiaddExtraDataToAMessage
1464
- */
1465
- apiToken?: string
1466
- /**
1467
- *
1468
- * @type AddExtraDataToAMessageRequest
1469
- * @memberof MessageApiaddExtraDataToAMessage
1470
- */
1471
- addExtraDataToAMessageRequest?: AddExtraDataToAMessageRequest
1472
- }
1473
-
1474
- export interface MessageApiDeleteAMessageRequest {
1475
- /**
1476
- * (Required)
1477
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1478
- * @memberof MessageApideleteAMessage
1479
- */
1480
- channelType: 'open_channels' | 'group_channels'
1481
- /**
1482
- * (Required)
1483
- * @type string
1484
- * @memberof MessageApideleteAMessage
1485
- */
1486
- channelUrl: string
1487
- /**
1488
- * (Required)
1489
- * @type number
1490
- * @memberof MessageApideleteAMessage
1491
- */
1492
- messageId: number
1493
- /**
1494
- *
1495
- * @type string
1496
- * @memberof MessageApideleteAMessage
1497
- */
1498
- apiToken?: string
1499
- }
1500
-
1501
- export interface MessageApiGetAMessageRequest {
1502
- /**
1503
- * (Required)
1504
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1505
- * @memberof MessageApigetAMessage
1506
- */
1507
- channelType: 'open_channels' | 'group_channels'
1508
- /**
1509
- * (Required)
1510
- * @type string
1511
- * @memberof MessageApigetAMessage
1512
- */
1513
- channelUrl: string
1514
- /**
1515
- * (Required)
1516
- * @type number
1517
- * @memberof MessageApigetAMessage
1518
- */
1519
- messageId: number
1520
- /**
1521
- *
1522
- * @type boolean
1523
- * @memberof MessageApigetAMessage
1524
- */
1525
- includeReactions?: boolean
1526
- /**
1527
- *
1528
- * @type boolean
1529
- * @memberof MessageApigetAMessage
1530
- */
1531
- includeThreadInfo?: boolean
1532
- /**
1533
- *
1534
- * @type boolean
1535
- * @memberof MessageApigetAMessage
1536
- */
1537
- includeParentMessageInfo?: boolean
1538
- /**
1539
- * 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.
1540
- * @type boolean
1541
- * @memberof MessageApigetAMessage
1542
- */
1543
- includePollDetails?: boolean
1544
- /**
1545
- *
1546
- * @type boolean
1547
- * @memberof MessageApigetAMessage
1548
- */
1549
- withSortedMetaArray?: boolean
1550
- /**
1551
- *
1552
- * @type string
1553
- * @memberof MessageApigetAMessage
1554
- */
1555
- apiToken?: string
1556
- }
1557
-
1558
- export interface MessageApiGetTotalNumberOfMessagesInAChannelRequest {
1559
- /**
1560
- * (Required)
1561
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1562
- * @memberof MessageApigetTotalNumberOfMessagesInAChannel
1563
- */
1564
- channelType: 'open_channels' | 'group_channels'
1565
- /**
1566
- * (Required)
1567
- * @type string
1568
- * @memberof MessageApigetTotalNumberOfMessagesInAChannel
1569
- */
1570
- channelUrl: string
1571
- /**
1572
- *
1573
- * @type string
1574
- * @memberof MessageApigetTotalNumberOfMessagesInAChannel
1575
- */
1576
- apiToken?: string
1577
- }
1578
-
1579
- export interface MessageApiListMessagesRequest {
1580
- /**
1581
- * (Required)
1582
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1583
- * @memberof MessageApilistMessages
1584
- */
1585
- channelType: 'open_channels' | 'group_channels'
1586
- /**
1587
- * (Required)
1588
- * @type string
1589
- * @memberof MessageApilistMessages
1590
- */
1591
- channelUrl: string
1592
- /**
1593
- * 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.
1594
- * @type number
1595
- * @memberof MessageApilistMessages
1596
- */
1597
- messageTs: number
1598
- /**
1599
- * 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.
1600
- * @type number
1601
- * @memberof MessageApilistMessages
1602
- */
1603
- messageId: number
1604
- /**
1605
- * 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)
1606
- * @type number
1607
- * @memberof MessageApilistMessages
1608
- */
1609
- prevLimit?: number
1610
- /**
1611
- * 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)
1612
- * @type number
1613
- * @memberof MessageApilistMessages
1614
- */
1615
- nextLimit?: number
1616
- /**
1617
- * Determines whether to include messages sent exactly on the specified message_ts in the results. (Default: true)
1618
- * @type boolean
1619
- * @memberof MessageApilistMessages
1620
- */
1621
- include?: boolean
1622
- /**
1623
- * 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)
1624
- * @type boolean
1625
- * @memberof MessageApilistMessages
1626
- */
1627
- reverse?: boolean
1628
- /**
1629
- * Restricts the search scope to only retrieve messages sent by the user with the specified ID.
1630
- * @type string
1631
- * @memberof MessageApilistMessages
1632
- */
1633
- senderId?: string
1634
- /**
1635
- * Restricts the search scope to only retrieve messages sent by one or more users with the specified IDs listed in a comma-separated string.
1636
- * @type string
1637
- * @memberof MessageApilistMessages
1638
- */
1639
- senderIds?: string
1640
- /**
1641
- *
1642
- * @type &#39;all&#39; | &#39;operator&#39; | &#39;nonoperator&#39;
1643
- * @memberof MessageApilistMessages
1644
- */
1645
- operatorFilter?: 'all' | 'operator' | 'nonoperator'
1646
- /**
1647
- * 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.
1648
- * @type string
1649
- * @memberof MessageApilistMessages
1650
- */
1651
- customTypes?: string
1652
- /**
1653
- *
1654
- * @type &#39;MESG&#39; | &#39;FILE&#39; | &#39;ADMM&#39;
1655
- * @memberof MessageApilistMessages
1656
- */
1657
- messageType?: 'MESG' | 'FILE' | 'ADMM'
1658
- /**
1659
- *
1660
- * @type boolean
1661
- * @memberof MessageApilistMessages
1662
- */
1663
- includingRemoved?: boolean
1664
- /**
1665
- *
1666
- * @type boolean
1667
- * @memberof MessageApilistMessages
1668
- */
1669
- includeReactions?: boolean
1670
- /**
1671
- * One of following values: NONE, ALL, ONLY_REPLY_TO_CHANNEL
1672
- * @type &#39;NONE&#39; | &#39;ALL&#39; | &#39;ONLY_REPLY_TO_CHANNEL&#39;
1673
- * @memberof MessageApilistMessages
1674
- */
1675
- includeReplyType?: 'NONE' | 'ALL' | 'ONLY_REPLY_TO_CHANNEL'
1676
- /**
1677
- *
1678
- * @type boolean
1679
- * @memberof MessageApilistMessages
1680
- */
1681
- includeParentMessageInfo?: boolean
1682
- /**
1683
- *
1684
- * @type boolean
1685
- * @memberof MessageApilistMessages
1686
- */
1687
- includeThreadInfo?: boolean
1688
- /**
1689
- * 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.
1690
- * @type boolean
1691
- * @memberof MessageApilistMessages
1692
- */
1693
- includePollDetails?: boolean
1694
- /**
1695
- * Determines whether to include the sorted_metaarray property in the response. (Default: false)
1696
- * @type boolean
1697
- * @memberof MessageApilistMessages
1698
- */
1699
- withSortedMetaArray?: boolean
1700
- /**
1701
- *
1702
- * @type boolean
1703
- * @memberof MessageApilistMessages
1704
- */
1705
- showSubchannelMessagesOnly?: boolean
1706
- /**
1707
- *
1708
- * @type string
1709
- * @memberof MessageApilistMessages
1710
- */
1711
- userId?: string
1712
- /**
1713
- *
1714
- * @type string
1715
- * @memberof MessageApilistMessages
1716
- */
1717
- apiToken?: string
1718
- }
1719
-
1720
- export interface MessageApiMarkChannelMessagesAsReadRequest {
1721
- /**
1722
- * (Required)
1723
- * @type string
1724
- * @memberof MessageApimarkChannelMessagesAsRead
1725
- */
1726
- channelUrl: string
1727
- /**
1728
- *
1729
- * @type string
1730
- * @memberof MessageApimarkChannelMessagesAsRead
1731
- */
1732
- apiToken?: string
1733
- /**
1734
- *
1735
- * @type MarkChannelMessagesAsReadRequest
1736
- * @memberof MessageApimarkChannelMessagesAsRead
1737
- */
1738
- markChannelMessagesAsReadRequest?: MarkChannelMessagesAsReadRequest
1739
- }
1740
-
1741
- export interface MessageApiMigrateMessagesRequest {
1742
- /**
1743
- * (Required)
1744
- * @type string
1745
- * @memberof MessageApimigrateMessages
1746
- */
1747
- targetChannelUrl: string
1748
- /**
1749
- *
1750
- * @type string
1751
- * @memberof MessageApimigrateMessages
1752
- */
1753
- apiToken?: string
1754
- /**
1755
- *
1756
- * @type MigrateMessagesRequest
1757
- * @memberof MessageApimigrateMessages
1758
- */
1759
- migrateMessagesRequest?: MigrateMessagesRequest
1760
- }
1761
-
1762
- export interface MessageApiRemoveExtraDataFromAMessageRequest {
1763
- /**
1764
- * (Required)
1765
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1766
- * @memberof MessageApiremoveExtraDataFromAMessage
1767
- */
1768
- channelType: 'open_channels' | 'group_channels'
1769
- /**
1770
- * (Required)
1771
- * @type string
1772
- * @memberof MessageApiremoveExtraDataFromAMessage
1773
- */
1774
- channelUrl: string
1775
- /**
1776
- * (Required)
1777
- * @type number
1778
- * @memberof MessageApiremoveExtraDataFromAMessage
1779
- */
1780
- messageId: number
1781
- /**
1782
- *
1783
- * @type string
1784
- * @memberof MessageApiremoveExtraDataFromAMessage
1785
- */
1786
- keys?: string
1787
- /**
1788
- *
1789
- * @type string
1790
- * @memberof MessageApiremoveExtraDataFromAMessage
1791
- */
1792
- apiToken?: string
1793
- }
1794
-
1795
- export interface MessageApiSendAMessageRequest {
1796
- /**
1797
- * (Required)
1798
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1799
- * @memberof MessageApisendAMessage
1800
- */
1801
- channelType: 'open_channels' | 'group_channels'
1802
- /**
1803
- * (Required)
1804
- * @type string
1805
- * @memberof MessageApisendAMessage
1806
- */
1807
- channelUrl: string
1808
- /**
1809
- *
1810
- * @type string
1811
- * @memberof MessageApisendAMessage
1812
- */
1813
- apiToken?: string
1814
- /**
1815
- *
1816
- * @type SendAMessageRequest
1817
- * @memberof MessageApisendAMessage
1818
- */
1819
- sendAMessageRequest?: SendAMessageRequest
1820
- }
1821
-
1822
- export interface MessageApiUpdateAMessageRequest {
1823
- /**
1824
- * (Required)
1825
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1826
- * @memberof MessageApiupdateAMessage
1827
- */
1828
- channelType: 'open_channels' | 'group_channels'
1829
- /**
1830
- * (Required)
1831
- * @type string
1832
- * @memberof MessageApiupdateAMessage
1833
- */
1834
- channelUrl: string
1835
- /**
1836
- * (Required)
1837
- * @type number
1838
- * @memberof MessageApiupdateAMessage
1839
- */
1840
- messageId: number
1841
- /**
1842
- *
1843
- * @type string
1844
- * @memberof MessageApiupdateAMessage
1845
- */
1846
- apiToken?: string
1847
- /**
1848
- *
1849
- * @type UpdateAMessageRequest
1850
- * @memberof MessageApiupdateAMessage
1851
- */
1852
- updateAMessageRequest?: UpdateAMessageRequest
1853
- }
1854
-
1855
- export interface MessageApiUpdateExtraDataInAMessageRequest {
1856
- /**
1857
- * (Required)
1858
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
1859
- * @memberof MessageApiupdateExtraDataInAMessage
1860
- */
1861
- channelType: 'open_channels' | 'group_channels'
1862
- /**
1863
- * (Required)
1864
- * @type string
1865
- * @memberof MessageApiupdateExtraDataInAMessage
1866
- */
1867
- channelUrl: string
1868
- /**
1869
- * (Required)
1870
- * @type number
1871
- * @memberof MessageApiupdateExtraDataInAMessage
1872
- */
1873
- messageId: number
1874
- /**
1875
- *
1876
- * @type string
1877
- * @memberof MessageApiupdateExtraDataInAMessage
1878
- */
1879
- apiToken?: string
1880
- /**
1881
- *
1882
- * @type UpdateExtraDataInAMessageRequest
1883
- * @memberof MessageApiupdateExtraDataInAMessage
1884
- */
1885
- updateExtraDataInAMessageRequest?: UpdateExtraDataInAMessageRequest
1886
- }
1887
-
1888
- export class ObjectMessageApi {
1889
- private api: ObservableMessageApi
1890
-
1891
- public constructor(configuration: Configuration, requestFactory?: MessageApiRequestFactory, responseProcessor?: MessageApiResponseProcessor) {
1892
- this.api = new ObservableMessageApi(configuration, requestFactory, responseProcessor);
1893
- }
1894
-
1895
- /**
1896
- * ## 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 ----------------------------
1897
- * Add extra data to a message
1898
- * @param param the request object
1899
- */
1900
- public addExtraDataToAMessage(param: MessageApiAddExtraDataToAMessageRequest, options?: Configuration): Promise<AddExtraDataToAMessageResponse> {
1901
- return this.api.addExtraDataToAMessage(param.channelType, param.channelUrl, param.messageId, param.apiToken, param.addExtraDataToAMessageRequest, options).toPromise();
1902
- }
1903
-
1904
- /**
1905
- * ## 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 ----------------------------
1906
- * Delete a message
1907
- * @param param the request object
1908
- */
1909
- public deleteAMessage(param: MessageApiDeleteAMessageRequest, options?: Configuration): Promise<any> {
1910
- return this.api.deleteAMessage(param.channelType, param.channelUrl, param.messageId, param.apiToken, options).toPromise();
1911
- }
1912
-
1913
- /**
1914
- * ## 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.
1915
- * Get a message
1916
- * @param param the request object
1917
- */
1918
- public getAMessage(param: MessageApiGetAMessageRequest, options?: Configuration): Promise<SendbirdMessageResponse> {
1919
- return this.api.getAMessage(param.channelType, param.channelUrl, param.messageId, param.includeReactions, param.includeThreadInfo, param.includeParentMessageInfo, param.includePollDetails, param.withSortedMetaArray, param.apiToken, options).toPromise();
1920
- }
1921
-
1922
- /**
1923
- * ## 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 ----------------------------
1924
- * Get total number of messages in a channel
1925
- * @param param the request object
1926
- */
1927
- public getTotalNumberOfMessagesInAChannel(param: MessageApiGetTotalNumberOfMessagesInAChannelRequest, options?: Configuration): Promise<GetTotalNumberOfMessagesInAChannelResponse> {
1928
- return this.api.getTotalNumberOfMessagesInAChannel(param.channelType, param.channelUrl, param.apiToken, options).toPromise();
1929
- }
1930
-
1931
- /**
1932
- * ## 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.
1933
- * List messages
1934
- * @param param the request object
1935
- */
1936
- public listMessages(param: MessageApiListMessagesRequest, options?: Configuration): Promise<ListMessagesResponse> {
1937
- return this.api.listMessages(param.channelType, param.channelUrl, param.messageTs, param.messageId, param.prevLimit, param.nextLimit, param.include, param.reverse, param.senderId, param.senderIds, param.operatorFilter, param.customTypes, param.messageType, param.includingRemoved, param.includeReactions, param.includeReplyType, param.includeParentMessageInfo, param.includeThreadInfo, param.includePollDetails, param.withSortedMetaArray, param.showSubchannelMessagesOnly, param.userId, param.apiToken, options).toPromise();
1938
- }
1939
-
1940
- /**
1941
- * ## 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
1942
- * Mark all messages as read
1943
- * @param param the request object
1944
- */
1945
- public markChannelMessagesAsRead(param: MessageApiMarkChannelMessagesAsReadRequest, options?: Configuration): Promise<any> {
1946
- return this.api.markChannelMessagesAsRead(param.channelUrl, param.apiToken, param.markChannelMessagesAsReadRequest, options).toPromise();
1947
- }
1948
-
1949
- /**
1950
- * ## 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
1951
- * Migrate messages
1952
- * @param param the request object
1953
- */
1954
- public migrateMessages(param: MessageApiMigrateMessagesRequest, options?: Configuration): Promise<any> {
1955
- return this.api.migrateMessages(param.targetChannelUrl, param.apiToken, param.migrateMessagesRequest, options).toPromise();
1956
- }
1957
-
1958
- /**
1959
- * ## 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 ----------------------------
1960
- * Remove extra data from a message
1961
- * @param param the request object
1962
- */
1963
- public removeExtraDataFromAMessage(param: MessageApiRemoveExtraDataFromAMessageRequest, options?: Configuration): Promise<any> {
1964
- return this.api.removeExtraDataFromAMessage(param.channelType, param.channelUrl, param.messageId, param.keys, param.apiToken, options).toPromise();
1965
- }
1966
-
1967
- /**
1968
- * ## 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 ----------------------------
1969
- * Send a message
1970
- * @param param the request object
1971
- */
1972
- public sendAMessage(param: MessageApiSendAMessageRequest, options?: Configuration): Promise<SendbirdMessageResponse> {
1973
- return this.api.sendAMessage(param.channelType, param.channelUrl, param.apiToken, param.sendAMessageRequest, options).toPromise();
1974
- }
1975
-
1976
- /**
1977
- * ## 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 ----------------------------
1978
- * Update a message
1979
- * @param param the request object
1980
- */
1981
- public updateAMessage(param: MessageApiUpdateAMessageRequest, options?: Configuration): Promise<SendbirdMessageResponse> {
1982
- return this.api.updateAMessage(param.channelType, param.channelUrl, param.messageId, param.apiToken, param.updateAMessageRequest, options).toPromise();
1983
- }
1984
-
1985
- /**
1986
- * ## 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 ----------------------------
1987
- * Update extra data in a message
1988
- * @param param the request object
1989
- */
1990
- public updateExtraDataInAMessage(param: MessageApiUpdateExtraDataInAMessageRequest, options?: Configuration): Promise<UpdateExtraDataInAMessageResponse> {
1991
- return this.api.updateExtraDataInAMessage(param.channelType, param.channelUrl, param.messageId, param.apiToken, param.updateExtraDataInAMessageRequest, options).toPromise();
1992
- }
1993
-
1994
- }
1995
-
1996
- import { ObservableMetadataApi } from "./ObservableAPI";
1997
- import { MetadataApiRequestFactory, MetadataApiResponseProcessor} from "../apis/MetadataApi";
1998
-
1999
- export interface MetadataApiCreateAChannelMetadataRequest {
2000
- /**
2001
- * (Required)
2002
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
2003
- * @memberof MetadataApicreateAChannelMetadata
2004
- */
2005
- channelType: 'open_channels' | 'group_channels'
2006
- /**
2007
- * (Required)
2008
- * @type string
2009
- * @memberof MetadataApicreateAChannelMetadata
2010
- */
2011
- channelUrl: string
2012
- /**
2013
- *
2014
- * @type string
2015
- * @memberof MetadataApicreateAChannelMetadata
2016
- */
2017
- apiToken?: string
2018
- /**
2019
- *
2020
- * @type CreateAChannelMetadataRequest
2021
- * @memberof MetadataApicreateAChannelMetadata
2022
- */
2023
- createAChannelMetadataRequest?: CreateAChannelMetadataRequest
2024
- }
2025
-
2026
- export interface MetadataApiDeleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadataRequest {
2027
- /**
2028
- * (Required)
2029
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
2030
- * @memberof MetadataApideleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata
2031
- */
2032
- channelType: 'open_channels' | 'group_channels'
2033
- /**
2034
- * (Required)
2035
- * @type string
2036
- * @memberof MetadataApideleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata
2037
- */
2038
- channelUrl: string
2039
- /**
2040
- *
2041
- * @type string
2042
- * @memberof MetadataApideleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata
2043
- */
2044
- key?: string
2045
- /**
2046
- *
2047
- * @type string
2048
- * @memberof MetadataApideleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata
2049
- */
2050
- apiToken?: string
2051
- }
2052
-
2053
- export interface MetadataApiUpdateAChannelMetadataRequest {
2054
- /**
2055
- * (Required)
2056
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
2057
- * @memberof MetadataApiupdateAChannelMetadata
2058
- */
2059
- channelType: 'open_channels' | 'group_channels'
2060
- /**
2061
- * (Required)
2062
- * @type string
2063
- * @memberof MetadataApiupdateAChannelMetadata
2064
- */
2065
- channelUrl: string
2066
- /**
2067
- *
2068
- * @type string
2069
- * @memberof MetadataApiupdateAChannelMetadata
2070
- */
2071
- apiToken?: string
2072
- /**
2073
- *
2074
- * @type UpdateAChannelMetadataRequest
2075
- * @memberof MetadataApiupdateAChannelMetadata
2076
- */
2077
- updateAChannelMetadataRequest?: UpdateAChannelMetadataRequest
2078
- }
2079
-
2080
- export interface MetadataApiViewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadataRequest {
2081
- /**
2082
- * (Required)
2083
- * @type &#39;open_channels&#39; | &#39;group_channels&#39;
2084
- * @memberof MetadataApiviewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata
2085
- */
2086
- channelType: 'open_channels' | 'group_channels'
2087
- /**
2088
- * (Required)
2089
- * @type string
2090
- * @memberof MetadataApiviewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata
2091
- */
2092
- channelUrl: string
2093
- /**
2094
- *
2095
- * @type string
2096
- * @memberof MetadataApiviewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata
2097
- */
2098
- key?: string
2099
- /**
2100
- * 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.
2101
- * @type string
2102
- * @memberof MetadataApiviewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata
2103
- */
2104
- keys?: string
2105
- /**
2106
- *
2107
- * @type string
2108
- * @memberof MetadataApiviewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata
2109
- */
2110
- apiToken?: string
2111
- }
2112
-
2113
- export class ObjectMetadataApi {
2114
- private api: ObservableMetadataApi
2115
-
2116
- public constructor(configuration: Configuration, requestFactory?: MetadataApiRequestFactory, responseProcessor?: MetadataApiResponseProcessor) {
2117
- this.api = new ObservableMetadataApi(configuration, requestFactory, responseProcessor);
2118
- }
2119
-
2120
- /**
2121
- * ## 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 ----------------------------
2122
- * Create a channel metadata
2123
- * @param param the request object
2124
- */
2125
- public createAChannelMetadata(param: MetadataApiCreateAChannelMetadataRequest, options?: Configuration): Promise<CreateAChannelMetadataResponse> {
2126
- return this.api.createAChannelMetadata(param.channelType, param.channelUrl, param.apiToken, param.createAChannelMetadataRequest, options).toPromise();
2127
- }
2128
-
2129
- /**
2130
- * ## 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.
2131
- * Delete a channel metadata - When deleting all items of a channel metadata
2132
- * @param param the request object
2133
- */
2134
- public deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata(param: MetadataApiDeleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadataRequest, options?: Configuration): Promise<any> {
2135
- return this.api.deleteAChannelMetadataWhenDeletingAllItemsOfAChannelMetadata(param.channelType, param.channelUrl, param.key, param.apiToken, options).toPromise();
2136
- }
2137
-
2138
- /**
2139
- * ## 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.
2140
- * Update a channel metadata - When updating existing items of a channel metadata by their keys or adding new items to the metadata
2141
- * @param param the request object
2142
- */
2143
- public updateAChannelMetadata(param: MetadataApiUpdateAChannelMetadataRequest, options?: Configuration): Promise<any> {
2144
- return this.api.updateAChannelMetadata(param.channelType, param.channelUrl, param.apiToken, param.updateAChannelMetadataRequest, options).toPromise();
2145
- }
2146
-
2147
- /**
2148
- * ## 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.
2149
- * View a channel metadata - When retrieving all items of a channel metadata
2150
- * @param param the request object
2151
- */
2152
- public viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata(param: MetadataApiViewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadataRequest, options?: Configuration): Promise<any> {
2153
- return this.api.viewAChannelMetadataWhenRetrievingAllItemsOfAChannelMetadata(param.channelType, param.channelUrl, param.key, param.keys, param.apiToken, options).toPromise();
2154
- }
2155
-
2156
- }
2157
-
2158
- import { ObservableModerationApi } from "./ObservableAPI";
2159
- import { ModerationApiRequestFactory, ModerationApiResponseProcessor} from "../apis/ModerationApi";
2160
-
2161
- export interface ModerationApiBlockAUserRequest {
2162
- /**
2163
- * (Required)
2164
- * @type string
2165
- * @memberof ModerationApiblockAUser
2166
- */
2167
- userId: string
2168
- /**
2169
- *
2170
- * @type string
2171
- * @memberof ModerationApiblockAUser
2172
- */
2173
- apiToken?: string
2174
- /**
2175
- *
2176
- * @type BlockAUserRequest
2177
- * @memberof ModerationApiblockAUser
2178
- */
2179
- blockAUserRequest?: BlockAUserRequest
2180
- }
2181
-
2182
- export interface ModerationApiFreezeAGroupChannelRequest {
2183
- /**
2184
- * (Required)
2185
- * @type string
2186
- * @memberof ModerationApifreezeAGroupChannel
2187
- */
2188
- channelUrl: string
2189
- /**
2190
- *
2191
- * @type string
2192
- * @memberof ModerationApifreezeAGroupChannel
2193
- */
2194
- apiToken?: string
2195
- /**
2196
- *
2197
- * @type FreezeAGroupChannelRequest
2198
- * @memberof ModerationApifreezeAGroupChannel
2199
- */
2200
- freezeAGroupChannelRequest?: FreezeAGroupChannelRequest
2201
- }
2202
-
2203
- export interface ModerationApiFreezeAnOpenChannelRequest {
2204
- /**
2205
- * (Required)
2206
- * @type string
2207
- * @memberof ModerationApifreezeAnOpenChannel
2208
- */
2209
- channelUrl: string
2210
- /**
2211
- *
2212
- * @type string
2213
- * @memberof ModerationApifreezeAnOpenChannel
2214
- */
2215
- apiToken?: string
2216
- /**
2217
- *
2218
- * @type FreezeAnOpenChannelRequest
2219
- * @memberof ModerationApifreezeAnOpenChannel
2220
- */
2221
- freezeAnOpenChannelRequest?: FreezeAnOpenChannelRequest
2222
- }
2223
-
2224
- export interface ModerationApiListBlockedUsersRequest {
2225
- /**
2226
- * (Required)
2227
- * @type string
2228
- * @memberof ModerationApilistBlockedUsers
2229
- */
2230
- userId: string
2231
- /**
2232
- * 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)
2233
- * @type &#39;blocked_by_me&#39; | &#39;blocking_me&#39;
2234
- * @memberof ModerationApilistBlockedUsers
2235
- */
2236
- list?: 'blocked_by_me' | 'blocking_me'
2237
- /**
2238
- *
2239
- * @type string
2240
- * @memberof ModerationApilistBlockedUsers
2241
- */
2242
- token?: string
2243
- /**
2244
- *
2245
- * @type number
2246
- * @memberof ModerationApilistBlockedUsers
2247
- */
2248
- limit?: number
2249
- /**
2250
- * 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.
2251
- * @type string
2252
- * @memberof ModerationApilistBlockedUsers
2253
- */
2254
- userIds?: string
2255
- /**
2256
- *
2257
- * @type string
2258
- * @memberof ModerationApilistBlockedUsers
2259
- */
2260
- metadatakey?: string
2261
- /**
2262
- *
2263
- * @type string
2264
- * @memberof ModerationApilistBlockedUsers
2265
- */
2266
- metadatavaluesIn?: string
2267
- /**
2268
- *
2269
- * @type string
2270
- * @memberof ModerationApilistBlockedUsers
2271
- */
2272
- apiToken?: string
2273
- }
2274
-
2275
- export interface ModerationApiUnblockAUserRequest {
2276
- /**
2277
- * (Required)
2278
- * @type string
2279
- * @memberof ModerationApiunblockAUser
2280
- */
2281
- userId: string
2282
- /**
2283
- * (Required)
2284
- * @type string
2285
- * @memberof ModerationApiunblockAUser
2286
- */
2287
- targetId: string
2288
- /**
2289
- *
2290
- * @type string
2291
- * @memberof ModerationApiunblockAUser
2292
- */
2293
- apiToken?: string
2294
- }
2295
-
2296
- export class ObjectModerationApi {
2297
- private api: ObservableModerationApi
2298
-
2299
- public constructor(configuration: Configuration, requestFactory?: ModerationApiRequestFactory, responseProcessor?: ModerationApiResponseProcessor) {
2300
- this.api = new ObservableModerationApi(configuration, requestFactory, responseProcessor);
2301
- }
2302
-
2303
- /**
2304
- * ## 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)
2305
- * Block a user
2306
- * @param param the request object
2307
- */
2308
- public blockAUser(param: ModerationApiBlockAUserRequest, options?: Configuration): Promise<BlockAUserResponse> {
2309
- return this.api.blockAUser(param.userId, param.apiToken, param.blockAUserRequest, options).toPromise();
2310
- }
2311
-
2312
- /**
2313
- * ## 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)
2314
- * Freeze a group channel
2315
- * @param param the request object
2316
- */
2317
- public freezeAGroupChannel(param: ModerationApiFreezeAGroupChannelRequest, options?: Configuration): Promise<SendbirdGroupChannelDetail> {
2318
- return this.api.freezeAGroupChannel(param.channelUrl, param.apiToken, param.freezeAGroupChannelRequest, options).toPromise();
2319
- }
2320
-
2321
- /**
2322
- * ## 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)
2323
- * Freeze an open channel
2324
- * @param param the request object
2325
- */
2326
- public freezeAnOpenChannel(param: ModerationApiFreezeAnOpenChannelRequest, options?: Configuration): Promise<SendbirdOpenChannel> {
2327
- return this.api.freezeAnOpenChannel(param.channelUrl, param.apiToken, param.freezeAnOpenChannelRequest, options).toPromise();
2328
- }
2329
-
2330
- /**
2331
- * ## 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.
2332
- * List blocked users
2333
- * @param param the request object
2334
- */
2335
- public listBlockedUsers(param: ModerationApiListBlockedUsersRequest, options?: Configuration): Promise<ListBlockedUsersResponse> {
2336
- return this.api.listBlockedUsers(param.userId, param.list, param.token, param.limit, param.userIds, param.metadatakey, param.metadatavaluesIn, param.apiToken, options).toPromise();
2337
- }
2338
-
2339
- /**
2340
- * ## Unblock a user Unblocks the user. https://sendbird.com/docs/chat/platform-api/v3/moderation/blocking-users/unblock-a-user#1-unblock-a-user
2341
- * Unblock a user
2342
- * @param param the request object
2343
- */
2344
- public unblockAUser(param: ModerationApiUnblockAUserRequest, options?: Configuration): Promise<any> {
2345
- return this.api.unblockAUser(param.userId, param.targetId, param.apiToken, options).toPromise();
2346
- }
2347
-
2348
- }
2349
-
2350
- import { ObservableOpenChannelApi } from "./ObservableAPI";
2351
- import { OpenChannelApiRequestFactory, OpenChannelApiResponseProcessor} from "../apis/OpenChannelApi";
2352
-
2353
- export interface OpenChannelApiCreateAnOpenChannelRequest {
2354
- /**
2355
- *
2356
- * @type string
2357
- * @memberof OpenChannelApicreateAnOpenChannel
2358
- */
2359
- apiToken?: string
2360
- /**
2361
- *
2362
- * @type CreateAnOpenChannelRequest
2363
- * @memberof OpenChannelApicreateAnOpenChannel
2364
- */
2365
- createAnOpenChannelRequest?: CreateAnOpenChannelRequest
2366
- }
2367
-
2368
- export interface OpenChannelApiDeleteAnOpenChannelRequest {
2369
- /**
2370
- * (Required)
2371
- * @type string
2372
- * @memberof OpenChannelApideleteAnOpenChannel
2373
- */
2374
- channelUrl: string
2375
- /**
2376
- *
2377
- * @type string
2378
- * @memberof OpenChannelApideleteAnOpenChannel
2379
- */
2380
- apiToken?: string
2381
- }
2382
-
2383
- export interface OpenChannelApiGetAnOpenChannelRequest {
2384
- /**
2385
- * (Required)
2386
- * @type string
2387
- * @memberof OpenChannelApigetAnOpenChannel
2388
- */
2389
- channelUrl: string
2390
- /**
2391
- *
2392
- * @type string
2393
- * @memberof OpenChannelApigetAnOpenChannel
2394
- */
2395
- apiToken?: string
2396
- /**
2397
- * Determines whether to include a list of operators in the response. (Default: false)
2398
- * @type boolean
2399
- * @memberof OpenChannelApigetAnOpenChannel
2400
- */
2401
- includeOperators?: boolean
2402
- }
2403
-
2404
- export interface OpenChannelApiListChannelOperatorsRequest {
2405
- /**
2406
- * (Required)
2407
- * @type string
2408
- * @memberof OpenChannelApilistChannelOperators
2409
- */
2410
- channelUrl: string
2411
- /**
2412
- *
2413
- * @type string
2414
- * @memberof OpenChannelApilistChannelOperators
2415
- */
2416
- token?: string
2417
- /**
2418
- *
2419
- * @type number
2420
- * @memberof OpenChannelApilistChannelOperators
2421
- */
2422
- limit?: number
2423
- /**
2424
- *
2425
- * @type string
2426
- * @memberof OpenChannelApilistChannelOperators
2427
- */
2428
- apiToken?: string
2429
- }
2430
-
2431
- export interface OpenChannelApiListOpenChannelsRequest {
2432
- /**
2433
- *
2434
- * @type string
2435
- * @memberof OpenChannelApilistOpenChannels
2436
- */
2437
- token?: string
2438
- /**
2439
- * Specifies a comma-separated string of one or more open channel URLs to restrict the search scope. URL encoding each channel URL is recommended.
2440
- * @type string
2441
- * @memberof OpenChannelApilistOpenChannels
2442
- */
2443
- channelUrls?: string
2444
- /**
2445
- *
2446
- * @type number
2447
- * @memberof OpenChannelApilistOpenChannels
2448
- */
2449
- limit?: number
2450
- /**
2451
- * 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.
2452
- * @type string
2453
- * @memberof OpenChannelApilistOpenChannels
2454
- */
2455
- customTypes?: string
2456
- /**
2457
- *
2458
- * @type string
2459
- * @memberof OpenChannelApilistOpenChannels
2460
- */
2461
- nameContains?: string
2462
- /**
2463
- *
2464
- * @type string
2465
- * @memberof OpenChannelApilistOpenChannels
2466
- */
2467
- urlContains?: string
2468
- /**
2469
- * Determines whether to include frozen channels in the response. Frozen channels are channels where only channel operators are allowed to send messages. (Default: true)
2470
- * @type boolean
2471
- * @memberof OpenChannelApilistOpenChannels
2472
- */
2473
- showFrozen?: boolean
2474
- /**
2475
- * Determines whether to include channel metadata in the response. (Default: false)
2476
- * @type boolean
2477
- * @memberof OpenChannelApilistOpenChannels
2478
- */
2479
- showMetadata?: boolean
2480
- /**
2481
- *
2482
- * @type string
2483
- * @memberof OpenChannelApilistOpenChannels
2484
- */
2485
- apiToken?: string
2486
- }
2487
-
2488
- export interface OpenChannelApiRegisterOperatorsRequest {
2489
- /**
2490
- * (Required)
2491
- * @type string
2492
- * @memberof OpenChannelApiregisterOperators
2493
- */
2494
- channelUrl: string
2495
- /**
2496
- *
2497
- * @type string
2498
- * @memberof OpenChannelApiregisterOperators
2499
- */
2500
- apiToken?: string
2501
- /**
2502
- *
2503
- * @type RegisterOperatorsToAGroupChannelRequest
2504
- * @memberof OpenChannelApiregisterOperators
2505
- */
2506
- registerOperatorsToAGroupChannelRequest?: RegisterOperatorsToAGroupChannelRequest
2507
- }
2508
-
2509
- export interface OpenChannelApiUnregisterOperatorsRequest {
2510
- /**
2511
- * (Required)
2512
- * @type string
2513
- * @memberof OpenChannelApiunregisterOperators
2514
- */
2515
- channelUrl: string
2516
- /**
2517
- * 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.
2518
- * @type string
2519
- * @memberof OpenChannelApiunregisterOperators
2520
- */
2521
- operatorIds: string
2522
- /**
2523
- * 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)
2524
- * @type boolean
2525
- * @memberof OpenChannelApiunregisterOperators
2526
- */
2527
- deleteAll?: boolean
2528
- /**
2529
- *
2530
- * @type string
2531
- * @memberof OpenChannelApiunregisterOperators
2532
- */
2533
- apiToken?: string
2534
- }
2535
-
2536
- export interface OpenChannelApiUpdateAnOpenChannelRequest {
2537
- /**
2538
- * (Required)
2539
- * @type string
2540
- * @memberof OpenChannelApiupdateAnOpenChannel
2541
- */
2542
- channelUrl: string
2543
- /**
2544
- *
2545
- * @type string
2546
- * @memberof OpenChannelApiupdateAnOpenChannel
2547
- */
2548
- apiToken?: string
2549
- /**
2550
- *
2551
- * @type UpdateAnOpenChannelRequest
2552
- * @memberof OpenChannelApiupdateAnOpenChannel
2553
- */
2554
- updateAnOpenChannelRequest?: UpdateAnOpenChannelRequest
2555
- }
2556
-
2557
- export class ObjectOpenChannelApi {
2558
- private api: ObservableOpenChannelApi
2559
-
2560
- public constructor(configuration: Configuration, requestFactory?: OpenChannelApiRequestFactory, responseProcessor?: OpenChannelApiResponseProcessor) {
2561
- this.api = new ObservableOpenChannelApi(configuration, requestFactory, responseProcessor);
2562
- }
2563
-
2564
- /**
2565
- * ## 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)
2566
- * Create an open channel
2567
- * @param param the request object
2568
- */
2569
- public createAnOpenChannel(param: OpenChannelApiCreateAnOpenChannelRequest = {}, options?: Configuration): Promise<SendbirdOpenChannel> {
2570
- return this.api.createAnOpenChannel(param.apiToken, param.createAnOpenChannelRequest, options).toPromise();
2571
- }
2572
-
2573
- /**
2574
- * ## 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
2575
- * Delete an open channel
2576
- * @param param the request object
2577
- */
2578
- public deleteAnOpenChannel(param: OpenChannelApiDeleteAnOpenChannelRequest, options?: Configuration): Promise<any> {
2579
- return this.api.deleteAnOpenChannel(param.channelUrl, param.apiToken, options).toPromise();
2580
- }
2581
-
2582
- /**
2583
- * ## 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)
2584
- * Get an open channel
2585
- * @param param the request object
2586
- */
2587
- public getAnOpenChannel(param: OpenChannelApiGetAnOpenChannelRequest, options?: Configuration): Promise<SendbirdOpenChannel> {
2588
- return this.api.getAnOpenChannel(param.channelUrl, param.apiToken, param.includeOperators, options).toPromise();
2589
- }
2590
-
2591
- /**
2592
- * ## 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.
2593
- * List operators of an open channel
2594
- * @param param the request object
2595
- */
2596
- public listChannelOperators(param: OpenChannelApiListChannelOperatorsRequest, options?: Configuration): Promise<ListOperatorsResponse> {
2597
- return this.api.listChannelOperators(param.channelUrl, param.token, param.limit, param.apiToken, options).toPromise();
2598
- }
2599
-
2600
- /**
2601
- * ## 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)
2602
- * List open channels
2603
- * @param param the request object
2604
- */
2605
- public listOpenChannels(param: OpenChannelApiListOpenChannelsRequest = {}, options?: Configuration): Promise<ListOpenChannelsResponse> {
2606
- return this.api.listOpenChannels(param.token, param.channelUrls, param.limit, param.customTypes, param.nameContains, param.urlContains, param.showFrozen, param.showMetadata, param.apiToken, options).toPromise();
2607
- }
2608
-
2609
- /**
2610
- * ## 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
2611
- * Register operators to an open channel
2612
- * @param param the request object
2613
- */
2614
- public registerOperators(param: OpenChannelApiRegisterOperatorsRequest, options?: Configuration): Promise<any> {
2615
- return this.api.registerOperators(param.channelUrl, param.apiToken, param.registerOperatorsToAGroupChannelRequest, options).toPromise();
2616
- }
2617
-
2618
- /**
2619
- * ## 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.
2620
- * Unregister operators from an open channel
2621
- * @param param the request object
2622
- */
2623
- public unregisterOperators(param: OpenChannelApiUnregisterOperatorsRequest, options?: Configuration): Promise<any> {
2624
- return this.api.unregisterOperators(param.channelUrl, param.operatorIds, param.deleteAll, param.apiToken, options).toPromise();
2625
- }
2626
-
2627
- /**
2628
- * ## 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
2629
- * Update an open channel
2630
- * @param param the request object
2631
- */
2632
- public updateAnOpenChannel(param: OpenChannelApiUpdateAnOpenChannelRequest, options?: Configuration): Promise<SendbirdOpenChannel> {
2633
- return this.api.updateAnOpenChannel(param.channelUrl, param.apiToken, param.updateAnOpenChannelRequest, options).toPromise();
2634
- }
2635
-
2636
- }
2637
-
2638
- import { ObservableStatisticsApi } from "./ObservableAPI";
2639
- import { StatisticsApiRequestFactory, StatisticsApiResponseProcessor} from "../apis/StatisticsApi";
2640
-
2641
- export interface StatisticsApiViewNumberOfDailyActiveUsersRequest {
2642
- /**
2643
- * YYYY-MM-DD
2644
- * @type string
2645
- * @memberof StatisticsApiviewNumberOfDailyActiveUsers
2646
- */
2647
- date?: string
2648
- /**
2649
- *
2650
- * @type string
2651
- * @memberof StatisticsApiviewNumberOfDailyActiveUsers
2652
- */
2653
- apiToken?: string
2654
- }
2655
-
2656
- export interface StatisticsApiViewNumberOfMonthlyActiveUsersRequest {
2657
- /**
2658
- * YYYY-MM-DD
2659
- * @type string
2660
- * @memberof StatisticsApiviewNumberOfMonthlyActiveUsers
2661
- */
2662
- date?: string
2663
- /**
2664
- *
2665
- * @type string
2666
- * @memberof StatisticsApiviewNumberOfMonthlyActiveUsers
2667
- */
2668
- apiToken?: string
2669
- }
2670
-
2671
- export class ObjectStatisticsApi {
2672
- private api: ObservableStatisticsApi
2673
-
2674
- public constructor(configuration: Configuration, requestFactory?: StatisticsApiRequestFactory, responseProcessor?: StatisticsApiResponseProcessor) {
2675
- this.api = new ObservableStatisticsApi(configuration, requestFactory, responseProcessor);
2676
- }
2677
-
2678
- /**
2679
- * ## 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)
2680
- * View number of daily active users
2681
- * @param param the request object
2682
- */
2683
- public viewNumberOfDailyActiveUsers(param: StatisticsApiViewNumberOfDailyActiveUsersRequest = {}, options?: Configuration): Promise<ViewNumberOfDailyActiveUsersResponse> {
2684
- return this.api.viewNumberOfDailyActiveUsers(param.date, param.apiToken, options).toPromise();
2685
- }
2686
-
2687
- /**
2688
- * ## 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)
2689
- * View number of monthly active users
2690
- * @param param the request object
2691
- */
2692
- public viewNumberOfMonthlyActiveUsers(param: StatisticsApiViewNumberOfMonthlyActiveUsersRequest = {}, options?: Configuration): Promise<ViewNumberOfMonthlyActiveUsersResponse> {
2693
- return this.api.viewNumberOfMonthlyActiveUsers(param.date, param.apiToken, options).toPromise();
2694
- }
2695
-
2696
- }
2697
-
2698
- import { ObservableUserApi } from "./ObservableAPI";
2699
- import { UserApiRequestFactory, UserApiResponseProcessor} from "../apis/UserApi";
2700
-
2701
- export interface UserApiAddARegistrationOrDeviceTokenRequest {
2702
- /**
2703
- * (Required)
2704
- * @type string
2705
- * @memberof UserApiaddARegistrationOrDeviceToken
2706
- */
2707
- userId: string
2708
- /**
2709
- * (Required)
2710
- * @type &#39;gcm&#39; | &#39;huawei&#39; | &#39;apns&#39;
2711
- * @memberof UserApiaddARegistrationOrDeviceToken
2712
- */
2713
- tokenType: 'gcm' | 'huawei' | 'apns'
2714
- /**
2715
- *
2716
- * @type string
2717
- * @memberof UserApiaddARegistrationOrDeviceToken
2718
- */
2719
- apiToken?: string
2720
- /**
2721
- *
2722
- * @type AddARegistrationOrDeviceTokenRequest
2723
- * @memberof UserApiaddARegistrationOrDeviceToken
2724
- */
2725
- addARegistrationOrDeviceTokenRequest?: AddARegistrationOrDeviceTokenRequest
2726
- }
2727
-
2728
- export interface UserApiChooseAPushNotificationContentTemplateRequest {
2729
- /**
2730
- * (Required)
2731
- * @type string
2732
- * @memberof UserApichooseAPushNotificationContentTemplate
2733
- */
2734
- userId: string
2735
- /**
2736
- *
2737
- * @type string
2738
- * @memberof UserApichooseAPushNotificationContentTemplate
2739
- */
2740
- apiToken?: string
2741
- /**
2742
- *
2743
- * @type ChooseAPushNotificationContentTemplateRequest
2744
- * @memberof UserApichooseAPushNotificationContentTemplate
2745
- */
2746
- chooseAPushNotificationContentTemplateRequest?: ChooseAPushNotificationContentTemplateRequest
2747
- }
2748
-
2749
- export interface UserApiCreateAUserRequest {
2750
- /**
2751
- *
2752
- * @type string
2753
- * @memberof UserApicreateAUser
2754
- */
2755
- apiToken?: string
2756
- /**
2757
- *
2758
- * @type CreateAUserRequest
2759
- * @memberof UserApicreateAUser
2760
- */
2761
- createAUserRequest?: CreateAUserRequest
2762
- }
2763
-
2764
- export interface UserApiCreateUserMetadataRequest {
2765
- /**
2766
- * (Required)
2767
- * @type string
2768
- * @memberof UserApicreateUserMetadata
2769
- */
2770
- userId: string
2771
- /**
2772
- *
2773
- * @type string
2774
- * @memberof UserApicreateUserMetadata
2775
- */
2776
- apiToken?: string
2777
- /**
2778
- *
2779
- * @type CreateUserMetadataRequest
2780
- * @memberof UserApicreateUserMetadata
2781
- */
2782
- createUserMetadataRequest?: CreateUserMetadataRequest
2783
- }
2784
-
2785
- export interface UserApiCreateUserTokenRequest {
2786
- /**
2787
- * (Required)
2788
- * @type string
2789
- * @memberof UserApicreateUserToken
2790
- */
2791
- userId: string
2792
- /**
2793
- *
2794
- * @type string
2795
- * @memberof UserApicreateUserToken
2796
- */
2797
- apiToken?: string
2798
- /**
2799
- *
2800
- * @type CreateUserTokenRequest
2801
- * @memberof UserApicreateUserToken
2802
- */
2803
- createUserTokenRequest?: CreateUserTokenRequest
2804
- }
2805
-
2806
- export interface UserApiDeleteAUserRequest {
2807
- /**
2808
- * (Required)
2809
- * @type string
2810
- * @memberof UserApideleteAUser
2811
- */
2812
- userId: string
2813
- /**
2814
- *
2815
- * @type string
2816
- * @memberof UserApideleteAUser
2817
- */
2818
- apiToken?: string
2819
- }
2820
-
2821
- export interface UserApiDeleteSpecificUserMetadataRequest {
2822
- /**
2823
- * (Required)
2824
- * @type string
2825
- * @memberof UserApideleteSpecificUserMetadata
2826
- */
2827
- userId: string
2828
- /**
2829
- *
2830
- * @type string
2831
- * @memberof UserApideleteSpecificUserMetadata
2832
- */
2833
- key: string
2834
- /**
2835
- *
2836
- * @type string
2837
- * @memberof UserApideleteSpecificUserMetadata
2838
- */
2839
- apiToken?: string
2840
- }
2841
-
2842
- export interface UserApiDeleteUserAllMetadataRequest {
2843
- /**
2844
- * (Required)
2845
- * @type string
2846
- * @memberof UserApideleteUserAllMetadata
2847
- */
2848
- userId: string
2849
- /**
2850
- *
2851
- * @type string
2852
- * @memberof UserApideleteUserAllMetadata
2853
- */
2854
- apiToken?: string
2855
- }
2856
-
2857
- export interface UserApiGetChannelInvitationPreferenceRequest {
2858
- /**
2859
- * (Required)
2860
- * @type string
2861
- * @memberof UserApigetChannelInvitationPreference
2862
- */
2863
- userId: string
2864
- /**
2865
- *
2866
- * @type string
2867
- * @memberof UserApigetChannelInvitationPreference
2868
- */
2869
- apiToken?: string
2870
- }
2871
-
2872
- export interface UserApiLeaveMyGroupChannelsRequest {
2873
- /**
2874
- * (Required)
2875
- * @type string
2876
- * @memberof UserApileaveMyGroupChannels
2877
- */
2878
- userId: string
2879
- /**
2880
- *
2881
- * @type string
2882
- * @memberof UserApileaveMyGroupChannels
2883
- */
2884
- apiToken?: string
2885
- /**
2886
- *
2887
- * @type LeaveMyGroupChannelsRequest
2888
- * @memberof UserApileaveMyGroupChannels
2889
- */
2890
- leaveMyGroupChannelsRequest?: LeaveMyGroupChannelsRequest
2891
- }
2892
-
2893
- export interface UserApiListMyGroupChannelsRequest {
2894
- /**
2895
- * (Required)
2896
- * @type string
2897
- * @memberof UserApilistMyGroupChannels
2898
- */
2899
- userId: string
2900
- /**
2901
- *
2902
- * @type string
2903
- * @memberof UserApilistMyGroupChannels
2904
- */
2905
- apiToken: string
2906
- /**
2907
- * Specifies a page token that indicates the starting index of a chunk of results. If not specified, the index is set as 0.
2908
- * @type string
2909
- * @memberof UserApilistMyGroupChannels
2910
- */
2911
- token?: string
2912
- /**
2913
- * Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
2914
- * @type number
2915
- * @memberof UserApilistMyGroupChannels
2916
- */
2917
- limit?: number
2918
- /**
2919
- *
2920
- * @type &#39;all&#39; | &#39;distinct&#39; | &#39;nondistinct&#39;
2921
- * @memberof UserApilistMyGroupChannels
2922
- */
2923
- distinctMode?: 'all' | 'distinct' | 'nondistinct'
2924
- /**
2925
- *
2926
- * @type &#39;all&#39; | &#39;private&#39; | &#39;public&#39;
2927
- * @memberof UserApilistMyGroupChannels
2928
- */
2929
- publicMode?: 'all' | 'private' | 'public'
2930
- /**
2931
- *
2932
- * @type &#39;all&#39; | &#39;super&#39; | &#39;nonsuper&#39;
2933
- * @memberof UserApilistMyGroupChannels
2934
- */
2935
- superMode?: 'all' | 'super' | 'nonsuper'
2936
- /**
2937
- * Restricts the search scope to only retrieve group channels which have been created after the specified time, in Unix milliseconds format.
2938
- * @type number
2939
- * @memberof UserApilistMyGroupChannels
2940
- */
2941
- createdAfter?: number
2942
- /**
2943
- * Restricts the search scope to only retrieve group channels which have been created before the specified time, in Unix milliseconds format.
2944
- * @type number
2945
- * @memberof UserApilistMyGroupChannels
2946
- */
2947
- createdBefore?: number
2948
- /**
2949
- *
2950
- * @type boolean
2951
- * @memberof UserApilistMyGroupChannels
2952
- */
2953
- showEmpty?: boolean
2954
- /**
2955
- *
2956
- * @type boolean
2957
- * @memberof UserApilistMyGroupChannels
2958
- */
2959
- showMember?: boolean
2960
- /**
2961
- *
2962
- * @type boolean
2963
- * @memberof UserApilistMyGroupChannels
2964
- */
2965
- showDeliveryReceipt?: boolean
2966
- /**
2967
- *
2968
- * @type boolean
2969
- * @memberof UserApilistMyGroupChannels
2970
- */
2971
- showReadReceipt?: boolean
2972
- /**
2973
- *
2974
- * @type boolean
2975
- * @memberof UserApilistMyGroupChannels
2976
- */
2977
- showMetadata?: boolean
2978
- /**
2979
- *
2980
- * @type boolean
2981
- * @memberof UserApilistMyGroupChannels
2982
- */
2983
- showFrozen?: boolean
2984
- /**
2985
- *
2986
- * @type &#39;chronological&#39; | &#39;latest_last_message&#39; | &#39;channel_name_alphabetical&#39; | &#39;metadata_value_alphabetical&#39;
2987
- * @memberof UserApilistMyGroupChannels
2988
- */
2989
- order?: 'chronological' | 'latest_last_message' | 'channel_name_alphabetical' | 'metadata_value_alphabetical'
2990
- /**
2991
- * 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.
2992
- * @type string
2993
- * @memberof UserApilistMyGroupChannels
2994
- */
2995
- metadataOrderKey?: string
2996
- /**
2997
- * 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.
2998
- * @type string
2999
- * @memberof UserApilistMyGroupChannels
3000
- */
3001
- customTypes?: string
3002
- /**
3003
- * Searches for group channels with the custom type which starts with the specified value. URL encoding the value is recommended.
3004
- * @type string
3005
- * @memberof UserApilistMyGroupChannels
3006
- */
3007
- customTypeStartswith?: string
3008
- /**
3009
- * Specifies a comma-separated string of one or more group channel URLs to restrict the search scope. URL encoding each channel URL is recommended.
3010
- * @type string
3011
- * @memberof UserApilistMyGroupChannels
3012
- */
3013
- channelUrls?: string
3014
- /**
3015
- * Specifies one or more group channel names.
3016
- * @type string
3017
- * @memberof UserApilistMyGroupChannels
3018
- */
3019
- name?: string
3020
- /**
3021
- * Searches for group channels whose names contain the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
3022
- * @type string
3023
- * @memberof UserApilistMyGroupChannels
3024
- */
3025
- nameContains?: string
3026
- /**
3027
- * Searches for group channels whose names start with the specified value. Note that this parameter is case-insensitive. URL encoding the value is recommended.
3028
- * @type string
3029
- * @memberof UserApilistMyGroupChannels
3030
- */
3031
- nameStartswith?: string
3032
- /**
3033
- * 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.
3034
- * @type string
3035
- * @memberof UserApilistMyGroupChannels
3036
- */
3037
- membersExactlyIn?: string
3038
- /**
3039
- * 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.
3040
- * @type string
3041
- * @memberof UserApilistMyGroupChannels
3042
- */
3043
- membersIncludeIn?: string
3044
- /**
3045
- * 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)
3046
- * @type string
3047
- * @memberof UserApilistMyGroupChannels
3048
- */
3049
- queryType?: string
3050
- /**
3051
- * Searches for group channels with members whose nicknames match the specified value. URL encoding the value is recommended.
3052
- * @type string
3053
- * @memberof UserApilistMyGroupChannels
3054
- */
3055
- membersNickname?: string
3056
- /**
3057
- * 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.
3058
- * @type string
3059
- * @memberof UserApilistMyGroupChannels
3060
- */
3061
- membersNicknameContains?: string
3062
- /**
3063
- * 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.
3064
- * @type string
3065
- * @memberof UserApilistMyGroupChannels
3066
- */
3067
- membersNicknameStartswith?: string
3068
- /**
3069
- * 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.
3070
- * @type string
3071
- * @memberof UserApilistMyGroupChannels
3072
- */
3073
- searchQuery?: string
3074
- /**
3075
- * 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)
3076
- * @type string
3077
- * @memberof UserApilistMyGroupChannels
3078
- */
3079
- searchFields?: string
3080
- /**
3081
- * 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.
3082
- * @type string
3083
- * @memberof UserApilistMyGroupChannels
3084
- */
3085
- metadataKey?: string
3086
- /**
3087
- * 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.
3088
- * @type string
3089
- * @memberof UserApilistMyGroupChannels
3090
- */
3091
- metadataValues?: string
3092
- /**
3093
- * 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.
3094
- * @type string
3095
- * @memberof UserApilistMyGroupChannels
3096
- */
3097
- metadataValueStartswith?: string
3098
- /**
3099
- * 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.
3100
- * @type string
3101
- * @memberof UserApilistMyGroupChannels
3102
- */
3103
- metacounterKey?: string
3104
- /**
3105
- * 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.
3106
- * @type string
3107
- * @memberof UserApilistMyGroupChannels
3108
- */
3109
- metacounterValues?: string
3110
- /**
3111
- * 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.
3112
- * @type string
3113
- * @memberof UserApilistMyGroupChannels
3114
- */
3115
- metacounterValueGt?: string
3116
- /**
3117
- * 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.
3118
- * @type string
3119
- * @memberof UserApilistMyGroupChannels
3120
- */
3121
- metacounterValueGte?: string
3122
- /**
3123
- * 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.
3124
- * @type string
3125
- * @memberof UserApilistMyGroupChannels
3126
- */
3127
- metacounterValueLt?: string
3128
- /**
3129
- * 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.
3130
- * @type string
3131
- * @memberof UserApilistMyGroupChannels
3132
- */
3133
- metacounterValueLte?: string
3134
- /**
3135
- * Determines whether to include the sorted_metaarray as one of the last_message’s properties in the response.
3136
- * @type boolean
3137
- * @memberof UserApilistMyGroupChannels
3138
- */
3139
- includeSortedMetaarrayInLastMessage?: boolean
3140
- /**
3141
- * Restricts the search scope to group channels that match a specific hidden_status and operating behavior
3142
- * @type &#39;unhidden_only&#39; | &#39;hidden_only&#39; | &#39;hidden_allow_auto_unhide&#39; | &#39;hidden_prevent_auto_unhide&#39; | &#39;all&#39;
3143
- * @memberof UserApilistMyGroupChannels
3144
- */
3145
- hiddenMode?: 'unhidden_only' | 'hidden_only' | 'hidden_allow_auto_unhide' | 'hidden_prevent_auto_unhide' | 'all'
3146
- /**
3147
- * 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)
3148
- * @type &#39;all&#39; | &#39;unread_message&#39;
3149
- * @memberof UserApilistMyGroupChannels
3150
- */
3151
- unreadFilter?: 'all' | 'unread_message'
3152
- /**
3153
- *
3154
- * @type &#39;all&#39; | &#39;invited_only&#39; | &#39;joined_only&#39; | &#39;invited_by_friend&#39; | &#39;invited_by_non_friend&#39;
3155
- * @memberof UserApilistMyGroupChannels
3156
- */
3157
- memberStateFilter?: 'all' | 'invited_only' | 'joined_only' | 'invited_by_friend' | 'invited_by_non_friend'
3158
- }
3159
-
3160
- export interface UserApiListRegistrationOrDeviceTokensRequest {
3161
- /**
3162
- * (Required)
3163
- * @type string
3164
- * @memberof UserApilistRegistrationOrDeviceTokens
3165
- */
3166
- userId: string
3167
- /**
3168
- * (Required)
3169
- * @type &#39;gcm&#39; | &#39;huawei&#39; | &#39;apns&#39;
3170
- * @memberof UserApilistRegistrationOrDeviceTokens
3171
- */
3172
- tokenType: 'gcm' | 'huawei' | 'apns'
3173
- /**
3174
- *
3175
- * @type string
3176
- * @memberof UserApilistRegistrationOrDeviceTokens
3177
- */
3178
- apiToken?: string
3179
- }
3180
-
3181
- export interface UserApiListUsersRequest {
3182
- /**
3183
- *
3184
- * @type string
3185
- * @memberof UserApilistUsers
3186
- */
3187
- token?: string
3188
- /**
3189
- *
3190
- * @type number
3191
- * @memberof UserApilistUsers
3192
- */
3193
- limit?: number
3194
- /**
3195
- * 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;)
3196
- * @type &#39;activated&#39; | &#39;deactivated&#39; | &#39;all&#39;
3197
- * @memberof UserApilistUsers
3198
- */
3199
- activeMode?: 'activated' | 'deactivated' | 'all'
3200
- /**
3201
- * Determines whether to include bots in the list. (Default: true)
3202
- * @type boolean
3203
- * @memberof UserApilistUsers
3204
- */
3205
- showBot?: boolean
3206
- /**
3207
- * 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.
3208
- * @type string
3209
- * @memberof UserApilistUsers
3210
- */
3211
- userIds?: string
3212
- /**
3213
- *
3214
- * @type string
3215
- * @memberof UserApilistUsers
3216
- */
3217
- nickname?: string
3218
- /**
3219
- *
3220
- * @type string
3221
- * @memberof UserApilistUsers
3222
- */
3223
- nicknameStartswith?: string
3224
- /**
3225
- *
3226
- * @type string
3227
- * @memberof UserApilistUsers
3228
- */
3229
- metadatakey?: string
3230
- /**
3231
- * 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.
3232
- * @type string
3233
- * @memberof UserApilistUsers
3234
- */
3235
- metadatavaluesIn?: string
3236
- /**
3237
- *
3238
- * @type string
3239
- * @memberof UserApilistUsers
3240
- */
3241
- apiToken?: string
3242
- }
3243
-
3244
- export interface UserApiMarkAllMessagesAsReadRequest {
3245
- /**
3246
- * (Required)
3247
- * @type string
3248
- * @memberof UserApimarkAllMessagesAsRead
3249
- */
3250
- userId: string
3251
- /**
3252
- *
3253
- * @type string
3254
- * @memberof UserApimarkAllMessagesAsRead
3255
- */
3256
- apiToken?: string
3257
- /**
3258
- *
3259
- * @type MarkAllMessagesAsReadRequest
3260
- * @memberof UserApimarkAllMessagesAsRead
3261
- */
3262
- markAllMessagesAsReadRequest?: MarkAllMessagesAsReadRequest
3263
- }
3264
-
3265
- export interface UserApiRemoveARegistrationOrDeviceTokenRequest {
3266
- /**
3267
- * (Required)
3268
- * @type string
3269
- * @memberof UserApiremoveARegistrationOrDeviceToken
3270
- */
3271
- userId: string
3272
- /**
3273
- * (Required)
3274
- * @type &#39;gcm&#39; | &#39;huawei&#39; | &#39;apns&#39;
3275
- * @memberof UserApiremoveARegistrationOrDeviceToken
3276
- */
3277
- tokenType: 'gcm' | 'huawei' | 'apns'
3278
- /**
3279
- * (Required)
3280
- * @type string
3281
- * @memberof UserApiremoveARegistrationOrDeviceToken
3282
- */
3283
- token: string
3284
- /**
3285
- *
3286
- * @type string
3287
- * @memberof UserApiremoveARegistrationOrDeviceToken
3288
- */
3289
- apiToken?: string
3290
- }
3291
-
3292
- export interface UserApiRemoveARegistrationOrDeviceTokenFromAnOwnerRequest {
3293
- /**
3294
- * (Required)
3295
- * @type string
3296
- * @memberof UserApiremoveARegistrationOrDeviceTokenFromAnOwner
3297
- */
3298
- tokenType: string
3299
- /**
3300
- * (Required)
3301
- * @type string
3302
- * @memberof UserApiremoveARegistrationOrDeviceTokenFromAnOwner
3303
- */
3304
- token: string
3305
- /**
3306
- *
3307
- * @type string
3308
- * @memberof UserApiremoveARegistrationOrDeviceTokenFromAnOwner
3309
- */
3310
- apiToken?: string
3311
- }
3312
-
3313
- export interface UserApiRemoveAllRegistrationOrDeviceTokenRequest {
3314
- /**
3315
- * (Required)
3316
- * @type string
3317
- * @memberof UserApiremoveAllRegistrationOrDeviceToken
3318
- */
3319
- userId: string
3320
- /**
3321
- *
3322
- * @type string
3323
- * @memberof UserApiremoveAllRegistrationOrDeviceToken
3324
- */
3325
- apiToken?: string
3326
- }
3327
-
3328
- export interface UserApiResetPushPreferencesRequest {
3329
- /**
3330
- * (Required)
3331
- * @type string
3332
- * @memberof UserApiresetPushPreferences
3333
- */
3334
- userId: string
3335
- /**
3336
- *
3337
- * @type string
3338
- * @memberof UserApiresetPushPreferences
3339
- */
3340
- apiToken?: string
3341
- }
3342
-
3343
- export interface UserApiUpdateAUserRequest {
3344
- /**
3345
- * (Required)
3346
- * @type string
3347
- * @memberof UserApiupdateAUser
3348
- */
3349
- userId: string
3350
- /**
3351
- *
3352
- * @type string
3353
- * @memberof UserApiupdateAUser
3354
- */
3355
- apiToken?: string
3356
- /**
3357
- *
3358
- * @type UpdateAUserRequest
3359
- * @memberof UserApiupdateAUser
3360
- */
3361
- updateAUserRequest?: UpdateAUserRequest
3362
- }
3363
-
3364
- export interface UserApiUpdateChannelInvitationPreferenceRequest {
3365
- /**
3366
- * (Required)
3367
- * @type string
3368
- * @memberof UserApiupdateChannelInvitationPreference
3369
- */
3370
- userId: string
3371
- /**
3372
- *
3373
- * @type string
3374
- * @memberof UserApiupdateChannelInvitationPreference
3375
- */
3376
- apiToken?: string
3377
- /**
3378
- *
3379
- * @type UpdateChannelInvitationPreferenceRequest
3380
- * @memberof UserApiupdateChannelInvitationPreference
3381
- */
3382
- updateChannelInvitationPreferenceRequest?: UpdateChannelInvitationPreferenceRequest
3383
- }
3384
-
3385
- export interface UserApiUpdateCountPreferenceOfAChannelRequest {
3386
- /**
3387
- * (Required)
3388
- * @type string
3389
- * @memberof UserApiupdateCountPreferenceOfAChannel
3390
- */
3391
- userId: string
3392
- /**
3393
- * (Required)
3394
- * @type string
3395
- * @memberof UserApiupdateCountPreferenceOfAChannel
3396
- */
3397
- channelUrl: string
3398
- /**
3399
- *
3400
- * @type string
3401
- * @memberof UserApiupdateCountPreferenceOfAChannel
3402
- */
3403
- apiToken?: string
3404
- /**
3405
- *
3406
- * @type UpdateCountPreferenceOfAChannelRequest
3407
- * @memberof UserApiupdateCountPreferenceOfAChannel
3408
- */
3409
- updateCountPreferenceOfAChannelRequest?: UpdateCountPreferenceOfAChannelRequest
3410
- }
3411
-
3412
- export interface UserApiUpdatePushPreferencesRequest {
3413
- /**
3414
- * (Required)
3415
- * @type string
3416
- * @memberof UserApiupdatePushPreferences
3417
- */
3418
- userId: string
3419
- /**
3420
- *
3421
- * @type string
3422
- * @memberof UserApiupdatePushPreferences
3423
- */
3424
- apiToken?: string
3425
- /**
3426
- *
3427
- * @type UpdatePushPreferencesRequest
3428
- * @memberof UserApiupdatePushPreferences
3429
- */
3430
- updatePushPreferencesRequest?: UpdatePushPreferencesRequest
3431
- }
3432
-
3433
- export interface UserApiUpdatePushPreferencesForAChannelRequest {
3434
- /**
3435
- * (Required)
3436
- * @type string
3437
- * @memberof UserApiupdatePushPreferencesForAChannel
3438
- */
3439
- userId: string
3440
- /**
3441
- * (Required)
3442
- * @type string
3443
- * @memberof UserApiupdatePushPreferencesForAChannel
3444
- */
3445
- channelUrl: string
3446
- /**
3447
- *
3448
- * @type string
3449
- * @memberof UserApiupdatePushPreferencesForAChannel
3450
- */
3451
- apiToken?: string
3452
- /**
3453
- *
3454
- * @type UpdatePushPreferencesForAChannelRequest
3455
- * @memberof UserApiupdatePushPreferencesForAChannel
3456
- */
3457
- updatePushPreferencesForAChannelRequest?: UpdatePushPreferencesForAChannelRequest
3458
- }
3459
-
3460
- export interface UserApiUpdateSpecificUserMetadataRequest {
3461
- /**
3462
- * (Required)
3463
- * @type string
3464
- * @memberof UserApiupdateSpecificUserMetadata
3465
- */
3466
- userId: string
3467
- /**
3468
- *
3469
- * @type string
3470
- * @memberof UserApiupdateSpecificUserMetadata
3471
- */
3472
- key: string
3473
- /**
3474
- *
3475
- * @type string
3476
- * @memberof UserApiupdateSpecificUserMetadata
3477
- */
3478
- apiToken?: string
3479
- /**
3480
- *
3481
- * @type UpdateSpecificUserMetadataRequest
3482
- * @memberof UserApiupdateSpecificUserMetadata
3483
- */
3484
- updateSpecificUserMetadataRequest?: UpdateSpecificUserMetadataRequest
3485
- }
3486
-
3487
- export interface UserApiUpdateUserMetadataRequest {
3488
- /**
3489
- * (Required)
3490
- * @type string
3491
- * @memberof UserApiupdateUserMetadata
3492
- */
3493
- userId: string
3494
- /**
3495
- *
3496
- * @type string
3497
- * @memberof UserApiupdateUserMetadata
3498
- */
3499
- apiToken?: string
3500
- /**
3501
- *
3502
- * @type UpdateUserMetadataRequest
3503
- * @memberof UserApiupdateUserMetadata
3504
- */
3505
- updateUserMetadataRequest?: UpdateUserMetadataRequest
3506
- }
3507
-
3508
- export interface UserApiViewAUserRequest {
3509
- /**
3510
- * (Required)
3511
- * @type string
3512
- * @memberof UserApiviewAUser
3513
- */
3514
- userId: string
3515
- /**
3516
- *
3517
- * @type boolean
3518
- * @memberof UserApiviewAUser
3519
- */
3520
- includeUnreadCount?: boolean
3521
- /**
3522
- *
3523
- * @type string
3524
- * @memberof UserApiviewAUser
3525
- */
3526
- customTypes?: string
3527
- /**
3528
- * 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;)
3529
- * @type &#39;all&#39; | &#39;super&#39; | &#39;nonsuper&#39;
3530
- * @memberof UserApiviewAUser
3531
- */
3532
- superMode?: 'all' | 'super' | 'nonsuper'
3533
- /**
3534
- *
3535
- * @type string
3536
- * @memberof UserApiviewAUser
3537
- */
3538
- apiToken?: string
3539
- }
3540
-
3541
- export interface UserApiViewCountPreferenceOfAChannelRequest {
3542
- /**
3543
- * (Required)
3544
- * @type string
3545
- * @memberof UserApiviewCountPreferenceOfAChannel
3546
- */
3547
- userId: string
3548
- /**
3549
- * (Required)
3550
- * @type string
3551
- * @memberof UserApiviewCountPreferenceOfAChannel
3552
- */
3553
- channelUrl: string
3554
- /**
3555
- *
3556
- * @type string
3557
- * @memberof UserApiviewCountPreferenceOfAChannel
3558
- */
3559
- apiToken?: string
3560
- }
3561
-
3562
- export interface UserApiViewNumberOfChannelsWithUnreadMessagesRequest {
3563
- /**
3564
- * (Required)
3565
- * @type string
3566
- * @memberof UserApiviewNumberOfChannelsWithUnreadMessages
3567
- */
3568
- userId: string
3569
- /**
3570
- *
3571
- * @type string
3572
- * @memberof UserApiviewNumberOfChannelsWithUnreadMessages
3573
- */
3574
- customTypes?: string
3575
- /**
3576
- * Restricts the search scope to either Supergroup channels or non-Supergroup channels or both. Acceptable values are all, super, and nonsuper. (Default: all)
3577
- * @type &#39;all&#39; | &#39;super&#39; | &#39;nonsuper&#39;
3578
- * @memberof UserApiviewNumberOfChannelsWithUnreadMessages
3579
- */
3580
- superMode?: 'all' | 'super' | 'nonsuper'
3581
- /**
3582
- *
3583
- * @type string
3584
- * @memberof UserApiviewNumberOfChannelsWithUnreadMessages
3585
- */
3586
- apiToken?: string
3587
- }
3588
-
3589
- export interface UserApiViewNumberOfUnreadMessagesRequest {
3590
- /**
3591
- * (Required)
3592
- * @type string
3593
- * @memberof UserApiviewNumberOfUnreadMessages
3594
- */
3595
- userId: string
3596
- /**
3597
- * 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.
3598
- * @type string
3599
- * @memberof UserApiviewNumberOfUnreadMessages
3600
- */
3601
- customTypes?: string
3602
- /**
3603
- * 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;)
3604
- * @type string
3605
- * @memberof UserApiviewNumberOfUnreadMessages
3606
- */
3607
- superMode?: string
3608
- /**
3609
- *
3610
- * @type string
3611
- * @memberof UserApiviewNumberOfUnreadMessages
3612
- */
3613
- apiToken?: string
3614
- }
3615
-
3616
- export interface UserApiViewPushPreferencesRequest {
3617
- /**
3618
- * (Required)
3619
- * @type string
3620
- * @memberof UserApiviewPushPreferences
3621
- */
3622
- userId: string
3623
- /**
3624
- *
3625
- * @type string
3626
- * @memberof UserApiviewPushPreferences
3627
- */
3628
- apiToken?: string
3629
- }
3630
-
3631
- export interface UserApiViewPushPreferencesForAChannelRequest {
3632
- /**
3633
- * (Required)
3634
- * @type string
3635
- * @memberof UserApiviewPushPreferencesForAChannel
3636
- */
3637
- userId: string
3638
- /**
3639
- * (Required)
3640
- * @type string
3641
- * @memberof UserApiviewPushPreferencesForAChannel
3642
- */
3643
- channelUrl: string
3644
- /**
3645
- *
3646
- * @type string
3647
- * @memberof UserApiviewPushPreferencesForAChannel
3648
- */
3649
- apiToken?: string
3650
- }
3651
-
3652
- export interface UserApiViewSpecificUserMetadataRequest {
3653
- /**
3654
- * (Required)
3655
- * @type string
3656
- * @memberof UserApiviewSpecificUserMetadata
3657
- */
3658
- userId: string
3659
- /**
3660
- *
3661
- * @type string
3662
- * @memberof UserApiviewSpecificUserMetadata
3663
- */
3664
- key: string
3665
- /**
3666
- *
3667
- * @type string
3668
- * @memberof UserApiviewSpecificUserMetadata
3669
- */
3670
- apiToken?: string
3671
- }
3672
-
3673
- export interface UserApiViewWhoOwnsARegistrationOrDeviceTokenRequest {
3674
- /**
3675
- * (Required)
3676
- * @type string
3677
- * @memberof UserApiviewWhoOwnsARegistrationOrDeviceToken
3678
- */
3679
- tokenType: string
3680
- /**
3681
- * (Required)
3682
- * @type string
3683
- * @memberof UserApiviewWhoOwnsARegistrationOrDeviceToken
3684
- */
3685
- token: string
3686
- /**
3687
- *
3688
- * @type string
3689
- * @memberof UserApiviewWhoOwnsARegistrationOrDeviceToken
3690
- */
3691
- apiToken?: string
3692
- }
3693
-
3694
- export class ObjectUserApi {
3695
- private api: ObservableUserApi
3696
-
3697
- public constructor(configuration: Configuration, requestFactory?: UserApiRequestFactory, responseProcessor?: UserApiResponseProcessor) {
3698
- this.api = new ObservableUserApi(configuration, requestFactory, responseProcessor);
3699
- }
3700
-
3701
- /**
3702
- * ## 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 ----------------------------
3703
- * Add a registration or device token
3704
- * @param param the request object
3705
- */
3706
- public addARegistrationOrDeviceToken(param: UserApiAddARegistrationOrDeviceTokenRequest, options?: Configuration): Promise<AddARegistrationOrDeviceTokenResponse> {
3707
- return this.api.addARegistrationOrDeviceToken(param.userId, param.tokenType, param.apiToken, param.addARegistrationOrDeviceTokenRequest, options).toPromise();
3708
- }
3709
-
3710
- /**
3711
- * ## 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
3712
- * Choose a push notification content template
3713
- * @param param the request object
3714
- */
3715
- public chooseAPushNotificationContentTemplate(param: UserApiChooseAPushNotificationContentTemplateRequest, options?: Configuration): Promise<ChooseAPushNotificationContentTemplateResponse> {
3716
- return this.api.chooseAPushNotificationContentTemplate(param.userId, param.apiToken, param.chooseAPushNotificationContentTemplateRequest, options).toPromise();
3717
- }
3718
-
3719
- /**
3720
- * ## 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
3721
- * Create a user
3722
- * @param param the request object
3723
- */
3724
- public createAUser(param: UserApiCreateAUserRequest = {}, options?: Configuration): Promise<SendbirdUser> {
3725
- return this.api.createAUser(param.apiToken, param.createAUserRequest, options).toPromise();
3726
- }
3727
-
3728
- /**
3729
- * ## Create metadata When creating new items of the user metadata. https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-create-metadata
3730
- * Create user metadata
3731
- * @param param the request object
3732
- */
3733
- public createUserMetadata(param: UserApiCreateUserMetadataRequest, options?: Configuration): Promise<any> {
3734
- return this.api.createUserMetadata(param.userId, param.apiToken, param.createUserMetadataRequest, options).toPromise();
3735
- }
3736
-
3737
- /**
3738
- * ## 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
3739
- * Create user token
3740
- * @param param the request object
3741
- */
3742
- public createUserToken(param: UserApiCreateUserTokenRequest, options?: Configuration): Promise<CreateUserTokenResponse> {
3743
- return this.api.createUserToken(param.userId, param.apiToken, param.createUserTokenRequest, options).toPromise();
3744
- }
3745
-
3746
- /**
3747
- * ## 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)
3748
- * Delete a user
3749
- * @param param the request object
3750
- */
3751
- public deleteAUser(param: UserApiDeleteAUserRequest, options?: Configuration): Promise<any> {
3752
- return this.api.deleteAUser(param.userId, param.apiToken, options).toPromise();
3753
- }
3754
-
3755
- /**
3756
- * ## Delete metadata https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-delete-metadata
3757
- * Delete user metadata
3758
- * @param param the request object
3759
- */
3760
- public deleteSpecificUserMetadata(param: UserApiDeleteSpecificUserMetadataRequest, options?: Configuration): Promise<any> {
3761
- return this.api.deleteSpecificUserMetadata(param.userId, param.key, param.apiToken, options).toPromise();
3762
- }
3763
-
3764
- /**
3765
- * ## 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
3766
- * Delete user metadata
3767
- * @param param the request object
3768
- */
3769
- public deleteUserAllMetadata(param: UserApiDeleteUserAllMetadataRequest, options?: Configuration): Promise<any> {
3770
- return this.api.deleteUserAllMetadata(param.userId, param.apiToken, options).toPromise();
3771
- }
3772
-
3773
- /**
3774
- * ## 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)
3775
- * Get channel invitation preference
3776
- * @param param the request object
3777
- */
3778
- public getChannelInvitationPreference(param: UserApiGetChannelInvitationPreferenceRequest, options?: Configuration): Promise<GetChannelInvitationPreferenceResponse> {
3779
- return this.api.getChannelInvitationPreference(param.userId, param.apiToken, options).toPromise();
3780
- }
3781
-
3782
- /**
3783
- * ## 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.
3784
- * Leave my group channels
3785
- * @param param the request object
3786
- */
3787
- public leaveMyGroupChannels(param: UserApiLeaveMyGroupChannelsRequest, options?: Configuration): Promise<any> {
3788
- return this.api.leaveMyGroupChannels(param.userId, param.apiToken, param.leaveMyGroupChannelsRequest, options).toPromise();
3789
- }
3790
-
3791
- /**
3792
- * ## 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.
3793
- * List my group channels
3794
- * @param param the request object
3795
- */
3796
- public listMyGroupChannels(param: UserApiListMyGroupChannelsRequest, options?: Configuration): Promise<ListMyGroupChannelsResponse> {
3797
- return this.api.listMyGroupChannels(param.userId, param.apiToken, param.token, param.limit, param.distinctMode, param.publicMode, param.superMode, param.createdAfter, param.createdBefore, param.showEmpty, param.showMember, param.showDeliveryReceipt, param.showReadReceipt, param.showMetadata, param.showFrozen, param.order, param.metadataOrderKey, param.customTypes, param.customTypeStartswith, param.channelUrls, param.name, param.nameContains, param.nameStartswith, param.membersExactlyIn, param.membersIncludeIn, param.queryType, param.membersNickname, param.membersNicknameContains, param.membersNicknameStartswith, param.searchQuery, param.searchFields, param.metadataKey, param.metadataValues, param.metadataValueStartswith, param.metacounterKey, param.metacounterValues, param.metacounterValueGt, param.metacounterValueGte, param.metacounterValueLt, param.metacounterValueLte, param.includeSortedMetaarrayInLastMessage, param.hiddenMode, param.unreadFilter, param.memberStateFilter, options).toPromise();
3798
- }
3799
-
3800
- /**
3801
- * ## 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
3802
- * List registration or device tokens
3803
- * @param param the request object
3804
- */
3805
- public listRegistrationOrDeviceTokens(param: UserApiListRegistrationOrDeviceTokensRequest, options?: Configuration): Promise<ListRegistrationOrDeviceTokensResponse> {
3806
- return this.api.listRegistrationOrDeviceTokens(param.userId, param.tokenType, param.apiToken, options).toPromise();
3807
- }
3808
-
3809
- /**
3810
- * ## 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
3811
- * List users
3812
- * @param param the request object
3813
- */
3814
- public listUsers(param: UserApiListUsersRequest = {}, options?: Configuration): Promise<ListUsersResponse> {
3815
- return this.api.listUsers(param.token, param.limit, param.activeMode, param.showBot, param.userIds, param.nickname, param.nicknameStartswith, param.metadatakey, param.metadatavaluesIn, param.apiToken, options).toPromise();
3816
- }
3817
-
3818
- /**
3819
- * ## 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
3820
- * Mark all messages as read
3821
- * @param param the request object
3822
- */
3823
- public markAllMessagesAsRead(param: UserApiMarkAllMessagesAsReadRequest, options?: Configuration): Promise<any> {
3824
- return this.api.markAllMessagesAsRead(param.userId, param.apiToken, param.markAllMessagesAsReadRequest, options).toPromise();
3825
- }
3826
-
3827
- /**
3828
- * ## 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
3829
- * Remove a registration or device token - When unregistering a specific token
3830
- * @param param the request object
3831
- */
3832
- public removeARegistrationOrDeviceToken(param: UserApiRemoveARegistrationOrDeviceTokenRequest, options?: Configuration): Promise<RemoveARegistrationOrDeviceTokenResponse> {
3833
- return this.api.removeARegistrationOrDeviceToken(param.userId, param.tokenType, param.token, param.apiToken, options).toPromise();
3834
- }
3835
-
3836
- /**
3837
- * ## 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
3838
- * Remove a registration or device token from an owner
3839
- * @param param the request object
3840
- */
3841
- public removeARegistrationOrDeviceTokenFromAnOwner(param: UserApiRemoveARegistrationOrDeviceTokenFromAnOwnerRequest, options?: Configuration): Promise<Array<MarkChannelMessagesAsReadRequest>> {
3842
- return this.api.removeARegistrationOrDeviceTokenFromAnOwner(param.tokenType, param.token, param.apiToken, options).toPromise();
3843
- }
3844
-
3845
- /**
3846
- * ## 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
3847
- * Remove a registration or device token - When unregistering all device tokens
3848
- * @param param the request object
3849
- */
3850
- public removeAllRegistrationOrDeviceToken(param: UserApiRemoveAllRegistrationOrDeviceTokenRequest, options?: Configuration): Promise<RemoveAllRegistrationOrDeviceTokenResponse> {
3851
- return this.api.removeAllRegistrationOrDeviceToken(param.userId, param.apiToken, options).toPromise();
3852
- }
3853
-
3854
- /**
3855
- * ## 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)
3856
- * Reset push preferences
3857
- * @param param the request object
3858
- */
3859
- public resetPushPreferences(param: UserApiResetPushPreferencesRequest, options?: Configuration): Promise<any> {
3860
- return this.api.resetPushPreferences(param.userId, param.apiToken, options).toPromise();
3861
- }
3862
-
3863
- /**
3864
- * ## 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)
3865
- * Update a user
3866
- * @param param the request object
3867
- */
3868
- public updateAUser(param: UserApiUpdateAUserRequest, options?: Configuration): Promise<SendbirdUser> {
3869
- return this.api.updateAUser(param.userId, param.apiToken, param.updateAUserRequest, options).toPromise();
3870
- }
3871
-
3872
- /**
3873
- * ## 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
3874
- * Update channel invitation preference
3875
- * @param param the request object
3876
- */
3877
- public updateChannelInvitationPreference(param: UserApiUpdateChannelInvitationPreferenceRequest, options?: Configuration): Promise<UpdateChannelInvitationPreferenceResponse> {
3878
- return this.api.updateChannelInvitationPreference(param.userId, param.apiToken, param.updateChannelInvitationPreferenceRequest, options).toPromise();
3879
- }
3880
-
3881
- /**
3882
- * ## 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
3883
- * Update count preference of a channel
3884
- * @param param the request object
3885
- */
3886
- public updateCountPreferenceOfAChannel(param: UserApiUpdateCountPreferenceOfAChannelRequest, options?: Configuration): Promise<UpdateCountPreferenceOfChannelByUrlResponse> {
3887
- return this.api.updateCountPreferenceOfAChannel(param.userId, param.channelUrl, param.apiToken, param.updateCountPreferenceOfAChannelRequest, options).toPromise();
3888
- }
3889
-
3890
- /**
3891
- * ## 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)
3892
- * Update push preferences
3893
- * @param param the request object
3894
- */
3895
- public updatePushPreferences(param: UserApiUpdatePushPreferencesRequest, options?: Configuration): Promise<UpdatePushPreferencesResponse> {
3896
- return this.api.updatePushPreferences(param.userId, param.apiToken, param.updatePushPreferencesRequest, options).toPromise();
3897
- }
3898
-
3899
- /**
3900
- * ## 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)
3901
- * Update push preferences for a channel
3902
- * @param param the request object
3903
- */
3904
- public updatePushPreferencesForAChannel(param: UserApiUpdatePushPreferencesForAChannelRequest, options?: Configuration): Promise<UpdatePushPreferencesForAChannelResponse> {
3905
- return this.api.updatePushPreferencesForAChannel(param.userId, param.channelUrl, param.apiToken, param.updatePushPreferencesForAChannelRequest, options).toPromise();
3906
- }
3907
-
3908
- /**
3909
- * ## Update metadata https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-update-metadata
3910
- * Update specific user metadata
3911
- * @param param the request object
3912
- */
3913
- public updateSpecificUserMetadata(param: UserApiUpdateSpecificUserMetadataRequest, options?: Configuration): Promise<any> {
3914
- return this.api.updateSpecificUserMetadata(param.userId, param.key, param.apiToken, param.updateSpecificUserMetadataRequest, options).toPromise();
3915
- }
3916
-
3917
- /**
3918
- * ## 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
3919
- * Update user metadata
3920
- * @param param the request object
3921
- */
3922
- public updateUserMetadata(param: UserApiUpdateUserMetadataRequest, options?: Configuration): Promise<any> {
3923
- return this.api.updateUserMetadata(param.userId, param.apiToken, param.updateUserMetadataRequest, options).toPromise();
3924
- }
3925
-
3926
- /**
3927
- * ## 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.
3928
- * View a user
3929
- * @param param the request object
3930
- */
3931
- public viewAUser(param: UserApiViewAUserRequest, options?: Configuration): Promise<SendbirdUser> {
3932
- return this.api.viewAUser(param.userId, param.includeUnreadCount, param.customTypes, param.superMode, param.apiToken, options).toPromise();
3933
- }
3934
-
3935
- /**
3936
- * ## 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
3937
- * View count preference of a channel
3938
- * @param param the request object
3939
- */
3940
- public viewCountPreferenceOfAChannel(param: UserApiViewCountPreferenceOfAChannelRequest, options?: Configuration): Promise<ViewCountPreferenceOfAChannelResponse> {
3941
- return this.api.viewCountPreferenceOfAChannel(param.userId, param.channelUrl, param.apiToken, options).toPromise();
3942
- }
3943
-
3944
- /**
3945
- * ## 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
3946
- * View number of channels with unread messages
3947
- * @param param the request object
3948
- */
3949
- public viewNumberOfChannelsWithUnreadMessages(param: UserApiViewNumberOfChannelsWithUnreadMessagesRequest, options?: Configuration): Promise<ViewNumberOfChannelsWithUnreadMessagesResponse> {
3950
- return this.api.viewNumberOfChannelsWithUnreadMessages(param.userId, param.customTypes, param.superMode, param.apiToken, options).toPromise();
3951
- }
3952
-
3953
- /**
3954
- * ## 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.
3955
- * View number of unread messages
3956
- * @param param the request object
3957
- */
3958
- public viewNumberOfUnreadMessages(param: UserApiViewNumberOfUnreadMessagesRequest, options?: Configuration): Promise<ViewNumberOfUnreadMessagesResponse> {
3959
- return this.api.viewNumberOfUnreadMessages(param.userId, param.customTypes, param.superMode, param.apiToken, options).toPromise();
3960
- }
3961
-
3962
- /**
3963
- * ## 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)
3964
- * View push preferences
3965
- * @param param the request object
3966
- */
3967
- public viewPushPreferences(param: UserApiViewPushPreferencesRequest, options?: Configuration): Promise<ViewPushPreferencesResponse> {
3968
- return this.api.viewPushPreferences(param.userId, param.apiToken, options).toPromise();
3969
- }
3970
-
3971
- /**
3972
- * ## 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)
3973
- * View push preferences for a channel
3974
- * @param param the request object
3975
- */
3976
- public viewPushPreferencesForAChannel(param: UserApiViewPushPreferencesForAChannelRequest, options?: Configuration): Promise<ViewPushPreferencesForAChannelResponse> {
3977
- return this.api.viewPushPreferencesForAChannel(param.userId, param.channelUrl, param.apiToken, options).toPromise();
3978
- }
3979
-
3980
- /**
3981
- * ## Get metadata https://sendbird.com/docs/chat/platform-api/v3/user/managing-metadata/user-get-metadata
3982
- * Get specific user metadata
3983
- * @param param the request object
3984
- */
3985
- public viewSpecificUserMetadata(param: UserApiViewSpecificUserMetadataRequest, options?: Configuration): Promise<any> {
3986
- return this.api.viewSpecificUserMetadata(param.userId, param.key, param.apiToken, options).toPromise();
3987
- }
3988
-
3989
- /**
3990
- * ## 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 ----------------------------
3991
- * View who owns a registration or device token
3992
- * @param param the request object
3993
- */
3994
- public viewWhoOwnsARegistrationOrDeviceToken(param: UserApiViewWhoOwnsARegistrationOrDeviceTokenRequest, options?: Configuration): Promise<Array<MarkChannelMessagesAsReadRequest>> {
3995
- return this.api.viewWhoOwnsARegistrationOrDeviceToken(param.tokenType, param.token, param.apiToken, options).toPromise();
3996
- }
3997
-
3998
- }