@sendbird/sendbird-platform-sdk-typescript 2.0.0

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