AdminApi class abstract

Annotations
  • @RestApi.new()

Constructors

AdminApi(Dio dio, {String? baseUrl})
factory

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addAvatarHashBan({required BanAvatarHashRequest body}) Future<void>
Add avatar hash ban.
addEmailBan({required BanEmailRequest body}) Future<void>
Add email ban.
addFileShaBan({required BanFileShaRequest body}) Future<void>
Add file SHA ban.
addIpBan({required BanIpRequest body}) Future<void>
Add IP ban.
addPhraseBan({required BanPhraseRequest body}) Future<void>
Add phrase ban.
addProfileSubstringBan({required BanProfileSubstringRequest body}) Future<void>
Add profile-substring ban.
addSuspiciousEmailDomain({required SuspiciousEmailDomainRequest body}) Future<void>
Add suspicious email domain.
addUrlBan({required BanUrlRequest body}) Future<void>
Add URL ban.
addUrlDomainBan({required BanUrlDomainRequest body}) Future<void>
Add URL domain ban.
adminBillingCancelSubscription({required String userId}) Future<void>
Cancel a user subscription.
adminBillingCancelSubscriptionNow({required String userId, required AdminBillingCancelImmediatelyRequest body}) Future<void>
Cancel a user subscription immediately.
adminBillingEndPremiumGracePeriod({required String userId}) Future<void>
End a user's premium grace period.
adminBillingGetSubscription({required String userId}) Future<AdminSubscriptionResponse>
Get subscription for a user.
adminBillingListInvoices({required String userId}) Future<AdminInvoiceListResponse>
List invoices for a user.
adminBillingListPaymentMethods({required String userId}) Future<AdminPaymentMethodListResponse>
List payment methods for a user.
adminBillingListPayments({required String userId}) Future<AdminPaymentListResponse>
List payments for a user.
adminBillingOverview({required String userId}) Future<AdminBillingOverviewResponse>
Get billing overview for a user.
adminBillingReactivateSubscription({required String userId}) Future<void>
Reactivate a user subscription.
adminBillingRefund({required String userId, required AdminBillingRefundRequest body}) Future<void>
Issue a refund for a user payment.
adminBillingRefundPolicyCancelNow({required String userId, required AdminBillingRefundLatestInvoiceCancelRequest body}) Future<AdminBillingRefundLatestInvoiceCancelResponse>
Apply refund policy and cancel subscription immediately.
adminResendVerificationEmail({required ResendVerificationEmailRequest body}) Future<void>
Resend verification email.
approveDiscoveryApplication({required SnowflakeType guildId, required DiscoveryAdminReviewRequest body}) Future<DiscoveryApplicationResponse>
Approve discovery application.
banGuildMember({required BanGuildMemberRequest body}) Future<void>
Ban guild member.
banUserAvatar({required SnowflakeType userId, required BanUserAvatarRequest body}) Future<BanUserAvatarResponseSchema>
Ban this user's current avatar.
browseChannelMessages({required BrowseChannelRequest body}) Future<BrowseChannelResponse>
Browse channel messages.
bulkAddGuildMembers({required BulkAddGuildMembersRequest body}) Future<BulkJobResponse>
Bulk add guild members.
bulkBanFileShas({required BulkBanFileShasRequest body}) Future<BulkJobResponse>
Bulk-ban file SHAs as a background job.
bulkUpdateGuildFeatures({required BulkUpdateGuildFeaturesRequest body}) Future<BulkJobResponse>
Bulk update guild features.
bulkUpdateSuspiciousActivityFlags({required BulkUpdateSuspiciousActivityFlagsRequest body}) Future<BulkJobResponse>
Bulk update suspicious activity flags.
bulkUpdateUserFlags({required BulkUpdateUserFlagsRequest body}) Future<BulkJobResponse>
Bulk update user flags.
cancelAccountDeletion({required DisableMfaRequest body}) Future<UserMutationResponse>
Cancel account deletion.
cancelBulkMessageDeletion({required CancelBulkMessageDeletionRequest body}) Future<UserMutationResponse>
Cancel bulk message deletion.
cancelJob({required CancelJobRequest body}) Future<CancelJobResponseSchema>
Request cancellation of a running job.
changeUserDob({required ChangeDobRequest body}) Future<UserMutationResponse>
Change user DOB.
changeUserEmail({required ChangeEmailRequest body}) Future<UserMutationResponse>
Change user email.
changeUserUsername({required ChangeUsernameRequest body}) Future<UserMutationResponse>
Change user username.
checkAvatarHashBanStatus({required CheckAvatarHashRequest body}) Future<BanCheckResponseSchema>
Check avatar hash ban status.
checkEmailBanStatus({required BanEmailRequest body}) Future<BanCheckResponseSchema>
Check email ban status.
checkFileShaBanStatus({required CheckFileShaRequest body}) Future<BanCheckResponseSchema>
Check file SHA ban status.
checkIpBanStatus({required BanIpRequest body}) Future<BanCheckResponseSchema>
Check IP ban status.
checkPhraseBanStatus({required BanPhraseRequest body}) Future<BanCheckResponseSchema>
Check phrase ban status.
checkProfileSubstringBanStatus({required BanProfileSubstringRequest body}) Future<BanCheckResponseSchema>
Check profile-substring ban status.
checkSuspiciousEmailDomain({required SuspiciousEmailDomainRequest body}) Future<BanCheckResponseSchema>
Check suspicious email domain status.
checkUrlBanStatus({required CheckUrlBlocklistRequest body}) Future<BanCheckResponseSchema>
Check URL ban status.
checkUrlDomainBanStatus({required BanUrlDomainRequest body}) Future<BanCheckResponseSchema>
Check URL domain ban status.
clearGuildFields({required ClearGuildFieldsRequest body}) Future<void>
Clear guild fields.
clearUserFields({required ClearUserFieldsRequest body}) Future<UserMutationResponse>
Clear user fields.
createAdminApiKey({required CreateAdminApiKeyRequest body}) Future<CreateAdminApiKeyResponse>
Create admin API key.
createVoiceRegion({required CreateVoiceRegionRequest body}) Future<CreateVoiceRegionResponse>
Create voice region.
createVoiceServer({required CreateVoiceServerRequest body}) Future<CreateVoiceServerResponse>
Create voice server.
deleteAdminApiKey({required String keyId}) Future<DeleteApiKeyResponse>
Delete admin API key.
deleteAllUserMessages({required DeleteAllUserMessagesRequest body}) Future<DeleteAllUserMessagesResponse>
Delete all user messages.
deleteGuild({required DeleteGuildRequest body}) Future<SuccessResponse>
Delete guild.
deleteMessage({required DeleteMessageRequest body}) Future<DeleteMessageResponse>
Delete single message.
deleteUserWebauthnCredential({required DeleteWebAuthnCredentialRequest body}) Future<void>
Delete user WebAuthn credential.
deleteVoiceRegion({required DeleteVoiceRegionRequest body}) Future<DeleteVoiceResponse>
Delete voice region.
deleteVoiceServer({required DeleteVoiceServerRequest body}) Future<DeleteVoiceResponse>
Delete voice server.
disableUserMfa({required DisableMfaRequest body}) Future<void>
Disable user MFA.
disableUserSuspicious({required DisableForSuspiciousActivityRequest body}) Future<UserMutationResponse>
Disable user for suspicious activity.
expandVisionarySlots({required ExpandVisionarySlotsRequest body}) Future<VisionarySlotOperationResponse>
Expand visionary slots.
forceAddUserToGuild({required ForceAddUserToGuildRequest body}) Future<SuccessResponse>
Force add user to guild.
generateGiftCodes({required GenerateGiftCodesRequest body}) Future<CodesResponse>
Generate gift codes.
getArchiveDetails({required String subjectType, required String subjectId, required String archiveId}) Future<GetArchiveResponseSchema>
Get archive details.
getArchiveDownloadUrl({required String subjectType, required String subjectId, required String archiveId}) Future<DownloadUrlResponseSchema>
Get archive download URL.
getAuthenticatedAdminUser() Future<AdminUsersMeResponse>
Get authenticated admin user.
getCsamEvidencePackage({required String reportId}) Future<CsamEvidencePackageResponse>
Get CSAM evidence package status.
getGatewayNodeStatistics() Future<NodeStatsResponse>
Get gateway node statistics.
getGatewayVoiceStateCounts() Future<GatewayVoiceStateCountsResponse>
Get gateway voice state counts.
getGuildMemoryStatistics({required GetProcessMemoryStatsRequest body}) Future<GuildMemoryStatsResponse>
Get guild memory statistics.
getInstanceConfig() Future<InstanceConfigResponse>
Get instance configuration.
getJob({required GetJobRequest body}) Future<GetJobResponseSchema>
Get job detail.
getLegalHoldStatus({required String reportId}) Future<LegalHoldResponse>
Get legal hold status.
getLimitConfig() Future<LimitConfigGetResponse>
Get limit configuration.
getMessageShredStatus({required MessageShredStatusRequest body}) Future<MessageShredStatusResponse>
Get message shred status.
getReport({required String reportId}) Future<ReportAdminResponseSchema>
Get report details.
getSearchIndexRefreshStatus({required GetIndexRefreshStatusRequest body}) Future<IndexRefreshStatusResponse>
Get search index refresh status.
getUserChangeLog({required ListUserChangeLogRequest body}) Future<ListUserChangeLogResponseSchema>
Get user change log.
getVoiceDiagnosticDownload({required GetVoiceDiagnosticDownloadRequest body}) Future<GetVoiceDiagnosticDownloadResponse>
Get a presigned download URL for a voice diagnostic upload.
getVoiceRegion({required GetVoiceRegionRequest body}) Future<GetVoiceRegionResponse>
Get voice region.
getVoiceServer({required GetVoiceServerRequest body}) Future<GetVoiceServerResponse>
Get voice server.
kickGuildMember({required KickGuildMemberRequest body}) Future<void>
Kick guild member.
listActiveJobs() Future<ActiveJobsResponseSchema>
List active (queued + running) jobs.
listAdminApiKeys() Future<List<ListAdminApiKeyResponse>>
List admin API keys.
listArchives({required ListArchivesRequest body}) Future<ListArchivesResponseSchema>
List archives.
listAuditLogs({required ListAuditLogsRequest body}) Future<AuditLogsListResponseSchema>
List audit logs.
listDiscoveryListedGuilds() Future<List<DiscoveryAdminListedGuildResponse>>
List all guilds currently listed in discovery.
listGuildAuditLogsAdmin({required ListGuildAuditLogsRequest body}) Future<ListGuildAuditLogsResponse>
List guild audit logs.
listGuildEmojis({required SnowflakeType guildId}) Future<ListGuildEmojisResponse>
List guild emojis.
listGuildMembers({required ListGuildMembersRequest body}) Future<ListGuildMembersResponse>
List guild members.
listGuildStickers({required SnowflakeType guildId}) Future<ListGuildStickersResponse>
List guild stickers.
listJobs({required ListJobsRequest body}) Future<ListJobsResponseSchema>
List jobs.
listPendingDiscoveryApplications() Future<List<DiscoveryAdminPendingApplicationResponse>>
List all pending discovery applications.
listReports({required ListReportsRequest body}) Future<ListReportsResponse>
List reports.
listUserApplications({required ListUserApplicationsRequest body}) Future<ListUserApplicationsResponse>
List applications owned by a user.
listUserDmChannels({required ListUserDmChannelsRequest body}) Future<ListUserDmChannelsResponse>
List user DM channels.
listUserGroupDmChannels({required ListUserGroupDmChannelsRequest body}) Future<ListUserGroupDmChannelsResponse>
List user group DM channels.
listUserGuilds({required ListUserGuildsRequest body}) Future<ListUserGuildsResponse>
List user guilds.
listUserRelationships({required ListUserRelationshipsRequest body}) Future<ListUserRelationshipsResponse>
List user relationships.
listUserSessions({required ListUserSessionsRequest body}) Future<ListUserSessionsResponse>
List user sessions.
listUserWebauthnCredentials({required ListWebAuthnCredentialsRequest body}) Future<WebAuthnCredentialListResponse>
List user WebAuthn credentials.
listVisionarySlots() Future<ListVisionarySlotsResponse>
List all visionary slots.
listVoiceDiagnosticUploads({required ListVoiceDiagnosticUploadsRequest body}) Future<ListVoiceDiagnosticUploadsResponse>
List voice diagnostic uploads for a user.
listVoiceRegions({required ListVoiceRegionsRequest body}) Future<ListVoiceRegionsResponse>
List voice regions.
listVoiceServers({required ListVoiceServersRequest body}) Future<ListVoiceServersResponse>
List voice servers.
lookupApplication({required LookupApplicationRequest body}) Future<LookupApplicationResponse>
Look up application.
lookupGuild({required LookupGuildRequest body}) Future<LookupGuildResponse>
Look up guild.
lookupMessage({required LookupMessageRequest body}) Future<LookupMessageResponse>
Look up message details.
lookupMessageByAttachment({required LookupMessageByAttachmentRequest body}) Future<LookupMessageResponse>
Look up message by attachment.
lookupUser({required LookupUserRequest body}) Future<LookupUserResponse>
Lookup user.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
purgeGuildAssets({required PurgeGuildAssetsRequest body}) Future<PurgeGuildAssetsResponseSchema>
Purge guild assets.
queueMessageShred({required MessageShredRequest body}) Future<MessageShredResponse>
Queue message shred operation.
refreshSearchIndex({required RefreshSearchIndexRequest body}) Future<RefreshSearchIndexResponse>
Refresh search index.
rejectDiscoveryApplication({required SnowflakeType guildId, required DiscoveryAdminRejectRequest body}) Future<DiscoveryApplicationResponse>
Reject discovery application.
releaseLegalHoldOnEvidence({required String reportId}) Future<LegalHoldResponse>
Release legal hold on evidence.
reloadAllSpecifiedGuilds({required ReloadGuildsRequest body}) Future<ReloadAllGuildsResponse>
Reload specified guilds.
reloadGuild({required ReloadGuildRequest body}) Future<SuccessResponse>
Reload guild.
removeAvatarHashBan({required CheckAvatarHashRequest body}) Future<void>
Remove avatar hash ban.
removeEmailBan({required BanEmailRequest body}) Future<void>
Remove email ban.
removeFileShaBan({required UnbanFileShaRequest body}) Future<void>
Remove file SHA ban.
removeFromDiscovery({required SnowflakeType guildId, required DiscoveryAdminRemoveRequest body}) Future<DiscoveryApplicationResponse>
Remove guild from discovery.
removeIpBan({required BanIpRequest body}) Future<void>
Remove IP ban.
removePhraseBan({required BanPhraseRequest body}) Future<void>
Remove phrase ban.
removeProfileSubstringBan({required BanProfileSubstringRequest body}) Future<void>
Remove profile-substring ban.
removeSuspiciousEmailDomain({required SuspiciousEmailDomainRequest body}) Future<void>
Remove suspicious email domain flag.
removeUrlBan({required UnbanUrlRequest body}) Future<void>
Remove URL ban.
removeUrlDomainBan({required UnbanUrlDomainRequest body}) Future<void>
Remove URL domain ban.
removeUserRelationship({required RemoveUserRelationshipRequest body}) Future<void>
Remove user relationship.
removeUserRelationshipsByCategory({required RemoveUserRelationshipsByCategoryRequest body}) Future<RemoveUserRelationshipsResponse>
Remove all of a user's relationships in a category.
reportMessageAttachmentToNcmec({required ReportAttachmentToNcmecRequest body}) Future<NcmecAttachmentSubmitResultResponse>
Report an image attachment to NCMEC.
reserveVisionarySlot({required ReserveVisionarySlotRequest body}) Future<VisionarySlotOperationResponse>
Reserve or unreserve a visionary slot.
resolveReport({required ResolveReportRequest body}) Future<ResolveReportResponse>
Resolve report.
scheduleAccountDeletion({required ScheduleAccountDeletionRequest body}) Future<UserMutationResponse>
Schedule account deletion.
scheduleBulkUserDeletion({required BulkScheduleUserDeletionRequest body}) Future<BulkJobResponse>
Schedule bulk user deletion.
searchAuditLogs({required SearchAuditLogsRequest body}) Future<AuditLogsListResponseSchema>
Search audit logs.
searchChannelMessages({required SearchChannelMessagesRequest body}) Future<SearchChannelMessagesResponse>
Search channel messages.
searchGuilds({required SearchGuildsRequest body}) Future<SearchGuildsResponse>
Search guilds.
searchReports({required SearchReportsRequest body}) Future<SearchReportsResponse>
Search reports.
searchUsers({required SearchUsersRequest body}) Future<SearchUsersResponse>
Search users.
sendPasswordReset({required SendPasswordResetRequest body}) Future<void>
Send password reset.
sendSystemDm({required SendSystemDmRequest body}) Future<SendSystemDmResponse>
Send system DM.
setLegalHoldOnEvidence({required String reportId, required LegalHoldRequest body}) Future<LegalHoldResponse>
Set legal hold on evidence.
setUserAcls({required SetUserAclsRequest body}) Future<UserMutationResponse>
Set user ACLs.
setUserBotStatus({required SetUserBotStatusRequest body}) Future<UserMutationResponse>
Set user bot status.
setUserSystemStatus({required SetUserSystemStatusRequest body}) Future<UserMutationResponse>
Set user system status.
setUserTraits({required SetUserTraitsRequest body}) Future<UserMutationResponse>
Set user traits.
shrinkVisionarySlots({required ShrinkVisionarySlotsRequest body}) Future<VisionarySlotOperationResponse>
Shrink visionary slots.
shutdownGuild({required ShutdownGuildRequest body}) Future<SuccessResponse>
Shutdown guild.
swapVisionarySlots({required SwapVisionarySlotsRequest body}) Future<VisionarySlotOperationResponse>
Swap visionary slot reservations.
takeHeapSnapshot() Future<HeapSnapshotResponse>
Take a V8 heap snapshot.
tempBanUser({required TempBanUserRequest body}) Future<UserMutationResponse>
Temp ban user.
terminateUserSessions({required TerminateSessionsRequest body}) Future<TerminateSessionsResponse>
Terminate user sessions.
toString() String
A string representation of this object.
inherited
transferApplicationOwnership({required TransferApplicationOwnershipRequest body}) Future<ApplicationUpdateResponse>
Transfer application ownership.
transferGuildOwnership({required TransferGuildOwnershipRequest body}) Future<GuildUpdateResponse>
Transfer guild ownership.
triggerGuildArchive({required TriggerGuildArchiveRequest body}) Future<AdminArchiveResponseSchema>
Trigger guild archive.
triggerUserArchive({required TriggerUserArchiveRequest body}) Future<AdminArchiveResponseSchema>
Trigger user archive.
unbanUser({required DisableMfaRequest body}) Future<UserMutationResponse>
Unban user.
updateGuildFeatures({required UpdateGuildFeaturesRequest body}) Future<GuildUpdateResponse>
Update guild features.
updateGuildName({required UpdateGuildNameRequest body}) Future<GuildUpdateResponse>
Update guild name.
updateGuildSettings({required UpdateGuildSettingsRequest body}) Future<GuildUpdateResponse>
Update guild settings.
updateGuildVanity({required UpdateGuildVanityRequest body}) Future<GuildUpdateResponse>
Update guild vanity.
updateInstanceConfig({required InstanceConfigUpdateRequest body}) Future<InstanceConfigResponse>
Update instance configuration.
updateLimitConfig({required LimitConfigUpdateRequest body}) Future<LimitConfigGetResponse>
Update limit configuration.
updateSuspiciousActivityFlags({required UpdateSuspiciousActivityFlagsRequest body}) Future<UserMutationResponse>
Update suspicious activity flags.
updateUserFlags({required UpdateUserFlagsRequest body}) Future<UserMutationResponse>
Update user flags.
updateUserHasVerifiedPhone({required UpdateHasVerifiedPhoneRequest body}) Future<UserMutationResponse>
Update user phone verification flag.
updateUserPremiumFlags({required UpdatePremiumFlagsRequest body}) Future<UserMutationResponse>
Update user premium flags.
updateVoiceRegion({required UpdateVoiceRegionRequest body}) Future<UpdateVoiceRegionResponse>
Update voice region.
updateVoiceServer({required UpdateVoiceServerRequest body}) Future<UpdateVoiceServerResponse>
Update voice server.
verifyUserEmail({required VerifyUserEmailRequest body}) Future<UserMutationResponse>
Verify user email.

Operators

operator ==(Object other) bool
The equality operator.
inherited