handlers

package
v0.0.0-...-37ad33d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 21, 2024 License: AGPL-3.0 Imports: 45 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MaxNormalScoreboardLimit int = 50
)

Variables

This section is empty.

Functions

func CreateHandler 

func CreateHandler(fn func(*gin.Context) *APIError) func(*gin.Context)

CreateHandler Creates a handler with automatic error handling

Types

type APIError 

type APIError struct {
	Status  int    `json:"status"`
	Message string `json:"error"`
	Error   error
}

func APIErrorBadRequest 

func APIErrorBadRequest(message string) *APIError

func APIErrorForbidden 

func APIErrorForbidden(message string) *APIError

func APIErrorNotFound 

func APIErrorNotFound(message string) *APIError

func APIErrorServerError 

func APIErrorServerError(message string, err error) *APIError

func APIErrorUnauthorized 

func APIErrorUnauthorized(message string) *APIError

func AcceptClanInvite 

func AcceptClanInvite(c *gin.Context) *APIError

AcceptClanInvite Accepts a clan invitation and joins the clan Endpoint: POST /v2/clan/invite/:id/accept

func AddCrashLog 

func AddCrashLog(c *gin.Context) *APIError

AddCrashLog Adds a new crash log into the database Endpoint: /v2/log/crash

func AddFriend 

func AddFriend(c *gin.Context) *APIError

AddFriend Adds a friend to the logged-in user's friends list Endpoint: POST /v2/user/:id/relationship/add

func AddMapToPlaylist 

func AddMapToPlaylist(c *gin.Context) *APIError

AddMapToPlaylist Adds a map to a playlist Endpoint: /v2/playlist/:id/add/:map_id

func AddNewGameBuild 

func AddNewGameBuild(c *gin.Context) *APIError

AddNewGameBuild Adds a new game build to the database Endpoint: POST /v2/builds

func AddRankingQueueComment 

func AddRankingQueueComment(c *gin.Context) *APIError

AddRankingQueueComment Inserts a ranking queue comment to the database Endpoint: POST /v2/ranking/queue/:id/comment

func BanUser 

func BanUser(c *gin.Context) *APIError

func BlacklistRankingQueueMapset 

func BlacklistRankingQueueMapset(c *gin.Context) *APIError

BlacklistRankingQueueMapset Blacklists a mapset from the ranking queue Endpoint: POST /v2/ranking/queue/:id/blacklist

func ChangeUserUsername 

func ChangeUserUsername(c *gin.Context) *APIError

ChangeUserUsername Changes a user's username Endpoint: POST /v2/user/profile/username

func CreateClan 

func CreateClan(c *gin.Context) *APIError

CreateClan Creates a new clan if the user is eligible to. Endpoint: POST /v2/clan

func CreateMusicArtistAlbum 

func CreateMusicArtistAlbum(c *gin.Context) *APIError

CreateMusicArtistAlbum Creates a new album for a music artist Endpoint: POST /v2/artists/:id/album

func CreateNewApplication 

func CreateNewApplication(c *gin.Context) *APIError

CreateNewApplication Creates a new application Endpoint: POST /v2/developers/applications

func CreateOrderCheckoutSession 

func CreateOrderCheckoutSession(c *gin.Context) *APIError

CreateOrderCheckoutSession Creates a checkout session for a given order (store items) Endpoint: POST /v2/orders/checkout

func CreatePinnedScore 

func CreatePinnedScore(c *gin.Context) *APIError

CreatePinnedScore Adds a pinned score Endpoint: POST /v2/scores/:id/pin

func CreatePlaylist 

func CreatePlaylist(c *gin.Context) *APIError

CreatePlaylist Creates a new playlist Endpoint: /v2/playlists

func CreateUserNotification 

func CreateUserNotification(c *gin.Context) *APIError

CreateUserNotification Inserts a user notification into the db Endpoint: POST /v2/notifications

func DeclineClanInvite 

func DeclineClanInvite(c *gin.Context) *APIError

DeclineClanInvite Declines a clan invite and deletes it Endpoint: POST /v2/clan/invite/:id/decline

func DeleteClan 

func DeleteClan(c *gin.Context) *APIError

DeleteClan Deletes an individual clan Endpoint: DELETE /v2/clan/:id

func DeleteMapset 

func DeleteMapset(c *gin.Context) *APIError

