lemmy-js-client 0.20.0-private-community.9 → 0.20.0-remove-aggregate-tables.1

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 (439) hide show
  1. package/README.md +1 -1
  2. package/dist/http.d.ts +252 -417
  3. package/dist/http.js +1264 -422
  4. package/dist/index.d.ts +74 -26
  5. package/dist/other_types.d.ts +81 -17
  6. package/dist/other_types.js +1 -1
  7. package/dist/types/AddAdmin.d.ts +5 -2
  8. package/dist/types/AddAdminResponse.d.ts +5 -2
  9. package/dist/types/AddModToCommunity.d.ts +5 -2
  10. package/dist/types/AddModToCommunityResponse.d.ts +5 -2
  11. package/dist/types/AdminAllowInstance.d.ts +11 -0
  12. package/dist/types/AdminAllowInstanceId.d.ts +1 -0
  13. package/dist/types/AdminAllowInstanceParams.d.ts +5 -0
  14. package/dist/types/AdminAllowInstanceView.d.ts +11 -0
  15. package/dist/types/AdminBlockInstance.d.ts +12 -0
  16. package/dist/types/AdminBlockInstanceId.d.ts +1 -0
  17. package/dist/types/AdminBlockInstanceParams.d.ts +6 -0
  18. package/dist/types/AdminBlockInstanceParams.js +3 -0
  19. package/dist/types/AdminBlockInstanceView.d.ts +11 -0
  20. package/dist/types/AdminPurgeComment.d.ts +8 -4
  21. package/dist/types/AdminPurgeCommentId.d.ts +1 -0
  22. package/dist/types/AdminPurgeCommentId.js +3 -0
  23. package/dist/types/AdminPurgeCommentView.d.ts +5 -2
  24. package/dist/types/AdminPurgeCommunity.d.ts +8 -4
  25. package/dist/types/AdminPurgeCommunityId.d.ts +1 -0
  26. package/dist/types/AdminPurgeCommunityId.js +3 -0
  27. package/dist/types/AdminPurgeCommunityView.d.ts +5 -2
  28. package/dist/types/AdminPurgePerson.d.ts +8 -4
  29. package/dist/types/AdminPurgePersonId.d.ts +1 -0
  30. package/dist/types/AdminPurgePersonId.js +3 -0
  31. package/dist/types/AdminPurgePersonView.d.ts +5 -2
  32. package/dist/types/AdminPurgePost.d.ts +8 -4
  33. package/dist/types/AdminPurgePostId.d.ts +1 -0
  34. package/dist/types/AdminPurgePostId.js +3 -0
  35. package/dist/types/AdminPurgePostView.d.ts +5 -2
  36. package/dist/types/ApproveCommunityPendingFollower.d.ts +2 -2
  37. package/dist/types/ApproveRegistrationApplication.d.ts +5 -2
  38. package/dist/types/AuthenticateWithOauth.d.ts +14 -3
  39. package/dist/types/AuthenticateWithOauth.js +0 -1
  40. package/dist/types/BanFromCommunity.d.ts +14 -2
  41. package/dist/types/BanFromCommunityResponse.d.ts +5 -2
  42. package/dist/types/BanPerson.d.ts +14 -2
  43. package/dist/types/BanPersonResponse.d.ts +5 -2
  44. package/dist/types/BannedPersonsResponse.d.ts +5 -2
  45. package/dist/types/BlockCommunity.d.ts +5 -2
  46. package/dist/types/BlockCommunityResponse.d.ts +5 -2
  47. package/dist/types/BlockPerson.d.ts +5 -2
  48. package/dist/types/BlockPersonResponse.d.ts +5 -2
  49. package/dist/types/CaptchaResponse.d.ts +14 -2
  50. package/dist/types/ChangePassword.d.ts +9 -5
  51. package/dist/types/ChangePassword.js +0 -1
  52. package/dist/types/Comment.d.ts +36 -3
  53. package/dist/types/CommentId.d.ts +3 -0
  54. package/dist/types/CommentReply.d.ts +5 -2
  55. package/dist/types/CommentReplyId.d.ts +3 -0
  56. package/dist/types/CommentReplyView.d.ts +5 -4
  57. package/dist/types/CommentReport.d.ts +5 -2
  58. package/dist/types/CommentReportId.d.ts +3 -0
  59. package/dist/types/CommentReportResponse.d.ts +5 -2
  60. package/dist/types/CommentReportView.d.ts +5 -4
  61. package/dist/types/CommentResponse.d.ts +5 -2
  62. package/dist/types/CommentSlimView.d.ts +18 -0
  63. package/dist/types/CommentSortType.d.ts +3 -0
  64. package/dist/types/CommentView.d.ts +5 -4
  65. package/dist/types/Community.d.ts +69 -6
  66. package/dist/types/CommunityFollowerView.d.ts +5 -2
  67. package/dist/types/CommunityId.d.ts +3 -0
  68. package/dist/types/CommunityModeratorView.d.ts +5 -2
  69. package/dist/types/CommunityReport.d.ts +22 -0
  70. package/dist/types/CommunityReportId.d.ts +4 -0
  71. package/dist/types/CommunityReportId.js +3 -0
  72. package/dist/types/CommunityReportView.d.ts +14 -0
  73. package/dist/types/CommunityResponse.d.ts +5 -2
  74. package/dist/types/CommunitySortType.d.ts +4 -0
  75. package/dist/types/CommunitySortType.js +3 -0
  76. package/dist/types/CommunityView.d.ts +5 -4
  77. package/dist/types/CommunityVisibility.d.ts +3 -0
  78. package/dist/types/CreateComment.d.ts +5 -2
  79. package/dist/types/CreateCommentLike.d.ts +8 -2
  80. package/dist/types/CreateCommentReport.d.ts +5 -2
  81. package/dist/types/CreateCommunity.d.ts +30 -2
  82. package/dist/types/CreateCustomEmoji.d.ts +5 -2
  83. package/dist/types/CreateOAuthProvider.d.ts +6 -2
  84. package/dist/types/CreatePost.d.ts +22 -2
  85. package/dist/types/CreatePostLike.d.ts +8 -2
  86. package/dist/types/CreatePostReport.d.ts +5 -2
  87. package/dist/types/CreatePrivateMessage.d.ts +5 -2
  88. package/dist/types/CreatePrivateMessageReport.d.ts +5 -2
  89. package/dist/types/CreateSite.d.ts +6 -8
  90. package/dist/types/CreateTagline.d.ts +5 -2
  91. package/dist/types/CustomEmoji.d.ts +7 -3
  92. package/dist/types/CustomEmojiId.d.ts +3 -0
  93. package/dist/types/CustomEmojiKeyword.d.ts +5 -2
  94. package/dist/types/CustomEmojiResponse.d.ts +5 -2
  95. package/dist/types/CustomEmojiView.d.ts +5 -2
  96. package/dist/types/DbUrl.d.ts +1 -0
  97. package/dist/types/DbUrl.js +3 -0
  98. package/dist/types/DeleteAccount.d.ts +7 -3
  99. package/dist/types/DeleteAccount.js +0 -1
  100. package/dist/types/DeleteComment.d.ts +5 -2
  101. package/dist/types/DeleteCommunity.d.ts +5 -2
  102. package/dist/types/DeleteCustomEmoji.d.ts +5 -2
  103. package/dist/types/DeleteImageParams.d.ts +3 -0
  104. package/dist/types/DeleteImageParams.js +3 -0
  105. package/dist/types/DeleteOAuthProvider.d.ts +5 -2
  106. package/dist/types/DeletePost.d.ts +5 -2
  107. package/dist/types/DeletePrivateMessage.d.ts +5 -2
  108. package/dist/types/DeleteTagline.d.ts +5 -2
  109. package/dist/types/DistinguishComment.d.ts +5 -2
  110. package/dist/types/EditComment.d.ts +5 -2
  111. package/dist/types/EditCommunity.d.ts +21 -4
  112. package/dist/types/EditCustomEmoji.d.ts +5 -2
  113. package/dist/types/EditOAuthProvider.d.ts +6 -2
  114. package/dist/types/EditPost.d.ts +19 -2
  115. package/dist/types/EditPrivateMessage.d.ts +5 -2
  116. package/dist/types/EditSite.d.ts +113 -8
  117. package/dist/types/FeaturePost.d.ts +5 -2
  118. package/dist/types/FederatedInstances.d.ts +5 -2
  119. package/dist/types/FederationBlockList.d.ts +7 -0
  120. package/dist/types/FederationError.d.ts +10 -0
  121. package/dist/types/FederationError.js +3 -0
  122. package/dist/types/FederationMode.d.ts +3 -0
  123. package/dist/types/FollowCommunity.d.ts +5 -2
  124. package/dist/types/GenerateTotpSecretResponse.d.ts +4 -3
  125. package/dist/types/GenerateTotpSecretResponse.js +0 -1
  126. package/dist/types/GetCaptchaResponse.d.ts +8 -2
  127. package/dist/types/GetComment.d.ts +5 -2
  128. package/dist/types/GetComments.d.ts +5 -3
  129. package/dist/types/GetCommentsResponse.d.ts +5 -2
  130. package/dist/types/GetCommentsSlimResponse.d.ts +7 -0
  131. package/dist/types/GetCommunity.d.ts +8 -2
  132. package/dist/types/GetCommunityPendingFollowsCount.d.ts +2 -2
  133. package/dist/types/GetCommunityPendingFollowsCountResponse.d.ts +2 -2
  134. package/dist/types/GetCommunityResponse.d.ts +5 -2
  135. package/dist/types/GetFederatedInstancesResponse.d.ts +8 -2
  136. package/dist/types/GetModlog.d.ts +8 -4
  137. package/dist/types/GetModlogResponse.d.ts +7 -32
  138. package/dist/types/GetPersonDetails.d.ts +10 -9
  139. package/dist/types/GetPersonDetailsResponse.d.ts +5 -6
  140. package/dist/types/GetPost.d.ts +5 -2
  141. package/dist/types/GetPostResponse.d.ts +8 -2
  142. package/dist/types/GetPosts.d.ts +28 -2
  143. package/dist/types/GetPostsResponse.d.ts +8 -2
  144. package/dist/types/GetRandomCommunity.d.ts +6 -2
  145. package/dist/types/GetRegistrationApplication.d.ts +5 -2
  146. package/dist/types/GetReportCount.d.ts +5 -2
  147. package/dist/types/GetReportCountResponse.d.ts +6 -7
  148. package/dist/types/GetReportCountResponse.js +1 -0
  149. package/dist/types/GetSiteMetadata.d.ts +5 -2
  150. package/dist/types/GetSiteMetadataResponse.d.ts +5 -2
  151. package/dist/types/GetSiteResponse.d.ts +12 -6
  152. package/dist/types/GetUnreadCountResponse.d.ts +6 -5
  153. package/dist/types/GetUnreadRegistrationApplicationCountResponse.d.ts +5 -2
  154. package/dist/types/HideCommunity.d.ts +5 -2
  155. package/dist/types/HidePost.d.ts +6 -3
  156. package/dist/types/ImageDetails.d.ts +4 -3
  157. package/dist/types/ImageDetails.js +0 -1
  158. package/dist/types/ImageGetParams.d.ts +4 -0
  159. package/dist/types/ImageGetParams.js +3 -0
  160. package/dist/types/ImageProxyParams.d.ts +5 -0
  161. package/dist/types/ImageProxyParams.js +3 -0
  162. package/dist/types/InboxCombinedPaginationCursor.d.ts +4 -0
  163. package/dist/types/InboxCombinedPaginationCursor.js +3 -0
  164. package/dist/types/InboxCombinedView.d.ts +13 -0
  165. package/dist/types/InboxDataType.d.ts +4 -0
  166. package/dist/types/InboxDataType.js +3 -0
  167. package/dist/types/Instance.d.ts +5 -2
  168. package/dist/types/InstanceId.d.ts +3 -0
  169. package/dist/types/InstanceWithFederationState.d.ts +7 -3
  170. package/dist/types/Language.d.ts +5 -2
  171. package/dist/types/LanguageId.d.ts +3 -0
  172. package/dist/types/LemmyErrorType.d.ts +25 -71
  173. package/dist/types/LemmyErrorType.js +0 -1
  174. package/dist/types/LinkMetadata.d.ts +9 -5
  175. package/dist/types/LinkMetadata.js +0 -1
  176. package/dist/types/ListCommentLikes.d.ts +5 -2
  177. package/dist/types/ListCommentLikesResponse.d.ts +5 -2
  178. package/dist/types/ListCommunities.d.ts +7 -4
  179. package/dist/types/ListCommunitiesResponse.d.ts +5 -2
  180. package/dist/types/ListCommunityPendingFollows.d.ts +9 -6
  181. package/dist/types/ListCommunityPendingFollowsResponse.d.ts +2 -2
  182. package/dist/types/ListCustomEmojis.d.ts +5 -2
  183. package/dist/types/ListCustomEmojisResponse.d.ts +5 -2
  184. package/dist/types/ListInbox.d.ts +11 -0
  185. package/dist/types/ListInboxResponse.d.ts +7 -0
  186. package/dist/types/ListLoginsResponse.d.ts +2 -2
  187. package/dist/types/ListMedia.d.ts +5 -2
  188. package/dist/types/ListMediaResponse.d.ts +2 -2
  189. package/dist/types/ListPersonContent.d.ts +18 -0
  190. package/dist/types/ListPersonContentResponse.d.ts +7 -0
  191. package/dist/types/ListPersonSaved.d.ts +10 -0
  192. package/dist/types/ListPersonSavedResponse.d.ts +7 -0
  193. package/dist/types/ListPostLikes.d.ts +5 -2
  194. package/dist/types/ListPostLikesResponse.d.ts +5 -2
  195. package/dist/types/ListRegistrationApplications.d.ts +8 -2
  196. package/dist/types/ListRegistrationApplicationsResponse.d.ts +5 -2
  197. package/dist/types/ListReports.d.ts +27 -0
  198. package/dist/types/ListReportsResponse.d.ts +7 -0
  199. package/dist/types/ListTaglines.d.ts +5 -2
  200. package/dist/types/ListTaglinesResponse.d.ts +5 -2
  201. package/dist/types/ListingType.d.ts +3 -0
  202. package/dist/types/LocalImage.d.ts +2 -3
  203. package/dist/types/LocalImageView.d.ts +5 -2
  204. package/dist/types/LocalSite.d.ts +83 -2
  205. package/dist/types/LocalSiteId.d.ts +3 -0
  206. package/dist/types/LocalSiteRateLimit.d.ts +5 -2
  207. package/dist/types/LocalSiteUrlBlocklist.d.ts +2 -2
  208. package/dist/types/LocalUser.d.ts +67 -3
  209. package/dist/types/LocalUserId.d.ts +3 -0
  210. package/dist/types/LocalUserView.d.ts +5 -4
  211. package/dist/types/LocalUserVoteDisplayMode.d.ts +5 -2
  212. package/dist/types/LockPost.d.ts +5 -2
  213. package/dist/types/Login.d.ts +11 -4
  214. package/dist/types/Login.js +0 -1
  215. package/dist/types/LoginResponse.d.ts +17 -3
  216. package/dist/types/LoginResponse.js +0 -1
  217. package/dist/types/LoginToken.d.ts +12 -2
  218. package/dist/types/MarkCommentReplyAsRead.d.ts +5 -2
  219. package/dist/types/MarkManyPostsAsRead.d.ts +7 -0
  220. package/dist/types/MarkPersonCommentMentionAsRead.d.ts +8 -0
  221. package/dist/types/MarkPersonPostMentionAsRead.d.ts +8 -0
  222. package/dist/types/MarkPostAsRead.d.ts +6 -3
  223. package/dist/types/MarkPrivateMessageAsRead.d.ts +5 -2
  224. package/dist/types/ModAdd.d.ts +8 -4
  225. package/dist/types/ModAddCommunity.d.ts +8 -4
  226. package/dist/types/ModAddCommunityId.d.ts +1 -0
  227. package/dist/types/ModAddCommunityId.js +3 -0
  228. package/dist/types/ModAddCommunityView.d.ts +6 -3
  229. package/dist/types/ModAddId.d.ts +1 -0
  230. package/dist/types/ModAddId.js +3 -0
  231. package/dist/types/ModAddView.d.ts +6 -3
  232. package/dist/types/ModBan.d.ts +8 -4
  233. package/dist/types/ModBanFromCommunity.d.ts +8 -4
  234. package/dist/types/ModBanFromCommunityId.d.ts +1 -0
  235. package/dist/types/ModBanFromCommunityId.js +3 -0
  236. package/dist/types/ModBanFromCommunityView.d.ts +6 -3
  237. package/dist/types/ModBanId.d.ts +1 -0
  238. package/dist/types/ModBanId.js +3 -0
  239. package/dist/types/ModBanView.d.ts +6 -3
  240. package/dist/types/ModFeaturePost.d.ts +8 -4
  241. package/dist/types/ModFeaturePostId.d.ts +1 -0
  242. package/dist/types/ModFeaturePostId.js +3 -0
  243. package/dist/types/ModFeaturePostView.d.ts +6 -2
  244. package/dist/types/ModHideCommunity.d.ts +8 -4
  245. package/dist/types/ModHideCommunityId.d.ts +1 -0
  246. package/dist/types/ModHideCommunityId.js +3 -0
  247. package/dist/types/ModHideCommunityView.d.ts +5 -2
  248. package/dist/types/ModLockPost.d.ts +8 -4
  249. package/dist/types/ModLockPostId.d.ts +1 -0
  250. package/dist/types/ModLockPostId.js +3 -0
  251. package/dist/types/ModLockPostView.d.ts +6 -2
  252. package/dist/types/ModRemoveComment.d.ts +8 -4
  253. package/dist/types/ModRemoveCommentId.d.ts +1 -0
  254. package/dist/types/ModRemoveCommentId.js +3 -0
  255. package/dist/types/ModRemoveCommentView.d.ts +6 -3
  256. package/dist/types/ModRemoveCommunity.d.ts +8 -4
  257. package/dist/types/ModRemoveCommunityId.d.ts +1 -0
  258. package/dist/types/ModRemoveCommunityId.js +3 -0
  259. package/dist/types/ModRemoveCommunityView.d.ts +5 -2
  260. package/dist/types/ModRemovePost.d.ts +8 -4
  261. package/dist/types/ModRemovePostId.d.ts +1 -0
  262. package/dist/types/ModRemovePostId.js +3 -0
  263. package/dist/types/ModRemovePostView.d.ts +6 -2
  264. package/dist/types/ModTransferCommunity.d.ts +8 -4
  265. package/dist/types/ModTransferCommunityId.d.ts +1 -0
  266. package/dist/types/ModTransferCommunityId.js +3 -0
  267. package/dist/types/ModTransferCommunityView.d.ts +6 -3
  268. package/dist/types/ModlogActionType.d.ts +4 -1
  269. package/dist/types/ModlogCombinedPaginationCursor.d.ts +4 -0
  270. package/dist/types/ModlogCombinedPaginationCursor.js +3 -0
  271. package/dist/types/ModlogCombinedView.d.ts +52 -0
  272. package/dist/types/MyUserInfo.d.ts +5 -2
  273. package/dist/types/OAuthAccount.d.ts +5 -2
  274. package/dist/types/OAuthProvider.d.ts +48 -2
  275. package/dist/types/OAuthProviderId.d.ts +3 -0
  276. package/dist/types/OpenGraphData.d.ts +8 -4
  277. package/dist/types/OpenGraphData.js +0 -1
  278. package/dist/types/PaginationCursor.d.ts +6 -0
  279. package/dist/types/PasswordChangeAfterReset.d.ts +9 -5
  280. package/dist/types/PasswordChangeAfterReset.js +0 -1
  281. package/dist/types/PasswordReset.d.ts +7 -3
  282. package/dist/types/PasswordReset.js +0 -1
  283. package/dist/types/PendingFollow.d.ts +2 -2
  284. package/dist/types/Person.d.ts +44 -5
  285. package/dist/types/{PersonMention.d.ts → PersonCommentMention.d.ts} +7 -4
  286. package/dist/types/PersonCommentMention.js +2 -0
  287. package/dist/types/PersonCommentMentionId.d.ts +4 -0
  288. package/dist/types/PersonCommentMentionId.js +3 -0
  289. package/dist/types/{PersonMentionView.d.ts → PersonCommentMentionView.d.ts} +7 -6
  290. package/dist/types/PersonCommentMentionView.js +2 -0
  291. package/dist/types/PersonContentCombinedPaginationCursor.d.ts +4 -0
  292. package/dist/types/PersonContentCombinedPaginationCursor.js +3 -0
  293. package/dist/types/PersonContentCombinedView.d.ts +7 -0
  294. package/dist/types/PersonContentCombinedView.js +2 -0
  295. package/dist/types/PersonContentType.d.ts +4 -0
  296. package/dist/types/PersonContentType.js +3 -0
  297. package/dist/types/PersonId.d.ts +3 -0
  298. package/dist/types/PersonPostMention.d.ts +13 -0
  299. package/dist/types/PersonPostMention.js +2 -0
  300. package/dist/types/PersonPostMentionId.d.ts +4 -0
  301. package/dist/types/PersonPostMentionId.js +3 -0
  302. package/dist/types/PersonPostMentionView.d.ts +30 -0
  303. package/dist/types/PersonPostMentionView.js +2 -0
  304. package/dist/types/PersonSavedCombinedPaginationCursor.d.ts +4 -0
  305. package/dist/types/PersonSavedCombinedPaginationCursor.js +3 -0
  306. package/dist/types/PersonView.d.ts +5 -4
  307. package/dist/types/Post.d.ts +68 -6
  308. package/dist/types/PostFeatureType.d.ts +3 -0
  309. package/dist/types/PostId.d.ts +3 -0
  310. package/dist/types/PostListingMode.d.ts +3 -0
  311. package/dist/types/PostReport.d.ts +16 -3
  312. package/dist/types/PostReportId.d.ts +3 -0
  313. package/dist/types/PostReportResponse.d.ts +5 -2
  314. package/dist/types/PostReportView.d.ts +5 -4
  315. package/dist/types/PostResponse.d.ts +2 -2
  316. package/dist/types/PostSortType.d.ts +3 -0
  317. package/dist/types/PostTags.d.ts +7 -0
  318. package/dist/types/PostTags.js +2 -0
  319. package/dist/types/PostView.d.ts +7 -4
  320. package/dist/types/PrivateMessage.d.ts +7 -3
  321. package/dist/types/PrivateMessageId.d.ts +3 -0
  322. package/dist/types/PrivateMessageReport.d.ts +8 -2
  323. package/dist/types/PrivateMessageReportId.d.ts +3 -0
  324. package/dist/types/PrivateMessageReportResponse.d.ts +5 -2
  325. package/dist/types/PrivateMessageReportView.d.ts +5 -2
  326. package/dist/types/PrivateMessageResponse.d.ts +5 -2
  327. package/dist/types/PrivateMessageView.d.ts +5 -2
  328. package/dist/types/PurgeComment.d.ts +5 -2
  329. package/dist/types/PurgeCommunity.d.ts +5 -2
  330. package/dist/types/PurgePerson.d.ts +5 -2
  331. package/dist/types/PurgePost.d.ts +5 -2
  332. package/dist/types/ReadableFederationState.d.ts +15 -3
  333. package/dist/types/Register.d.ts +24 -5
  334. package/dist/types/Register.js +0 -1
  335. package/dist/types/RegistrationApplication.d.ts +5 -2
  336. package/dist/types/RegistrationApplicationId.d.ts +3 -0
  337. package/dist/types/RegistrationApplicationResponse.d.ts +5 -2
  338. package/dist/types/RegistrationApplicationView.d.ts +5 -2
  339. package/dist/types/RegistrationMode.d.ts +3 -0
  340. package/dist/types/RemoveComment.d.ts +5 -2
  341. package/dist/types/RemoveCommunity.d.ts +5 -2
  342. package/dist/types/RemovePost.d.ts +5 -2
  343. package/dist/types/ReportCombinedPaginationCursor.d.ts +4 -0
  344. package/dist/types/ReportCombinedPaginationCursor.js +3 -0
  345. package/dist/types/ReportCombinedView.d.ts +13 -0
  346. package/dist/types/ReportCombinedView.js +2 -0
  347. package/dist/types/ReportType.d.ts +4 -0
  348. package/dist/types/ReportType.js +3 -0
  349. package/dist/types/ResolveCommentReport.d.ts +5 -2
  350. package/dist/types/ResolveObject.d.ts +8 -2
  351. package/dist/types/ResolveObjectResponse.d.ts +5 -2
  352. package/dist/types/ResolvePostReport.d.ts +5 -2
  353. package/dist/types/ResolvePrivateMessageReport.d.ts +5 -2
  354. package/dist/types/SaveComment.d.ts +5 -2
  355. package/dist/types/SavePost.d.ts +5 -2
  356. package/dist/types/SaveUserSettings.d.ts +92 -5
  357. package/dist/types/Search.d.ts +11 -8
  358. package/dist/types/SearchCombinedPaginationCursor.d.ts +4 -0
  359. package/dist/types/SearchCombinedPaginationCursor.js +3 -0
  360. package/dist/types/SearchCombinedView.d.ts +13 -0
  361. package/dist/types/SearchCombinedView.js +2 -0
  362. package/dist/types/SearchResponse.d.ts +7 -12
  363. package/dist/types/SearchSortType.d.ts +4 -0
  364. package/dist/types/SearchSortType.js +3 -0
  365. package/dist/types/SearchType.d.ts +3 -0
  366. package/dist/types/SensitiveString.d.ts +1 -0
  367. package/dist/types/SensitiveString.js +3 -0
  368. package/dist/types/Site.d.ts +35 -6
  369. package/dist/types/SiteAggregates.d.ts +17 -2
  370. package/dist/types/SiteId.d.ts +3 -0
  371. package/dist/types/SiteResponse.d.ts +8 -2
  372. package/dist/types/SiteView.d.ts +5 -2
  373. package/dist/types/SubscribedType.d.ts +3 -0
  374. package/dist/types/SuccessResponse.d.ts +5 -2
  375. package/dist/types/Tag.d.ts +27 -0
  376. package/dist/types/Tag.js +2 -0
  377. package/dist/types/TagId.d.ts +4 -0
  378. package/dist/types/TagId.js +3 -0
  379. package/dist/types/Tagline.d.ts +5 -2
  380. package/dist/types/TaglineId.d.ts +3 -0
  381. package/dist/types/TaglineResponse.d.ts +2 -2
  382. package/dist/types/TransferCommunity.d.ts +5 -2
  383. package/dist/types/UpdateTagline.d.ts +5 -2
  384. package/dist/types/UpdateTotp.d.ts +2 -2
  385. package/dist/types/UpdateTotpResponse.d.ts +2 -2
  386. package/dist/types/UploadImageResponse.d.ts +4 -0
  387. package/dist/types/UploadImageResponse.js +3 -0
  388. package/dist/types/{BlockInstance.d.ts → UserBlockInstanceParams.d.ts} +5 -2
  389. package/dist/types/UserBlockInstanceParams.js +2 -0
  390. package/dist/types/VerifyEmail.d.ts +5 -2
  391. package/dist/types/VoteView.d.ts +5 -2
  392. package/package.json +10 -5
  393. package/dist/types/BlockInstanceResponse.d.ts +0 -3
  394. package/dist/types/CommentAggregates.d.ts +0 -9
  395. package/dist/types/CommentReplyResponse.d.ts +0 -4
  396. package/dist/types/CommunityAggregates.d.ts +0 -13
  397. package/dist/types/GetPersonMentions.d.ts +0 -7
  398. package/dist/types/GetPersonMentionsResponse.d.ts +0 -4
  399. package/dist/types/GetPrivateMessages.d.ts +0 -7
  400. package/dist/types/GetReplies.d.ts +0 -7
  401. package/dist/types/GetRepliesResponse.d.ts +0 -4
  402. package/dist/types/ListCommentReports.d.ts +0 -9
  403. package/dist/types/ListCommentReportsResponse.d.ts +0 -4
  404. package/dist/types/ListPostReports.d.ts +0 -9
  405. package/dist/types/ListPostReportsResponse.d.ts +0 -4
  406. package/dist/types/ListPrivateMessageReports.d.ts +0 -5
  407. package/dist/types/ListPrivateMessageReportsResponse.d.ts +0 -4
  408. package/dist/types/MarkPersonMentionAsRead.d.ts +0 -5
  409. package/dist/types/ModlogListParams.d.ts +0 -14
  410. package/dist/types/PersonAggregates.d.ts +0 -6
  411. package/dist/types/PersonMentionId.d.ts +0 -1
  412. package/dist/types/PersonMentionResponse.d.ts +0 -4
  413. package/dist/types/PostAggregates.d.ts +0 -10
  414. package/dist/types/PrivateMessagesResponse.d.ts +0 -4
  415. /package/dist/types/{BlockInstance.js → AdminAllowInstance.js} +0 -0
  416. /package/dist/types/{BlockInstanceResponse.js → AdminAllowInstanceId.js} +0 -0
  417. /package/dist/types/{ListPrivateMessageReports.js → AdminAllowInstanceParams.js} +0 -0
  418. /package/dist/types/{CommentAggregates.js → AdminAllowInstanceView.js} +0 -0
  419. /package/dist/types/{CommentReplyResponse.js → AdminBlockInstance.js} +0 -0
  420. /package/dist/types/{PersonMentionId.js → AdminBlockInstanceId.js} +0 -0
  421. /package/dist/types/{CommunityAggregates.js → AdminBlockInstanceView.js} +0 -0
  422. /package/dist/types/{GetPersonMentions.js → CommentSlimView.js} +0 -0
  423. /package/dist/types/{GetPersonMentionsResponse.js → CommunityReport.js} +0 -0
  424. /package/dist/types/{GetPrivateMessages.js → CommunityReportView.js} +0 -0
  425. /package/dist/types/{GetReplies.js → FederationBlockList.js} +0 -0
  426. /package/dist/types/{GetRepliesResponse.js → GetCommentsSlimResponse.js} +0 -0
  427. /package/dist/types/{ListCommentReports.js → InboxCombinedView.js} +0 -0
  428. /package/dist/types/{ListCommentReportsResponse.js → ListInbox.js} +0 -0
  429. /package/dist/types/{ListPostReports.js → ListInboxResponse.js} +0 -0
  430. /package/dist/types/{ListPostReportsResponse.js → ListPersonContent.js} +0 -0
  431. /package/dist/types/{ListPrivateMessageReportsResponse.js → ListPersonContentResponse.js} +0 -0
  432. /package/dist/types/{MarkPersonMentionAsRead.js → ListPersonSaved.js} +0 -0
  433. /package/dist/types/{ModlogListParams.js → ListPersonSavedResponse.js} +0 -0
  434. /package/dist/types/{PersonAggregates.js → ListReports.js} +0 -0
  435. /package/dist/types/{PersonMention.js → ListReportsResponse.js} +0 -0
  436. /package/dist/types/{PersonMentionResponse.js → MarkManyPostsAsRead.js} +0 -0
  437. /package/dist/types/{PersonMentionView.js → MarkPersonCommentMentionAsRead.js} +0 -0
  438. /package/dist/types/{PostAggregates.js → MarkPersonPostMentionAsRead.js} +0 -0
  439. /package/dist/types/{PrivateMessagesResponse.js → ModlogCombinedView.js} +0 -0
