api

package

v0.0.0-...-5bf8448 Latest Latest Go to latest Published: Aug 1, 2023 License: GPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package api allows interaction with the SoT API

This section is empty.

This section is empty.

This section is empty.

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

Client allows querying SoT API endpoints

func NewClient(ratToken string, locale language.Tag, logger *slog.Logger) *Client

NewClient creates a new API client with the specified token

func (c *Client) GetBalance() (b structs.Balance, err error)

GetBalance retrieves the balance of in-game currencies for the pirate

func (c *Client) GetHealth() (h structs.Health, err error)

GetHealth retrieves data about the status of the API

func (c *Client) GetReputation() (r structs.Reputation, err error)

GetReputation retrieves the reputation for all available campaigns

func (c *Client) GetSeason() (s structs.Season, err error)

GetSeason retrieves data about the current active season

type RequestError struct {
	StatusCode int
	Err        error
}

RequestError is returned as error when a non-200 HTTP response is received

func (r RequestError) Error() string

Path	Synopsis
structs Package structs contains structs for API responses	Package structs contains structs for API responses