DeleteMapset Removes a mapset from being visible on the server Endpoint: POST /v2/mapset/:id/delete

func DeleteMusicArtist 

func DeleteMusicArtist(c *gin.Context) *APIError

DeleteMusicArtist Deletes a music artist (hides) Endpoint: DELETE /v2/artists/:id

func DeleteMusicArtistAlbum 

func DeleteMusicArtistAlbum(c *gin.Context) *APIError

DeleteMusicArtistAlbum Deletes a music artist's album Endpoint: DELETE /v2/artists/album/:id

func DeleteMusicArtistSong 

func DeleteMusicArtistSong(c *gin.Context) *APIError

DeleteMusicArtistSong Deletes a music artist's song Endpoint: DELETE /v2/artists/song/:id

func DeleteNotification 

func DeleteNotification(c *gin.Context) *APIError

DeleteNotification Deletes a notification from the DB Endpoint: DELETE /v2/notifications/:id

func DeletePlaylist 

func DeletePlaylist(c *gin.Context) *APIError

DeletePlaylist Deletes (hides) a playlist Endpoint: DELETE /v2/playlists/:id

func DeleteUserApplication 

func DeleteUserApplication(c *gin.Context) *APIError

DeleteUserApplication Deletes a user's application Endpoint: DELETE /v2/developers/applications/:id

func DenyRankingQueueMapset 

func DenyRankingQueueMapset(c *gin.Context) *APIError

DenyRankingQueueMapset Adds a deny to a ranking queue mapset Endpoint: POST /v2/ranking/queue/:id/deny

func DownloadMapset 

func DownloadMapset(c *gin.Context) *APIError

DownloadMapset Handles the downloading of an individual .qp file Endpoint: GET /v2/download/mapset/:id

func DownloadMultiplayerMapset 

func DownloadMultiplayerMapset(c *gin.Context) *APIError

DownloadMultiplayerMapset Serves the multiplayer mapset that was shared Endpoint: GET /v2/download/multiplayer/:id

func DownloadQua 

func DownloadQua(c *gin.Context) *APIError

DownloadQua Handles the downloading of an individual .qua file Endpoint: GET /v2/download/map/:id

func DownloadReplay 

func DownloadReplay(c *gin.Context) *APIError

DownloadReplay Handles the downloading of a replay file Endpoint: GET /v2/download/replay/:id

func EditRankingQueueComment 

func EditRankingQueueComment(c *gin.Context) *APIError

EditRankingQueueComment Edits a ranking queue comment Endpoint: POST /v2/ranking/queue/comment/:id/edit

func FinalizePaidStripeInvoice 

func FinalizePaidStripeInvoice(event *stripe.Event) *APIError

FinalizePaidStripeInvoice Handles when a user pays their Stripe invoice

func FinalizeSteamTransaction 

func FinalizeSteamTransaction(c *gin.Context) *APIError

FinalizeSteamTransaction Finalizes a Steam transaction Endpoint: GET /v2/orders/steam/finalize?order_id=&transaction_id=

func FinalizeStripeOrder 

func FinalizeStripeOrder(event *stripe.Event) *APIError

FinalizeStripeOrder Handles the finalization of a Stripe order

func GetActiveSubscriptions 

func GetActiveSubscriptions(c *gin.Context) *APIError

GetActiveSubscriptions Returns a user's active subscriptions GET /v2/orders/stripe/subscriptions

func GetAllScoresForMap 

func GetAllScoresForMap(c *gin.Context) *APIError

GetAllScoresForMap Retrieves all scores for a given map Endpoint: GET v2/scores/:md5/all

func GetCanUserChangeUsername 

func GetCanUserChangeUsername(c *gin.Context) *APIError

GetCanUserChangeUsername Returns if a user is eligible to change their username Endpoint: GET /v2/user/profile/username/eligible

func GetChatHistory 

func GetChatHistory(c *gin.Context) *APIError

GetChatHistory Retrieves the chat message history for a given channel Endpoint: GET /v2/chat/:channel/history?page=0

func GetClan 

func GetClan(c *gin.Context) *APIError

GetClan Retrieves data about an individual clan GET /v2/clan/:id

func GetClanActivity 

func GetClanActivity(c *gin.Context) *APIError

GetClanActivity Retrieves clan activity from the database GET /v2/clan/:id/activity?page=0

func GetClanInvite 

func GetClanInvite(c *gin.Context) *APIError

