omgtaplounge_javascript_client
v1.0.0
Published
Object
Downloads
2
Readme
twitch_game_api
TwitchGameApi - JavaScript client for twitch_game_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install twitch_game_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var TwitchGameApi = require('twitch_game_api');
var api = new TwitchGameApi.CurrencyApi()
var card = "card_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.currencyCardCardPost(card, callback);
Documentation for API Endpoints
All URIs are relative to /
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TwitchGameApi.CurrencyApi | currencyCardCardPost | POST /Currency/Card/{card} | TwitchGameApi.CurrencyApi | currencyCardGet | GET /Currency/Card | TwitchGameApi.CurrencyApi | currencyCardsGet | GET /Currency/Cards | TwitchGameApi.CurrencyApi | currencyCreditsGet | GET /Currency/Credits | TwitchGameApi.OutfitApi | outfitChangePost | POST /Outfit/Change | TwitchGameApi.OutfitApi | outfitClaimCosmeticIdPost | POST /Outfit/Claim/{cosmeticId} | TwitchGameApi.OutfitApi | outfitCosmeticsUserIdGet | GET /Outfit/Cosmetics/{userId} | TwitchGameApi.OutfitApi | outfitUserIdGet | GET /Outfit/{userId} | TwitchGameApi.OutfitApi | outfitUsernameUsernameGet | GET /Outfit/Username/{username} | TwitchGameApi.RewardsApi | rewardsGiftPost | POST /Rewards/Gift | TwitchGameApi.RewardsApi | rewardsOpenIdPost | POST /Rewards/Open/{id} | TwitchGameApi.RewardsApi | rewardsPickupsCoinDropPost | POST /Rewards/Pickups/CoinDrop | TwitchGameApi.RewardsApi | rewardsPickupsPost | POST /Rewards/Pickups | TwitchGameApi.RewardsApi | rewardsSummaryTwitchLoginGet | GET /Rewards/Summary/{twitchLogin} | TwitchGameApi.RewardsApi | rewardsUserIdGet | GET /Rewards/User/{id} | TwitchGameApi.RewardsApi | rewardsUserPickupPickupIdPost | POST /Rewards/User/Pickup/{pickupId} | TwitchGameApi.RewardsApi | rewardsUserPickupsGet | GET /Rewards/User/Pickups | TwitchGameApi.ShopApi | shopItemsBuyItemIdPost | POST /Shop/Items/Buy/{itemId} | TwitchGameApi.ShopApi | shopItemsItemIdPatch | PATCH /Shop/Items/{itemId} | TwitchGameApi.ShopApi | shopItemsPost | POST /Shop/Items | TwitchGameApi.ShopApi | shopItemsTypeGet | GET /Shop/Items/{type} | TwitchGameApi.ShopApi | shopPayFastNotificationPost | POST /Shop/PayFastNotification | TwitchGameApi.ShopApi | shopSpinTheWheelTicketsGet | GET /Shop/SpinTheWheelTickets | TwitchGameApi.ShopApi | shopTapTokensGet | GET /Shop/TapTokens | TwitchGameApi.TournamentApi | tournamentAllGet | GET /Tournament/All | TwitchGameApi.TournamentApi | tournamentDonateOrderIdGet | GET /Tournament/donate/{orderId} | TwitchGameApi.TournamentApi | tournamentDonationsTournamentIdGet | GET /Tournament/donations/{tournamentId} | TwitchGameApi.TournamentApi | tournamentGameModeDivisionsGameModeIdGet | GET /Tournament/GameModeDivisions/{gameModeId} | TwitchGameApi.TournamentApi | tournamentGameModesAllGet | GET /Tournament/GameModes/All | TwitchGameApi.TournamentApi | tournamentGameModesGameIdGet | GET /Tournament/GameModes/{gameId} | TwitchGameApi.TournamentApi | tournamentGamesGet | GET /Tournament/Games | TwitchGameApi.TournamentApi | tournamentIdGet | GET /Tournament/{id} | TwitchGameApi.TournamentApi | tournamentIdPlayersGet | GET /Tournament/{id}/players | TwitchGameApi.TournamentApi | tournamentIdTeamsGet | GET /Tournament/{id}/teams | TwitchGameApi.TournamentApi | tournamentPastGet | GET /Tournament/Past | TwitchGameApi.TournamentApi | tournamentPaymentsUpdateGet | GET /Tournament/payments/update | TwitchGameApi.TournamentApi | tournamentScoresUpdateGet | GET /Tournament/scores/update | TwitchGameApi.TournamentApi | tournamentSetTournamentDivisionsTournamentIdForceResetGet | GET /Tournament/SetTournamentDivisions/{tournamentId}/{forceReset} | TwitchGameApi.TournamentApi | tournamentTeamAddScoresTeamIdPost | POST /Tournament/Team/AddScores/{teamId} | TwitchGameApi.TournamentApi | tournamentTeamRemovePlayerTeamUserIdDelete | DELETE /Tournament/Team/RemovePlayer/{teamUserId} | TwitchGameApi.TournamentApi | tournamentTeamRemoveScoreScoreIdDelete | DELETE /Tournament/Team/RemoveScore/{scoreId} | TwitchGameApi.TournamentApi | tournamentTeamRemoveTeamTeamIdDelete | DELETE /Tournament/Team/RemoveTeam/{teamId} | TwitchGameApi.TournamentApi | tournamentTeamTeamIdChangeCaptainNewCaptainIdPost | POST /Tournament/Team/{teamId}/ChangeCaptain/{newCaptainId} | TwitchGameApi.TournamentApi | tournamentTournamentAddScoresTournamentIdPost | POST /Tournament/Tournament/AddScores/{tournamentId} | TwitchGameApi.TournamentApi | tournamentTournamentIdEnterPost | POST /Tournament/{tournamentId}/enter | TwitchGameApi.TournamentApi | tournamentTournamentIdJoinPost | POST /Tournament/{tournamentId}/join | TwitchGameApi.TournamentApi | tournamentTournamentIdReservesAddPost | POST /Tournament/{tournamentId}/reserves/add | TwitchGameApi.TournamentApi | tournamentTournamentIdScoresGet | GET /Tournament/{tournamentId}/scores | TwitchGameApi.TournamentApi | tournamentTournamentIdTeammemberStatusPost | POST /Tournament/{tournamentId}/teammember/status | TwitchGameApi.TournamentApi | tournamentTournamentIdUpdatePost | POST /Tournament/{tournamentId}/update | TwitchGameApi.TournamentApi | tournamentTournamentTeamScoresTeamIdGet | GET /Tournament/TournamentTeamScores/{teamId} | TwitchGameApi.TournamentApi | tournamentTournamentTeamTeamIdGet | GET /Tournament/TournamentTeam/{teamId} | TwitchGameApi.TournamentApi | tournamentTournamentsCreatePost | POST /Tournament/Tournaments/create | TwitchGameApi.TournamentApi | tournamentUpcomingGet | GET /Tournament/Upcoming | TwitchGameApi.TournamentApi | tournamentUpdateKdTournamentTeamUserIdGet | GET /Tournament/updateKd/{tournamentTeamUserId} | TwitchGameApi.TournamentApi | tournamentUpdateTournamentTeamStatsTournamentTeamIdForceResetGet | GET /Tournament/UpdateTournamentTeamStats/{tournamentTeamId}/{forceReset} | TwitchGameApi.TournamentApi | tournamentUpdateTournamentTeamUserStatsTournamentTeamUserIdGet | GET /Tournament/UpdateTournamentTeamUserStats/{tournamentTeamUserId} | TwitchGameApi.TournamentApi | tournamentUpdateUnprocessedUserStatsInTournamentTournamentIdMaxUsersGet | GET /Tournament/UpdateUnprocessedUserStatsInTournament/{tournamentId}/{maxUsers} | TwitchGameApi.UsersApi | usersGetUserStatsGet | GET /Users/GetUserStats | TwitchGameApi.UsersApi | usersIdGet | GET /Users/{id} | TwitchGameApi.UsersApi | usersLoginTwitchCodeGet | GET /Users/LoginTwitchCode | TwitchGameApi.UsersApi | usersLoginTwitchCodeV2Get | GET /Users/LoginTwitchCodeV2 | TwitchGameApi.UsersApi | usersLoginTwitchExtensionGet | GET /Users/LoginTwitchExtension | TwitchGameApi.UsersApi | usersLoginTwitchGet | GET /Users/LoginTwitch | TwitchGameApi.UsersApi | usersLoginWithoutTokenGet | GET /Users/LoginWithoutToken | TwitchGameApi.UsersApi | usersMeGet | GET /Users/Me | TwitchGameApi.UsersApi | usersOmgGet | GET /Users/omg | TwitchGameApi.UsersApi | usersOnlineUsersGet | GET /Users/onlineUsers | TwitchGameApi.UsersApi | usersSearchForUserPost | POST /Users/SearchForUser | TwitchGameApi.UsersApi | usersStreamersFiltersGet | GET /Users/streamers/filters | TwitchGameApi.UsersApi | usersStreamersPost | POST /Users/streamers | TwitchGameApi.UsersApi | usersSyncOnlineStreamsGet | GET /Users/SyncOnlineStreams | TwitchGameApi.UsersApi | usersSyncSubsGet | GET /Users/SyncSubs | TwitchGameApi.UsersApi | usersUserAccountAccountTypeIdDelete | DELETE /Users/UserAccount/{accountTypeId} | TwitchGameApi.UsersApi | usersUserAccountIdGet | GET /Users/UserAccount/{id} | TwitchGameApi.UsersApi | usersUserAccountPost | POST /Users/UserAccount | TwitchGameApi.UsersApi | usersUserAccountTypesGet | GET /Users/UserAccount/types | TwitchGameApi.WeatherForecastApi | weatherForecastGet | GET /WeatherForecast |
Documentation for Models
- TwitchGameApi.AddReservesModel
- TwitchGameApi.AuthModel
- TwitchGameApi.BasicUserModel
- TwitchGameApi.CoinDropModel
- TwitchGameApi.CosmeticModel
- TwitchGameApi.CreatePickupModel
- TwitchGameApi.CreateRewardModel
- TwitchGameApi.CreateShopItemModel
- TwitchGameApi.EnterTournamentModel
- TwitchGameApi.FollowerDetail
- TwitchGameApi.GameModeDivisionModel
- TwitchGameApi.GameModeModel
- TwitchGameApi.GameModel
- TwitchGameApi.MessageResponseModel
- TwitchGameApi.OmgRoleModel
- TwitchGameApi.OutfitModel
- TwitchGameApi.PickupModel
- TwitchGameApi.RewardModel
- TwitchGameApi.SearchForUserModel
- TwitchGameApi.ShopItemModel
- TwitchGameApi.ShopPayFastNotificationBody
- TwitchGameApi.StreamerFilterModel
- TwitchGameApi.SubscriberDetail
- TwitchGameApi.TournamentDonationModel
- TwitchGameApi.TournamentModel
- TwitchGameApi.TournamentScoreMatchModel
- TwitchGameApi.TournamentScoreMatchPlayerModel
- TwitchGameApi.TournamentScoreModel
- TwitchGameApi.TournamentTeamModel
- TwitchGameApi.TournamentTeamUserModel
- TwitchGameApi.UserAccountModel
- TwitchGameApi.UserAccountTypeModel
- TwitchGameApi.UserModel
- TwitchGameApi.UserStatsModel
- TwitchGameApi.UserSummaryModel
- TwitchGameApi.WeatherForecast
Documentation for Authorization
All endpoints do not require authorization.