package/dist/http.d.ts CHANGED
@@ -5,6 +5,7 @@ import { AddModToCommunityResponse } from "./types/AddModToCommunityResponse";
5
5
  import { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
6
6
  import { BanFromCommunity } from "./types/BanFromCommunity";
7
7
  import { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
8
+ import { MarkManyPostsAsRead } from "./types/MarkManyPostsAsRead";
8
9
  import { BanPerson } from "./types/BanPerson";
9
10
  import { BanPersonResponse } from "./types/BanPersonResponse";
10
11
  import { BannedPersonsResponse } from "./types/BannedPersonsResponse";
@@ -13,7 +14,6 @@ import { BlockCommunityResponse } from "./types/BlockCommunityResponse";
13
14
  import { BlockPerson } from "./types/BlockPerson";
14
15
  import { BlockPersonResponse } from "./types/BlockPersonResponse";
15
16
  import { ChangePassword } from "./types/ChangePassword";
16
- import { CommentReplyResponse } from "./types/CommentReplyResponse";
17
17
  import { CommentReportResponse } from "./types/CommentReportResponse";
18
18
  import { CommentResponse } from "./types/CommentResponse";
19
19
  import { CommunityResponse } from "./types/CommunityResponse";
@@ -49,57 +49,32 @@ import { OAuthProvider } from "./types/OAuthProvider";
49
49
  import { FeaturePost } from "./types/FeaturePost";
50
50
  import { FollowCommunity } from "./types/FollowCommunity";
51
51
  import { GetCaptchaResponse } from "./types/GetCaptchaResponse";
52
- import { GetComment } from "./types/GetComment";
53
- import { GetComments } from "./types/GetComments";
54
52
  import { GetCommentsResponse } from "./types/GetCommentsResponse";
55
- import { GetCommunity } from "./types/GetCommunity";
56
53
  import { GetCommunityResponse } from "./types/GetCommunityResponse";
57
54
  import { GetFederatedInstancesResponse } from "./types/GetFederatedInstancesResponse";
58
- import { GetModlog } from "./types/GetModlog";
59
55
  import { GetModlogResponse } from "./types/GetModlogResponse";
60
- import { GetPersonDetails } from "./types/GetPersonDetails";
61
56
  import { GetPersonDetailsResponse } from "./types/GetPersonDetailsResponse";
62
- import { GetPersonMentions } from "./types/GetPersonMentions";
63
- import { GetPersonMentionsResponse } from "./types/GetPersonMentionsResponse";
64
- import { GetPost } from "./types/GetPost";
65
57
  import { GetPostResponse } from "./types/GetPostResponse";
66
- import { GetPosts } from "./types/GetPosts";
67
58
  import { GetPostsResponse } from "./types/GetPostsResponse";
68
- import { GetPrivateMessages } from "./types/GetPrivateMessages";
69
- import { GetReplies } from "./types/GetReplies";
70
- import { GetRepliesResponse } from "./types/GetRepliesResponse";
71
- import { GetReportCount } from "./types/GetReportCount";
72
59
  import { GetReportCountResponse } from "./types/GetReportCountResponse";
73
- import { GetSiteMetadata } from "./types/GetSiteMetadata";
74
60
  import { GetSiteMetadataResponse } from "./types/GetSiteMetadataResponse";
75
61
  import { GetSiteResponse } from "./types/GetSiteResponse";
76
62
  import { GetUnreadCountResponse } from "./types/GetUnreadCountResponse";
77
63
  import { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnreadRegistrationApplicationCountResponse";
78
- import { ListCommentReports } from "./types/ListCommentReports";
79
- import { ListCommentReportsResponse } from "./types/ListCommentReportsResponse";
80
- import { ListCommunities } from "./types/ListCommunities";
81
64
  import { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
82
- import { ListPostReports } from "./types/ListPostReports";
83
- import { ListPostReportsResponse } from "./types/ListPostReportsResponse";
84
- import { ListPrivateMessageReports } from "./types/ListPrivateMessageReports";
85
- import { ListPrivateMessageReportsResponse } from "./types/ListPrivateMessageReportsResponse";
86
- import { ListRegistrationApplications } from "./types/ListRegistrationApplications";
87
65
  import { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
88
66
  import { LockPost } from "./types/LockPost";
89
67
  import { Login } from "./types/Login";
90
68
  import { LoginResponse } from "./types/LoginResponse";
91
69
  import { MarkCommentReplyAsRead } from "./types/MarkCommentReplyAsRead";
92
- import { MarkPersonMentionAsRead } from "./types/MarkPersonMentionAsRead";
93
70
  import { MarkPostAsRead } from "./types/MarkPostAsRead";
94
71
  import { MarkPrivateMessageAsRead } from "./types/MarkPrivateMessageAsRead";
95
72
  import { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
96
73
  import { PasswordReset } from "./types/PasswordReset";
97
- import { PersonMentionResponse } from "./types/PersonMentionResponse";
98
74
  import { PostReportResponse } from "./types/PostReportResponse";
99
75
  import { PostResponse } from "./types/PostResponse";
100
76
  import { PrivateMessageReportResponse } from "./types/PrivateMessageReportResponse";
101
77
  import { PrivateMessageResponse } from "./types/PrivateMessageResponse";
102
- import { PrivateMessagesResponse } from "./types/PrivateMessagesResponse";
103
78
  import { PurgeComment } from "./types/PurgeComment";
104
79
  import { PurgeCommunity } from "./types/PurgeCommunity";
105
80
  import { PurgePerson } from "./types/PurgePerson";
@@ -110,55 +85,55 @@ import { RemoveComment } from "./types/RemoveComment";
110
85
  import { RemoveCommunity } from "./types/RemoveCommunity";
111
86
  import { RemovePost } from "./types/RemovePost";
112
87
  import { ResolveCommentReport } from "./types/ResolveCommentReport";
113
- import { ResolveObject } from "./types/ResolveObject";
114
88
  import { ResolveObjectResponse } from "./types/ResolveObjectResponse";
115
89
  import { ResolvePostReport } from "./types/ResolvePostReport";
116
90
  import { ResolvePrivateMessageReport } from "./types/ResolvePrivateMessageReport";
117
91
  import { SaveComment } from "./types/SaveComment";
118
92
  import { SavePost } from "./types/SavePost";
119
93
  import { SaveUserSettings } from "./types/SaveUserSettings";
120
- import { Search } from "./types/Search";
121
94
  import { SearchResponse } from "./types/SearchResponse";
122
95
  import { SiteResponse } from "./types/SiteResponse";
123
96
  import { TransferCommunity } from "./types/TransferCommunity";
124
97
  import { VerifyEmail } from "./types/VerifyEmail";
125
- import { DeleteImage, UploadImage, UploadImageResponse } from "./other_types";
98
+ import { DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListPersonContentI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
126
99
  import { HideCommunity } from "./types/HideCommunity";
127
- import { BlockInstance } from "./types/BlockInstance";
128
- import { BlockInstanceResponse } from "./types/BlockInstanceResponse";
129
100
  import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
130
101
  import { UpdateTotp } from "./types/UpdateTotp";
131
102
  import { UpdateTotpResponse } from "./types/UpdateTotpResponse";
132
103
  import { SuccessResponse } from "./types/SuccessResponse";
133
104
  import { LoginToken } from "./types/LoginToken";
134
- import { ListPostLikes } from "./types/ListPostLikes";
135
105
  import { ListPostLikesResponse } from "./types/ListPostLikesResponse";
136
- import { ListCommentLikes } from "./types/ListCommentLikes";
137
106
  import { ListCommentLikesResponse } from "./types/ListCommentLikesResponse";
138
107
  import { HidePost } from "./types/HidePost";
139
- import { ListMedia } from "./types/ListMedia";
140
108
  import { ListMediaResponse } from "./types/ListMediaResponse";
141
109
  import { AuthenticateWithOauth } from "./types/AuthenticateWithOauth";
142
- import { GetRegistrationApplication } from "./types/GetRegistrationApplication";
143
110
  import { CreateTagline } from "./types/CreateTagline";
144
111
  import { TaglineResponse } from "./types/TaglineResponse";
145
112
  import { UpdateTagline } from "./types/UpdateTagline";
146
113
  import { DeleteTagline } from "./types/DeleteTagline";
147
- import { ListTaglines } from "./types/ListTaglines";
148
114
  import { ListTaglinesResponse } from "./types/ListTaglinesResponse";
149
- import { ListCustomEmojis } from "./types/ListCustomEmojis";
150
115
  import { ListCustomEmojisResponse } from "./types/ListCustomEmojisResponse";
151
- import { GetRandomCommunity } from "./types/GetRandomCommunity";
152
116
  import { ApproveCommunityPendingFollower } from "./types/ApproveCommunityPendingFollower";
153
117
  import { GetCommunityPendingFollowsCountResponse } from "./types/GetCommunityPendingFollowsCountResponse";
154
118
  import { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
155
- import { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows";
156
- import { CommunityId } from "./types/CommunityId";
119
+ import { ListReportsResponse } from "./types/ListReportsResponse";
120
+ import { MyUserInfo } from "./types/MyUserInfo";
121
+ import { UserBlockInstanceParams } from "./types/UserBlockInstanceParams";
122
+ import { AdminAllowInstanceParams } from "./types/AdminAllowInstanceParams";
123
+ import { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
124
+ import { ListPersonContentResponse } from "./types/ListPersonContentResponse";
125
+ import { ListPersonSavedResponse } from "./types/ListPersonSavedResponse";
126
+ import { UploadImageResponse } from "./types/UploadImageResponse";
127
+ import { ListInboxResponse } from "./types/ListInboxResponse";
128
+ import { MarkPersonCommentMentionAsRead } from "./types/MarkPersonCommentMentionAsRead";
129
+ import { MarkPersonPostMentionAsRead } from "./types/MarkPersonPostMentionAsRead";
130
+ import { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
131
+ import { Controller } from "tsoa";
157
132
  type RequestOptions = Pick<RequestInit, "signal">;
158
133
  /**
159
134
  * Helps build lemmy HTTP requests.
160
135
  */
161
- export declare class LemmyHttp {
136
+ export declare class LemmyHttp extends Controller {
162
137
  #private;
163
138
  /**
164
139
  * Generates a new instance of LemmyHttp.
@@ -172,683 +147,543 @@ export declare class LemmyHttp {
172
147
  };
173
148
  });
174
149
  /**
175
- * Gets the site, and your user data.
176
- *
177
- * `HTTP.GET /site`
150
+ * @summary Gets the site, and your user data.
178
151
  */
179
152
  getSite(options?: RequestOptions): Promise<GetSiteResponse>;
180
153
  /**
181
- * Create your site.
182
- *
183
- * `HTTP.POST /site`
154
+ * @summary Create your site.
184
155
  */
185
156
  createSite(form: CreateSite, options?: RequestOptions): Promise<SiteResponse>;
186
157
  /**
187
- * Edit your site.
188
- *
189
- * `HTTP.PUT /site`
158
+ * @summary Edit your site.
190
159
  */
191
160
  editSite(form: EditSite, options?: RequestOptions): Promise<SiteResponse>;
192
161
  /**
193
- * Leave the Site admins.
194
- *
195
- * `HTTP.POST /user/leave_admin`
162
+ * @summary Leave the Site admins.
196
163
  */
197
164
  leaveAdmin(options?: RequestOptions): Promise<GetSiteResponse>;
198
165
  /**
199
- * Generate a TOTP / two-factor secret.
200
- *
201
- * Afterwards you need to call `/user/totp/update` with a valid token to enable it.
166
+ * @summary Generate a TOTP / two-factor secret.
202
167
  *
203
- * `HTTP.POST /user/totp/generate`
168
+ * Generate a TOTP / two-factor secret.
169
+ * Afterwards you need to call `/account/auth/totp/update` with a valid token to enable it.
204
170
  */
205
171
  generateTotpSecret(options?: RequestOptions): Promise<GenerateTotpSecretResponse>;
206
172
  /**
173
+ * @summary Get data of current user.
174
+ */
175
+ getMyUser(options?: RequestOptions): Promise<MyUserInfo>;
176
+ /**
177
+ * @summary Export a backup of your user settings.
178
+ *
207
179
  * Export a backup of your user settings, including your saved content,
208
180
  * followed communities, and blocks.
209
- *
210
- * `HTTP.GET /user/export_settings`
211
181
  */
212
182
  exportSettings(options?: RequestOptions): Promise<string>;
213
183
  /**
214
- * Import a backup of your user settings.
215
- *
216
- * `HTTP.POST /user/import_settings`
184
+ * @summary Import a backup of your user settings.
217
185
  */
218
186
  importSettings(form: any, options?: RequestOptions): Promise<SuccessResponse>;
219
187
  /**
220
- * List login tokens for your user
221
- *
222
- * `HTTP.GET /user/list_logins`
188
+ * @summary List login tokens for your user
223
189
  */
224
190
  listLogins(options?: RequestOptions): Promise<LoginToken[]>;
225
191
  /**
226
- * Returns an error message if your auth token is invalid
227
- *
228
- * `HTTP.GET /user/validate_auth`
192
+ * @summary Returns an error message if your auth token is invalid
229
193
  */
230
194
  validateAuth(options?: RequestOptions): Promise<SuccessResponse>;
231
195
  /**
232
- * List all the media for your user
233
- *
234
- * `HTTP.GET /account/list_media`
196
+ * @summary List all the media for your user
235
197
  */
236
- listMedia(form?: ListMedia, options?: RequestOptions): Promise<ListMediaResponse>;
198
+ listMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
237
199
  /**
238
- * List all the media known to your instance.
239
- *
240
- * `HTTP.GET /admin/list_all_media`
200
+ * @summary List all the media known to your instance.
241
201
  */
242
- listAllMedia(form?: ListMedia, options?: RequestOptions): Promise<ListMediaResponse>;
202
+ listAllMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
243
203
  /**
244
- * Enable / Disable TOTP / two-factor authentication.
204
+ * @summary Enable / Disable TOTP / two-factor authentication.
245
205
  *
246
- * To enable, you need to first call `/user/totp/generate` and then pass a valid token to this.
206
+ * To enable, you need to first call `/account/auth/totp/generate` and then pass a valid token to this.
247
207
  *
248
208
  * Disabling is only possible if 2FA was previously enabled. Again it is necessary to pass a valid token.
249
- *
250
- * `HTTP.POST /user/totp/update`
251
209
  */
252
210
  updateTotp(form: UpdateTotp, options?: RequestOptions): Promise<UpdateTotpResponse>;
253
211
  /**
254
- * Get the modlog.
255
- *
256
- * `HTTP.GET /modlog`
212
+ * @summary Get the modlog.
257
213
  */
258
- getModlog(form?: GetModlog, options?: RequestOptions): Promise<GetModlogResponse>;
214
+ getModlog(form?: GetModlogI, options?: RequestOptions): Promise<GetModlogResponse>;
259
215
  /**
260
- * Search lemmy.
261
- *
262
- * `HTTP.GET /search`
216
+ * @summary Search lemmy.
263
217
  */
264
- search(form: Search, options?: RequestOptions): Promise<SearchResponse>;
218
+ search(form: SearchI, options?: RequestOptions): Promise<SearchResponse>;
265
219
  /**
266
- * Fetch a non-local / federated object.
267
- *
268
- * `HTTP.GET /resolve_object`
220
+ * @summary Fetch a non-local / federated object.
269
221
  */
270
- resolveObject(form: ResolveObject, options?: RequestOptions): Promise<ResolveObjectResponse>;
222
+ resolveObject(form: ResolveObjectI, options?: RequestOptions): Promise<ResolveObjectResponse>;
271
223
  /**
272
- * Create a new community.
273
- *
274
- * `HTTP.POST /community`
224
+ * @summary Create a new community.
275
225
  */
276
226
  createCommunity(form: CreateCommunity, options?: RequestOptions): Promise<CommunityResponse>;
277
227
  /**
278
- * Get / fetch a community.
279
- *
280
- * `HTTP.GET /community`
228
+ * @summary Get / fetch a community.
281
229
  */
282
- getCommunity(form?: GetCommunity, options?: RequestOptions): Promise<GetCommunityResponse>;
230
+ getCommunity(form?: GetCommunityI, options?: RequestOptions): Promise<GetCommunityResponse>;
283
231
  /**
284
- * Edit a community.
285
- *
286
- * `HTTP.PUT /community`
232
+ * @summary Edit a community.
287
233
  */
288
234
  editCommunity(form: EditCommunity, options?: RequestOptions): Promise<CommunityResponse>;
289
235
  /**
290
- * List communities, with various filters.
291
- *
292
- * `HTTP.GET /community/list`
236
+ * @summary List communities, with various filters.
293
237
  */
294
- listCommunities(form?: ListCommunities, options?: RequestOptions): Promise<ListCommunitiesResponse>;
238
+ listCommunities(form?: ListCommunitiesI, options?: RequestOptions): Promise<ListCommunitiesResponse>;
295
239
  /**
296
- * Follow / subscribe to a community.
297
- *
298
- * `HTTP.POST /community/follow`
240
+ * @summary Follow / subscribe to a community.
299
241
  */
300
242
  followCommunity(form: FollowCommunity, options?: RequestOptions): Promise<CommunityResponse>;
301
- getCommunityPendingFollowsCount(community_id: CommunityId, options?: RequestOptions): Promise<GetCommunityPendingFollowsCountResponse>;
302
- listCommunityPendingFollows(form: ListCommunityPendingFollows, options?: RequestOptions): Promise<ListCommunityPendingFollowsResponse>;
243
+ /**
244
+ * @summary Get a community's pending follows count.
245
+ */
246
+ getCommunityPendingFollowsCount(form: GetCommunityPendingFollowsCountI, options?: RequestOptions): Promise<GetCommunityPendingFollowsCountResponse>;
247
+ /**
248
+ * @summary Get a community's pending followers.
249
+ */
250
+ listCommunityPendingFollows(form: ListCommunityPendingFollowsI, options?: RequestOptions): Promise<ListCommunityPendingFollowsResponse>;
251
+ /**
252
+ * @summary Approve a community pending follow request.
253
+ */
303
254
  approveCommunityPendingFollow(form: ApproveCommunityPendingFollower, options?: RequestOptions): Promise<SuccessResponse>;
304
255
  /**
305
- * Block a community.
306
- *
307
- * `HTTP.POST /community/block`
256
+ * @summary Block a community.
308
257
  */
309
258
  blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<BlockCommunityResponse>;
310
259
  /**
311
- * Delete a community.
312
- *
313
- * `HTTP.POST /community/delete`
260
+ * @summary Delete a community.
314
261
  */
315
262
  deleteCommunity(form: DeleteCommunity, options?: RequestOptions): Promise<CommunityResponse>;
316
263
  /**
317
- * Hide a community from public / "All" view. Admins only.
318
- *
319
- * `HTTP.PUT /community/hide`
264
+ * @summary Hide a community from public / "All" view. Admins only.
320
265
  */
321
266
  hideCommunity(form: HideCommunity, options?: RequestOptions): Promise<SuccessResponse>;
322
267
  /**
323
- * A moderator remove for a community.
324
- *
325
- * `HTTP.POST /community/remove`
268
+ * @summary A moderator remove for a community.
326
269
  */
327
270
  removeCommunity(form: RemoveCommunity, options?: RequestOptions): Promise<CommunityResponse>;
328
271
  /**
329
- * Transfer your community to an existing moderator.
330
- *
331
- * `HTTP.POST /community/transfer`
272
+ * @summary Transfer your community to an existing moderator.
332
273
  */
333
274
  transferCommunity(form: TransferCommunity, options?: RequestOptions): Promise<GetCommunityResponse>;
334
275
  /**
335
- * Ban a user from a community.
336
- *
337
- * `HTTP.POST /community/ban_user`
276
+ * @summary Ban a user from a community.
338
277
  */
339
278
  banFromCommunity(form: BanFromCommunity, options?: RequestOptions): Promise<BanFromCommunityResponse>;
340
279
  /**
341
- * Add a moderator to your community.
342
- *
343
- * `HTTP.POST /community/mod`
280
+ * @summary Add a moderator to your community.
344
281
  */
345
282
  addModToCommunity(form: AddModToCommunity, options?: RequestOptions): Promise<AddModToCommunityResponse>;
346
283
  /**
347
- * Get a random community.
348
- *
349
- * `HTTP.GET /community/random`
284
+ * @summary Get a random community.
350
285
  */
351
- getRandomCommunity(form: GetRandomCommunity, options?: RequestOptions): Promise<CommunityResponse>;
286
+ getRandomCommunity(form: GetRandomCommunityI, options?: RequestOptions): Promise<CommunityResponse>;
352
287
  /**
353
- * Create a post.
354
- *
355
- * `HTTP.POST /post`
288
+ * @summary Create a post.
356
289
  */
357
290
  createPost(form: CreatePost, options?: RequestOptions): Promise<PostResponse>;
358
291
  /**
359
- * Get / fetch a post.
360
- *
361
- * `HTTP.GET /post`
292
+ * @summary Get / fetch a post.
362
293
  */
363
- getPost(form?: GetPost, options?: RequestOptions): Promise<GetPostResponse>;
294
+ getPost(form?: GetPostI, options?: RequestOptions): Promise<GetPostResponse>;
364
295
  /**
365
- * Edit a post.
366
- *
367
- * `HTTP.PUT /post`
296
+ * @summary Edit a post.
368
297
  */
369
298
  editPost(form: EditPost, options?: RequestOptions): Promise<PostResponse>;
370
299
  /**
371
- * Delete a post.
372
- *
373
- * `HTTP.POST /post/delete`
300
+ * @summary Delete a post.
374
301
  */
375
302
  deletePost(form: DeletePost, options?: RequestOptions): Promise<PostResponse>;
376
303
  /**
377
- * A moderator remove for a post.
378
- *
379
- * `HTTP.POST /post/remove`
304
+ * @summary A moderator remove for a post.
380
305
  */
381
306
  removePost(form: RemovePost, options?: RequestOptions): Promise<PostResponse>;
382
307
  /**
383
- * Mark a post as read.
384
- *
385
- * `HTTP.POST /post/mark_as_read`
308
+ * @summary Mark a post as read.
386
309
  */
387
310
  markPostAsRead(form: MarkPostAsRead, options?: RequestOptions): Promise<SuccessResponse>;
388
311
  /**
389
- * Hide a post from list views.
390
- *
391
- * `HTTP.POST /post/hide`
312
+ * @summary Mark multiple posts as read.
313
+ */
314
+ markManyPostAsRead(form: MarkManyPostsAsRead, options?: RequestOptions): Promise<SuccessResponse>;
315
+ /**
316
+ * @summary Hide a post from list views.
392
317
  */
393
318
  hidePost(form: HidePost, options?: RequestOptions): Promise<SuccessResponse>;
394
319
  /**
395
- * A moderator can lock a post ( IE disable new comments ).
396
- *
397
- * `HTTP.POST /post/lock`
320
+ * @summary A moderator can lock a post ( IE disable new comments ).
398
321
  */
399
322
  lockPost(form: LockPost, options?: RequestOptions): Promise<PostResponse>;
400
323
  /**
401
- * A moderator can feature a community post ( IE stick it to the top of a community ).
402
- *
403
- * `HTTP.POST /post/feature`
324
+ * @summary A moderator can feature a community post ( IE stick it to the top of a community ).
404
325
  */
405
326
  featurePost(form: FeaturePost, options?: RequestOptions): Promise<PostResponse>;
406
327
  /**
407
- * Get / fetch posts, with various filters.
408
- *
409
- * `HTTP.GET /post/list`
328
+ * @summary Get / fetch posts, with various filters.
410
329
  */
411
- getPosts(form?: GetPosts, options?: RequestOptions): Promise<GetPostsResponse>;
330
+ getPosts(form?: GetPostsI, options?: RequestOptions): Promise<GetPostsResponse>;
412
331
  /**
413
- * Like / vote on a post.
414
- *
415
- * `HTTP.POST /post/like`
332
+ * @summary Like / vote on a post.
416
333
  */
417
334
  likePost(form: CreatePostLike, options?: RequestOptions): Promise<PostResponse>;
418
335
  /**
419
- * List a post's likes. Admin-only.
420
- *
421
- * `HTTP.GET /post/like/list`
336
+ * @summary List a post's likes. Admin-only.
422
337
  */
423
- listPostLikes(form: ListPostLikes, options?: RequestOptions): Promise<ListPostLikesResponse>;
338
+ listPostLikes(form: ListPostLikesI, options?: RequestOptions): Promise<ListPostLikesResponse>;
424
339
  /**
425
- * Save a post.
426
- *
427
- * `HTTP.PUT /post/save`
340
+ * @summary Save a post.
428
341
  */
429
342
  savePost(form: SavePost, options?: RequestOptions): Promise<PostResponse>;
430
343
  /**
431
- * Report a post.
432
- *
433
- * `HTTP.POST /post/report`
344
+ * @summary Report a post.
434
345
  */
435
346
  createPostReport(form: CreatePostReport, options?: RequestOptions): Promise<PostReportResponse>;
436
347
  /**
437
- * Resolve a post report. Only a mod can do this.
438
- *
439
- * `HTTP.PUT /post/report/resolve`
348
+ * @summary Resolve a post report. Only a mod can do this.
440
349
  */
441
350
  resolvePostReport(form: ResolvePostReport, options?: RequestOptions): Promise<PostReportResponse>;
442
351
  /**
443
- * List post reports.
444
- *
445
- * `HTTP.GET /post/report/list`
446
- */
447
- listPostReports(form: ListPostReports, options?: RequestOptions): Promise<ListPostReportsResponse>;
448
- /**
449
- * Fetch metadata for any given site.
450
- *
451
- * `HTTP.GET /post/site_metadata`
352
+ * @summary Fetch metadata for any given site.
452
353
  */
453
- getSiteMetadata(form: GetSiteMetadata, options?: RequestOptions): Promise<GetSiteMetadataResponse>;
354
+ getSiteMetadata(form: GetSiteMetadataI, options?: RequestOptions): Promise<GetSiteMetadataResponse>;
454
355
  /**
455
- * Create a comment.
456
- *
457
- * `HTTP.POST /comment`
356
+ * @summary Create a comment.
458
357
  */
459
358
  createComment(form: CreateComment, options?: RequestOptions): Promise<CommentResponse>;
460
359
  /**
461
- * Edit a comment.
462
- *
463
- * `HTTP.PUT /comment`
360
+ * @summary Edit a comment.
464
361
  */
465
362
  editComment(form: EditComment, options?: RequestOptions): Promise<CommentResponse>;
466
363
  /**
467
- * Delete a comment.
468
- *
469
- * `HTTP.POST /comment/delete`
364
+ * @summary Delete a comment.
470
365
  */
471
366
  deleteComment(form: DeleteComment, options?: RequestOptions): Promise<CommentResponse>;
472
367
  /**
473
- * A moderator remove for a comment.
474
- *
475
- * `HTTP.POST /comment/remove`
368
+ * @summary A moderator remove for a comment.
476
369
  */
477
370
  removeComment(form: RemoveComment, options?: RequestOptions): Promise<CommentResponse>;
478
371
  /**
479
- * Mark a comment as read.
480
- *
481
- * `HTTP.POST /comment/mark_as_read`
372
+ * @summary Mark a comment as read.
482
373
  */
483
- markCommentReplyAsRead(form: MarkCommentReplyAsRead, options?: RequestOptions): Promise<CommentReplyResponse>;
374
+ markCommentReplyAsRead(form: MarkCommentReplyAsRead, options?: RequestOptions): Promise<SuccessResponse>;
484
375
  /**
485
- * Like / vote on a comment.
486
- *
487
- * `HTTP.POST /comment/like`
376
+ * @summary Like / vote on a comment.
488
377
  */
489
378
  likeComment(form: CreateCommentLike, options?: RequestOptions): Promise<CommentResponse>;
490
379
  /**
491
- * List a comment's likes. Admin-only.
492
- *
493
- * `HTTP.GET /comment/like/list`
380
+ * @summary List a comment's likes. Admin-only.
494
381
  */
495
- listCommentLikes(form: ListCommentLikes, options?: RequestOptions): Promise<ListCommentLikesResponse>;
382
+ listCommentLikes(form: ListCommentLikesI, options?: RequestOptions): Promise<ListCommentLikesResponse>;
496
383
  /**
497
- * Save a comment.
498
- *
499
- * `HTTP.PUT /comment/save`
384
+ * @summary Save a comment.
500
385
  */
501
386
  saveComment(form: SaveComment, options?: RequestOptions): Promise<CommentResponse>;
502
387
  /**
503
- * Distinguishes a comment (speak as moderator)
504
- *
505
- * `HTTP.POST /comment/distinguish`
388
+ * @summary Distinguishes a comment (speak as moderator)
506
389
  */
507
390
  distinguishComment(form: DistinguishComment, options?: RequestOptions): Promise<CommentResponse>;
508
391
  /**
509
- * Get / fetch comments.
510
- *
511
- * `HTTP.GET /comment/list`
392
+ * @summary Get / fetch comments.
512
393
  */
513
- getComments(form?: GetComments, options?: RequestOptions): Promise<GetCommentsResponse>;
394
+ getComments(form?: GetCommentsI, options?: RequestOptions): Promise<GetCommentsResponse>;
514
395
  /**
515
- * Get / fetch comment.
516
- *
517
- * `HTTP.GET /comment`
396
+ * @summary Get / fetch comments, but without the post or community.
518
397
  */
519
- getComment(form: GetComment, options?: RequestOptions): Promise<CommentResponse>;
398
+ getCommentsSlim(form?: GetCommentsI, options?: RequestOptions): Promise<GetCommentsSlimResponse>;
520
399
  /**
521
- * Report a comment.
522
- *
523
- * `HTTP.POST /comment/report`
400
+ * @summary Get / fetch comment.
524
401
  */
525
- createCommentReport(form: CreateCommentReport, options?: RequestOptions): Promise<CommentReportResponse>;
402
+ getComment(form: GetCommentI, options?: RequestOptions): Promise<CommentResponse>;
526
403
  /**
527
- * Resolve a comment report. Only a mod can do this.
528
- *
529
- * `HTTP.PUT /comment/report/resolve`
404
+ * @summary Report a comment.
530
405
  */
531
- resolveCommentReport(form: ResolveCommentReport, options?: RequestOptions): Promise<CommentReportResponse>;
532
- /**
533
- * List comment reports.
534
- *
535
- * `HTTP.GET /comment/report/list`
536
- */
537
- listCommentReports(form: ListCommentReports, options?: RequestOptions): Promise<ListCommentReportsResponse>;
406
+ createCommentReport(form: CreateCommentReport, options?: RequestOptions): Promise<CommentReportResponse>;
538
407
  /**
539
- * Get / fetch private messages.
540
- *
541
- * `HTTP.GET /private_message/list`
408
+ * @summary Resolve a comment report. Only a mod can do this.
542
409
  */
543
- getPrivateMessages(form: GetPrivateMessages, options?: RequestOptions): Promise<PrivateMessagesResponse>;
410
+ resolveCommentReport(form: ResolveCommentReport, options?: RequestOptions): Promise<CommentReportResponse>;
544
411
  /**
545
- * Create a private message.
546
- *
547
- * `HTTP.POST /private_message`
412
+ * @summary Create a private message.
548
413
  */
549
414
  createPrivateMessage(form: CreatePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
550
415
  /**
551
- * Edit a private message.
552
- *
553
- * `HTTP.PUT /private_message`
416
+ * @summary Edit a private message.
554
417
  */
555
418
  editPrivateMessage(form: EditPrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
556
419
  /**
557
- * Delete a private message.
558
- *
559
- * `HTTP.POST /private_message/delete`
420
+ * @summary Delete a private message.
560
421
  */
561
422
  deletePrivateMessage(form: DeletePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
562
423
  /**
563
- * Mark a private message as read.
564
- *
565
- * `HTTP.POST /private_message/mark_as_read`
424
+ * @summary Mark a private message as read.
566
425
  */
567
426
  markPrivateMessageAsRead(form: MarkPrivateMessageAsRead, options?: RequestOptions): Promise<PrivateMessageResponse>;
568
427
  /**
569
- * Create a report for a private message.
570
- *
571
- * `HTTP.POST /private_message/report`
428
+ * @summary Create a report for a private message.
572
429
  */
573
430
  createPrivateMessageReport(form: CreatePrivateMessageReport, options?: RequestOptions): Promise<PrivateMessageReportResponse>;
574
431
  /**
575
- * Resolve a report for a private message.
576
- *
577
- * `HTTP.PUT /private_message/report/resolve`
432
+ * @summary Resolve a report for a private message.
578
433
  */
579
434
  resolvePrivateMessageReport(form: ResolvePrivateMessageReport, options?: RequestOptions): Promise<PrivateMessageReportResponse>;
580
435
  /**
581
- * List private message reports.
582
- *
583
- * `HTTP.GET /private_message/report/list`
584
- */
585
- listPrivateMessageReports(form: ListPrivateMessageReports, options?: RequestOptions): Promise<ListPrivateMessageReportsResponse>;
586
- /**
587
- * Register a new user.
588
- *
589
- * `HTTP.POST /user/register`
436
+ * @summary Register a new user.
590
437
  */
591
438
  register(form: Register, options?: RequestOptions): Promise<LoginResponse>;
592
439
  /**
593
- * Log into lemmy.
594
- *
595
- * `HTTP.POST /user/login`
440
+ * @summary Log into lemmy.
596
441
  */
597
442
  login(form: Login, options?: RequestOptions): Promise<LoginResponse>;
598
443
  /**
599
- * Invalidate the currently used auth token.
600
- *
601
- * `HTTP.POST /user/logout`
444
+ * @summary Invalidate the currently used auth token.
602
445
  */
603
446
  logout(options?: RequestOptions): Promise<SuccessResponse>;
604
447
  /**
605
- * Get the details for a person.
606
- *
607
- * `HTTP.GET /user`
448
+ * @summary Get the details for a person.
608
449
  */
609
- getPersonDetails(form?: GetPersonDetails, options?: RequestOptions): Promise<GetPersonDetailsResponse>;
450
+ getPersonDetails(form?: GetPersonDetailsI, options?: RequestOptions): Promise<GetPersonDetailsResponse>;
610
451
  /**
611
- * Get mentions for your user.
612
- *
613
- * `HTTP.GET /user/mention`
452
+ * @summary List the content for a person.
614
453
  */
615
- getPersonMentions(form: GetPersonMentions, options?: RequestOptions): Promise<GetPersonMentionsResponse>;
454
+ listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
616
455
  /**
617
- * Mark a person mention as read.
618
- *
619
- * `HTTP.POST /user/mention/mark_as_read`
456
+ * @summary Mark a person mention as read.
620
457
  */
621
- markPersonMentionAsRead(form: MarkPersonMentionAsRead, options?: RequestOptions): Promise<PersonMentionResponse>;
458
+ markCommentMentionAsRead(form: MarkPersonCommentMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
622
459
  /**
623
- * Get comment replies.
624
- *
625
- * `HTTP.GET /user/replies`
460
+ * @summary Mark a person post body mention as read.
626
461
  */
627
- getReplies(form: GetReplies, options?: RequestOptions): Promise<GetRepliesResponse>;
462
+ markPostMentionAsRead(form: MarkPersonPostMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
628
463
  /**
629
- * Ban a person from your site.
630
- *
631
- * `HTTP.POST /user/ban`
464
+ * @summary Ban a person from your site.
632
465
  */
633
466
  banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>;
634
467
  /**
635
- * Get a list of banned users
636
- *
637
- * `HTTP.GET /user/banned`
468
+ * @summary Get a list of banned users.
638
469
  */
639
470
  getBannedPersons(options?: RequestOptions): Promise<BannedPersonsResponse>;
640
471
  /**
641
- * Block a person.
642
- *
643
- * `HTTP.POST /user/block`
472
+ * @summary Block a person.
644
473
  */
645
474
  blockPerson(form: BlockPerson, options?: RequestOptions): Promise<BlockPersonResponse>;
646
475
  /**
647
- * Fetch a Captcha.
648
- *
649
- * `HTTP.GET /user/get_captcha`
476
+ * @summary Fetch a Captcha.
650
477
  */
651
478
  getCaptcha(options?: RequestOptions): Promise<GetCaptchaResponse>;
652
479
  /**
653
- * Delete your account.
654
- *
655
- * `HTTP.POST /user/delete_account`
480
+ * @summary Delete your account.
656
481
  */
657
482
  deleteAccount(form: DeleteAccount, options?: RequestOptions): Promise<SuccessResponse>;
658
483
  /**
659
- * Reset your password.
660
- *
661
- * `HTTP.POST /user/password_reset`
484
+ * @summary Reset your password.
662
485
  */
663
486
  passwordReset(form: PasswordReset, options?: RequestOptions): Promise<SuccessResponse>;
664
487
  /**
665
- * Change your password from an email / token based reset.
666
- *
667
- * `HTTP.POST /user/password_change`
488
+ * @summary Change your password from an email / token based reset.
668
489
  */
669
490
  passwordChangeAfterReset(form: PasswordChangeAfterReset, options?: RequestOptions): Promise<SuccessResponse>;
670
491
  /**
671
- * Mark all replies as read.
672
- *
673
- * `HTTP.POST /user/mark_all_as_read`
492
+ * @summary Mark all replies as read.
674
493
  */
675
- markAllAsRead(options?: RequestOptions): Promise<GetRepliesResponse>;
494
+ markAllNotificationsAsRead(options?: RequestOptions): Promise<SuccessResponse>;
676
495
  /**
677
- * Save your user settings.
678
- *
679
- * `HTTP.PUT /user/save_user_settings`
496
+ * @summary Save your user settings.
680
497
  */
681
498
  saveUserSettings(form: SaveUserSettings, options?: RequestOptions): Promise<SuccessResponse>;
682
499
  /**
683
- * Change your user password.
684
- *
685
- * `HTTP.PUT /user/change_password`
500
+ * @summary Change your user password.
686
501
  */
687
502
  changePassword(form: ChangePassword, options?: RequestOptions): Promise<LoginResponse>;
688
503
  /**
689
- * Get counts for your reports
690
- *
691
- * `HTTP.GET /user/report_count`
504
+ * @summary Get counts for your reports.
692
505
  */
693
- getReportCount(form: GetReportCount, options?: RequestOptions): Promise<GetReportCountResponse>;
506
+ getReportCount(form: GetReportCountI, options?: RequestOptions): Promise<GetReportCountResponse>;
694
507
  /**
695
- * Get your unread counts
696
- *
697
- * `HTTP.GET /user/unread_count`
508
+ * @summary Get your unread counts.
698
509
  */
699
510
  getUnreadCount(options?: RequestOptions): Promise<GetUnreadCountResponse>;
700
511
  /**
701
- * Verify your email
702
- *
703
- * `HTTP.POST /user/verify_email`
512
+ * @summary Get your inbox (replies, comment mentions, post mentions, and messages)
513
+ */
514
+ listInbox(form: ListInboxI, options?: RequestOptions): Promise<ListInboxResponse>;
515
+ /**
516
+ * @summary Verify your email
704
517
  */
705
518
  verifyEmail(form: VerifyEmail, options?: RequestOptions): Promise<SuccessResponse>;
706
519
  /**
707
- * Add an admin to your site.
708
- *
709
- * `HTTP.POST /admin/add`
520
+ * @summary List your saved content.
521
+ */
522
+ listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<ListPersonSavedResponse>;
523
+ /**
524
+ * @summary Add an admin to your site.
710
525
  */
711
526
  addAdmin(form: AddAdmin, options?: RequestOptions): Promise<AddAdminResponse>;
712
527
  /**
713
- * Get the unread registration applications count.
714
- *
715
- * `HTTP.GET /admin/registration_application/count`
528
+ * @summary Get the unread registration applications count.
716
529
  */
717
530
  getUnreadRegistrationApplicationCount(options?: RequestOptions): Promise<GetUnreadRegistrationApplicationCountResponse>;
718
531
  /**
719
- * List the registration applications.
720
- *
721
- * `HTTP.GET /admin/registration_application/list`
532
+ * @summary List the registration applications.
722
533
  */
723
- listRegistrationApplications(form: ListRegistrationApplications, options?: RequestOptions): Promise<ListRegistrationApplicationsResponse>;
534
+ listRegistrationApplications(form: ListRegistrationApplicationsI, options?: RequestOptions): Promise<ListRegistrationApplicationsResponse>;
724
535
  /**
725
- * Approve a registration application
726
- *
727
- * `HTTP.PUT /admin/registration_application/approve`
536
+ * @summary Approve a registration application
728
537
  */
729
538
  approveRegistrationApplication(form: ApproveRegistrationApplication, options?: RequestOptions): Promise<RegistrationApplicationResponse>;
730
539
  /**
731
- * Get the application a user submitted when they first registered their account
732
- *
733
- * `HTTP.GET /admin/registration_application`
540
+ * @summary Get the application a user submitted when they first registered their account
734
541
  */
735
- getRegistrationApplication(form: GetRegistrationApplication, options?: RequestOptions): Promise<RegistrationApplicationResponse>;
542
+ getRegistrationApplication(form: GetRegistrationApplicationI, options?: RequestOptions): Promise<RegistrationApplicationResponse>;
736
543
  /**
737
- * Purge / Delete a person from the database.
738
- *
739
- * `HTTP.POST /admin/purge/person`
544
+ * @summary Purge / Delete a person from the database.
740
545
  */
741
546
  purgePerson(form: PurgePerson, options?: RequestOptions): Promise<SuccessResponse>;
742
547
  /**
743
- * Purge / Delete a community from the database.
744
- *
745
- * `HTTP.POST /admin/purge/community`
548
+ * @summary Purge / Delete a community from the database.
746
549
  */
747
550
  purgeCommunity(form: PurgeCommunity, options?: RequestOptions): Promise<SuccessResponse>;
748
551
  /**
749
- * Purge / Delete a post from the database.
750
- *
751
- * `HTTP.POST /admin/purge/post`
552
+ * @summary Purge / Delete a post from the database.
752
553
  */
753
554
  purgePost(form: PurgePost, options?: RequestOptions): Promise<SuccessResponse>;
754
555
  /**
755
- * Purge / Delete a comment from the database.
756
- *
757
- * `HTTP.POST /admin/purge/comment`
556
+ * @summary Purge / Delete a comment from the database.
758
557
  */
759
558
  purgeComment(form: PurgeComment, options?: RequestOptions): Promise<SuccessResponse>;
760
559
  /**
761
- * Create a new custom emoji
762
- *
763
- * `HTTP.POST /custom_emoji`
560
+ * @summary Create a new custom emoji.
764
561
  */
765
562
  createCustomEmoji(form: CreateCustomEmoji, options?: RequestOptions): Promise<CustomEmojiResponse>;
766
563
  /**
767
- * Edit an existing custom emoji
768
- *
769
- * `HTTP.PUT /custom_emoji`
564
+ * @summary Edit an existing custom emoji.
770
565
  */
771
566
  editCustomEmoji(form: EditCustomEmoji, options?: RequestOptions): Promise<CustomEmojiResponse>;
772
567
  /**
773
- * Delete a custom emoji
774
- *
775
- * `HTTP.Post /custom_emoji/delete`
568
+ * @summary Delete a custom emoji.
776
569
  */
777
570
  deleteCustomEmoji(form: DeleteCustomEmoji, options?: RequestOptions): Promise<SuccessResponse>;
778
571
  /**
779
- * List custom emojis
780
- *
781
- * `HTTP.GET /custom_emoji/list`
572
+ * @summary List custom emojis
782
573
  */
783
- listCustomEmojis(form: ListCustomEmojis, options?: RequestOptions): Promise<ListCustomEmojisResponse>;
574
+ listCustomEmojis(form: ListCustomEmojisI, options?: RequestOptions): Promise<ListCustomEmojisResponse>;
784
575
  /**
785
- * Create a new tagline
786
- *
787
- * `HTTP.POST /admin/tagline`
576
+ * @summary Create a new tagline
788
577
  */
789
578
  createTagline(form: CreateTagline, options?: RequestOptions): Promise<TaglineResponse>;
790
579
  /**
791
- * Edit an existing tagline
792
- *
793
- * `HTTP.PUT /admin/tagline`
580
+ * @summary Edit an existing tagline
794
581
  */
795
582
  editTagline(form: UpdateTagline, options?: RequestOptions): Promise<TaglineResponse>;
796
583
  /**
797
- * Delete a tagline
798
- *
799
- * `HTTP.Post /admin/tagline/delete`
584
+ * @summary Delete a tagline
800
585
  */
801
586
  deleteTagline(form: DeleteTagline, options?: RequestOptions): Promise<SuccessResponse>;
802
587
  /**
803
- * List taglines
804
- *
805
- * `HTTP.GET /admin/tagline/list`
588
+ * @summary List taglines.
806
589
  */
807
- listTaglines(form: ListTaglines, options?: RequestOptions): Promise<ListTaglinesResponse>;
590
+ listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<ListTaglinesResponse>;
808
591
  /**
809
- * Create a new oauth provider method
810
- *
811
- * `HTTP.POST /oauth_provider`
592
+ * @summary Create a new oauth provider method
812
593
  */
813
594
  createOAuthProvider(form: CreateOAuthProvider, options?: RequestOptions): Promise<OAuthProvider>;
814
595
  /**
815
- * Edit an existing oauth provider method
816
- *
817
- * `HTTP.PUT /oauth_provider`
596
+ * @summary Edit an existing oauth provider method
818
597
  */
819
598
  editOAuthProvider(form: EditOAuthProvider, options?: RequestOptions): Promise<OAuthProvider>;
820
599
  /**
821
- * Delete an oauth provider method
822
- *
823
- * `HTTP.Post /oauth_provider/delete`
600
+ * @summary Delete an oauth provider method
824
601
  */
825
602
  deleteOAuthProvider(form: DeleteOAuthProvider, options?: RequestOptions): Promise<SuccessResponse>;
826
603
  /**
827
- * Authenticate with OAuth
828
- *
829
- * `HTTP.Post /oauth/authenticate`
604
+ * @summary Authenticate with OAuth
830
605
  */
831
606
  authenticateWithOAuth(form: AuthenticateWithOauth, options?: RequestOptions): Promise<LoginResponse>;
832
607
  /**
833
- * Fetch federated instances.
834
- *
835
- * `HTTP.Get /federated_instances`
608
+ * @summary Fetch federated instances.
836
609
  */
837
610
  getFederatedInstances(options?: RequestOptions): Promise<GetFederatedInstancesResponse>;
838
611
  /**
839
- * Block an instance.
840
- *
841
- * `HTTP.Post /site/block`
612
+ * @summary List user reports.
613
+ */
614
+ listReports(form: ListReportsI, options?: RequestOptions): Promise<ListReportsResponse>;
615
+ /**
616
+ * @summary Block an instance as user.
617
+ */
618
+ userBlockInstance(form: UserBlockInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
619
+ /**
620
+ * @summary Globally block an instance as admin.
621
+ */
622
+ adminBlockInstance(form: AdminBlockInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
623
+ /**
624
+ * @summary Globally allow an instance as admin.
625
+ */
626
+ adminAllowInstance(form: AdminAllowInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
627
+ /**
628
+ * @summary Upload new user avatar.
629
+ */
630
+ uploadUserAvatar(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
631
+ /**
632
+ * @summary Delete the user avatar.
633
+ */
634
+ deleteUserAvatar(options?: RequestOptions): Promise<SuccessResponse>;
635
+ /**
636
+ * @summary Upload new user banner.
637
+ */
638
+ uploadUserBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
639
+ /**
640
+ * @summary Delete the user banner.
641
+ */
642
+ deleteUserBanner(options?: RequestOptions): Promise<SuccessResponse>;
643
+ /**
644
+ * @summary Upload new community icon.
645
+ */
646
+ uploadCommunityIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
647
+ /**
648
+ * @summary Delete the community icon.
649
+ */
650
+ deleteCommunityIcon(options?: RequestOptions): Promise<SuccessResponse>;
651
+ /**
652
+ * @summary Upload new community banner.
653
+ */
654
+ uploadCommunityBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
655
+ /**
656
+ * @summary Delete the community banner.
657
+ */
658
+ deleteCommunityBanner(options?: RequestOptions): Promise<SuccessResponse>;
659
+ /**
660
+ * @summary Upload new site icon.
661
+ */
662
+ uploadSiteIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
663
+ /**
664
+ * @summary Delete the site icon.
665
+ */
666
+ deleteSiteIcon(options?: RequestOptions): Promise<SuccessResponse>;
667
+ /**
668
+ * @summary Upload new site banner.
669
+ */
670
+ uploadSiteBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
671
+ /**
672
+ * @summary Delete the site banner.
673
+ */
674
+ deleteSiteBanner(options?: RequestOptions): Promise<SuccessResponse>;
675
+ /**
676
+ * @summary Upload an image to the server.
842
677
  */
843
- blockInstance(form: BlockInstance, options?: RequestOptions): Promise<BlockInstanceResponse>;
678
+ uploadImage(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
844
679
  /**
845
- * Upload an image to the server.
680
+ * @summary Delete a pictrs image
846
681
  */
847
- uploadImage({ image }: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
682
+ deleteImage(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse>;
848
683
  /**
849
- * Delete a pictrs image
684
+ * @summary Health check for image functionality
850
685
  */
851
- deleteImage({ token, filename }: DeleteImage, options?: RequestOptions): Promise<boolean>;
686
+ imageHealth(options?: RequestOptions): Promise<SuccessResponse>;
852
687
  /**
853
688
  * Set the headers (can be used to set the auth header)
854
689
  */