GetClanInvite Retrieves a clan invite by id Endpoint: GET /v2/clan/invite/:id

func GetClanLeaderboard 

func GetClanLeaderboard(c *gin.Context) *APIError

GetClanLeaderboard Retrieves the clan leaderboard for a given game mode

func GetClanMembers 

func GetClanMembers(c *gin.Context) *APIError

GetClanMembers Retrieves a list of members in the clan GET /v2/clan/:id/members

func GetClanPendingInvites 

func GetClanPendingInvites(c *gin.Context) *APIError

GetClanPendingInvites Returns a clan's pending invites Endpoint: GET /v2/clan/invites

func GetClanPersonalBestScore 

func GetClanPersonalBestScore(c *gin.Context) *APIError

GetClanPersonalBestScore Retrieves a clan's best score on a map Endpoint: GET /v2/scores/:md5/:clan_id/clan

func GetClanScoresForMap 

func GetClanScoresForMap(c *gin.Context) *APIError

GetClanScoresForMap Retrieves the scoreboard for a clan Endpoint: GET /v2/scores/:md5/clans

func GetClanScoresForMode 

func GetClanScoresForMode(c *gin.Context) *APIError

GetClanScoresForMode Retrieves clan scores for a given mode Endpoint: GET /v2/clan/:id/scores/:mode

func GetCountryLeaderboard 

func GetCountryLeaderboard(c *gin.Context) *APIError

GetCountryLeaderboard Retrieves the country leaderboard for a given country and mode Endpoint: GET /v2/leaderboard/country?country=&mode=&page=

func GetCountryPlayers 

func GetCountryPlayers(c *gin.Context) *APIError

GetCountryPlayers Returns the countries and their total user counts Endpoint: /v2/server/stats/countries

func GetCountryScoresForMap 

func GetCountryScoresForMap(c *gin.Context) *APIError

GetCountryScoresForMap Retrieves country scores for a given map Endpoint: GET v2/scores/:md5/country/:country

func GetDonatorPrices 

func GetDonatorPrices(c *gin.Context) *APIError

GetDonatorPrices Returns the current donator prices Endpoint: GET /v2/orders/donations/prices

func GetFriendScoresForMap 

func GetFriendScoresForMap(c *gin.Context) *APIError

GetFriendScoresForMap Retrieves the friends scoreboard for a given map. Endpoint: GET: /v2/scores/:md5/friends

func GetFriendsList 

func GetFriendsList(c *gin.Context) *APIError

GetFriendsList Retrieves the logged-in user's friend's list Endpoint: GET /v2/user/relationship/friends

func GetGlobalLeaderboardForMode 

func GetGlobalLeaderboardForMode(c *gin.Context) *APIError

GetGlobalLeaderboardForMode Retrieves the global leaderboard for a given game mode Endpoint: GET /v2/leaderboard/global?mode=&page=

func GetGlobalScoresForMap 

func GetGlobalScoresForMap(c *gin.Context) *APIError

GetGlobalScoresForMap Retrieves the global scoreboard for a given map. Endpoint: GET: /v2/scores/:md5/global

func GetMap 

func GetMap(c *gin.Context) *APIError

GetMap Gets an individual map's data Endpoint: /v2/map/:id

func GetMapMods 

func GetMapMods(c *gin.Context) *APIError

GetMapMods Gets mods for a given map Endpoint: GET /v2/maps/:id/mods

func GetMapsetById 

func GetMapsetById(c *gin.Context) *APIError

GetMapsetById Retrieves a mapset from the database by its id Endpoint: GET /v2/mapset/:id

func GetMapsetOnlineOffsets 

func GetMapsetOnlineOffsets(c *gin.Context) *APIError

GetMapsetOnlineOffsets Retrieves online offsets for all ranked mapsets Endpoint: GET /v2/mapset/offsets

func GetMapsetsSearch 

func GetMapsetsSearch(c *gin.Context) *APIError

GetMapsetsSearch Gets a list of mapsets that match a search query Endpoint: GET /v2/mapsets/search

func GetModifierScoresForMap 

func GetModifierScoresForMap(c *gin.Context) *APIError

GetModifierScoresForMap Retrieves modifier scores for a given map Endpoint: GET v2/scores/:md5/mods/:mods

func GetMultiplayerGame 

func GetMultiplayerGame(c *gin.Context) *APIError

GetMultiplayerGame Gets an individual multiplayer game Endpoint: GET /v2/multiplayer/games/:id

