api

Documentation

Index

• Constants
• Variables
• type Cluster
• type ContentDTO
• type Division
• type EquinoxConfig
  • func (c *EquinoxConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error
• type ErrorResponse
  • func (e ErrorResponse) Error() string
• type Game
• type IncidentSeverity
• type LogLevel
• type PlainTextResponse
• type Platform
• type PlatformDataDTO
• type PublishLocation
• type Status
• type StatusDTO
• type UpdateDTO

Constants

const (
	// Base API URL format
	BaseURLFormat = "https://%s.api.riotgames.com"
)

Variables

var (
	NotFoundError = ErrorResponse{
		Status: Status{
			Message:    "Not Found",
			StatusCode: http.StatusNotFound,
		},
	}

	UnauthorizedError = ErrorResponse{
		Status: Status{
			Message:    "Unauthorized",
			StatusCode: http.StatusUnauthorized,
		},
	}

	ForbiddenError = ErrorResponse{
		Status: Status{
			Message:    "Forbidden",
			StatusCode: http.StatusForbidden,
		},
	}

	RateLimitedError = ErrorResponse{
		Status: Status{
			Message:    "Rate limited",
			StatusCode: http.StatusTooManyRequests,
		},
	}
)

Types

type Cluster

type Cluster string

const (
	Americas Cluster = "americas"
	Europe   Cluster = "europe"
	Asia     Cluster = "asia"
)

Riot API clusters

type ContentDTO

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

type Division

type Division string

const (
	I   Division = "I"
	II  Division = "II"
	III Division = "III"
	IV  Division = "IV"
)

type EquinoxConfig

type EquinoxConfig struct {
	// Riot API Key.
	Key string
	// Cluster name, using the nearest cluster to you is recommended.
	Cluster Cluster
	// Log level. Default: api.FatalLevel
	LogLevel LogLevel
	// Timeout for http.Request in seconds, 0 disables it. Default: 10
	Timeout time.Duration
	// Retry request if it returns a 429 status code. Default: true
	Retry bool
}

An config object for the EquinoxClient.

func (*EquinoxConfig) MarshalLogObject

func (c *EquinoxConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error

type ErrorResponse

type ErrorResponse struct {
	Status Status `json:"status"`
}

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

type Game

type Game string

const (
	LOR Game = "lor"
	VAL Game = "val"
)

type IncidentSeverity

type IncidentSeverity string

const (
	InfoSeverity     IncidentSeverity = "info"
	WarningSeverity  IncidentSeverity = "warning"
	CriticalSeverity IncidentSeverity = "critical"
)

type LogLevel

type LogLevel int8

const (
	DebugLevel LogLevel = -1
	InfoLevel  LogLevel = 0
	WarnLevel  LogLevel = 1
	ErrorLevel LogLevel = 2
	FatalLevel LogLevel = 5
)

type PlainTextResponse

type PlainTextResponse struct {
	Response any `json:"response"`
}

type Platform

type Platform string

const (
	WindowsPlatform Platform = "windows"
	MacOSPlatform   Platform = "macos"
	AndroidPlatform Platform = "android"
	IOSPlatform     Platform = "ios"
	PS4Platform     Platform = "ps4"
	XboxOnePlatform Platform = "xbone"
	SwitchPlatform  Platform = "switch"
)

type PlatformDataDTO

type PlatformDataDTO struct {
	ID           string      `json:"id"`
	Name         string      `json:"name"`
	Locales      []string    `json:"locales"`
	Maintenances []StatusDTO `json:"maintenances"`
	Incidents    []StatusDTO `json:"incidents"`
}

type PublishLocation

type PublishLocation string

const (
	RiotClientLocation PublishLocation = "riotclient"
	RiotStatusLocation PublishLocation = "riotstatus"
	GameLocation       PublishLocation = "game"
)

type Status

type Status struct {
	Message    string `json:"message"`
	StatusCode int    `json:"status_code"`
}

type StatusDTO

type StatusDTO struct {
	ArchiveAt         time.Time        `json:"archive_at"`
	Titles            []ContentDTO     `json:"titles"`
	UpdatedAt         time.Time        `json:"updated_at"`
	IncidentSeverity  IncidentSeverity `json:"incident_severity"`
	Platforms         []Platform       `json:"platforms"`
	Updates           []UpdateDTO      `json:"updates"`
	CreatedAt         time.Time        `json:"created_at"`
	ID                int              `json:"id"`
	MaintenanceStatus string           `json:"maintenance_status"`
}

type UpdateDTO

type UpdateDTO struct {
	UpdatedAt        time.Time         `json:"updated_at"`
	Translations     []ContentDTO      `json:"translations"`
	Author           string            `json:"author"`
	Publish          bool              `json:"publish"`
	CreatedAt        time.Time         `json:"created_at"`
	ID               int               `json:"id"`
	PublishLocations []PublishLocation `json:"publish_locations"`
}