Documentation
¶
Overview ¶
This package is used to interact with all LOR endpoints.
- DeckV1
- InventoryV1
- MatchV1
- RankedV1
- StatusV1
Note: this package is automatically generated.
Index ¶
- type Client
- type DeckNewDeckV1DTO
- type DeckV1
- type DeckV1DTO
- type InventoryCardV1DTO
- type InventoryV1
- type MatchInfoV1DTO
- type MatchMetadataV1DTO
- type MatchPlayerV1DTO
- type MatchV1
- type MatchV1DTO
- type RankedLeaderboardV1DTO
- type RankedPlayerV1DTO
- type RankedV1
- type StatusContentV1DTO
- type StatusPlatformDataV1DTO
- type StatusUpdateV1DTO
- type StatusV1
- type StatusV1DTO
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
DeckV1 DeckV1
InventoryV1 InventoryV1
MatchV1 MatchV1
RankedV1 RankedV1
StatusV1 StatusV1
}
func NewLORClient ¶
Creates a new LOR Client using the internal.Client provided.
type DeckNewDeckV1DTO ¶
type DeckNewDeckV1DTO struct {
Code string `json:"code,omitempty"`
Name string `json:"name,omitempty"`
}
lor-deck-v1.NewDeckDto
type DeckV1 ¶
type DeckV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*DeckV1) CreateDeck ¶
func (endpoint *DeckV1) CreateDeck(ctx context.Context, route api.RegionalRoute, accessToken string, body *DeckNewDeckV1DTO) (string, error)
Create a new deck for the calling user.
Parameters ¶
- route: Route to query.
- accessToken: RSO access token.
Riot API Reference ¶
type DeckV1DTO ¶
type DeckV1DTO struct {
Code string `json:"code,omitempty"`
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
}
lor-deck-v1.DeckDto
type InventoryCardV1DTO ¶
type InventoryCardV1DTO struct {
Code string `json:"code,omitempty"`
Count string `json:"count,omitempty"`
}
lor-inventory-v1.CardDto
type InventoryV1 ¶
type InventoryV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*InventoryV1) Cards ¶
func (endpoint *InventoryV1) Cards(ctx context.Context, route api.RegionalRoute, accessToken string) ([]InventoryCardV1DTO, error)
Return a list of cards owned by the calling user.
Parameters ¶
- route: Route to query.
- accessToken: RSO access token.
Riot API Reference ¶
type MatchInfoV1DTO ¶
type MatchInfoV1DTO struct {
// (Legal values: standard, eternal)
GameFormat string `json:"game_format,omitempty"`
// (Legal values: Constructed, Expeditions, Tutorial)
GameMode string `json:"game_mode,omitempty"`
GameStartTimeUtc string `json:"game_start_time_utc,omitempty"`
// (Legal values: Ranked, Normal, AI, Tutorial, VanillaTrial, Singleton, StandardGauntlet)
GameType string `json:"game_type,omitempty"`
GameVersion string `json:"game_version,omitempty"`
Players []MatchPlayerV1DTO `json:"players,omitempty"`
// Total turns taken by both players.
TotalTurnCount int `json:"total_turn_count,omitempty"`
}
lor-match-v1.InfoDto
type MatchMetadataV1DTO ¶
type MatchMetadataV1DTO struct {
// Match data version.
DataVersion string `json:"data_version,omitempty"`
// Match id.
MatchID string `json:"match_id,omitempty"`
// A list of participant PUUIDs.
Participants []string `json:"participants,omitempty"`
}
lor-match-v1.MetadataDto
type MatchPlayerV1DTO ¶
type MatchPlayerV1DTO struct {
// Code for the deck played. Refer to LOR documentation for details on deck codes.
DeckCode string `json:"deck_code,omitempty"`
DeckID string `json:"deck_id,omitempty"`
GameOutcome string `json:"game_outcome,omitempty"`
PUUID string `json:"puuid,omitempty"`
Factions []string `json:"factions,omitempty"`
// The order in which the players took turns.
OrderOfPlay int `json:"order_of_play,omitempty"`
}
lor-match-v1.PlayerDto
type MatchV1 ¶
type MatchV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*MatchV1) ByID ¶
func (endpoint *MatchV1) ByID(ctx context.Context, route api.RegionalRoute, matchId string) (*MatchV1DTO, error)
Get match by id
Parameters ¶
- route: Route to query.
- matchId
Riot API Reference ¶
type MatchV1DTO ¶
type MatchV1DTO struct {
// Match metadata.
Metadata MatchMetadataV1DTO `json:"metadata"`
// Match info.
Info MatchInfoV1DTO `json:"info"`
}
lor-match-v1.MatchDto
type RankedLeaderboardV1DTO ¶
type RankedLeaderboardV1DTO struct {
// A list of players in Master tier.
Players []RankedPlayerV1DTO `json:"players,omitempty"`
}
lor-ranked-v1.LeaderboardDto
type RankedPlayerV1DTO ¶
type RankedPlayerV1DTO struct {
Name string `json:"name,omitempty"`
// League points.
LP int `json:"lp,omitempty"`
Rank int `json:"rank,omitempty"`
}
lor-ranked-v1.PlayerDto
type RankedV1 ¶
type RankedV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
func (*RankedV1) Leaderboards ¶
func (endpoint *RankedV1) Leaderboards(ctx context.Context, route api.RegionalRoute) (*RankedLeaderboardV1DTO, error)
Get the players in Master tier.
Parameters ¶
- route: Route to query.
Riot API Reference ¶
type StatusContentV1DTO ¶
type StatusContentV1DTO struct {
Content string `json:"content,omitempty"`
Locale string `json:"locale,omitempty"`
}
lor-status-v1.ContentDto
type StatusPlatformDataV1DTO ¶
type StatusPlatformDataV1DTO struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Incidents []StatusV1DTO `json:"incidents,omitempty"`
Locales []string `json:"locales,omitempty"`
Maintenances []StatusV1DTO `json:"maintenances,omitempty"`
}
lor-status-v1.PlatformDataDto
type StatusUpdateV1DTO ¶
type StatusUpdateV1DTO struct {
Author string `json:"author,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
// (Legal values: riotclient, riotstatus, game)
PublishLocations []string `json:"publish_locations,omitempty"`
Translations []StatusContentV1DTO `json:"translations,omitempty"`
ID int `json:"id,omitempty"`
Publish bool `json:"publish,omitempty"`
}
lor-status-v1.UpdateDto
type StatusV1 ¶
type StatusV1 struct {
// contains filtered or unexported fields
}
Riot API Reference ¶
type StatusV1DTO ¶
type StatusV1DTO struct {
ArchiveAt string `json:"archive_at,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
// (Legal values: info, warning, critical)
IncidentSeverity string `json:"incident_severity,omitempty"`
// (Legal values: scheduled, in_progress, complete)
MaintenanceStatus string `json:"maintenance_status,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
// (Legal values: windows, macos, android, ios, ps4, xbone, switch)
Platforms []string `json:"platforms,omitempty"`
Titles []StatusContentV1DTO `json:"titles,omitempty"`
Updates []StatusUpdateV1DTO `json:"updates,omitempty"`
ID int `json:"id,omitempty"`
}
lor-status-v1.StatusDto
Click to show internal directories.
Click to hide internal directories.