func GetMusicArtists 

func GetMusicArtists(c *gin.Context) *APIError

GetMusicArtists Returns all music artists Endpoint: GET /artists

func GetOrderItemById 

func GetOrderItemById(c *gin.Context) *APIError

GetOrderItemById \Retrieves an individual order item by its id Endpoint: GET /v2/items/:id

func GetPinnedScoresForMode 

func GetPinnedScoresForMode(c *gin.Context) *APIError

GetPinnedScoresForMode Gets a user's pinned scores for a given game mode Endpoint: GET /v2/user/:id/scores/:mode/pinned

func GetPlaylist 

func GetPlaylist(c *gin.Context) *APIError

GetPlaylist Gets an individual playlist Endpoint: GET /v2/playlists/:id

func GetPlaylistContainsMap 

func GetPlaylistContainsMap(c *gin.Context) *APIError

GetPlaylistContainsMap Returns if a playlist contains an individual map id Endpoint: /v2/playlists/:id/contains/:map_id

func GetRankedMapsetIds 

func GetRankedMapsetIds(c *gin.Context) *APIError

GetRankedMapsetIds Retrieves the list of ranked mapset ids Endpoint: GET /v2/mapset/ranked

func GetRankingQueue 

func GetRankingQueue(c *gin.Context) *APIError

GetRankingQueue Retrieves the ranking queue for a given mode Endpoint: /v2/ranking/queue/mode/:mode

func GetRankingQueueComments 

func GetRankingQueueComments(c *gin.Context) *APIError

GetRankingQueueComments Returns all of the comments for a mapset in the ranking queue Endpoint: GET /v2/ranking/queue/:id/comments

func GetRankingQueueConfig 

func GetRankingQueueConfig(c *gin.Context) *APIError

GetRankingQueueConfig Returns the vote/denial configuration for the ranking queue

func GetRankingQueueMapset 

func GetRankingQueueMapset(c *gin.Context) *APIError

GetRankingQueueMapset Gets a single mapset in the ranking queue Endpoint: GET /v2/ranking/queue/:id

func GetRankingSupervisorActions 

func GetRankingSupervisorActions(c *gin.Context) *APIError

GetRankingSupervisorActions Retrieves ranking supervisor actions between a given time frame Endpoint: GET /ranking/queue/supervisors/actions?start=&end=

func GetRateScoresForMap 

func GetRateScoresForMap(c *gin.Context) *APIError

GetRateScoresForMap Retrieves rate scores for a given map Endpoint: GET v2/scores/:md5/rate/:mods

func GetRecentMultiplayerGames 

func GetRecentMultiplayerGames(c *gin.Context) *APIError

GetRecentMultiplayerGames Retrieves the most recent multiplayer games from the database Endpoint: GET /v2/multiplayer/games

func GetServerStats 

func GetServerStats(c *gin.Context) *APIError

GetServerStats Retrieves statistics about Quaver Endpoint: /v2/server/stats

func GetSingleMusicArtist 

func GetSingleMusicArtist(c *gin.Context) *APIError

GetSingleMusicArtist Retrieves a single music artist by id Endpoint: GET /artists/:id

func GetTeamMembers 

func GetTeamMembers(c *gin.Context) *APIError

GetTeamMembers Retrieves users in the Quaver team along with contributors and donators Endpoint: /v2/user/team/members

func GetTotalHitsLeaderboard 

func GetTotalHitsLeaderboard(c *gin.Context) *APIError

GetTotalHitsLeaderboard Retrieves the total hits leaderboard for a given game mode Endpoint: GET /v2/leaderboard/hits?mode=&page=

func GetUser 

func GetUser(c *gin.Context) *APIError

GetUser Gets a user by their id or username Endpoint: /v2/user/:query

func GetUserAboutMe 

func GetUserAboutMe(c *gin.Context) *APIError

GetUserAboutMe Retrieves a user's about me / userpage Endpoint: GET /v2/user/:id/aboutme

func GetUserAchievements 

func GetUserAchievements(c *gin.Context) *APIError

GetUserAchievements Returns a list of achievements that a user has locked/unlocked Endpoint: GET /v2/user/:id/achievements

func GetUserActivity 

func GetUserActivity(c *gin.Context) *APIError

GetUserActivity Gets the user's recent activity Endpoint: GET /v2/user/:id/activity

