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

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