Documentation
¶
Overview ¶
This package is used to interact with the following LOR endpoints:
- DeckV1
- InventoryV1
- MatchV1
- RankedV1
- StatusV1
Note: this package is automatically generated.
Index ¶
- type CardV1DTO
- type ContentV1DTO
- type DeckV1
- type DeckV1DTO
- type InfoV1DTO
- type InventoryV1
- type LORClient
- type LeaderboardPlayerV1DTO
- type LeaderboardV1DTO
- type MatchV1
- type MatchV1DTO
- type MetadataV1DTO
- type NewDeckV1DTO
- type PlatformDataV1DTO
- type PlayerV1DTO
- type RankedV1
- type StatusV1
- type StatusV1DTO
- type UpdateV1DTO
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContentV1DTO ¶ added in v0.17.0
ContentDTO data object.
type DeckV1 ¶ added in v0.17.0
type DeckV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
Note: this struct is automatically generated.
func (*DeckV1) CreateDeck ¶ added in v0.17.0
func (e *DeckV1) CreateDeck(route api.RegionalRoute, body *NewDeckV1DTO, authorization string) (string, error)
Create a new deck for the calling user.
Parameters ¶
- `route` - Route to query.
- `authorization` (required, in header)
Riot API Reference ¶
Note: this method is automatically generated.
type InfoV1DTO ¶ added in v0.17.0
type InfoV1DTO struct {
// (Legal values: Constructed, Expeditions, Tutorial)
GameMode string `json:"game_mode"`
// (Legal values: Ranked, Normal, AI, Tutorial, VanillaTrial, Singleton, StandardGauntlet)
GameType string `json:"game_type"`
GameStartTimeUtc string `json:"game_start_time_utc"`
GameVersion string `json:"game_version"`
Players []PlayerV1DTO `json:"players"`
// Total turns taken by both players.
TotalTurnCount int32 `json:"total_turn_count"`
}
InfoDTO data object.
type InventoryV1 ¶ added in v0.17.0
type InventoryV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
Note: this struct is automatically generated.
func (*InventoryV1) Cards ¶ added in v0.17.0
func (e *InventoryV1) Cards(route api.RegionalRoute, authorization string) ([]CardV1DTO, error)
Return a list of cards owned by the calling user.
Parameters ¶
- `route` - Route to query.
- `authorization` (required, in header)
Riot API Reference ¶
Note: this method is automatically generated.
type LORClient ¶
type LORClient struct {
DeckV1 *DeckV1
InventoryV1 *InventoryV1
MatchV1 *MatchV1
RankedV1 *RankedV1
StatusV1 *StatusV1
// contains filtered or unexported fields
}
Note: this struct is automatically generated.
func NewLORClient ¶
func NewLORClient(client *internal.InternalClient) *LORClient
Creates a new LORClient using the InternalClient provided.
type LeaderboardPlayerV1DTO ¶ added in v0.17.0
type LeaderboardPlayerV1DTO struct {
Name string `json:"name"`
Rank int32 `json:"rank"`
// League points.
Lp int32 `json:"lp"`
}
PlayerDTO data object.
type LeaderboardV1DTO ¶ added in v0.17.0
type LeaderboardV1DTO struct {
// A list of players in Master tier.
Players []PlayerV1DTO `json:"players"`
}
LeaderboardDTO data object.
type MatchV1 ¶ added in v0.17.0
type MatchV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
Note: this struct is automatically generated.
func (*MatchV1) ByID ¶ added in v0.17.0
func (e *MatchV1) ByID(route api.RegionalRoute, matchId string) (*MatchV1DTO, error)
Get match by id
Parameters ¶
- `route` - Route to query.
- `matchId` (required, in path)
Riot API Reference ¶
Note: this method is automatically generated.
func (*MatchV1) ListByPUUID ¶ added in v0.17.0
Get a list of match ids by PUUID
Parameters ¶
- `route` - Route to query.
- `puuid` (required, in path)
Riot API Reference ¶
lor-match-v1.getMatchIdsByPUUID
Note: this method is automatically generated.
type MatchV1DTO ¶ added in v0.17.0
type MatchV1DTO struct {
// Match metadata.
Metadata MetadataV1DTO `json:"metadata"`
// Match info.
Info InfoV1DTO `json:"info"`
}
MatchDTO data object.
type MetadataV1DTO ¶ added in v0.17.0
type MetadataV1DTO struct {
// Match data version.
DataVersion string `json:"data_version"`
// Match id.
MatchID string `json:"match_id"`
// A list of participant PUUIDs.
Participants []string `json:"participants"`
}
MetadataDTO data object.
type NewDeckV1DTO ¶ added in v0.17.0
NewDeckDTO data object.
type PlatformDataV1DTO ¶ added in v0.17.0
type PlatformDataV1DTO struct {
ID string `json:"id"`
Name string `json:"name"`
Locales []string `json:"locales"`
Maintenances []StatusV1DTO `json:"maintenances"`
Incidents []StatusV1DTO `json:"incidents"`
}
PlatformDataDTO data object.
type PlayerV1DTO ¶ added in v0.17.0
type PlayerV1DTO struct {
PUUID string `json:"puuid"`
DeckID string `json:"deck_id"`
// Code for the deck played. Refer to LOR documentation for details on deck codes.
DeckCode string `json:"deck_code"`
Factions []string `json:"factions"`
GameOutcome string `json:"game_outcome"`
// The order in which the players took turns.
OrderOfPlay int32 `json:"order_of_play"`
}
PlayerDTO data object.
type RankedV1 ¶ added in v0.17.0
type RankedV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
Note: this struct is automatically generated.
func (*RankedV1) Leaderboards ¶ added in v0.17.0
func (e *RankedV1) Leaderboards(route api.RegionalRoute) (*LeaderboardV1DTO, error)
Get the players in Master tier.
Parameters ¶
- `route` - Route to query.
Riot API Reference ¶
Note: this method is automatically generated.
type StatusV1 ¶ added in v0.17.0
type StatusV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
Note: this struct is automatically generated.
func (*StatusV1) Platform ¶ added in v0.17.0
func (e *StatusV1) Platform(route api.RegionalRoute) (*PlatformDataV1DTO, error)
Get Legends of Runeterra status for the given platform.
Parameters ¶
- `route` - Route to query.
Riot API Reference ¶
Note: this method is automatically generated.
type StatusV1DTO ¶ added in v0.17.0
type StatusV1DTO struct {
ID int32 `json:"id"`
// (Legal values: scheduled, in_progress, complete)
MaintenanceStatus string `json:"maintenance_status"`
// (Legal values: info, warning, critical)
IncidentSeverity string `json:"incident_severity"`
Titles []ContentV1DTO `json:"titles"`
Updates []UpdateV1DTO `json:"updates"`
CreatedAt string `json:"created_at"`
ArchiveAt string `json:"archive_at"`
UpdatedAt string `json:"updated_at"`
// (Legal values: windows, macos, android, ios, ps4, xbone, switch)
Platforms []string `json:"platforms"`
}
StatusDTO data object.
type UpdateV1DTO ¶ added in v0.17.0
type UpdateV1DTO struct {
ID int32 `json:"id"`
Author string `json:"author"`
Publish bool `json:"publish"`
// (Legal values: riotclient, riotstatus, game)
PublishLocations []string `json:"publish_locations"`
Translations []ContentV1DTO `json:"translations"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
}
UpdateDTO data object.