lor

package
v0.19.2 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2023 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

This package is used to interact with all Legends of Runeterra endpoints.

  • DeckV1
  • InventoryV1
  • MatchV1
  • RankedV1
  • StatusV1

Note: this package is automatically generated.

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,omitempty"`
	Count string `json:"count,omitempty"`
}

CardDTO data object.

type Client added in v0.19.0 

type Client struct {
	DeckV1      *DeckV1
	InventoryV1 *InventoryV1
	MatchV1     *MatchV1
	RankedV1    *RankedV1
	StatusV1    *StatusV1
}

Note: this struct is automatically generated.

func NewLORClient 

func NewLORClient(client *internal.Client) *Client

Creates a new LOR Client using the internal.Client provided.

type ContentV1DTO added in v0.17.0 

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

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(ctx context.Context, 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(ctx context.Context, 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,omitempty"`
	Name string `json:"name,omitempty"`
	Code string `json:"code,omitempty"`
}

DeckDTO data object.

type InfoV1DTO added in v0.17.0 

type InfoV1DTO struct {
	// (Legal values:  Constructed,  Expeditions,  Tutorial)
	GameMode string `json:"game_mode,omitempty"`
	// (Legal values:  Ranked,  Normal,  AI,  Tutorial,  VanillaTrial,  Singleton,  StandardGauntlet)
	GameType         string        `json:"game_type,omitempty"`
	GameStartTimeUtc string        `json:"game_start_time_utc,omitempty"`
	GameVersion      string        `json:"game_version,omitempty"`
	Players          []PlayerV1DTO `json:"players,omitempty"`
	// Total turns taken by both players.
	TotalTurnCount int32 `json:"total_turn_count,omitempty"`
}

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(ctx context.Context, 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 LeaderboardPlayerV1DTO added in v0.17.0 

type LeaderboardPlayerV1DTO struct {
	Name string `json:"name,omitempty"`
	Rank int32  `json:"rank,omitempty"`
	// League points.
	Lp int32 `json:"lp,omitempty"`
}

PlayerDTO data object.

type LeaderboardV1DTO added in v0.17.0 

type LeaderboardV1DTO struct {
	// A list of players in Master tier.
	Players []PlayerV1DTO `json:"players,omitempty"`
}

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(ctx context.Context, 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(ctx context.Context, 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,omitempty"`
	// Match info.
	Info InfoV1DTO `json:"info,omitempty"`
}

MatchDTO data object.

type MetadataV1DTO added in v0.17.0 

type MetadataV1DTO 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"`
}

MetadataDTO data object.

type NewDeckV1DTO added in v0.17.0 

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

NewDeckDTO data object.

type PlatformDataV1DTO added in v0.17.0 

type PlatformDataV1DTO struct {
	ID           string        `json:"id,omitempty"`
	Name         string        `json:"name,omitempty"`
	Locales      []string      `json:"locales,omitempty"`
	Maintenances []StatusV1DTO `json:"maintenances,omitempty"`
	Incidents    []StatusV1DTO `json:"incidents,omitempty"`
}

PlatformDataDTO data object.

type PlayerV1DTO added in v0.17.0 

type PlayerV1DTO struct {
	PUUID  string `json:"puuid,omitempty"`
	DeckID string `json:"deck_id,omitempty"`
	// Code for the deck played. Refer to LOR documentation for details on deck codes.
	DeckCode    string   `json:"deck_code,omitempty"`
	GameOutcome string   `json:"game_outcome,omitempty"`
	Factions    []string `json:"factions,omitempty"`
	// The order in which the players took turns.
	OrderOfPlay int32 `json:"order_of_play,omitempty"`
}

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(ctx context.Context, 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(ctx context.Context, 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 {
	// (Legal values:  scheduled,  in_progress,  complete)
	MaintenanceStatus string `json:"maintenance_status,omitempty"`
	// (Legal values:  info,  warning,  critical)
	IncidentSeverity string         `json:"incident_severity,omitempty"`
	CreatedAt        string         `json:"created_at,omitempty"`
	ArchiveAt        string         `json:"archive_at,omitempty"`
	UpdatedAt        string         `json:"updated_at,omitempty"`
	Titles           []ContentV1DTO `json:"titles,omitempty"`
	Updates          []UpdateV1DTO  `json:"updates,omitempty"`
	// (Legal values: windows, macos, android, ios, ps4, xbone, switch)
	Platforms []string `json:"platforms,omitempty"`
	ID        int32    `json:"id,omitempty"`
}

StatusDTO data object.

type UpdateV1DTO added in v0.17.0 

type UpdateV1DTO 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     []ContentV1DTO `json:"translations,omitempty"`
	ID               int32          `json:"id,omitempty"`
	Publish          bool           `json:"publish,omitempty"`
}

UpdateDTO data object.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.