lor

package
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 13, 2023 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

This package is used to interact with LOR endpoints.

Automatically generated package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CardV1DTO added in v0.17.0

type CardV1DTO struct {
	Code  string `json:"code"`
	Count string `json:"count"`
}

CardDTO data object.

type ContentV1DTO added in v0.17.0

type ContentV1DTO struct {
	Locale  string `json:"locale"`
	Content string `json:"content"`
}

ContentDTO data object.

type DeckV1 added in v0.17.0

type DeckV1 struct {
	// contains filtered or unexported fields
}

Riot API Reference

lor-deck-v1

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

lor-deck-v1.createDeck

Note: this method is automatically generated.

func (*DeckV1) Decks added in v0.17.0

func (e *DeckV1) Decks(route api.RegionalRoute, authorization string) ([]DeckV1DTO, error)

Get a list of the calling user's decks.

Parameters

  • `route` - Route to query.
  • `authorization` (required, in header)

Riot API Reference

lor-deck-v1.getDecks

Note: this method is automatically generated.

type DeckV1DTO added in v0.17.0

type DeckV1DTO struct {
	Id   string `json:"id"`
	Name string `json:"name"`
	Code string `json:"code"`
}

DeckDTO data object.

type InfoV1DTO added in v0.17.0

type InfoV1DTO struct {
	// (Legal values:  Constructed,  Expeditions,  Tutorial)
	Game_mode string `json:"game_mode"`
	// (Legal values:  Ranked,  Normal,  AI,  Tutorial,  VanillaTrial,  Singleton,  StandardGauntlet)
	Game_type           string        `json:"game_type"`
	Game_start_time_utc string        `json:"game_start_time_utc"`
	Game_version        string        `json:"game_version"`
	Players             []PlayerV1DTO `json:"players"`
	// Total turns taken by both players.
	Total_turn_count 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

lor-inventory-v1

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

lor-inventory-v1.getCards

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

lor-match-v1

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

lor-match-v1.getMatch

Note: this method is automatically generated.

func (*MatchV1) ListByPUUID added in v0.17.0

func (e *MatchV1) ListByPUUID(route api.RegionalRoute, puuid string) ([]string, error)

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.
	Data_version string `json:"data_version"`
	// Match id.
	Match_id string `json:"match_id"`
	// A list of participant PUUIDs.
	Participants []string `json:"participants"`
}

MetadataDTO data object.

type NewDeckV1DTO added in v0.17.0

type NewDeckV1DTO struct {
	Name string `json:"name"`
	Code string `json:"code"`
}

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"`
	Deck_id string `json:"deck_id"`
	// Code for the deck played. Refer to LOR documentation for details on deck codes.
	Deck_code    string   `json:"deck_code"`
	Factions     []string `json:"factions"`
	Game_outcome string   `json:"game_outcome"`
	// The order in which the players took turns.
	Order_of_play 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

lor-ranked-v1

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

lor-ranked-v1.getLeaderboards

Note: this method is automatically generated.

type StatusV1 added in v0.17.0

type StatusV1 struct {
	// contains filtered or unexported fields
}

Riot API Reference

lor-status-v1

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

lor-status-v1.getPlatformData

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)
	Maintenance_status string `json:"maintenance_status"`
	// (Legal values:  info,  warning,  critical)
	Incident_severity string         `json:"incident_severity"`
	Titles            []ContentV1DTO `json:"titles"`
	Updates           []UpdateV1DTO  `json:"updates"`
	Created_at        string         `json:"created_at"`
	Archive_at        string         `json:"archive_at"`
	Updated_at        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)
	Publish_locations []string       `json:"publish_locations"`
	Translations      []ContentV1DTO `json:"translations"`
	Created_at        string         `json:"created_at"`
	Updated_at        string         `json:"updated_at"`
}

UpdateDTO data object.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL