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

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