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