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