/** * Tribufu API * REST API to access Tribufu services. * * The version of the OpenAPI document: 1.1.0 * Contact: contact@tribufu.com * * NOTE: This class is auto generated by OpenAPI-Generator 7.12.0. * https://openapi-generator.tech * Do not edit the class manually. */ /* * TribufuGeneratedApi.h * * */ #ifndef TRIBUFU_API_TribufuGeneratedApi_H_ #define TRIBUFU_API_TribufuGeneratedApi_H_ #include "tribufu++/ApiClient.h" #include "tribufu++/model/Account.h" #include "tribufu++/AnyType.h" #include "tribufu++/model/AuthorizeRequest.h" #include "tribufu++/model/CryptoViewModel.h" #include "tribufu++/model/Game.h" #include "tribufu++/model/GameServer.h" #include "tribufu++/model/GameServerCluster.h" #include "tribufu++/model/Group.h" #include "tribufu++/model/GroupGame.h" #include "tribufu++/model/GroupMember.h" #include "tribufu++/model/HashViewModel.h" #include "tribufu++/model/IntrospectRequest.h" #include "tribufu++/model/IpAddress.h" #include "tribufu++/model/LeaderboardItem.h" #include "tribufu++/model/LeaderboardOrder.h" #include "tribufu++/model/LoginRequest.h" #include "tribufu++/model/LoginResponse.h" #include "tribufu++/model/Package.h" #include "tribufu++/model/Profile.h" #include "tribufu++/model/ProfileGame.h" #include "tribufu++/model/ProfileGroup.h" #include "tribufu++/model/RefreshRequest.h" #include "tribufu++/model/RegisterRequest.h" #include "tribufu++/model/RevokeRequest.h" #include "tribufu++/model/SearchRequest.h" #include "tribufu++/model/ServerMetrics.h" #include "tribufu++/model/Subscription.h" #include "tribufu++/model/TokenRequest.h" #include "tribufu++/model/TokenResponse.h" #include "tribufu++/model/UpdateProfile.h" #include "tribufu++/model/UserInfo.h" #include #include #include #include namespace tribufu { namespace api { using namespace tribufu::models; class TribufuGeneratedApi { public: explicit TribufuGeneratedApi( std::shared_ptr apiClient ); virtual ~TribufuGeneratedApi(); /// /// Authorize the client to access the user information. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.oauth2.authorize</code> /// /// (optional) pplx::task authorize( boost::optional> authorizeRequest ) const; /// /// Change the email of a user. /// /// /// This endpoint is not available with an api key, only with a bearer token.<br/><br/><b>🔒 Required permissions:</b> <code>tribufu.identity.user.email.update</code> /// /// /// (optional) pplx::task changeEmail( utility::string_t id, boost::optional> body ) const; /// /// Change the password of a user. /// /// /// This endpoint is not available with an api key, only with a bearer token.<br/><br/><b>🔒 Required permissions:</b> <code>tribufu.identity.user.password.update</code> /// /// /// (optional) pplx::task changePassword( utility::string_t id, boost::optional> body ) const; /// /// Claim a game server. /// /// /// This endpoint is not available with an api key, only with a bearer token.<br/><br/><b>🔒 Required permissions:</b> <code>tribufu.community.game.server.claim</code> /// /// /// (optional) pplx::task claimGameServer( utility::string_t id, boost::optional> body ) const; /// /// Convert a string to base64 or vice versa. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.convert.base64</code> /// /// (optional) pplx::task> convertBase64( boost::optional> cryptoViewModel ) const; /// /// Create a new game server. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.create</code> /// /// (optional) pplx::task createGameServer( boost::optional> body ) const; /// /// Create a new game server cluster. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.cluster.create</code> /// /// (optional) pplx::task createGameServerCluster( boost::optional> body ) const; /// /// Create a new group. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.create</code> /// /// (optional) pplx::task createGroup( boost::optional> body ) const; /// /// Create a new token with grant type. /// /// /// /// /// (optional) pplx::task> createToken( boost::optional> tokenRequest ) const; /// /// Delete a game server. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.delete</code> /// /// pplx::task deleteGameServer( utility::string_t id ) const; /// /// Delete a game server cluster. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.cluster.delete</code> /// /// pplx::task deleteGameServerCluster( utility::string_t id ) const; /// /// Delete a group. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.delete</code> /// /// pplx::task deleteGroup( utility::string_t id ) const; /// /// Generate one or more flake ids. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.generate.flake</code> /// /// (optional, default to 0) pplx::task> generateFlakeId( boost::optional amount ) const; /// /// Generate one or more flake ids from a timestamp. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.generate.flake.timestamp</code> /// /// /// (optional, default to 0) pplx::task> generateFlakeIdFromTimestamp( utility::string_t timestamp, boost::optional amount ) const; /// /// Generate a random password. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.generate.password</code> /// /// (optional, default to 0) /// (optional, default to false) pplx::task> generatePassword( boost::optional length, boost::optional symbols ) const; /// /// Generate one or more uuids with a specific version. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.generate.uuid</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task> generateUuid( boost::optional version, boost::optional amount ) const; /// /// Get current client information. /// /// /// /// pplx::task getClientInfo( ) const; /// /// Get current ip address location. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.geoip.current</code> /// pplx::task>> getCurrentIpAddress( ) const; /// /// Get a game by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.get</code> /// /// pplx::task> getGameById( utility::string_t id ) const; /// /// Get a list of game server clusters of a game. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.cluster.list</code> /// /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGameClustersByGameId( utility::string_t id, boost::optional page, boost::optional limit ) const; /// /// Get a list of game items. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.item.list</code> /// /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGameItems( utility::string_t id, boost::optional page, boost::optional limit ) const; /// /// Get a game server by address and query port. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.get.address</code> /// /// /// pplx::task> getGameServerByAddressAndQueryPort( utility::string_t address, int32_t port ) const; /// /// Get a game server by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.get</code> /// /// pplx::task> getGameServerById( utility::string_t id ) const; /// /// Get a game server cluster by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.cluster.get</code> /// /// pplx::task> getGameServerClusterById( utility::string_t id ) const; /// /// Get a list of game server clusters. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.cluster.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGameServerClusters( boost::optional page, boost::optional limit ) const; /// /// Get a list of game servers. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGameServers( boost::optional page, boost::optional limit ) const; /// /// Get a list of game servers from a country. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.list.country</code> /// /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGameServersByCountry( utility::string_t country, boost::optional page, boost::optional limit ) const; /// /// Get a list of game servers of a game. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.list</code> /// /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGameServersByGameId( utility::string_t id, boost::optional page, boost::optional limit ) const; /// /// Get a list of countries with the number of game servers. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.country.list</code> /// pplx::task> getGameServersCountries( ) const; /// /// Get metrics about the tracked game servers. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.metric.get</code> /// pplx::task> getGameServersMetrics( ) const; /// /// Get a list of games. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.list</code> /// pplx::task>> getGames( ) const; /// /// Get a group by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.get</code> /// /// pplx::task> getGroupById( utility::string_t id ) const; /// /// Get a group by tag. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.get.tag</code> /// /// pplx::task> getGroupByTag( utility::string_t tag ) const; /// /// Get a group by uuid. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.get.uuid</code> /// /// pplx::task> getGroupByUuid( utility::string_t uuid ) const; /// /// Get a list of games of a group. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.game.list</code> /// /// pplx::task>> getGroupGames( utility::string_t id ) const; /// /// Get a list of members in a group. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.member.list</code> /// /// pplx::task>> getGroupMembers( utility::string_t id ) const; /// /// Get a list of groups. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getGroups( boost::optional page, boost::optional limit ) const; /// /// Get a ip address location. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.geoip.address.get</code> /// /// pplx::task> getIpAddress( utility::string_t address ) const; /// /// Get a list of ip addresses. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.geoip.address.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getIpAddresses( boost::optional page, boost::optional limit ) const; /// /// Get the top 20 leaderboard users. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.leaderboard.get</code> /// /// (optional, default to new LeaderboardOrder()) pplx::task>> getLeaderboard( boost::optional> order ) const; /// /// Get current user information. /// /// /// /// pplx::task> getMe( ) const; /// /// Get a package by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.package.get</code> /// /// pplx::task> getPackageById( utility::string_t id ) const; /// /// Get a list of packages. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.package.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getPackages( boost::optional page, boost::optional limit ) const; /// /// Get the public keys for the client. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.oauth2.client.keys</code> /// pplx::task getPublicKeys( ) const; /// /// Get a subscription by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.store.subscription.get</code> /// /// pplx::task> getSubscriptionById( utility::string_t id ) const; /// /// Get a list of subscriptions. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.store.subscription.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getSubscriptions( boost::optional page, boost::optional limit ) const; /// /// Get a list of connected accounts of the user. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.user.account.list</code> /// /// pplx::task>> getUserAccounts( utility::string_t id ) const; /// /// Get a user profile by id. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.get</code> /// /// pplx::task> getUserById( utility::string_t id ) const; /// /// Get a user profile by name. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.get.name</code> /// /// pplx::task> getUserByName( utility::string_t name ) const; /// /// Get a user profile by uuid. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.get.uuid</code> /// /// pplx::task> getUserByUuid( utility::string_t uuid ) const; /// /// Get a list of friends of the user. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.friend.list</code> /// /// pplx::task>> getUserFriends( utility::string_t id ) const; /// /// Get a list of games the user has played. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.game.list</code> /// /// pplx::task>> getUserGames( utility::string_t id ) const; /// /// Get a list of groups the user is a member of. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.group.list</code> /// /// pplx::task>> getUserGroups( utility::string_t id ) const; /// /// Get current user information. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.oauth2.user.info</code> /// pplx::task> getUserInfo( ) const; /// /// Get a list of punishments the user has received. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.punishment.list</code> /// /// pplx::task>> getUserPunishments( utility::string_t id ) const; /// /// Get a list of servers the user is owner of. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.game.server.list</code> /// /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getUserServers( utility::string_t id, boost::optional page, boost::optional limit ) const; /// /// Get a list of user profiles. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.list</code> /// /// (optional, default to 0) /// (optional, default to 0) pplx::task>> getUsers( boost::optional page, boost::optional limit ) const; /// /// Hash a string using argon2. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.hash.argon2</code> /// /// (optional) pplx::task> hashArgon2( boost::optional> hashViewModel ) const; /// /// Hash a string using bcrypt. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.hash.bcrypt</code> /// /// (optional) pplx::task> hashBcrypt( boost::optional> hashViewModel ) const; /// /// Hash a string using md5. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.hash.md5</code> /// /// (optional) pplx::task> hashMd5( boost::optional> hashViewModel ) const; /// /// Hash a string using sha256. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.utils.hash.sha256</code> /// /// (optional) pplx::task> hashSha256( boost::optional> hashViewModel ) const; /// /// Introspect a token. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.oauth2.token.introspect</code> /// /// (optional) pplx::task introspectToken( boost::optional> introspectRequest ) const; /// /// Login with name or email and password. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.token.create</code> /// /// (optional) pplx::task> login( boost::optional> loginRequest ) const; /// /// Invalidate credentials. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.token.revoke</code> /// pplx::task logout( ) const; /// /// Create a new user. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.user.create</code> /// /// (optional) pplx::task> r_register( boost::optional> registerRequest ) const; /// /// Refresh credentials. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.token.refresh</code> /// /// (optional) pplx::task> refresh( boost::optional> refreshRequest ) const; /// /// Revoke a token. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.identity.oauth2.token.revoke</code> /// /// (optional) pplx::task revokeToken( boost::optional> revokeRequest ) const; /// /// Advanced search for servers or players. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.search</code> /// /// (optional) pplx::task>> search( boost::optional> searchRequest ) const; /// /// Update a game server. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.update</code> /// /// /// (optional) pplx::task updateGameServer( utility::string_t id, boost::optional> body ) const; /// /// Update a game server cluster. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.game.server.cluster.update</code> /// /// /// (optional) pplx::task updateGameServerCluster( utility::string_t id, boost::optional> body ) const; /// /// Update a group. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.group.update</code> /// /// /// (optional) pplx::task updateGroup( utility::string_t id, boost::optional> body ) const; /// /// Update a user profile. /// /// /// <b>🔒 Required permissions:</b> <code>tribufu.community.profile.update</code> /// /// /// (optional) pplx::task> updateUserProfile( utility::string_t id, boost::optional> updateProfile ) const; protected: std::shared_ptr m_ApiClient; }; } } #endif /* TRIBUFU_API_TribufuGeneratedApi_H_ */