func GetUserApplication 

func GetUserApplication(c *gin.Context) *APIError

GetUserApplication Returns a single user application Endpoint: GET /v2/developers/applications/:id

func GetUserApplications 

func GetUserApplications(c *gin.Context) *APIError

GetUserApplications Returns a users active applications Endpoint: GET /v2/developers/applications

func GetUserBadges 

func GetUserBadges(c *gin.Context) *APIError

GetUserBadges Gets a user's profile badges Endpoint: GET /v2/user/:id/badges

func GetUserBestScoresForMode 

func GetUserBestScoresForMode(c *gin.Context) *APIError

GetUserBestScoresForMode Gets the user's best scores for a given game mode Endpoint: /v2/user/:id/scores/:mode/best

func GetUserFirstPlaceScoresForMode 

func GetUserFirstPlaceScoresForMode(c *gin.Context) *APIError

GetUserFirstPlaceScoresForMode Gets a user's first place scores for a given game mode Endpoint: /v2/user/:id/scores/:mode/firstplace

func GetUserFreeTrialDonatorOrder 

func GetUserFreeTrialDonatorOrder(c *gin.Context) *APIError

GetUserFreeTrialDonatorOrder Retrieves a user's free trial donator order if they've had one before

func GetUserGradesForMode 

func GetUserGradesForMode(c *gin.Context) *APIError

GetUserGradesForMode Gets a user's scores with a particular grade Endpoint: GET /v2/user/:id/scores/:mode/grade/:grade

func GetUserMapsets 

func GetUserMapsets(c *gin.Context) *APIError

GetUserMapsets Gets a user's uploaded mapsets Endpoint: GET /v2/user/:id/mapsets

func GetUserMostPlayedMaps 

func GetUserMostPlayedMaps(c *gin.Context) *APIError

GetUserMostPlayedMaps Gets a user's most played maps Endpoint: /v2/user/:id/mostplayed

func GetUserNotifications 

func GetUserNotifications(c *gin.Context) *APIError

GetUserNotifications Gets a user's notification Endpoint /v2/notifications

func GetUserOrders 

func GetUserOrders(c *gin.Context) *APIError

GetUserOrders Gets a user's completed orders. Endpoint: GET /v2/orders

func GetUserPendingClanInvites 

func GetUserPendingClanInvites(c *gin.Context) *APIError

GetUserPendingClanInvites Retrieves all pending clan invites for the user Endpoint: GET /v2/clan/invites

func GetUserPersonalBestScoreAll 

func GetUserPersonalBestScoreAll(c *gin.Context) *APIError

GetUserPersonalBestScoreAll Retrieves the personal best (ALL lb) score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/all

func GetUserPersonalBestScoreGlobal 

func GetUserPersonalBestScoreGlobal(c *gin.Context) *APIError

GetUserPersonalBestScoreGlobal Retrieves the personal best score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/global

func GetUserPersonalBestScoreMods 

func GetUserPersonalBestScoreMods(c *gin.Context) *APIError

GetUserPersonalBestScoreMods Retrieves the personal best modifier score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/mods/:mods

func GetUserPersonalBestScoreRate 

func GetUserPersonalBestScoreRate(c *gin.Context) *APIError

GetUserPersonalBestScoreRate Retrieves the personal best rate score on a map for a user Endpoint: GET /v2/scores/:md5/:user_id/rate/:mods

func GetUserPlaylists 

func GetUserPlaylists(c *gin.Context) *APIError

GetUserPlaylists Returns a user's created playlists Endpoint: /v2/user/:id/playlists

func GetUserRankStatisticsForMode 

func GetUserRankStatisticsForMode(c *gin.Context) *APIError

GetUserRankStatisticsForMode Gets a user's rank statistics for a given game mode Endpoint: GET /v2/user/:id/statistics/:mode/rank

func GetUserRecentScoresForMode 

func GetUserRecentScoresForMode(c *gin.Context) *APIError

GetUserRecentScoresForMode Gets the user's recent scores for a given game mode Endpoint: /v2/user/:id/scores/:mode/recent

func GetUserScoresForClanScore 

func GetUserScoresForClanScore(c *gin.Context) *APIError

GetUserScoresForClanScore Retrieves all individual scores that make up a clan score Endpoint: /v2/clan/scores/:id

func GetVirtualReplayPlayerOutput 

func GetVirtualReplayPlayerOutput(c *gin.Context) *APIError

