lemmy-js-client 0.20.0-modlog-combined.1 → 0.20.0-move-community-hidden.2

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