client

Documentation

Overview

Package client wraps the API specs into a client

Index

• type Client
  • func New(cfg *config.Config, logger *log.Logger) (*Client, error)
  • func (c *Client) Assignments(ctx context.Context) (*[]api.Assignment2, error)
  • func (c *Client) Campaigns(ctx context.Context) (*[]api.Campaign2, error)
  • func (c *Client) Connect(ctx context.Context) error
  • func (c *Client) Dispatches(ctx context.Context) (*[]api.Dispatch, error)
  • func (c *Client) Planets(ctx context.Context) (*[]api.Planet, error)
  • func (c *Client) War(ctx context.Context) (*api.War, error)
  • func (c *Client) WarID(ctx context.Context) (*api.WarId, error)

Types

type Client

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

Client wraps the generated OpenAPI client

func New

func New(cfg *config.Config, logger *log.Logger) (*Client, error)

New creates a new client instance

func (*Client) Assignments

func (c *Client) Assignments(ctx context.Context) (*[]api.Assignment2, error)

Assignments returns all currently active assignments

func (*Client) Campaigns

func (c *Client) Campaigns(ctx context.Context) (*[]api.Campaign2, error)

Campaigns returns all currently active campaigns

func (*Client) Connect

func (c *Client) Connect(ctx context.Context) error

Connect implements main.ConnectWaiter.

func (*Client) Dispatches

func (c *Client) Dispatches(ctx context.Context) (*[]api.Dispatch, error)

Dispatches returns all currently active dispatches

func (*Client) Planets

func (c *Client) Planets(ctx context.Context) (*[]api.Planet, error)

Planets returns all planets in the current war

func (*Client) War

func (c *Client) War(ctx context.Context) (*api.War, error)

War returns the current war

func (*Client) WarID

func (c *Client) WarID(ctx context.Context) (*api.WarId, error)

WarID returns the ID of the current war