GetVirtualReplayPlayerOutput Plays the virtual replay player & returns the output Endpoint: GET /v2/scores/:id/stats

func GetWeeklyMostPlayedMapsets 

func GetWeeklyMostPlayedMapsets(c *gin.Context) *APIError

GetWeeklyMostPlayedMapsets Gets the most played mapsets of the week Endpoint: GET /v2/server/stats/mostplayed

func HandleMapsetSubmission 

func HandleMapsetSubmission(c *gin.Context) *APIError

HandleMapsetSubmission Handles the uploading/updating of a mapset archive (.qp) file Endpoint: POST /v2/mapset

func HandleStripeWebhook 

func HandleStripeWebhook(c *gin.Context) *APIError

HandleStripeWebhook Handles an incoming stripe webhook POST: /v2/orders/stripe/webhook

func InitiateSteamDonatorTransaction 

func InitiateSteamDonatorTransaction(c *gin.Context) *APIError

InitiateSteamDonatorTransaction Initiates a transaction for Steam donator Endpoint: POST /v2/orders/steam/initiate/donation

func InitiateStripeDonatorCheckoutSession 

func InitiateStripeDonatorCheckoutSession(c *gin.Context) *APIError

InitiateStripeDonatorCheckoutSession Initiates a stripe checkout session for donator Endpoint: POST /v2/orders/stripe/initiate/donation

func InsertMusicArtist 

func InsertMusicArtist(c *gin.Context) *APIError

InsertMusicArtist Creates a new music artists Endpoint: POST /artists

func InsertOrUpdateMap 

func InsertOrUpdateMap(user *db.User, mapset *db.Mapset, quaFile *qua.Qua) (*db.MapQua, *APIError)

InsertOrUpdateMap Inserts/Updates a map in the database

func InviteUserToClan 

func InviteUserToClan(c *gin.Context) *APIError

InviteUserToClan Invites a user to the clan Endpoint: POST /v2/clan/invite

func IsUsernameAvailable 

func IsUsernameAvailable(c *gin.Context) *APIError

IsUsernameAvailable Returns if a username is available for a user to take Endpoint: GET /v2/user/profile/username/available?name=

func KickClanMember 

func KickClanMember(c *gin.Context) *APIError

KickClanMember Kicks a member from the clan POST /v2/clan/kick/:user_id

func LeaveClan 

func LeaveClan(c *gin.Context) *APIError

LeaveClan Leaves the user's current clan Endpoint: POST /v2/clan/leave

func MarkAllNotificationsAsRead 

func MarkAllNotificationsAsRead(c *gin.Context) *APIError

MarkAllNotificationsAsRead Marks all notifications from a user as read POST: /v2/notifications/all/read

func MarkMapsetAsExplicit 

func MarkMapsetAsExplicit(c *gin.Context) *APIError

MarkMapsetAsExplicit Marks a mapset as explicit POST /v2/mapset/:id/explicit

func MarkMapsetAsNotExplicit 

func MarkMapsetAsNotExplicit(c *gin.Context) *APIError

MarkMapsetAsNotExplicit Marks a mapsets as not explicit POST /v2/mapset/:id/unexplicit

func MarkUserNotificationAsRead 

func MarkUserNotificationAsRead(c *gin.Context) *APIError

MarkUserNotificationAsRead Marks an individual notification as read Endpoint: POST /v2/notifications/:id/read

func MarkUserNotificationAsUnread 

func MarkUserNotificationAsUnread(c *gin.Context) *APIError

MarkUserNotificationAsUnread Marks an individual notification as unread Endpoint: POST /v2/notifications/:id/unread

func ModifyStripeSubscription 

func ModifyStripeSubscription(c *gin.Context) *APIError

ModifyStripeSubscription Returns a link so the user can modify their subscription Endpoint: GET /v2/orders/stripe/subscriptions/modify

func OnHoldRankingQueueMapset 

func OnHoldRankingQueueMapset(c *gin.Context) *APIError

OnHoldRankingQueueMapset On-holds a mapset from the ranking queue Endpoint: POST /v2/ranking/queue/:id/hold

func RegisterNewUser 

func RegisterNewUser(c *gin.Context) *APIError

RegisterNewUser Registers a new user account Endpoint: POST /v2/user

func RemoveFriend 

func RemoveFriend(c *gin.Context) *APIError

