@valoranchi/riot-client / raw / RiotApi

Class: RiotApi

Defined in: src/riot/RiotApi.ts:37

Constructors

Constructor

new RiotApi(gateway, session, cache?): RiotApi

Defined in: src/riot/RiotApi.ts:42

Parameters

gateway

HttpGateway

session

Session

cache?

FileResponseCache | null

Returns

RiotApi

Methods

accountXp()

accountXp(): Promise<RiotAccountXpResponse>

Defined in: src/riot/RiotApi.ts:80

Returns

Promise<RiotAccountXpResponse>

---

activateContract()

activateContract(contractId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:342

Parameters

contractId

string

Returns

Promise<unknown>

---

addFavorite()

addFavorite(itemId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:355

Parameters

itemId

string

Returns

Promise<unknown>

---

balancePartyTeams()

balancePartyTeams(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:300

Parameters

partyId

string

Returns

Promise<unknown>

---

clientConfig()

clientConfig(region?): Promise<RiotClientConfigResponse>

Defined in: src/riot/RiotApi.ts:382

Parameters

region?

string = ...

Returns

Promise<RiotClientConfigResponse>

---

competitiveUpdates()

competitiveUpdates(startIndex?, endIndex?, queue?, puuid?): Promise<RiotCompetitiveUpdatesResponse>

Defined in: src/riot/RiotApi.ts:125

Parameters

startIndex?

number = 0

endIndex?

number = 20

queue?

string = "competitive"

puuid?

string = ...

Returns

Promise<RiotCompetitiveUpdatesResponse>

---

content()

content(): Promise<RiotContentResponse>

Defined in: src/riot/RiotApi.ts:409

Returns

Promise<RiotContentResponse>

---

contracts()

contracts(puuid?): Promise<RiotContractsResponse>

Defined in: src/riot/RiotApi.ts:338

Parameters

puuid?

string = ...

Returns

Promise<RiotContractsResponse>

---

coreGameLoadouts()

coreGameLoadouts(id): Promise<RiotCoreGameLoadoutsResponse>

Defined in: src/riot/RiotApi.ts:175

Parameters

id

string

Returns

Promise<RiotCoreGameLoadoutsResponse>

---

coreGameMatch()

coreGameMatch(id): Promise<RiotCoreGameMatchResponse>

Defined in: src/riot/RiotApi.ts:170

Parameters

id

string

Returns

Promise<RiotCoreGameMatchResponse>

---

coreGamePlayer()

coreGamePlayer(): Promise<RiotCoreGamePlayerResponse | null>

Defined in: src/riot/RiotApi.ts:165

Returns

Promise<RiotCoreGamePlayerResponse | null>

---

createBundleOrder()

createBundleOrder(bundleId, body): Promise<RiotOrderResponse>

Defined in: src/riot/RiotApi.ts:400

Parameters

bundleId

string

body

unknown

Returns

Promise<RiotOrderResponse>

---

createOrder()

createOrder(body): Promise<RiotOrderResponse>

Defined in: src/riot/RiotApi.ts:395

Parameters

body

unknown

Returns

Promise<RiotOrderResponse>

---

createPartyInviteCode()

createPartyInviteCode(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:200

Parameters

partyId

string

Returns

Promise<unknown>

---

customGameConfigs()

customGameConfigs(): Promise<RiotCustomGameConfigsResponse>

Defined in: src/riot/RiotApi.ts:420

Returns

Promise<RiotCustomGameConfigsResponse>

---

declinePartyInvite()

declinePartyInvite(partyId, inviteId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:260

Parameters

partyId

string

inviteId

string

Returns

Promise<unknown>

---

declinePartyRequest()

declinePartyRequest(partyId, requestId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:270

Parameters

partyId

string

requestId

string

Returns

Promise<unknown>

---

disassociatePlayer()

disassociatePlayer(matchId, puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:180

Parameters

matchId

string

puuid?

string = ...

Returns

Promise<unknown>

---

entitlements()

entitlements(): Promise<RiotEntitlementsResponse>

Defined in: src/riot/RiotApi.ts:56

Returns

Promise<RiotEntitlementsResponse>

---

favorites()

favorites(puuid?): Promise<RiotFavoritesResponse>

Defined in: src/riot/RiotApi.ts:351

Parameters

puuid?

string = ...

Returns

Promise<RiotFavoritesResponse>

---

gameSession()

gameSession(): Promise<RiotSessionResponse>

Defined in: src/riot/RiotApi.ts:375

Returns

Promise<RiotSessionResponse>

---

invalidateLoadout()

invalidateLoadout(): void

Defined in: src/riot/RiotApi.ts:71

Returns

void

---

inviteToParty()

inviteToParty(partyId, name, tag): Promise<unknown>

Defined in: src/riot/RiotApi.ts:195

Parameters

partyId

string

name

string

tag

string

Returns

Promise<unknown>

---

joinParty()

joinParty(partyId, puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:255

Parameters

partyId

string

puuid?

string = ...

Returns

Promise<unknown>

---

joinPartyByCode()

joinPartyByCode(code): Promise<unknown>

Defined in: src/riot/RiotApi.ts:210

Parameters

code

string

Returns

Promise<unknown>

---

kickFromParty()

kickFromParty(partyId, puuid): Promise<unknown>

Defined in: src/riot/RiotApi.ts:215

Parameters

partyId

string

puuid

string

Returns

Promise<unknown>

---

leaderboard()

leaderboard(seasonId, startIndex?, size?, query?): Promise<RiotLeaderboardResponse>

Defined in: src/riot/RiotApi.ts:427

Parameters

seasonId

string

startIndex?

number = 0

size?

number = 100

query?

string = ""

Returns

Promise<RiotLeaderboardResponse>

---

leaveParty()

leaveParty(puuid): Promise<unknown>

Defined in: src/riot/RiotApi.ts:250

Parameters

puuid

string

Returns

Promise<unknown>

---

loadout()

loadout(): Promise<RiotLoadoutResponse>

Defined in: src/riot/RiotApi.ts:60

Returns

Promise<RiotLoadoutResponse>

---

lockAgent()

lockAgent(matchId, agentUuid): Promise<RiotPregameMatchResponse>

Defined in: src/riot/RiotApi.ts:150

Parameters

matchId

string

agentUuid

string

Returns

Promise<RiotPregameMatchResponse>

---

makePartyCustomGame()

makePartyCustomGame(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:275

Parameters

partyId

string

Returns

Promise<unknown>

---

makePartyDefault()

makePartyDefault(partyId, queue): Promise<unknown>

Defined in: src/riot/RiotApi.ts:280

Parameters

partyId

string

queue

string

Returns

Promise<unknown>

---

matchDetails()

matchDetails(matchId): Promise<RiotMatchDetailsResponse>

Defined in: src/riot/RiotApi.ts:113

Parameters

matchId

string

Returns

Promise<RiotMatchDetailsResponse>

---

matchHistory()

matchHistory(startIndex?, endIndex?, queue?, puuid?): Promise<RiotMatchHistoryResponse>

Defined in: src/riot/RiotApi.ts:102

Parameters

startIndex?

number = 0

endIndex?

number = 20

queue?

string

puuid?

string = ...

Returns

Promise<RiotMatchHistoryResponse>

---

mmr()

mmr(puuid?): Promise<RiotMmrResponse>

Defined in: src/riot/RiotApi.ts:121

Parameters

puuid?

string = ...

Returns

Promise<RiotMmrResponse>

---

names()

names(puuids): Promise<RiotNameResponse[]>

Defined in: src/riot/RiotApi.ts:95

Parameters

puuids

string[]

Returns

Promise<RiotNameResponse[]>

---

offers()

offers(): Promise<RiotOffersResponse>

Defined in: src/riot/RiotApi.ts:386

Returns

Promise<RiotOffersResponse>

---

order()

order(orderId): Promise<RiotOrderResponse>

Defined in: src/riot/RiotApi.ts:405

Parameters

orderId

string

Returns

Promise<RiotOrderResponse>

---

party()

party(id): Promise<RiotPartyResponse>

Defined in: src/riot/RiotApi.ts:190

Parameters

id

string

Returns

Promise<RiotPartyResponse>

---

partyPlayer()

partyPlayer(): Promise<RiotPartyPlayerResponse | null>

Defined in: src/riot/RiotApi.ts:185

Returns

Promise<RiotPartyPlayerResponse | null>

---

penalties()

penalties(): Promise<RiotPenaltiesResponse>

Defined in: src/riot/RiotApi.ts:347

Returns

Promise<RiotPenaltiesResponse>

---

pregameLoadouts()

pregameLoadouts(matchId): Promise<RiotCoreGameLoadoutsResponse>

Defined in: src/riot/RiotApi.ts:160

Parameters

matchId

string

Returns

Promise<RiotCoreGameLoadoutsResponse>

---

pregameMatch()

pregameMatch(id): Promise<RiotPregameMatchResponse>

Defined in: src/riot/RiotApi.ts:140

Parameters

id

string

Returns

Promise<RiotPregameMatchResponse>

---

pregamePlayer()

pregamePlayer(): Promise<RiotPregamePlayerResponse | null>

Defined in: src/riot/RiotApi.ts:135

Returns

Promise<RiotPregamePlayerResponse | null>

---

premierActiveSeason()

premierActiveSeason(region?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:447

Parameters

region?

string = ...

Returns

Promise<unknown>

---

premierConferences()

premierConferences(region?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:453

Parameters

region?

string = ...

Returns

Promise<unknown>

---

premierEligibility()

premierEligibility(): Promise<unknown>

Defined in: src/riot/RiotApi.ts:443

Returns

Promise<unknown>

---

premierPlayer()

premierPlayer(puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:439

Parameters

puuid?

string = ...

Returns

Promise<unknown>

---

promotePartyMember()

promotePartyMember(partyId, puuid): Promise<unknown>

Defined in: src/riot/RiotApi.ts:220

Parameters

partyId

string

puuid

string

Returns

Promise<unknown>

---

putLoadout()

putLoadout(body): Promise<RiotLoadoutResponse>

Defined in: src/riot/RiotApi.ts:66

Parameters

body

unknown

Returns

Promise<RiotLoadoutResponse>

---

queueConfigs()

queueConfigs(): Promise<RiotQueueConfigsResponse>

Defined in: src/riot/RiotApi.ts:413

Returns

Promise<RiotQueueConfigsResponse>

---

quitPregameMatch()

quitPregameMatch(matchId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:155

Parameters

matchId

string

Returns

Promise<unknown>

---

refreshPartyCompetitiveTier()

refreshPartyCompetitiveTier(partyId, puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:328

Parameters

partyId

string

puuid?

string = ...

Returns

Promise<unknown>

---

refreshPartyPings()

refreshPartyPings(partyId, puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:323

Parameters

partyId

string

puuid?

string = ...

Returns

Promise<unknown>

---

refreshPartyPlayerIdentity()

refreshPartyPlayerIdentity(partyId, puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:333

Parameters

partyId

string

puuid?

string = ...

Returns

Promise<unknown>

---

removeFavorite()

removeFavorite(itemIdWithoutDashes): Promise<unknown>

Defined in: src/riot/RiotApi.ts:360

Parameters

itemIdWithoutDashes

string

Returns

Promise<unknown>

---

requestPartyJoin()

requestPartyJoin(partyId, puuid?): Promise<unknown>

Defined in: src/riot/RiotApi.ts:265

Parameters

partyId

string

puuid?

string = ...

Returns

Promise<unknown>

---

revealNightMarket()

revealNightMarket(): Promise<unknown>

Defined in: src/riot/RiotApi.ts:390

Returns

Promise<unknown>

---

revokePartyInviteCode()

revokePartyInviteCode(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:205

Parameters

partyId

string

Returns

Promise<unknown>

---

selectAgent()

selectAgent(matchId, agentUuid): Promise<RiotPregameMatchResponse>

Defined in: src/riot/RiotApi.ts:145

Parameters

matchId

string

agentUuid

string

Returns

Promise<RiotPregameMatchResponse>

---

setActRankBadgeHidden()

setActRankBadgeHidden(hidden): Promise<unknown>

Defined in: src/riot/RiotApi.ts:365

Parameters

hidden

boolean

Returns

Promise<unknown>

---

setLeaderboardAnonymized()

setLeaderboardAnonymized(seasonId, anonymized): Promise<unknown>

Defined in: src/riot/RiotApi.ts:370

Parameters

seasonId

string

anonymized

boolean

Returns

Promise<unknown>

---

setPartyAccessibility()

setPartyAccessibility(partyId, accessibility): Promise<unknown>

Defined in: src/riot/RiotApi.ts:235

Parameters

partyId

string

accessibility

"OPEN" | "CLOSED"

Returns

Promise<unknown>

---

setPartyCustomGameSettings()

setPartyCustomGameSettings(partyId, settings): Promise<unknown>

Defined in: src/riot/RiotApi.ts:285

Parameters

partyId

string

settings

unknown

Returns

Promise<unknown>

---

setPartyCustomGameTeam()

setPartyCustomGameTeam(partyId, team, puuid): Promise<unknown>

Defined in: src/riot/RiotApi.ts:290

Parameters

partyId

string

team

string

puuid

string

Returns

Promise<unknown>

---

setPartyQueue()

setPartyQueue(partyId, queueId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:230

Parameters

partyId

string

queueId

string

Returns

Promise<unknown>

---

setPartyReady()

setPartyReady(partyId, puuid, ready): Promise<unknown>

Defined in: src/riot/RiotApi.ts:225

Parameters

partyId

string

puuid

string

ready

boolean

Returns

Promise<unknown>

---

setPlayerModeratorStatus()

setPlayerModeratorStatus(partyId, puuid, isModerator): Promise<unknown>

Defined in: src/riot/RiotApi.ts:310

Parameters

partyId

string

puuid

string

isModerator

boolean

Returns

Promise<unknown>

---

setPreferredGamePods()

setPreferredGamePods(partyId, gamePodIds): Promise<unknown>

Defined in: src/riot/RiotApi.ts:305

Parameters

partyId

string

gamePodIds

string[]

Returns

Promise<unknown>

---

startPartyCustomGame()

startPartyCustomGame(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:295

Parameters

partyId

string

Returns

Promise<unknown>

---

startPartyMatchmaking()

startPartyMatchmaking(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:240

Parameters

partyId

string

Returns

Promise<unknown>

---

stopPartyMatchmaking()

stopPartyMatchmaking(partyId): Promise<unknown>

Defined in: src/riot/RiotApi.ts:245

Parameters

partyId

string

Returns

Promise<unknown>

---

storefront()

storefront(): Promise<RiotStorefrontResponse>

Defined in: src/riot/RiotApi.ts:88

Returns

Promise<RiotStorefrontResponse>

---

wallet()

wallet(): Promise<RiotWalletResponse>

Defined in: src/riot/RiotApi.ts:84

Returns

Promise<RiotWalletResponse>