twhelp

Documentation

Index

• type APIError
  • func (e APIError) Error() string
• type Client
  • func NewClient(baseURL *url.URL, opts ...ClientOption) *Client
  • func (c *Client) GetServer(ctx context.Context, version, server string) (Server, error)
  • func (c *Client) GetTribeByID(ctx context.Context, version, server string, id int64) (Tribe, error)
  • func (c *Client) ListEnnoblements(ctx context.Context, version, server string, ...) ([]Ennoblement, error)
  • func (c *Client) ListServers(ctx context.Context, version string, params ListServersQueryParams) ([]Server, error)
  • func (c *Client) ListTribes(ctx context.Context, version, server string, params ListTribesQueryParams) ([]Tribe, error)
  • func (c *Client) ListVersions(ctx context.Context) ([]Version, error)
  • func (c *Client) ListVillages(ctx context.Context, version, server string, params ListVillagesQueryParams) ([]Village, error)
• type ClientOption
  • func WithHTTPClient(hc *http.Client) ClientOption
  • func WithRateLimiter(rl *rate.Limiter) ClientOption
  • func WithUserAgent(ua string) ClientOption
• type Ennoblement
• type EnnoblementSort
  • func (s EnnoblementSort) String() string
• type ErrorCode
  • func (c ErrorCode) String() string
• type ListEnnoblementsQueryParams
• type ListServersQueryParams
• type ListTribesQueryParams
• type ListVillagesQueryParams
• type NullBool
• type NullPlayerMeta
  • func (p NullPlayerMeta) MarshalJSON() ([]byte, error)
  • func (p *NullPlayerMeta) UnmarshalJSON(data []byte) error
• type NullTribeMeta
  • func (t NullTribeMeta) MarshalJSON() ([]byte, error)
  • func (t *NullTribeMeta) UnmarshalJSON(data []byte) error
• type PlayerMeta
• type Server
• type Tribe
• type TribeMeta
• type Version
• type Village
• type VillageMeta

Types

type APIError

type APIError struct {
	Code    ErrorCode `json:"code"`
	Message string    `json:"message"`
}

func (APIError) Error

func (e APIError) Error() string

type Client

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

func NewClient

func NewClient(baseURL *url.URL, opts ...ClientOption) *Client

func (*Client) GetServer

func (c *Client) GetServer(ctx context.Context, version, server string) (Server, error)

func (*Client) GetTribeByID

func (c *Client) GetTribeByID(ctx context.Context, version, server string, id int64) (Tribe, error)

func (*Client) ListEnnoblements

func (c *Client) ListEnnoblements(
	ctx context.Context,
	version, server string,
	params ListEnnoblementsQueryParams,
) ([]Ennoblement, error)

func (*Client) ListServers

func (c *Client) ListServers(
	ctx context.Context,
	version string,
	params ListServersQueryParams,
) ([]Server, error)

func (*Client) ListTribes

func (c *Client) ListTribes(
	ctx context.Context,
	version, server string,
	params ListTribesQueryParams,
) ([]Tribe, error)

func (*Client) ListVersions

func (c *Client) ListVersions(ctx context.Context) ([]Version, error)

func (*Client) ListVillages

func (c *Client) ListVillages(
	ctx context.Context,
	version, server string,
	params ListVillagesQueryParams,
) ([]Village, error)

type ClientOption

type ClientOption func(c *Client)

func WithHTTPClient

func WithHTTPClient(hc *http.Client) ClientOption

func WithRateLimiter

func WithRateLimiter(rl *rate.Limiter) ClientOption

func WithUserAgent

func WithUserAgent(ua string) ClientOption

type Ennoblement

type Ennoblement struct {
	ID        int64          `json:"id"`
	Village   VillageMeta    `json:"village"`
	NewOwner  NullPlayerMeta `json:"newOwner"`
	CreatedAt time.Time      `json:"createdAt"`
}

type EnnoblementSort

type EnnoblementSort string

const (
	EnnoblementSortCreatedAtASC EnnoblementSort = "createdAt:ASC"
)

func (EnnoblementSort) String

func (s EnnoblementSort) String() string

type ErrorCode

type ErrorCode string

const (
	ErrorCodeInternalServerError ErrorCode = "internal-server-error"
	ErrorCodeEntityNotFound      ErrorCode = "entity-not-found"
	ErrorCodeValidationError     ErrorCode = "validation-error"
	ErrorCodeRouteNotFound       ErrorCode = "route-not-found"
	ErrorCodeMethodNotAllowed    ErrorCode = "method-not-allowed"
)

func (ErrorCode) String

func (c ErrorCode) String() string

type ListEnnoblementsQueryParams

type ListEnnoblementsQueryParams struct {
	Limit  int32
	Offset int32
	Since  time.Time
	Sort   []EnnoblementSort
}

type ListServersQueryParams

type ListServersQueryParams struct {
	Limit  int32
	Offset int32
	Open   NullBool
}

type ListTribesQueryParams

type ListTribesQueryParams struct {
	Limit   int32
	Offset  int32
	Tags    []string
	Deleted NullBool
}

type ListVillagesQueryParams

type ListVillagesQueryParams struct {
	Limit  int32
	Offset int32
	Coords []string
}

type NullBool

type NullBool struct {
	Bool  bool
	Valid bool // Valid is true if Bool is not NULL
}

type NullPlayerMeta

type NullPlayerMeta struct {
	Player PlayerMeta
	Valid  bool
}

func (NullPlayerMeta) MarshalJSON

func (p NullPlayerMeta) MarshalJSON() ([]byte, error)

func (*NullPlayerMeta) UnmarshalJSON

func (p *NullPlayerMeta) UnmarshalJSON(data []byte) error

type NullTribeMeta

type NullTribeMeta struct {
	Tribe TribeMeta
	Valid bool
}

func (NullTribeMeta) MarshalJSON

func (t NullTribeMeta) MarshalJSON() ([]byte, error)

func (*NullTribeMeta) UnmarshalJSON

func (t *NullTribeMeta) UnmarshalJSON(data []byte) error

type PlayerMeta

type PlayerMeta struct {
	ID         int64         `json:"id"`
	Name       string        `json:"name"`
	ProfileURL string        `json:"profileUrl"`
	Tribe      NullTribeMeta `json:"tribe"`
}

type Server

type Server struct {
	Key  string `json:"key"`
	URL  string `json:"url"`
	Open bool   `json:"open"`
}

type Tribe

type Tribe struct {
	ID         int64     `json:"id"`
	Tag        string    `json:"tag"`
	Name       string    `json:"name"`
	ProfileURL string    `json:"profileUrl"`
	DeletedAt  time.Time `json:"deletedAt"`
}

type TribeMeta

type TribeMeta struct {
	ID         int64  `json:"id"`
	Name       string `json:"name"`
	Tag        string `json:"tag"`
	ProfileURL string `json:"profileUrl"`
}

type Version

type Version struct {
	Code     string `json:"code"`
	Host     string `json:"host"`
	Name     string `json:"name"`
	Timezone string `json:"timezone"`
}

type Village

type Village struct {
	ID         int64          `json:"id"`
	FullName   string         `json:"fullName"`
	ProfileURL string         `json:"profileUrl"`
	Points     int64          `json:"points"`
	X          int64          `json:"x"`
	Y          int64          `json:"y"`
	Player     NullPlayerMeta `json:"player"`
}

type VillageMeta

type VillageMeta struct {
	ID         int64          `json:"id"`
	FullName   string         `json:"fullName"`
	ProfileURL string         `json:"profileUrl"`
	Player     NullPlayerMeta `json:"player"`
}