RemoveFriend Removes a friend from the logged-in users friend's list Endpoint: POST /v2/user/:id/relationship/delete

func RemoveFromRankingQueue 

func RemoveFromRankingQueue(c *gin.Context) *APIError

RemoveFromRankingQueue Allows a user to remove their mapset from the ranking queue (self deny) Endpoint: POST /v2/ranking/queue/:id/remove

func RemoveMapFromPlaylist 

func RemoveMapFromPlaylist(c *gin.Context) *APIError

RemoveMapFromPlaylist Removes a map from a playlist Endpoint: /v2/playlist/:id/remove/:map_id

func RemovePinnedScore 

func RemovePinnedScore(c *gin.Context) *APIError

RemovePinnedScore Removes a user's pinned score Endpoint: POST /v2/scores/:id/unpin

func ResetApplicationSecret 

func ResetApplicationSecret(c *gin.Context) *APIError

ResetApplicationSecret Resets the secret of an application Endpoint: POST /v2/developers/applications/:id/secret

func SearchPlaylists 

func SearchPlaylists(c *gin.Context) *APIError

SearchPlaylists Searches for playlists by name/creator username Endpoint: /v2/playlists/search?query=

func SearchUsers 

func SearchUsers(c *gin.Context) *APIError

SearchUsers Searches for users by username and returns them Endpoint: /v2/user/search/:name

func SortMusicArtistAlbums 

func SortMusicArtistAlbums(c *gin.Context) *APIError

SortMusicArtistAlbums Sorts music artist albums Endpoints: POST: /v2/artists/:id/album/sort

func SortMusicArtistSongs 

func SortMusicArtistSongs(c *gin.Context) *APIError

SortMusicArtistSongs Sort's an album's songs Endpoint: POST /v2/artists/album/:id/song/sort

func SortMusicArtists 

func SortMusicArtists(c *gin.Context) *APIError

SortMusicArtists Custom sort music artists Endpoint: POST /v2/artists/sort

func SortPinnedScores 

func SortPinnedScores(c *gin.Context) *APIError

SortPinnedScores Sorts pins scores by a custom sort order Endpoint: POST /v2/scores/pinned/:mode/sort

func SubmitMapMod 

func SubmitMapMod(c *gin.Context) *APIError

SubmitMapMod Inserts a map mod to the db Endpoint: POST /v2/maps/:id/mods

func SubmitMapModComment 

func SubmitMapModComment(c *gin.Context) *APIError

SubmitMapModComment Submits a comment for a map mod Endpoint: POST /v2/maps/:id/mods/:mod_id/comment

func SubmitMapsetToRankingQueue 

func SubmitMapsetToRankingQueue(c *gin.Context) *APIError

SubmitMapsetToRankingQueue Submits a mapsets to the ranking queue Endpoint: POST /v2/ranking/queue/:id/submit

func TransferClanOwnership 

func TransferClanOwnership(c *gin.Context) *APIError

TransferClanOwnership Transfers ownership of the clan to another member. Endpoint: POST /v2/clan/transfer/:user_id

func UnbanUser 

func UnbanUser(c *gin.Context) *APIError

UnbanUser Unbans a user from the game Endpoint: POST /v2/user/:id/unban

func UpdateApplication 

func UpdateApplication(c *gin.Context) *APIError

UpdateApplication Updates an application's data Endpoint: POST /v2/developers/applications/:id

func UpdateClan 

func UpdateClan(c *gin.Context) *APIError

UpdateClan Updates data about a clan Endpoint: PATCH /v2/clan/:id

func UpdateElasticSearchMapset 

func UpdateElasticSearchMapset(c *gin.Context) *APIError

UpdateElasticSearchMapset Updates a mapset in elastic search Endpoint: GET /v2/mapset/:id/elastic

func UpdateMapModStatus 

func UpdateMapModStatus(c *gin.Context) *APIError

UpdateMapModStatus Updates the status of a map mod Endpoint: POST /v2/maps/:id/mods/:mod_id/status

func UpdateMapsetDescription 

func UpdateMapsetDescription(c *gin.Context) *APIError

UpdateMapsetDescription Updates the description of a given mapset Endpoint: PATCH /v2/mapset/:id/description

func UpdateMusicArtist 

func UpdateMusicArtist(c *gin.Context) *APIError

UpdateMusicArtist Updates the name, description, and links for a music artists Endpoint: POST /artists/:id

