api

Documentation

Index

• Constants
• Variables
• type Cluster
• type Division
• type EquinoxConfig
  • func (c *EquinoxConfig) MarshalLogObject(encoder zapcore.ObjectEncoder) error
• type ErrorResponse
  • func (e ErrorResponse) Error() string
• type Game
• type LogLevel
• type Status

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"
	Esports  Cluster = "esports"
	Asia     Cluster = "asia"
)

Riot API clusters

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 LogLevel

type LogLevel int8

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

type Status

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