From 73f2d691135eb941fd1b8d6ae079817e98e9bab7 Mon Sep 17 00:00:00 2001 From: riku6460 <17585784+riku6460@users.noreply.github.com> Date: Wed, 27 Dec 2023 06:50:31 +0900 Subject: [PATCH] fix api report --- packages/misskey-js/etc/misskey-js.api.md | 139 +++++++++++++++++++++- 1 file changed, 137 insertions(+), 2 deletions(-) diff --git a/packages/misskey-js/etc/misskey-js.api.md b/packages/misskey-js/etc/misskey-js.api.md index 71a2e50b0..d86863287 100644 --- a/packages/misskey-js/etc/misskey-js.api.md +++ b/packages/misskey-js/etc/misskey-js.api.md @@ -26,6 +26,9 @@ declare namespace acct { } export { acct } +// @public (undocumented) +type Ad = components['schemas']['Ad']; + // Warning: (ae-forgotten-export) The symbol "operations" needs to be exported by the entry point index.d.ts // // @public (undocumented) @@ -64,15 +67,24 @@ type AdminAccountsDeleteRequest = operations['admin/accounts/delete']['requestBo // @public (undocumented) type AdminAccountsFindByEmailRequest = operations['admin/accounts/find-by-email']['requestBody']['content']['application/json']; +// @public (undocumented) +type AdminAccountsFindByEmailResponse = operations['admin/accounts/find-by-email']['responses']['200']['content']['application/json']; + // @public (undocumented) type AdminAdCreateRequest = operations['admin/ad/create']['requestBody']['content']['application/json']; +// @public (undocumented) +type AdminAdCreateResponse = operations['admin/ad/create']['responses']['200']['content']['application/json']; + // @public (undocumented) type AdminAdDeleteRequest = operations['admin/ad/delete']['requestBody']['content']['application/json']; // @public (undocumented) type AdminAdListRequest = operations['admin/ad/list']['requestBody']['content']['application/json']; +// @public (undocumented) +type AdminAdListResponse = operations['admin/ad/list']['responses']['200']['content']['application/json']; + // @public (undocumented) type AdminAdUpdateRequest = operations['admin/ad/update']['requestBody']['content']['application/json']; @@ -190,12 +202,18 @@ type AdminFederationRemoveAllFollowingRequest = operations['admin/federation/rem // @public (undocumented) type AdminFederationUpdateInstanceRequest = operations['admin/federation/update-instance']['requestBody']['content']['application/json']; +// @public (undocumented) +type AdminGetIndexStatsResponse = operations['admin/get-index-stats']['responses']['200']['content']['application/json']; + // @public (undocumented) type AdminGetTableStatsResponse = operations['admin/get-table-stats']['responses']['200']['content']['application/json']; // @public (undocumented) type AdminGetUserIpsRequest = operations['admin/get-user-ips']['requestBody']['content']['application/json']; +// @public (undocumented) +type AdminGetUserIpsResponse = operations['admin/get-user-ips']['responses']['200']['content']['application/json']; + // @public (undocumented) type AdminInviteCreateRequest = operations['admin/invite/create']['requestBody']['content']['application/json']; @@ -280,6 +298,9 @@ type AdminRolesUpdateRequest = operations['admin/roles/update']['requestBody'][' // @public (undocumented) type AdminRolesUsersRequest = operations['admin/roles/users']['requestBody']['content']['application/json']; +// @public (undocumented) +type AdminRolesUsersResponse = operations['admin/roles/users']['responses']['200']['content']['application/json']; + // @public (undocumented) type AdminSendEmailRequest = operations['admin/send-email']['requestBody']['content']['application/json']; @@ -1010,6 +1031,9 @@ type EmptyResponse = Record | undefined; // @public (undocumented) type EndpointRequest = operations['endpoint']['requestBody']['content']['application/json']; +// @public (undocumented) +type EndpointResponse = operations['endpoint']['responses']['200']['content']['application/json']; + // Warning: (ae-forgotten-export) The symbol "Overwrite" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "Endpoints_2" needs to be exported by the entry point index.d.ts // @@ -1059,9 +1083,12 @@ declare namespace entities { AdminAccountsCreateResponse, AdminAccountsDeleteRequest, AdminAccountsFindByEmailRequest, + AdminAccountsFindByEmailResponse, AdminAdCreateRequest, + AdminAdCreateResponse, AdminAdDeleteRequest, AdminAdListRequest, + AdminAdListResponse, AdminAdUpdateRequest, AdminAnnouncementsCreateRequest, AdminAnnouncementsCreateResponse, @@ -1107,8 +1134,10 @@ declare namespace entities { AdminFederationRefreshRemoteInstanceMetadataRequest, AdminFederationRemoveAllFollowingRequest, AdminFederationUpdateInstanceRequest, + AdminGetIndexStatsResponse, AdminGetTableStatsResponse, AdminGetUserIpsRequest, + AdminGetUserIpsResponse, AdminInviteCreateRequest, AdminInviteCreateResponse, AdminInviteListRequest, @@ -1150,6 +1179,7 @@ declare namespace entities { AdminRolesUnassignRequest, AdminRolesUpdateDefaultPoliciesRequest, AdminRolesUsersRequest, + AdminRolesUsersResponse, AnnouncementsRequest, AnnouncementsResponse, AntennasCreateRequest, @@ -1277,6 +1307,7 @@ declare namespace entities { EmailAddressAvailableRequest, EmailAddressAvailableResponse, EndpointRequest, + EndpointResponse, EndpointsResponse, FederationFollowersRequest, FederationFollowersResponse, @@ -1290,6 +1321,7 @@ declare namespace entities { FederationUsersRequest, FederationUsersResponse, FederationStatsRequest, + FederationStatsResponse, FollowingCreateRequest, FollowingCreateResponse, FollowingDeleteRequest, @@ -1319,6 +1351,7 @@ declare namespace entities { GalleryPostsUnlikeRequest, GalleryPostsUpdateRequest, GalleryPostsUpdateResponse, + GetOnlineUsersCountResponse, GetAvatarDecorationsResponse, HashtagsListRequest, HashtagsListResponse, @@ -1332,14 +1365,19 @@ declare namespace entities { IResponse, I2faDoneRequest, I2faKeyDoneRequest, + I2faKeyDoneResponse, I2faPasswordLessRequest, I2faRegisterKeyRequest, + I2faRegisterKeyResponse, I2faRegisterRequest, + I2faRegisterResponse, I2faUpdateKeyRequest, I2faRemoveKeyRequest, I2faUnregisterRequest, IAppsRequest, + IAppsResponse, IAuthorizedAppsRequest, + IAuthorizedAppsResponse, IClaimAchievementRequest, IChangePasswordRequest, IDeleteAccountRequest, @@ -1368,11 +1406,16 @@ declare namespace entities { IReadAnnouncementRequest, IRegenerateTokenRequest, IRegistryGetAllRequest, + IRegistryGetAllResponse, IRegistryGetDetailRequest, + IRegistryGetDetailResponse, IRegistryGetRequest, + IRegistryGetResponse, IRegistryKeysWithTypeRequest, + IRegistryKeysWithTypeResponse, IRegistryKeysRequest, IRegistryRemoveRequest, + IRegistryScopesWithDomainResponse, IRegistrySetRequest, IRevokeTokenRequest, ISigninHistoryRequest, @@ -1380,11 +1423,16 @@ declare namespace entities { IUnpinRequest, IUnpinResponse, IUpdateEmailRequest, + IUpdateEmailResponse, IUpdateRequest, IUpdateResponse, IMoveRequest, + IMoveResponse, IWebhooksCreateRequest, + IWebhooksCreateResponse, + IWebhooksListResponse, IWebhooksShowRequest, + IWebhooksShowResponse, IWebhooksUpdateRequest, IWebhooksDeleteRequest, InviteCreateResponse, @@ -1472,6 +1520,7 @@ declare namespace entities { PagesUnlikeRequest, PagesUpdateRequest, FlashCreateRequest, + FlashCreateResponse, FlashDeleteRequest, FlashFeaturedResponse, FlashLikeRequest, @@ -1490,10 +1539,12 @@ declare namespace entities { RolesShowRequest, RolesShowResponse, RolesUsersRequest, + RolesUsersResponse, RolesNotesRequest, RolesNotesResponse, RequestResetPasswordRequest, ResetPasswordRequest, + ServerInfoResponse, StatsResponse, SwShowRegistrationRequest, SwShowRegistrationResponse, @@ -1503,6 +1554,7 @@ declare namespace entities { SwRegisterResponse, SwUnregisterRequest, TestRequest, + TestResponse, UsernameAvailableRequest, UsernameAvailableResponse, UsersRequest, @@ -1536,6 +1588,7 @@ declare namespace entities { UsersListsCreateFromPublicResponse, UsersListsUpdateMembershipRequest, UsersListsGetMembershipsRequest, + UsersListsGetMembershipsResponse, UsersNotesRequest, UsersNotesResponse, UsersPagesRequest, @@ -1558,9 +1611,12 @@ declare namespace entities { UsersStatsRequest, UsersStatsResponse, UsersAchievementsRequest, + UsersAchievementsResponse, UsersUpdateMemoRequest, FetchRssRequest, + FetchRssResponse, FetchExternalResourcesRequest, + FetchExternalResourcesResponse, RetentionResponse, Error_2 as Error, UserLite, @@ -1572,6 +1628,7 @@ declare namespace entities { User, UserList, UserListMembership, + Ad, Announcement, App, Note, @@ -1641,6 +1698,9 @@ type FederationShowInstanceResponse = operations['federation/show-instance']['re // @public (undocumented) type FederationStatsRequest = operations['federation/stats']['requestBody']['content']['application/json']; +// @public (undocumented) +type FederationStatsResponse = operations['federation/stats']['responses']['200']['content']['application/json']; + // @public (undocumented) type FederationUpdateRemoteUserRequest = operations['federation/update-remote-user']['requestBody']['content']['application/json']; @@ -1653,6 +1713,9 @@ type FederationUsersResponse = operations['federation/users']['responses']['200' // @public (undocumented) type FetchExternalResourcesRequest = operations['fetch-external-resources']['requestBody']['content']['application/json']; +// @public (undocumented) +type FetchExternalResourcesResponse = operations['fetch-external-resources']['responses']['200']['content']['application/json']; + // @public (undocumented) type FetchLike = (input: string, init?: { method?: string; @@ -1671,7 +1734,7 @@ type FetchLike = (input: string, init?: { type FetchRssRequest = operations['fetch-rss']['requestBody']['content']['application/json']; // @public (undocumented) -export const ffVisibility: readonly ["public", "followers", "private"]; +type FetchRssResponse = operations['fetch-rss']['responses']['200']['content']['application/json']; // @public (undocumented) type Flash = components['schemas']['Flash']; @@ -1679,6 +1742,9 @@ type Flash = components['schemas']['Flash']; // @public (undocumented) type FlashCreateRequest = operations['flash/create']['requestBody']['content']['application/json']; +// @public (undocumented) +type FlashCreateResponse = operations['flash/create']['responses']['200']['content']['application/json']; + // @public (undocumented) type FlashDeleteRequest = operations['flash/delete']['requestBody']['content']['application/json']; @@ -1715,6 +1781,9 @@ type FlashUnlikeRequest = operations['flash/unlike']['requestBody']['content'][' // @public (undocumented) type FlashUpdateRequest = operations['flash/update']['requestBody']['content']['application/json']; +// @public (undocumented) +export const followersVisibilities: readonly ["public", "followers", "private"]; + // @public (undocumented) type Following = components['schemas']['Following']; @@ -1763,6 +1832,9 @@ type FollowingUpdateRequest = operations['following/update']['requestBody']['con // @public (undocumented) type FollowingUpdateResponse = operations['following/update']['responses']['200']['content']['application/json']; +// @public (undocumented) +export const followingVisibilities: readonly ["public", "followers", "private"]; + // @public (undocumented) type FollowRequest = components['schemas']['FollowRequest']; @@ -1817,6 +1889,9 @@ type GalleryPostsUpdateResponse = operations['gallery/posts/update']['responses' // @public (undocumented) type GetAvatarDecorationsResponse = operations['get-avatar-decorations']['responses']['200']['content']['application/json']; +// @public (undocumented) +type GetOnlineUsersCountResponse = operations['get-online-users-count']['responses']['200']['content']['application/json']; + // @public (undocumented) type Hashtag = components['schemas']['Hashtag']; @@ -1853,15 +1928,24 @@ type I2faDoneRequest = operations['i/2fa/done']['requestBody']['content']['appli // @public (undocumented) type I2faKeyDoneRequest = operations['i/2fa/key-done']['requestBody']['content']['application/json']; +// @public (undocumented) +type I2faKeyDoneResponse = operations['i/2fa/key-done']['responses']['200']['content']['application/json']; + // @public (undocumented) type I2faPasswordLessRequest = operations['i/2fa/password-less']['requestBody']['content']['application/json']; // @public (undocumented) type I2faRegisterKeyRequest = operations['i/2fa/register-key']['requestBody']['content']['application/json']; +// @public (undocumented) +type I2faRegisterKeyResponse = operations['i/2fa/register-key']['responses']['200']['content']['application/json']; + // @public (undocumented) type I2faRegisterRequest = operations['i/2fa/register']['requestBody']['content']['application/json']; +// @public (undocumented) +type I2faRegisterResponse = operations['i/2fa/register']['responses']['200']['content']['application/json']; + // @public (undocumented) type I2faRemoveKeyRequest = operations['i/2fa/remove-key']['requestBody']['content']['application/json']; @@ -1874,9 +1958,15 @@ type I2faUpdateKeyRequest = operations['i/2fa/update-key']['requestBody']['conte // @public (undocumented) type IAppsRequest = operations['i/apps']['requestBody']['content']['application/json']; +// @public (undocumented) +type IAppsResponse = operations['i/apps']['responses']['200']['content']['application/json']; + // @public (undocumented) type IAuthorizedAppsRequest = operations['i/authorized-apps']['requestBody']['content']['application/json']; +// @public (undocumented) +type IAuthorizedAppsResponse = operations['i/authorized-apps']['responses']['200']['content']['application/json']; + // @public (undocumented) type IChangePasswordRequest = operations['i/change-password']['requestBody']['content']['application/json']; @@ -1928,6 +2018,9 @@ type IImportUserListsRequest = operations['i/import-user-lists']['requestBody'][ // @public (undocumented) type IMoveRequest = operations['i/move']['requestBody']['content']['application/json']; +// @public (undocumented) +type IMoveResponse = operations['i/move']['responses']['200']['content']['application/json']; + // @public (undocumented) type INotificationsGroupedRequest = operations['i/notifications-grouped']['requestBody']['content']['application/json']; @@ -1985,21 +2078,36 @@ type IRegenerateTokenRequest = operations['i/regenerate-token']['requestBody'][' // @public (undocumented) type IRegistryGetAllRequest = operations['i/registry/get-all']['requestBody']['content']['application/json']; +// @public (undocumented) +type IRegistryGetAllResponse = operations['i/registry/get-all']['responses']['200']['content']['application/json']; + // @public (undocumented) type IRegistryGetDetailRequest = operations['i/registry/get-detail']['requestBody']['content']['application/json']; +// @public (undocumented) +type IRegistryGetDetailResponse = operations['i/registry/get-detail']['responses']['200']['content']['application/json']; + // @public (undocumented) type IRegistryGetRequest = operations['i/registry/get']['requestBody']['content']['application/json']; +// @public (undocumented) +type IRegistryGetResponse = operations['i/registry/get']['responses']['200']['content']['application/json']; + // @public (undocumented) type IRegistryKeysRequest = operations['i/registry/keys']['requestBody']['content']['application/json']; // @public (undocumented) type IRegistryKeysWithTypeRequest = operations['i/registry/keys-with-type']['requestBody']['content']['application/json']; +// @public (undocumented) +type IRegistryKeysWithTypeResponse = operations['i/registry/keys-with-type']['responses']['200']['content']['application/json']; + // @public (undocumented) type IRegistryRemoveRequest = operations['i/registry/remove']['requestBody']['content']['application/json']; +// @public (undocumented) +type IRegistryScopesWithDomainResponse = operations['i/registry/scopes-with-domain']['responses']['200']['content']['application/json']; + // @public (undocumented) type IRegistrySetRequest = operations['i/registry/set']['requestBody']['content']['application/json']; @@ -2027,6 +2135,9 @@ type IUnpinResponse = operations['i/unpin']['responses']['200']['content']['appl // @public (undocumented) type IUpdateEmailRequest = operations['i/update-email']['requestBody']['content']['application/json']; +// @public (undocumented) +type IUpdateEmailResponse = operations['i/update-email']['responses']['200']['content']['application/json']; + // @public (undocumented) type IUpdateRequest = operations['i/update']['requestBody']['content']['application/json']; @@ -2036,12 +2147,21 @@ type IUpdateResponse = operations['i/update']['responses']['200']['content']['ap // @public (undocumented) type IWebhooksCreateRequest = operations['i/webhooks/create']['requestBody']['content']['application/json']; +// @public (undocumented) +type IWebhooksCreateResponse = operations['i/webhooks/create']['responses']['200']['content']['application/json']; + // @public (undocumented) type IWebhooksDeleteRequest = operations['i/webhooks/delete']['requestBody']['content']['application/json']; +// @public (undocumented) +type IWebhooksListResponse = operations['i/webhooks/list']['responses']['200']['content']['application/json']; + // @public (undocumented) type IWebhooksShowRequest = operations['i/webhooks/show']['requestBody']['content']['application/json']; +// @public (undocumented) +type IWebhooksShowResponse = operations['i/webhooks/show']['responses']['200']['content']['application/json']; + // @public (undocumented) type IWebhooksUpdateRequest = operations['i/webhooks/update']['requestBody']['content']['application/json']; @@ -2381,7 +2501,7 @@ type Notification_2 = components['schemas']['Notification']; type NotificationsCreateRequest = operations['notifications/create']['requestBody']['content']['application/json']; // @public (undocumented) -export const notificationTypes: readonly ["note", "follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app", "achievementEarned"]; +export const notificationTypes: readonly ["note", "follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app", "roleAssigned", "achievementEarned"]; // @public (undocumented) type Page = components['schemas']['Page']; @@ -2513,6 +2633,12 @@ type RolesShowResponse = operations['roles/show']['responses']['200']['content'] // @public (undocumented) type RolesUsersRequest = operations['roles/users']['requestBody']['content']['application/json']; +// @public (undocumented) +type RolesUsersResponse = operations['roles/users']['responses']['200']['content']['application/json']; + +// @public (undocumented) +type ServerInfoResponse = operations['server-info']['responses']['200']['content']['application/json']; + // @public (undocumented) type ServerStats = { cpu: number; @@ -2609,6 +2735,9 @@ type SwUpdateRegistrationResponse = operations['sw/update-registration']['respon // @public (undocumented) type TestRequest = operations['test']['requestBody']['content']['application/json']; +// @public (undocumented) +type TestResponse = operations['test']['responses']['200']['content']['application/json']; + // @public (undocumented) function toString_2(acct: Acct): string; @@ -2642,6 +2771,9 @@ type UsernameAvailableResponse = operations['username/available']['responses'][' // @public (undocumented) type UsersAchievementsRequest = operations['users/achievements']['requestBody']['content']['application/json']; +// @public (undocumented) +type UsersAchievementsResponse = operations['users/achievements']['responses']['200']['content']['application/json']; + // @public (undocumented) type UsersClipsRequest = operations['users/clips']['requestBody']['content']['application/json']; @@ -2705,6 +2837,9 @@ type UsersListsFavoriteRequest = operations['users/lists/favorite']['requestBody // @public (undocumented) type UsersListsGetMembershipsRequest = operations['users/lists/get-memberships']['requestBody']['content']['application/json']; +// @public (undocumented) +type UsersListsGetMembershipsResponse = operations['users/lists/get-memberships']['responses']['200']['content']['application/json']; + // @public (undocumented) type UsersListsListRequest = operations['users/lists/list']['requestBody']['content']['application/json'];