func UpdateMusicArtistAlbum 

func UpdateMusicArtistAlbum(c *gin.Context) *APIError

UpdateMusicArtistAlbum Updates a music artist album Endpoint: POST /v2/artists/album/:id

func UpdateMusicArtistSong 

func UpdateMusicArtistSong(c *gin.Context) *APIError

UpdateMusicArtistSong Updates metadata for a given song Endpoint: POST /v2/artists/song/:id

func UpdatePlaylist 

func UpdatePlaylist(c *gin.Context) *APIError

UpdatePlaylist Updates a playlists name/description Endpoint: POST /v2/playlists/:id/update

func UpdateUserAboutMe 

func UpdateUserAboutMe(c *gin.Context) *APIError

UpdateUserAboutMe Updates a user's about me Endpoint: POST /v2/user/profile/aboutme

func UpdateUserAccentColor 

func UpdateUserAccentColor(c *gin.Context) *APIError

UpdateUserAccentColor Updates a user's accent color Endpoint: POST /v2/user/:id/accent

func UpdateUserDiscordId 

func UpdateUserDiscordId(c *gin.Context) *APIError

UpdateUserDiscordId Updates a user's discord id Endpoint: POST /v2/user/:id/discord

func UploadClanAvatar 

func UploadClanAvatar(c *gin.Context) *APIError

UploadClanAvatar Handles the uploading of a clan avatar Endpoint: /v2/clan/avatar

func UploadClanBanner 

func UploadClanBanner(c *gin.Context) *APIError

UploadClanBanner Handles the uploading of a clan banner Endpoint: /v2/clan/banner

func UploadMultiplayerMapset 

func UploadMultiplayerMapset(c *gin.Context) *APIError

UploadMultiplayerMapset Uploads a multiplayer map to be shared. Endpoint: POST /v2/download/multiplayer/:id/upload

func UploadMusicArtistAlbumCover 

func UploadMusicArtistAlbumCover(c *gin.Context) *APIError

UploadMusicArtistAlbumCover Uploads an album cover for an album Endpoint: POST /v2/artists/album/:id/cover

func UploadMusicArtistAvatar 

func UploadMusicArtistAvatar(c *gin.Context) *APIError

UploadMusicArtistAvatar Uploads a music artist's avatar Endpoint: POST /v2/artists/:id/avatar

func UploadMusicArtistBanner 

func UploadMusicArtistBanner(c *gin.Context) *APIError

UploadMusicArtistBanner Uploads a music artist's banner Endpoint: POST /v2/artists/:id/banner

func UploadMusicArtistSong 

func UploadMusicArtistSong(c *gin.Context) *APIError

UploadMusicArtistSong Uploads a new song for a music artist's album Endpoint: POST /v2/artists/album/:id/song

func UploadPlaylistCover 

func UploadPlaylistCover(c *gin.Context) *APIError

UploadPlaylistCover Uploads a playlist cover Endpoint: POST /v2/playlists/:id/cover

func UploadUnsubmittedMap 

func UploadUnsubmittedMap(c *gin.Context) *APIError

UploadUnsubmittedMap Uploads an unsubmitted map to azure for donator leaderboards. Endpoint: POST /v2/map

func UploadUserProfileCover 

func UploadUserProfileCover(c *gin.Context) *APIError

UploadUserProfileCover Handles the uploading of a user's profile cover Endpoint: POST /v2/user/profile/cover

func VoteForRankingQueueMapset 

func VoteForRankingQueueMapset(c *gin.Context) *APIError

VoteForRankingQueueMapset Adds a vote for a mapset in the ranking queue Endpoint: POST /v2/ranking/queue/:id/vote

type ClanImage 

type ClanImage int8
const (
	ClanImageAvatar ClanImage = iota
	ClanImageBanner
)

type DonatorPaymentMethod 

type DonatorPaymentMethod struct {
	Months1  float32 `json:"months_1"`
	Months3  float32 `json:"months_3"`
	Months6  float32 `json:"months_6"`
	Months12 float32 `json:"months_12"`
}

type DonatorPricing 

type DonatorPricing struct {
	Steam  DonatorPaymentMethod `json:"steam"`
	Stripe DonatorPaymentMethod `json:"stripe"`
}

type MusicArtistImage 

type MusicArtistImage int
const (
	MusicArtistImageAvatar MusicArtistImage = iota
	MusicArtistImageBanner
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.