package
0.0.0-20241221201723-37ad33de60bf
Repository: https://github.com/quaver/api2.git
Documentation: pkg.go.dev
# Functions
AcceptClanInvite Accepts a clan invitation and joins the clan Endpoint: POST /v2/clan/invite/:id/accept.
AddCrashLog Adds a new crash log into the database Endpoint: /v2/log/crash.
AddFriend Adds a friend to the logged-in user's friends list Endpoint: POST /v2/user/:id/relationship/add.
AddMapToPlaylist Adds a map to a playlist Endpoint: /v2/playlist/:id/add/:map_id.
AddNewGameBuild Adds a new game build to the database Endpoint: POST /v2/builds.
AddRankingQueueComment Inserts a ranking queue comment to the database Endpoint: POST /v2/ranking/queue/:id/comment.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BlacklistRankingQueueMapset Blacklists a mapset from the ranking queue Endpoint: POST /v2/ranking/queue/:id/blacklist.
ChangeUserUsername Changes a user's username Endpoint: POST /v2/user/profile/username.
CreateClan Creates a new clan if the user is eligible to.
CreateHandler Creates a handler with automatic error handling.
CreateMusicArtistAlbum Creates a new album for a music artist Endpoint: POST /v2/artists/:id/album.
CreateNewApplication Creates a new application Endpoint: POST /v2/developers/applications.
CreateOrderCheckoutSession Creates a checkout session for a given order (store items) Endpoint: POST /v2/orders/checkout.
CreatePinnedScore Adds a pinned score Endpoint: POST /v2/scores/:id/pin.
CreatePlaylist Creates a new playlist Endpoint: /v2/playlists.
CreateUserNotification Inserts a user notification into the db Endpoint: POST /v2/notifications.
DeclineClanInvite Declines a clan invite and deletes it Endpoint: POST /v2/clan/invite/:id/decline.
DeleteClan Deletes an individual clan Endpoint: DELETE /v2/clan/:id.
DeleteMapset Removes a mapset from being visible on the server Endpoint: POST /v2/mapset/:id/delete.
DeleteMusicArtist Deletes a music artist (hides) Endpoint: DELETE /v2/artists/:id.
DeleteMusicArtistAlbum Deletes a music artist's album Endpoint: DELETE /v2/artists/album/:id.
DeleteMusicArtistSong Deletes a music artist's song Endpoint: DELETE /v2/artists/song/:id.
DeleteNotification Deletes a notification from the DB Endpoint: DELETE /v2/notifications/:id.
DeletePlaylist Deletes (hides) a playlist Endpoint: DELETE /v2/playlists/:id.
DeleteUserApplication Deletes a user's application Endpoint: DELETE /v2/developers/applications/:id.
DenyRankingQueueMapset Adds a deny to a ranking queue mapset Endpoint: POST /v2/ranking/queue/:id/deny.
DownloadMapset Handles the downloading of an individual .qp file Endpoint: GET /v2/download/mapset/:id.
DownloadMultiplayerMapset Serves the multiplayer mapset that was shared Endpoint: GET /v2/download/multiplayer/:id.
DownloadQua Handles the downloading of an individual .qua file Endpoint: GET /v2/download/map/:id.
DownloadReplay Handles the downloading of a replay file Endpoint: GET /v2/download/replay/:id.
EditRankingQueueComment Edits a ranking queue comment Endpoint: POST /v2/ranking/queue/comment/:id/edit.
FinalizePaidStripeInvoice Handles when a user pays their Stripe invoice.
FinalizeSteamTransaction Finalizes a Steam transaction Endpoint: GET /v2/orders/steam/finalize?order_id=&transaction_id=.
FinalizeStripeOrder Handles the finalization of a Stripe order.
GetActiveSubscriptions Returns a user's active subscriptions GET /v2/orders/stripe/subscriptions.
GetAllScoresForMap Retrieves all scores for a given map Endpoint: GET v2/scores/:md5/all.
GetCanUserChangeUsername Returns if a user is eligible to change their username Endpoint: GET /v2/user/profile/username/eligible.
GetChatHistory Retrieves the chat message history for a given channel Endpoint: GET /v2/chat/:channel/history?page=0.
GetClan Retrieves data about an individual clan GET /v2/clan/:id.
GetClanActivity Retrieves clan activity from the database GET /v2/clan/:id/activity?page=0.
GetClanInvite Retrieves a clan invite by id Endpoint: GET /v2/clan/invite/:id.
GetClanLeaderboard Retrieves the clan leaderboard for a given game mode.
GetClanMembers Retrieves a list of members in the clan GET /v2/clan/:id/members.
GetClanPendingInvites Returns a clan's pending invites Endpoint: GET /v2/clan/invites.
GetClanPersonalBestScore Retrieves a clan's best score on a map Endpoint: GET /v2/scores/:md5/:clan_id/clan.
GetClanScoresForMap Retrieves the scoreboard for a clan Endpoint: GET /v2/scores/:md5/clans.
GetClanScoresForMode Retrieves clan scores for a given mode Endpoint: GET /v2/clan/:id/scores/:mode.
GetCountryLeaderboard Retrieves the country leaderboard for a given country and mode Endpoint: GET /v2/leaderboard/country?country=&mode=&page=.
GetCountryPlayers Returns the countries and their total user counts Endpoint: /v2/server/stats/countries.
GetCountryScoresForMap Retrieves country scores for a given map Endpoint: GET v2/scores/:md5/country/:country.
GetDonatorPrices Returns the current donator prices Endpoint: GET /v2/orders/donations/prices.
GetFriendScoresForMap Retrieves the friends scoreboard for a given map.
GetFriendsList Retrieves the logged-in user's friend's list Endpoint: GET /v2/user/relationship/friends.
GetGlobalLeaderboardForMode Retrieves the global leaderboard for a given game mode Endpoint: GET /v2/leaderboard/global?mode=&page=.
GetGlobalScoresForMap Retrieves the global scoreboard for a given map.
GetMap Gets an individual map's data Endpoint: /v2/map/:id.
GetMapMods Gets mods for a given map Endpoint: GET /v2/maps/:id/mods.
GetMapsetById Retrieves a mapset from the database by its id Endpoint: GET /v2/mapset/:id.
GetMapsetOnlineOffsets Retrieves online offsets for all ranked mapsets Endpoint: GET /v2/mapset/offsets.
GetMapsetsSearch Gets a list of mapsets that match a search query Endpoint: GET /v2/mapsets/search.
GetModifierScoresForMap Retrieves modifier scores for a given map Endpoint: GET v2/scores/:md5/mods/:mods.
GetMultiplayerGame Gets an individual multiplayer game Endpoint: GET /v2/multiplayer/games/:id.
GetMusicArtists Returns all music artists Endpoint: GET /artists.
GetOrderItemById \Retrieves an individual order item by its id Endpoint: GET /v2/items/:id.
GetPinnedScoresForMode Gets a user's pinned scores for a given game mode Endpoint: GET /v2/user/:id/scores/:mode/pinned.
GetPlaylist Gets an individual playlist Endpoint: GET /v2/playlists/:id.
GetPlaylistContainsMap Returns if a playlist contains an individual map id Endpoint: /v2/playlists/:id/contains/:map_id.
GetRankedMapsetIds Retrieves the list of ranked mapset ids Endpoint: GET /v2/mapset/ranked.
GetRankingQueue Retrieves the ranking queue for a given mode Endpoint: /v2/ranking/queue/mode/:mode.
GetRankingQueueComments Returns all of the comments for a mapset in the ranking queue Endpoint: GET /v2/ranking/queue/:id/comments.
GetRankingQueueConfig Returns the vote/denial configuration for the ranking queue.
GetRankingQueueMapset Gets a single mapset in the ranking queue Endpoint: GET /v2/ranking/queue/:id.
GetRankingSupervisorActions Retrieves ranking supervisor actions between a given time frame Endpoint: GET /ranking/queue/supervisors/actions?start=&end=.
GetRateScoresForMap Retrieves rate scores for a given map Endpoint: GET v2/scores/:md5/rate/:mods.
GetRecentMultiplayerGames Retrieves the most recent multiplayer games from the database Endpoint: GET /v2/multiplayer/games.
GetServerStats Retrieves statistics about Quaver Endpoint: /v2/server/stats.
GetSingleMusicArtist Retrieves a single music artist by id Endpoint: GET /artists/:id.
GetTeamMembers Retrieves users in the Quaver team along with contributors and donators Endpoint: /v2/user/team/members.
GetTotalHitsLeaderboard Retrieves the total hits leaderboard for a given game mode Endpoint: GET /v2/leaderboard/hits?mode=&page=.
GetUser Gets a user by their id or username Endpoint: /v2/user/:query.
GetUserAboutMe Retrieves a user's about me / userpage Endpoint: GET /v2/user/:id/aboutme.
GetUserAchievements Returns a list of achievements that a user has locked/unlocked Endpoint: GET /v2/user/:id/achievements.
GetUserActivity Gets the user's recent activity Endpoint: GET /v2/user/:id/activity.
GetUserApplication Returns a single user application Endpoint: GET /v2/developers/applications/:id.
GetUserApplications Returns a users active applications Endpoint: GET /v2/developers/applications.
GetUserBadges Gets a user's profile badges Endpoint: GET /v2/user/:id/badges.
GetUserBestScoresForMode Gets the user's best scores for a given game mode Endpoint: /v2/user/:id/scores/:mode/best.
GetUserFirstPlaceScoresForMode Gets a user's first place scores for a given game mode Endpoint: /v2/user/:id/scores/:mode/firstplace.
GetUserFreeTrialDonatorOrder Retrieves a user's free trial donator order if they've had one before.
GetUserGradesForMode Gets a user's scores with a particular grade Endpoint: GET /v2/user/:id/scores/:mode/grade/:grade.
GetUserMapsets Gets a user's uploaded mapsets Endpoint: GET /v2/user/:id/mapsets.
GetUserMostPlayedMaps Gets a user's most played maps Endpoint: /v2/user/:id/mostplayed.
GetUserNotifications Gets a user's notification Endpoint /v2/notifications.
GetUserOrders Gets a user's completed orders.
GetUserPendingClanInvites Retrieves all pending clan invites for the user Endpoint: GET /v2/clan/invites.
GetUserPersonalBestScoreAll Retrieves the personal best (ALL lb) score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/all.
GetUserPersonalBestScoreGlobal Retrieves the personal best score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/global.
GetUserPersonalBestScoreMods Retrieves the personal best modifier score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/mods/:mods.
GetUserPersonalBestScoreRate Retrieves the personal best rate score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/rate/:mods.
GetUserPlaylists Returns a user's created playlists Endpoint: /v2/user/:id/playlists.
GetUserRankStatisticsForMode Gets a user's rank statistics for a given game mode Endpoint: GET /v2/user/:id/statistics/:mode/rank.
GetUserRecentScoresForMode Gets the user's recent scores for a given game mode Endpoint: /v2/user/:id/scores/:mode/recent.
GetUserScoresForClanScore Retrieves all individual scores that make up a clan score Endpoint: /v2/clan/scores/:id.
GetVirtualReplayPlayerOutput Plays the virtual replay player & returns the output Endpoint: GET /v2/scores/:id/stats.
GetWeeklyMostPlayedMapsets Gets the most played mapsets of the week Endpoint: GET /v2/server/stats/mostplayed.
HandleMapsetSubmission Handles the uploading/updating of a mapset archive (.qp) file Endpoint: POST /v2/mapset.
HandleStripeWebhook Handles an incoming stripe webhook POST: /v2/orders/stripe/webhook.
InitiateSteamDonatorTransaction Initiates a transaction for Steam donator Endpoint: POST /v2/orders/steam/initiate/donation.
InitiateStripeDonatorCheckoutSession Initiates a stripe checkout session for donator Endpoint: POST /v2/orders/stripe/initiate/donation.
InsertMusicArtist Creates a new music artists Endpoint: POST /artists.
InsertOrUpdateMap Inserts/Updates a map in the database.
InviteUserToClan Invites a user to the clan Endpoint: POST /v2/clan/invite.
IsUsernameAvailable Returns if a username is available for a user to take Endpoint: GET /v2/user/profile/username/available?name=.
KickClanMember Kicks a member from the clan POST /v2/clan/kick/:user_id.
LeaveClan Leaves the user's current clan Endpoint: POST /v2/clan/leave.
MarkAllNotificationsAsRead Marks all notifications from a user as read POST: /v2/notifications/all/read.
MarkMapsetAsExplicit Marks a mapset as explicit POST /v2/mapset/:id/explicit.
MarkMapsetAsNotExplicit Marks a mapsets as not explicit POST /v2/mapset/:id/unexplicit.
MarkUserNotificationAsRead Marks an individual notification as read Endpoint: POST /v2/notifications/:id/read.
MarkUserNotificationAsUnread Marks an individual notification as unread Endpoint: POST /v2/notifications/:id/unread.
ModifyStripeSubscription Returns a link so the user can modify their subscription Endpoint: GET /v2/orders/stripe/subscriptions/modify.
OnHoldRankingQueueMapset On-holds a mapset from the ranking queue Endpoint: POST /v2/ranking/queue/:id/hold.
RegisterNewUser Registers a new user account Endpoint: POST /v2/user.
RemoveFriend Removes a friend from the logged-in users friend's list Endpoint: POST /v2/user/:id/relationship/delete.
RemoveFromRankingQueue Allows a user to remove their mapset from the ranking queue (self deny) Endpoint: POST /v2/ranking/queue/:id/remove.
RemoveMapFromPlaylist Removes a map from a playlist Endpoint: /v2/playlist/:id/remove/:map_id.
RemovePinnedScore Removes a user's pinned score Endpoint: POST /v2/scores/:id/unpin.
ResetApplicationSecret Resets the secret of an application Endpoint: POST /v2/developers/applications/:id/secret.
SearchPlaylists Searches for playlists by name/creator username Endpoint: /v2/playlists/search?query=.
SearchUsers Searches for users by username and returns them Endpoint: /v2/user/search/:name.
SortMusicArtistAlbums Sorts music artist albums Endpoints: POST: /v2/artists/:id/album/sort.
SortMusicArtists Custom sort music artists Endpoint: POST /v2/artists/sort.
SortMusicArtistSongs Sort's an album's songs Endpoint: POST /v2/artists/album/:id/song/sort.
SortPinnedScores Sorts pins scores by a custom sort order Endpoint: POST /v2/scores/pinned/:mode/sort.
SubmitMapMod Inserts a map mod to the db Endpoint: POST /v2/maps/:id/mods.
SubmitMapModComment Submits a comment for a map mod Endpoint: POST /v2/maps/:id/mods/:mod_id/comment.
SubmitMapsetToRankingQueue Submits a mapsets to the ranking queue Endpoint: POST /v2/ranking/queue/:id/submit.
TransferClanOwnership Transfers ownership of the clan to another member.
UnbanUser Unbans a user from the game Endpoint: POST /v2/user/:id/unban.
UpdateApplication Updates an application's data Endpoint: POST /v2/developers/applications/:id.
UpdateClan Updates data about a clan Endpoint: PATCH /v2/clan/:id.
UpdateElasticSearchMapset Updates a mapset in elastic search Endpoint: GET /v2/mapset/:id/elastic.
UpdateMapModStatus Updates the status of a map mod Endpoint: POST /v2/maps/:id/mods/:mod_id/status.
UpdateMapsetDescription Updates the description of a given mapset Endpoint: PATCH /v2/mapset/:id/description.
UpdateMusicArtist Updates the name, description, and links for a music artists Endpoint: POST /artists/:id.
UpdateMusicArtistAlbum Updates a music artist album Endpoint: POST /v2/artists/album/:id.
UpdateMusicArtistSong Updates metadata for a given song Endpoint: POST /v2/artists/song/:id.
UpdatePlaylist Updates a playlists name/description Endpoint: POST /v2/playlists/:id/update.
UpdateUserAboutMe Updates a user's about me Endpoint: POST /v2/user/profile/aboutme.
UpdateUserAccentColor Updates a user's accent color Endpoint: POST /v2/user/:id/accent.
UpdateUserDiscordId Updates a user's discord id Endpoint: POST /v2/user/:id/discord.
UploadClanAvatar Handles the uploading of a clan avatar Endpoint: /v2/clan/avatar.
UploadClanBanner Handles the uploading of a clan banner Endpoint: /v2/clan/banner.
UploadMultiplayerMapset Uploads a multiplayer map to be shared.
UploadMusicArtistAlbumCover Uploads an album cover for an album Endpoint: POST /v2/artists/album/:id/cover.
UploadMusicArtistAvatar Uploads a music artist's avatar Endpoint: POST /v2/artists/:id/avatar.
UploadMusicArtistBanner Uploads a music artist's banner Endpoint: POST /v2/artists/:id/banner.
UploadMusicArtistSong Uploads a new song for a music artist's album Endpoint: POST /v2/artists/album/:id/song.
UploadPlaylistCover Uploads a playlist cover Endpoint: POST /v2/playlists/:id/cover.
UploadUnsubmittedMap Uploads an unsubmitted map to azure for donator leaderboards.
UploadUserProfileCover Handles the uploading of a user's profile cover Endpoint: POST /v2/user/profile/cover.
VoteForRankingQueueMapset Adds a vote for a mapset in the ranking queue Endpoint: POST /v2/ranking/queue/:id/vote.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author