api

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 6, 2024 License: GPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.

Package api contains interfaces for the Helldivers 2 API, generated from OpenAPI spec

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetApiV1AssignmentsAllRequest 

func NewGetApiV1AssignmentsAllRequest(server string) (*http.Request, error)

NewGetApiV1AssignmentsAllRequest generates requests for GetApiV1AssignmentsAll

func NewGetApiV1AssignmentsRequest 

func NewGetApiV1AssignmentsRequest(server string, index int64) (*http.Request, error)

NewGetApiV1AssignmentsRequest generates requests for GetApiV1Assignments

func NewGetApiV1CampaignsAllRequest 

func NewGetApiV1CampaignsAllRequest(server string) (*http.Request, error)

NewGetApiV1CampaignsAllRequest generates requests for GetApiV1CampaignsAll

func NewGetApiV1CampaignsRequest 

func NewGetApiV1CampaignsRequest(server string, index int32) (*http.Request, error)

NewGetApiV1CampaignsRequest generates requests for GetApiV1Campaigns

func NewGetApiV1DispatchesAllRequest 

func NewGetApiV1DispatchesAllRequest(server string) (*http.Request, error)

NewGetApiV1DispatchesAllRequest generates requests for GetApiV1DispatchesAll

func NewGetApiV1DispatchesRequest 

func NewGetApiV1DispatchesRequest(server string, index int32) (*http.Request, error)

NewGetApiV1DispatchesRequest generates requests for GetApiV1Dispatches

func NewGetApiV1PlanetEventsRequest 

func NewGetApiV1PlanetEventsRequest(server string) (*http.Request, error)

NewGetApiV1PlanetEventsRequest generates requests for GetApiV1PlanetEvents

func NewGetApiV1PlanetsAllRequest 

func NewGetApiV1PlanetsAllRequest(server string) (*http.Request, error)

NewGetApiV1PlanetsAllRequest generates requests for GetApiV1PlanetsAll

func NewGetApiV1PlanetsRequest 

func NewGetApiV1PlanetsRequest(server string, index int32) (*http.Request, error)

NewGetApiV1PlanetsRequest generates requests for GetApiV1Planets

func NewGetApiV1Steam2Request 

func NewGetApiV1Steam2Request(server string, gid string) (*http.Request, error)

NewGetApiV1Steam2Request generates requests for GetApiV1Steam2

func NewGetApiV1SteamRequest 

func NewGetApiV1SteamRequest(server string) (*http.Request, error)

NewGetApiV1SteamRequest generates requests for GetApiV1Steam

func NewGetApiV1WarRequest 

func NewGetApiV1WarRequest(server string) (*http.Request, error)

NewGetApiV1WarRequest generates requests for GetApiV1War

func NewGetRawApiNewsFeed801Request 

func NewGetRawApiNewsFeed801Request(server string) (*http.Request, error)

NewGetRawApiNewsFeed801Request generates requests for GetRawApiNewsFeed801

func NewGetRawApiStatsWar801SummaryRequest 

func NewGetRawApiStatsWar801SummaryRequest(server string) (*http.Request, error)

NewGetRawApiStatsWar801SummaryRequest generates requests for GetRawApiStatsWar801Summary

func NewGetRawApiV2AssignmentWar801Request 

func NewGetRawApiV2AssignmentWar801Request(server string) (*http.Request, error)

NewGetRawApiV2AssignmentWar801Request generates requests for GetRawApiV2AssignmentWar801

func NewGetRawApiWarSeason801StatusRequest 

func NewGetRawApiWarSeason801StatusRequest(server string) (*http.Request, error)

NewGetRawApiWarSeason801StatusRequest generates requests for GetRawApiWarSeason801Status

func NewGetRawApiWarSeason801WarInfoRequest 

func NewGetRawApiWarSeason801WarInfoRequest(server string) (*http.Request, error)

NewGetRawApiWarSeason801WarInfoRequest generates requests for GetRawApiWarSeason801WarInfo

func NewGetRawApiWarSeasonCurrentWarIDRequest 

func NewGetRawApiWarSeasonCurrentWarIDRequest(server string) (*http.Request, error)

NewGetRawApiWarSeasonCurrentWarIDRequest generates requests for GetRawApiWarSeasonCurrentWarID

func NewGetRequest added in v0.0.3 

func NewGetRequest(server string) (*http.Request, error)

NewGetRequest generates requests for Get

Types

type Assignment 

type Assignment struct {
	// ExpiresIn The amount of seconds until this assignment expires.
	ExpiresIn *int64 `json:"expiresIn,omitempty"`

	// Id32 Internal identifier of this assignment.
	Id32 *int64 `json:"id32,omitempty"`

	// Progress A list of numbers, how they represent progress is unknown.
	Progress *[]int32 `json:"progress,omitempty"`

	// Setting Contains detailed information on this assignment like briefing, rewards, ...
	Setting *Assignment_Setting `json:"setting,omitempty"`
}

Assignment Represents an assignment given from Super Earth to the Helldivers.

type Assignment2 

type Assignment2 struct {
	// Briefing A long form description of the assignment, usually contains context.
	Briefing *Assignment2_Briefing `json:"briefing,omitempty"`

	// Description A very short summary of the description.
	Description *Assignment2_Description `json:"description,omitempty"`

	// Expiration The date when the assignment will expire.
	Expiration *time.Time `json:"expiration,omitempty"`

	// Id The unique identifier of this assignment.
	Id *int64 `json:"id,omitempty"`

	// Progress A list of numbers, how they represent progress is unknown.
	Progress *[]int32 `json:"progress,omitempty"`

	// Reward The reward for completing the assignment.
	Reward *Assignment2_Reward `json:"reward,omitempty"`

	// Tasks A list of tasks that need to be completed for this assignment.
	Tasks *[]Task2 `json:"tasks,omitempty"`

	// Title The title of the assignment.
	Title *Assignment2_Title `json:"title,omitempty"`
}

Assignment2 Represents an assignment given by Super Earth to the community. This is also known as 'Major Order's in the game.

type Assignment2Briefing0 added in v0.0.3 

type Assignment2Briefing0 = string

Assignment2Briefing0 defines model for .

type Assignment2Briefing1 added in v0.0.3 

type Assignment2Briefing1 struct {
	// DeDE The message in de-DE
	DeDE *string `json:"de-DE,omitempty"`

	// EnUS The message in en-US
	EnUS *string `json:"en-US,omitempty"`

	// EsES The message in es-ES
	EsES *string `json:"es-ES,omitempty"`

	// FrFR The message in fr-FR
	FrFR *string `json:"fr-FR,omitempty"`

	// ItIT The message in it-IT
	ItIT *string `json:"it-IT,omitempty"`

	// PlPL The message in pl-PL
	PlPL *string `json:"pl-PL,omitempty"`

	// RuRU The message in ru-RU
	RuRU *string `json:"ru-RU,omitempty"`

	// ZhHans The message in zh-Hans
	ZhHans *string `json:"zh-Hans,omitempty"`

	// ZhHant The message in zh-Hant
	ZhHant *string `json:"zh-Hant,omitempty"`
}

Assignment2Briefing1 When passing in ivl-IV as Accept-Language, all available languages are returned

type Assignment2Description0 added in v0.0.3 

type Assignment2Description0 = string

Assignment2Description0 defines model for .

type Assignment2Description1 added in v0.0.3 

type Assignment2Description1 struct {
	// DeDE The message in de-DE
	DeDE *string `json:"de-DE,omitempty"`

	// EnUS The message in en-US
	EnUS *string `json:"en-US,omitempty"`

	// EsES The message in es-ES
	EsES *string `json:"es-ES,omitempty"`

	// FrFR The message in fr-FR
	FrFR *string `json:"fr-FR,omitempty"`

	// ItIT The message in it-IT
	ItIT *string `json:"it-IT,omitempty"`

	// PlPL The message in pl-PL
	PlPL *string `json:"pl-PL,omitempty"`

	// RuRU The message in ru-RU
	RuRU *string `json:"ru-RU,omitempty"`

	// ZhHans The message in zh-Hans
	ZhHans *string `json:"zh-Hans,omitempty"`

	// ZhHant The message in zh-Hant
	ZhHant *string `json:"zh-Hant,omitempty"`
}

Assignment2Description1 When passing in ivl-IV as Accept-Language, all available languages are returned

type Assignment2Title0 added in v0.0.3 

type Assignment2Title0 = string

Assignment2Title0 defines model for .

type Assignment2Title1 added in v0.0.3 

type Assignment2Title1 struct {
	// DeDE The message in de-DE
	DeDE *string `json:"de-DE,omitempty"`

	// EnUS The message in en-US
	EnUS *string `json:"en-US,omitempty"`

	// EsES The message in es-ES
	EsES *string `json:"es-ES,omitempty"`

	// FrFR The message in fr-FR
	FrFR *string `json:"fr-FR,omitempty"`

	// ItIT The message in it-IT
	ItIT *string `json:"it-IT,omitempty"`

	// PlPL The message in pl-PL
	PlPL *string `json:"pl-PL,omitempty"`

	// RuRU The message in ru-RU
	RuRU *string `json:"ru-RU,omitempty"`

	// ZhHans The message in zh-Hans
	ZhHans *string `json:"zh-Hans,omitempty"`

	// ZhHant The message in zh-Hant
	ZhHant *string `json:"zh-Hant,omitempty"`
}

Assignment2Title1 When passing in ivl-IV as Accept-Language, all available languages are returned

type Assignment2_Briefing added in v0.0.3 

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

Assignment2_Briefing A long form description of the assignment, usually contains context.

func (Assignment2_Briefing) AsAssignment2Briefing0 added in v0.0.3 

func (t Assignment2_Briefing) AsAssignment2Briefing0() (Assignment2Briefing0, error)

AsAssignment2Briefing0 returns the union data inside the Assignment2_Briefing as a Assignment2Briefing0

func (Assignment2_Briefing) AsAssignment2Briefing1 added in v0.0.3 

func (t Assignment2_Briefing) AsAssignment2Briefing1() (Assignment2Briefing1, error)

AsAssignment2Briefing1 returns the union data inside the Assignment2_Briefing as a Assignment2Briefing1

func (*Assignment2_Briefing) FromAssignment2Briefing0 added in v0.0.3 

func (t *Assignment2_Briefing) FromAssignment2Briefing0(v Assignment2Briefing0) error

FromAssignment2Briefing0 overwrites any union data inside the Assignment2_Briefing as the provided Assignment2Briefing0

func (*Assignment2_Briefing) FromAssignment2Briefing1 added in v0.0.3 

func (t *Assignment2_Briefing) FromAssignment2Briefing1(v Assignment2Briefing1) error

FromAssignment2Briefing1 overwrites any union data inside the Assignment2_Briefing as the provided Assignment2Briefing1

func (Assignment2_Briefing) MarshalJSON added in v0.0.3 

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

func (*Assignment2_Briefing) MergeAssignment2Briefing0 added in v0.0.3 

func (t *Assignment2_Briefing) MergeAssignment2Briefing0(v Assignment2Briefing0) error

MergeAssignment2Briefing0 performs a merge with any union data inside the Assignment2_Briefing, using the provided Assignment2Briefing0

func (*Assignment2_Briefing) MergeAssignment2Briefing1 added in v0.0.3 

func (t *Assignment2_Briefing) MergeAssignment2Briefing1(v Assignment2Briefing1) error

MergeAssignment2Briefing1 performs a merge with any union data inside the Assignment2_Briefing, using the provided Assignment2Briefing1

func (*Assignment2_Briefing) UnmarshalJSON added in v0.0.3 

func (t *Assignment2_Briefing) UnmarshalJSON(b []byte) error

type Assignment2_Description added in v0.0.3 

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

Assignment2_Description A very short summary of the description.

func (Assignment2_Description) AsAssignment2Description0 added in v0.0.3 

func (t Assignment2_Description) AsAssignment2Description0() (Assignment2Description0, error)

AsAssignment2Description0 returns the union data inside the Assignment2_Description as a Assignment2Description0

func (Assignment2_Description) AsAssignment2Description1 added in v0.0.3 

func (t Assignment2_Description) AsAssignment2Description1() (Assignment2Description1, error)

AsAssignment2Description1 returns the union data inside the Assignment2_Description as a Assignment2Description1

func (*Assignment2_Description) FromAssignment2Description0 added in v0.0.3 

func (t *Assignment2_Description) FromAssignment2Description0(v Assignment2Description0) error

FromAssignment2Description0 overwrites any union data inside the Assignment2_Description as the provided Assignment2Description0

func (*Assignment2_Description) FromAssignment2Description1 added in v0.0.3 

func (t *Assignment2_Description) FromAssignment2Description1(v Assignment2Description1) error

FromAssignment2Description1 overwrites any union data inside the Assignment2_Description as the provided Assignment2Description1

func (Assignment2_Description) MarshalJSON added in v0.0.3 

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

func (*Assignment2_Description) MergeAssignment2Description0 added in v0.0.3 

func (t *Assignment2_Description) MergeAssignment2Description0(v Assignment2Description0) error

MergeAssignment2Description0 performs a merge with any union data inside the Assignment2_Description, using the provided Assignment2Description0

func (*Assignment2_Description) MergeAssignment2Description1 added in v0.0.3 

func (t *Assignment2_Description) MergeAssignment2Description1(v Assignment2Description1) error

MergeAssignment2Description1 performs a merge with any union data inside the Assignment2_Description, using the provided Assignment2Description1

func (*Assignment2_Description) UnmarshalJSON added in v0.0.3 

func (t *Assignment2_Description) UnmarshalJSON(b []byte) error

type Assignment2_Reward 

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

Assignment2_Reward The reward for completing the assignment.

func (Assignment2_Reward) AsReward2 

func (t Assignment2_Reward) AsReward2() (Reward2, error)

AsReward2 returns the union data inside the Assignment2_Reward as a Reward2

func (*Assignment2_Reward) FromReward2 

func (t *Assignment2_Reward) FromReward2(v Reward2) error

FromReward2 overwrites any union data inside the Assignment2_Reward as the provided Reward2

func (Assignment2_Reward) MarshalJSON 

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

func (*Assignment2_Reward) MergeReward2 

func (t *Assignment2_Reward) MergeReward2(v Reward2) error

MergeReward2 performs a merge with any union data inside the Assignment2_Reward, using the provided Reward2

func (*Assignment2_Reward) UnmarshalJSON 

func (t *Assignment2_Reward) UnmarshalJSON(b []byte) error

type Assignment2_Title added in v0.0.3 

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

Assignment2_Title The title of the assignment.

func (Assignment2_Title) AsAssignment2Title0 added in v0.0.3 

func (t Assignment2_Title) AsAssignment2Title0() (Assignment2Title0, error)

AsAssignment2Title0 returns the union data inside the Assignment2_Title as a Assignment2Title0

func (Assignment2_Title) AsAssignment2Title1 added in v0.0.3 

func (t Assignment2_Title) AsAssignment2Title1() (Assignment2Title1, error)

AsAssignment2Title1 returns the union data inside the Assignment2_Title as a Assignment2Title1

func (*Assignment2_Title) FromAssignment2Title0 added in v0.0.3 

func (t *Assignment2_Title) FromAssignment2Title0(v Assignment2Title0) error

FromAssignment2Title0 overwrites any union data inside the Assignment2_Title as the provided Assignment2Title0

func (*Assignment2_Title) FromAssignment2Title1 added in v0.0.3 

func (t *Assignment2_Title) FromAssignment2Title1(v Assignment2Title1) error

FromAssignment2Title1 overwrites any union data inside the Assignment2_Title as the provided Assignment2Title1

func (Assignment2_Title) MarshalJSON added in v0.0.3 

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

func (*Assignment2_Title) MergeAssignment2Title0 added in v0.0.3 

func (t *Assignment2_Title) MergeAssignment2Title0(v Assignment2Title0) error

MergeAssignment2Title0 performs a merge with any union data inside the Assignment2_Title, using the provided Assignment2Title0

func (*Assignment2_Title) MergeAssignment2Title1 added in v0.0.3 

func (t *Assignment2_Title) MergeAssignment2Title1(v Assignment2Title1) error

MergeAssignment2Title1 performs a merge with any union data inside the Assignment2_Title, using the provided Assignment2Title1

func (*Assignment2_Title) UnmarshalJSON added in v0.0.3 

func (t *Assignment2_Title) UnmarshalJSON(b []byte) error

type Assignment_Setting 

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

Assignment_Setting Contains detailed information on this assignment like briefing, rewards, ...

func (Assignment_Setting) AsSetting 

func (t Assignment_Setting) AsSetting() (Setting, error)

AsSetting returns the union data inside the Assignment_Setting as a Setting

func (*Assignment_Setting) FromSetting 

func (t *Assignment_Setting) FromSetting(v Setting) error

FromSetting overwrites any union data inside the Assignment_Setting as the provided Setting

func (Assignment_Setting) MarshalJSON 

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

func (*Assignment_Setting) MergeSetting 

func (t *Assignment_Setting) MergeSetting(v Setting) error

MergeSetting performs a merge with any union data inside the Assignment_Setting, using the provided Setting

func (*Assignment_Setting) UnmarshalJSON 

func (t *Assignment_Setting) UnmarshalJSON(b []byte) error

type Biome 

type Biome struct {
	// Description A human-readable description of the biome.
	Description *string `json:"description,omitempty"`

	// Name The name of this biome.
	Name *string `json:"name,omitempty"`
}

Biome Represents information about a biome of a planet.

type Campaign 

type Campaign struct {
	// Count A numerical count, the amount of campaigns the planet has seen.
	Count *int32 `json:"count,omitempty"`

	// Id The identifier of this campaign.
	Id *int32 `json:"id,omitempty"`

	// PlanetIndex The Index of the planet this campaign refers to.
	PlanetIndex *int32 `json:"planetIndex,omitempty"`

	// Type A numerical type, indicates the type of campaign (see helldivers-2/json).
	Type *int32 `json:"type,omitempty"`
}

Campaign Contains information of ongoing campaigns.

type Campaign2 

type Campaign2 struct {
	// Count Indicates how many campaigns have already been fought on this Planet.
	Count *int32 `json:"count,omitempty"`

	// Id The unique identifier of this Campaign.
	Id *int32 `json:"id,omitempty"`

	// Planet The planet on which this campaign is being fought.
	Planet *Campaign2_Planet `json:"planet,omitempty"`

	// Type The type of campaign, this should be mapped onto an enum.
	Type *int32 `json:"type,omitempty"`
}

Campaign2 Represents an ongoing campaign on a planet.

type Campaign2_Planet 

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

Campaign2_Planet The planet on which this campaign is being fought.

func (Campaign2_Planet) AsPlanet 

func (t Campaign2_Planet) AsPlanet() (Planet, error)

AsPlanet returns the union data inside the Campaign2_Planet as a Planet

func (*Campaign2_Planet) FromPlanet 

func (t *Campaign2_Planet) FromPlanet(v Planet) error

FromPlanet overwrites any union data inside the Campaign2_Planet as the provided Planet

func (Campaign2_Planet) MarshalJSON 

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

func (*Campaign2_Planet) MergePlanet 

func (t *Campaign2_Planet) MergePlanet(v Planet) error

MergePlanet performs a merge with any union data inside the Campaign2_Planet, using the provided Planet

func (*Campaign2_Planet) UnmarshalJSON 

func (t *Campaign2_Planet) UnmarshalJSON(b []byte) error

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) Get added in v0.0.3 

func (c *Client) Get(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1Assignments 

func (c *Client) GetApiV1Assignments(ctx context.Context, index int64, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1AssignmentsAll 

func (c *Client) GetApiV1AssignmentsAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1Campaigns 

func (c *Client) GetApiV1Campaigns(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1CampaignsAll 

func (c *Client) GetApiV1CampaignsAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1Dispatches 

func (c *Client) GetApiV1Dispatches(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1DispatchesAll 

func (c *Client) GetApiV1DispatchesAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1PlanetEvents 

func (c *Client) GetApiV1PlanetEvents(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1Planets 

func (c *Client) GetApiV1Planets(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1PlanetsAll 

func (c *Client) GetApiV1PlanetsAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1Steam 

func (c *Client) GetApiV1Steam(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1Steam2 

func (c *Client) GetApiV1Steam2(ctx context.Context, gid string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiV1War 

func (c *Client) GetApiV1War(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRawApiNewsFeed801 

func (c *Client) GetRawApiNewsFeed801(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRawApiStatsWar801Summary 

func (c *Client) GetRawApiStatsWar801Summary(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRawApiV2AssignmentWar801 

func (c *Client) GetRawApiV2AssignmentWar801(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRawApiWarSeason801Status 

func (c *Client) GetRawApiWarSeason801Status(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRawApiWarSeason801WarInfo 

func (c *Client) GetRawApiWarSeason801WarInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRawApiWarSeasonCurrentWarID 

func (c *Client) GetRawApiWarSeasonCurrentWarID(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// Get request
	Get(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1AssignmentsAll request
	GetApiV1AssignmentsAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1Assignments request
	GetApiV1Assignments(ctx context.Context, index int64, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1CampaignsAll request
	GetApiV1CampaignsAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1Campaigns request
	GetApiV1Campaigns(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1DispatchesAll request
	GetApiV1DispatchesAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1Dispatches request
	GetApiV1Dispatches(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1PlanetEvents request
	GetApiV1PlanetEvents(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1PlanetsAll request
	GetApiV1PlanetsAll(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1Planets request
	GetApiV1Planets(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1Steam request
	GetApiV1Steam(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1Steam2 request
	GetApiV1Steam2(ctx context.Context, gid string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiV1War request
	GetApiV1War(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRawApiNewsFeed801 request
	GetRawApiNewsFeed801(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRawApiStatsWar801Summary request
	GetRawApiStatsWar801Summary(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRawApiWarSeason801Status request
	GetRawApiWarSeason801Status(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRawApiWarSeason801WarInfo request
	GetRawApiWarSeason801WarInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRawApiWarSeasonCurrentWarID request
	GetRawApiWarSeasonCurrentWarID(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRawApiV2AssignmentWar801 request
	GetRawApiV2AssignmentWar801(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetApiV1AssignmentsAllWithResponse 

func (c *ClientWithResponses) GetApiV1AssignmentsAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AssignmentsAllResponse, error)

GetApiV1AssignmentsAllWithResponse request returning *GetApiV1AssignmentsAllResponse

func (*ClientWithResponses) GetApiV1AssignmentsWithResponse 

func (c *ClientWithResponses) GetApiV1AssignmentsWithResponse(ctx context.Context, index int64, reqEditors ...RequestEditorFn) (*GetApiV1AssignmentsResponse, error)

GetApiV1AssignmentsWithResponse request returning *GetApiV1AssignmentsResponse

func (*ClientWithResponses) GetApiV1CampaignsAllWithResponse 

func (c *ClientWithResponses) GetApiV1CampaignsAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1CampaignsAllResponse, error)

GetApiV1CampaignsAllWithResponse request returning *GetApiV1CampaignsAllResponse

func (*ClientWithResponses) GetApiV1CampaignsWithResponse 

func (c *ClientWithResponses) GetApiV1CampaignsWithResponse(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*GetApiV1CampaignsResponse, error)

GetApiV1CampaignsWithResponse request returning *GetApiV1CampaignsResponse

func (*ClientWithResponses) GetApiV1DispatchesAllWithResponse 

func (c *ClientWithResponses) GetApiV1DispatchesAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1DispatchesAllResponse, error)

GetApiV1DispatchesAllWithResponse request returning *GetApiV1DispatchesAllResponse

func (*ClientWithResponses) GetApiV1DispatchesWithResponse 

func (c *ClientWithResponses) GetApiV1DispatchesWithResponse(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*GetApiV1DispatchesResponse, error)

GetApiV1DispatchesWithResponse request returning *GetApiV1DispatchesResponse

func (*ClientWithResponses) GetApiV1PlanetEventsWithResponse 

func (c *ClientWithResponses) GetApiV1PlanetEventsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1PlanetEventsResponse, error)

GetApiV1PlanetEventsWithResponse request returning *GetApiV1PlanetEventsResponse

func (*ClientWithResponses) GetApiV1PlanetsAllWithResponse 

func (c *ClientWithResponses) GetApiV1PlanetsAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1PlanetsAllResponse, error)

GetApiV1PlanetsAllWithResponse request returning *GetApiV1PlanetsAllResponse

func (*ClientWithResponses) GetApiV1PlanetsWithResponse 

func (c *ClientWithResponses) GetApiV1PlanetsWithResponse(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*GetApiV1PlanetsResponse, error)

GetApiV1PlanetsWithResponse request returning *GetApiV1PlanetsResponse

func (*ClientWithResponses) GetApiV1Steam2WithResponse 

func (c *ClientWithResponses) GetApiV1Steam2WithResponse(ctx context.Context, gid string, reqEditors ...RequestEditorFn) (*GetApiV1Steam2Response, error)

GetApiV1Steam2WithResponse request returning *GetApiV1Steam2Response

func (*ClientWithResponses) GetApiV1SteamWithResponse 

func (c *ClientWithResponses) GetApiV1SteamWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1SteamResponse, error)

GetApiV1SteamWithResponse request returning *GetApiV1SteamResponse

func (*ClientWithResponses) GetApiV1WarWithResponse 

func (c *ClientWithResponses) GetApiV1WarWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1WarResponse, error)

GetApiV1WarWithResponse request returning *GetApiV1WarResponse

func (*ClientWithResponses) GetRawApiNewsFeed801WithResponse 

func (c *ClientWithResponses) GetRawApiNewsFeed801WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiNewsFeed801Response, error)

GetRawApiNewsFeed801WithResponse request returning *GetRawApiNewsFeed801Response

func (*ClientWithResponses) GetRawApiStatsWar801SummaryWithResponse 

func (c *ClientWithResponses) GetRawApiStatsWar801SummaryWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiStatsWar801SummaryResponse, error)

GetRawApiStatsWar801SummaryWithResponse request returning *GetRawApiStatsWar801SummaryResponse

func (*ClientWithResponses) GetRawApiV2AssignmentWar801WithResponse 

func (c *ClientWithResponses) GetRawApiV2AssignmentWar801WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiV2AssignmentWar801Response, error)

GetRawApiV2AssignmentWar801WithResponse request returning *GetRawApiV2AssignmentWar801Response

func (*ClientWithResponses) GetRawApiWarSeason801StatusWithResponse 

func (c *ClientWithResponses) GetRawApiWarSeason801StatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiWarSeason801StatusResponse, error)

GetRawApiWarSeason801StatusWithResponse request returning *GetRawApiWarSeason801StatusResponse

func (*ClientWithResponses) GetRawApiWarSeason801WarInfoWithResponse 

func (c *ClientWithResponses) GetRawApiWarSeason801WarInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiWarSeason801WarInfoResponse, error)

GetRawApiWarSeason801WarInfoWithResponse request returning *GetRawApiWarSeason801WarInfoResponse

func (*ClientWithResponses) GetRawApiWarSeasonCurrentWarIDWithResponse 

func (c *ClientWithResponses) GetRawApiWarSeasonCurrentWarIDWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiWarSeasonCurrentWarIDResponse, error)

GetRawApiWarSeasonCurrentWarIDWithResponse request returning *GetRawApiWarSeasonCurrentWarIDResponse

func (*ClientWithResponses) GetWithResponse added in v0.0.3 

func (c *ClientWithResponses) GetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetResponse, error)

GetWithResponse request returning *GetResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetWithResponse request
	GetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetResponse, error)

	// GetApiV1AssignmentsAllWithResponse request
	GetApiV1AssignmentsAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1AssignmentsAllResponse, error)

	// GetApiV1AssignmentsWithResponse request
	GetApiV1AssignmentsWithResponse(ctx context.Context, index int64, reqEditors ...RequestEditorFn) (*GetApiV1AssignmentsResponse, error)

	// GetApiV1CampaignsAllWithResponse request
	GetApiV1CampaignsAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1CampaignsAllResponse, error)

	// GetApiV1CampaignsWithResponse request
	GetApiV1CampaignsWithResponse(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*GetApiV1CampaignsResponse, error)

	// GetApiV1DispatchesAllWithResponse request
	GetApiV1DispatchesAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1DispatchesAllResponse, error)

	// GetApiV1DispatchesWithResponse request
	GetApiV1DispatchesWithResponse(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*GetApiV1DispatchesResponse, error)

	// GetApiV1PlanetEventsWithResponse request
	GetApiV1PlanetEventsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1PlanetEventsResponse, error)

	// GetApiV1PlanetsAllWithResponse request
	GetApiV1PlanetsAllWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1PlanetsAllResponse, error)

	// GetApiV1PlanetsWithResponse request
	GetApiV1PlanetsWithResponse(ctx context.Context, index int32, reqEditors ...RequestEditorFn) (*GetApiV1PlanetsResponse, error)

	// GetApiV1SteamWithResponse request
	GetApiV1SteamWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1SteamResponse, error)

	// GetApiV1Steam2WithResponse request
	GetApiV1Steam2WithResponse(ctx context.Context, gid string, reqEditors ...RequestEditorFn) (*GetApiV1Steam2Response, error)

	// GetApiV1WarWithResponse request
	GetApiV1WarWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiV1WarResponse, error)

	// GetRawApiNewsFeed801WithResponse request
	GetRawApiNewsFeed801WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiNewsFeed801Response, error)

	// GetRawApiStatsWar801SummaryWithResponse request
	GetRawApiStatsWar801SummaryWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiStatsWar801SummaryResponse, error)

	// GetRawApiWarSeason801StatusWithResponse request
	GetRawApiWarSeason801StatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiWarSeason801StatusResponse, error)

	// GetRawApiWarSeason801WarInfoWithResponse request
	GetRawApiWarSeason801WarInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiWarSeason801WarInfoResponse, error)

	// GetRawApiWarSeasonCurrentWarIDWithResponse request
	GetRawApiWarSeasonCurrentWarIDWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiWarSeasonCurrentWarIDResponse, error)

	// GetRawApiV2AssignmentWar801WithResponse request
	GetRawApiV2AssignmentWar801WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRawApiV2AssignmentWar801Response, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Dispatch 

type Dispatch struct {
	// Id The unique identifier of this dispatch.
	Id *int32 `json:"id,omitempty"`

	// Message The message this dispatch represents.
	Message *Dispatch_Message `json:"message,omitempty"`

	// Published When the dispatch was published.
	Published *time.Time `json:"published,omitempty"`

	// Type The type of dispatch, purpose unknown.
	Type *int32 `json:"type,omitempty"`
}

Dispatch A message from high command to the players, usually updates on the status of the war effort.

type DispatchMessage0 added in v0.0.3 

type DispatchMessage0 = string

DispatchMessage0 defines model for .

type DispatchMessage1 added in v0.0.3 

type DispatchMessage1 struct {
	// DeDE The message in de-DE
	DeDE *string `json:"de-DE,omitempty"`

	// EnUS The message in en-US
	EnUS *string `json:"en-US,omitempty"`

	// EsES The message in es-ES
	EsES *string `json:"es-ES,omitempty"`

	// FrFR The message in fr-FR
	FrFR *string `json:"fr-FR,omitempty"`

	// ItIT The message in it-IT
	ItIT *string `json:"it-IT,omitempty"`

	// PlPL The message in pl-PL
	PlPL *string `json:"pl-PL,omitempty"`

	// RuRU The message in ru-RU
	RuRU *string `json:"ru-RU,omitempty"`

	// ZhHans The message in zh-Hans
	ZhHans *string `json:"zh-Hans,omitempty"`

	// ZhHant The message in zh-Hant
	ZhHant *string `json:"zh-Hant,omitempty"`
}

DispatchMessage1 When passing in ivl-IV as Accept-Language, all available languages are returned

type Dispatch_Message added in v0.0.3 

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

Dispatch_Message The message this dispatch represents.

func (Dispatch_Message) AsDispatchMessage0 added in v0.0.3 

func (t Dispatch_Message) AsDispatchMessage0() (DispatchMessage0, error)

AsDispatchMessage0 returns the union data inside the Dispatch_Message as a DispatchMessage0

func (Dispatch_Message) AsDispatchMessage1 added in v0.0.3 

func (t Dispatch_Message) AsDispatchMessage1() (DispatchMessage1, error)

AsDispatchMessage1 returns the union data inside the Dispatch_Message as a DispatchMessage1

func (*Dispatch_Message) FromDispatchMessage0 added in v0.0.3 

func (t *Dispatch_Message) FromDispatchMessage0(v DispatchMessage0) error

FromDispatchMessage0 overwrites any union data inside the Dispatch_Message as the provided DispatchMessage0

func (*Dispatch_Message) FromDispatchMessage1 added in v0.0.3 

func (t *Dispatch_Message) FromDispatchMessage1(v DispatchMessage1) error

FromDispatchMessage1 overwrites any union data inside the Dispatch_Message as the provided DispatchMessage1

func (Dispatch_Message) MarshalJSON added in v0.0.3 

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

func (*Dispatch_Message) MergeDispatchMessage0 added in v0.0.3 

func (t *Dispatch_Message) MergeDispatchMessage0(v DispatchMessage0) error

MergeDispatchMessage0 performs a merge with any union data inside the Dispatch_Message, using the provided DispatchMessage0

func (*Dispatch_Message) MergeDispatchMessage1 added in v0.0.3 

func (t *Dispatch_Message) MergeDispatchMessage1(v DispatchMessage1) error

MergeDispatchMessage1 performs a merge with any union data inside the Dispatch_Message, using the provided DispatchMessage1

func (*Dispatch_Message) UnmarshalJSON added in v0.0.3 

func (t *Dispatch_Message) UnmarshalJSON(b []byte) error

type Event 

type Event struct {
	// CampaignId The identifier of the Campaign linked to this event.
	CampaignId *int32 `json:"campaignId,omitempty"`

	// EndTime When the event will end.
	EndTime *time.Time `json:"endTime,omitempty"`

	// EventType The type of event.
	EventType *int32 `json:"eventType,omitempty"`

	// Faction The faction that initiated the event.
	Faction *string `json:"faction,omitempty"`

	// Health The health of the Event at the time of snapshot.
	Health *int64 `json:"health,omitempty"`

	// Id The unique identifier of this event.
	Id *int32 `json:"id,omitempty"`

	// JointOperationIds A list of joint operation identifier linked to this event.
	JointOperationIds *[]int32 `json:"jointOperationIds,omitempty"`

	// MaxHealth The maximum health of the Event at the time of snapshot.
	MaxHealth *int64 `json:"maxHealth,omitempty"`

	// StartTime When the event started.
	StartTime *time.Time `json:"startTime,omitempty"`
}

Event An ongoing event on a Planet.

type GalaxyStats 

type GalaxyStats struct {
	// Accurracy A percentage indicating average accuracy of Helldivers.
	Accurracy *uint64 `json:"accurracy,omitempty"`

	// AutomatonKills The total amount of automatons killed since start of the season.
	AutomatonKills *uint64 `json:"automatonKills,omitempty"`

	// BugKills The total amount of bugs killed since start of the season.
	BugKills *uint64 `json:"bugKills,omitempty"`

	// BulletsFired The total amount of bullets fired
	BulletsFired *uint64 `json:"bulletsFired,omitempty"`

	// BulletsHit The total amount of bullets hit
	BulletsHit *uint64 `json:"bulletsHit,omitempty"`

	// Deaths The amount of casualties on the side of humanity.
	Deaths *uint64 `json:"deaths,omitempty"`

	// Friendlies The amount of friendly fire casualties.
	Friendlies *uint64 `json:"friendlies,omitempty"`

	// IlluminateKills The total amount of Illuminate killed since start of the season.
	IlluminateKills *uint64 `json:"illuminateKills,omitempty"`

	// MissionSuccessRate A percentage indicating how many started missions end in success.
	MissionSuccessRate *uint64 `json:"missionSuccessRate,omitempty"`

	// MissionTime The total amount of time spent planetside (in seconds).
	MissionTime *uint64 `json:"missionTime,omitempty"`

	// MissionsLost The amount of missions lost.
	MissionsLost *uint64 `json:"missionsLost,omitempty"`

	// MissionsWon The amount of missions won.
	MissionsWon *uint64 `json:"missionsWon,omitempty"`

	// Revives The amount of revives(?).
	Revives *uint64 `json:"revives,omitempty"`

	// TimePlayed The total amount of time played (including off-planet) in seconds.
	TimePlayed *uint64 `json:"timePlayed,omitempty"`
}

GalaxyStats Represents galaxy wide statistics.

type GetApiV1AssignmentsAllResponse 

type GetApiV1AssignmentsAllResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Assignment2
}

func ParseGetApiV1AssignmentsAllResponse 

func ParseGetApiV1AssignmentsAllResponse(rsp *http.Response) (*GetApiV1AssignmentsAllResponse, error)

ParseGetApiV1AssignmentsAllResponse parses an HTTP response from a GetApiV1AssignmentsAllWithResponse call

func (*GetApiV1AssignmentsAllResponse) Data 

func (resp *GetApiV1AssignmentsAllResponse) Data() (*[]Assignment2, error)

Data implements the interface required for client processing

func (GetApiV1AssignmentsAllResponse) Status 

func (r GetApiV1AssignmentsAllResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1AssignmentsAllResponse) StatusCode 

func (r GetApiV1AssignmentsAllResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1AssignmentsResponse 

type GetApiV1AssignmentsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Assignment2
}

func ParseGetApiV1AssignmentsResponse 

func ParseGetApiV1AssignmentsResponse(rsp *http.Response) (*GetApiV1AssignmentsResponse, error)

ParseGetApiV1AssignmentsResponse parses an HTTP response from a GetApiV1AssignmentsWithResponse call

func (GetApiV1AssignmentsResponse) Status 

func (r GetApiV1AssignmentsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1AssignmentsResponse) StatusCode 

func (r GetApiV1AssignmentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1CampaignsAllResponse 

type GetApiV1CampaignsAllResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Campaign2
}

func ParseGetApiV1CampaignsAllResponse 

func ParseGetApiV1CampaignsAllResponse(rsp *http.Response) (*GetApiV1CampaignsAllResponse, error)

ParseGetApiV1CampaignsAllResponse parses an HTTP response from a GetApiV1CampaignsAllWithResponse call

func (*GetApiV1CampaignsAllResponse) Data 

func (resp *GetApiV1CampaignsAllResponse) Data() (*[]Campaign2, error)

Data implements the interface required for client processing

func (GetApiV1CampaignsAllResponse) Status 

func (r GetApiV1CampaignsAllResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1CampaignsAllResponse) StatusCode 

func (r GetApiV1CampaignsAllResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1CampaignsResponse 

type GetApiV1CampaignsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Campaign2
}

func ParseGetApiV1CampaignsResponse 

func ParseGetApiV1CampaignsResponse(rsp *http.Response) (*GetApiV1CampaignsResponse, error)

ParseGetApiV1CampaignsResponse parses an HTTP response from a GetApiV1CampaignsWithResponse call

func (GetApiV1CampaignsResponse) Status 

func (r GetApiV1CampaignsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1CampaignsResponse) StatusCode 

func (r GetApiV1CampaignsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1DispatchesAllResponse 

type GetApiV1DispatchesAllResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Dispatch
}

func ParseGetApiV1DispatchesAllResponse 

func ParseGetApiV1DispatchesAllResponse(rsp *http.Response) (*GetApiV1DispatchesAllResponse, error)

ParseGetApiV1DispatchesAllResponse parses an HTTP response from a GetApiV1DispatchesAllWithResponse call

func (*GetApiV1DispatchesAllResponse) Data 

func (resp *GetApiV1DispatchesAllResponse) Data() (*[]Dispatch, error)

Data implements the interface required for client processing

func (GetApiV1DispatchesAllResponse) Status 

func (r GetApiV1DispatchesAllResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1DispatchesAllResponse) StatusCode 

func (r GetApiV1DispatchesAllResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1DispatchesResponse 

type GetApiV1DispatchesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Dispatch
}

func ParseGetApiV1DispatchesResponse 

func ParseGetApiV1DispatchesResponse(rsp *http.Response) (*GetApiV1DispatchesResponse, error)

ParseGetApiV1DispatchesResponse parses an HTTP response from a GetApiV1DispatchesWithResponse call

func (GetApiV1DispatchesResponse) Status 

func (r GetApiV1DispatchesResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1DispatchesResponse) StatusCode 

func (r GetApiV1DispatchesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1PlanetEventsResponse 

type GetApiV1PlanetEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Planet
}

func ParseGetApiV1PlanetEventsResponse 

func ParseGetApiV1PlanetEventsResponse(rsp *http.Response) (*GetApiV1PlanetEventsResponse, error)

ParseGetApiV1PlanetEventsResponse parses an HTTP response from a GetApiV1PlanetEventsWithResponse call

func (GetApiV1PlanetEventsResponse) Status 

func (r GetApiV1PlanetEventsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1PlanetEventsResponse) StatusCode 

func (r GetApiV1PlanetEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1PlanetsAllResponse 

type GetApiV1PlanetsAllResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Planet
}

func ParseGetApiV1PlanetsAllResponse 

func ParseGetApiV1PlanetsAllResponse(rsp *http.Response) (*GetApiV1PlanetsAllResponse, error)

ParseGetApiV1PlanetsAllResponse parses an HTTP response from a GetApiV1PlanetsAllWithResponse call

func (*GetApiV1PlanetsAllResponse) Data 

func (resp *GetApiV1PlanetsAllResponse) Data() (*[]Planet, error)

Data implements the interface required for client processing

func (GetApiV1PlanetsAllResponse) Status 

func (r GetApiV1PlanetsAllResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1PlanetsAllResponse) StatusCode 

func (r GetApiV1PlanetsAllResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1PlanetsResponse 

type GetApiV1PlanetsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Planet
}

func ParseGetApiV1PlanetsResponse 

func ParseGetApiV1PlanetsResponse(rsp *http.Response) (*GetApiV1PlanetsResponse, error)

ParseGetApiV1PlanetsResponse parses an HTTP response from a GetApiV1PlanetsWithResponse call

func (GetApiV1PlanetsResponse) Status 

func (r GetApiV1PlanetsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1PlanetsResponse) StatusCode 

func (r GetApiV1PlanetsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1Steam2Response 

type GetApiV1Steam2Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SteamNews
}

func ParseGetApiV1Steam2Response 

func ParseGetApiV1Steam2Response(rsp *http.Response) (*GetApiV1Steam2Response, error)

ParseGetApiV1Steam2Response parses an HTTP response from a GetApiV1Steam2WithResponse call

func (GetApiV1Steam2Response) Status 

func (r GetApiV1Steam2Response) Status() string

Status returns HTTPResponse.Status

func (GetApiV1Steam2Response) StatusCode 

func (r GetApiV1Steam2Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1SteamResponse 

type GetApiV1SteamResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SteamNews
}

func ParseGetApiV1SteamResponse 

func ParseGetApiV1SteamResponse(rsp *http.Response) (*GetApiV1SteamResponse, error)

ParseGetApiV1SteamResponse parses an HTTP response from a GetApiV1SteamWithResponse call

func (GetApiV1SteamResponse) Status 

func (r GetApiV1SteamResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1SteamResponse) StatusCode 

func (r GetApiV1SteamResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiV1WarResponse 

type GetApiV1WarResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *War
}

func ParseGetApiV1WarResponse 

func ParseGetApiV1WarResponse(rsp *http.Response) (*GetApiV1WarResponse, error)

ParseGetApiV1WarResponse parses an HTTP response from a GetApiV1WarWithResponse call

func (*GetApiV1WarResponse) Data 

func (resp *GetApiV1WarResponse) Data() (*War, error)

Data implements the interface required for client processing

func (GetApiV1WarResponse) Status 

func (r GetApiV1WarResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiV1WarResponse) StatusCode 

func (r GetApiV1WarResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRawApiNewsFeed801Response 

type GetRawApiNewsFeed801Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]NewsFeedItem
}

func ParseGetRawApiNewsFeed801Response 

func ParseGetRawApiNewsFeed801Response(rsp *http.Response) (*GetRawApiNewsFeed801Response, error)

ParseGetRawApiNewsFeed801Response parses an HTTP response from a GetRawApiNewsFeed801WithResponse call

func (GetRawApiNewsFeed801Response) Status 

func (r GetRawApiNewsFeed801Response) Status() string

Status returns HTTPResponse.Status

func (GetRawApiNewsFeed801Response) StatusCode 

func (r GetRawApiNewsFeed801Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRawApiStatsWar801SummaryResponse 

type GetRawApiStatsWar801SummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WarSummary
}

func ParseGetRawApiStatsWar801SummaryResponse 

func ParseGetRawApiStatsWar801SummaryResponse(rsp *http.Response) (*GetRawApiStatsWar801SummaryResponse, error)

ParseGetRawApiStatsWar801SummaryResponse parses an HTTP response from a GetRawApiStatsWar801SummaryWithResponse call

func (GetRawApiStatsWar801SummaryResponse) Status 

func (r GetRawApiStatsWar801SummaryResponse) Status() string

Status returns HTTPResponse.Status

func (GetRawApiStatsWar801SummaryResponse) StatusCode 

func (r GetRawApiStatsWar801SummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRawApiV2AssignmentWar801Response 

type GetRawApiV2AssignmentWar801Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Assignment
}

func ParseGetRawApiV2AssignmentWar801Response 

func ParseGetRawApiV2AssignmentWar801Response(rsp *http.Response) (*GetRawApiV2AssignmentWar801Response, error)

ParseGetRawApiV2AssignmentWar801Response parses an HTTP response from a GetRawApiV2AssignmentWar801WithResponse call

func (GetRawApiV2AssignmentWar801Response) Status 

func (r GetRawApiV2AssignmentWar801Response) Status() string

Status returns HTTPResponse.Status

func (GetRawApiV2AssignmentWar801Response) StatusCode 

func (r GetRawApiV2AssignmentWar801Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRawApiWarSeason801StatusResponse 

type GetRawApiWarSeason801StatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WarStatus
}

func ParseGetRawApiWarSeason801StatusResponse 

func ParseGetRawApiWarSeason801StatusResponse(rsp *http.Response) (*GetRawApiWarSeason801StatusResponse, error)

ParseGetRawApiWarSeason801StatusResponse parses an HTTP response from a GetRawApiWarSeason801StatusWithResponse call

func (GetRawApiWarSeason801StatusResponse) Status 

func (r GetRawApiWarSeason801StatusResponse) Status() string

Status returns HTTPResponse.Status

func (GetRawApiWarSeason801StatusResponse) StatusCode 

func (r GetRawApiWarSeason801StatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRawApiWarSeason801WarInfoResponse 

type GetRawApiWarSeason801WarInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WarInfo
}

func ParseGetRawApiWarSeason801WarInfoResponse 

func ParseGetRawApiWarSeason801WarInfoResponse(rsp *http.Response) (*GetRawApiWarSeason801WarInfoResponse, error)

ParseGetRawApiWarSeason801WarInfoResponse parses an HTTP response from a GetRawApiWarSeason801WarInfoWithResponse call

func (GetRawApiWarSeason801WarInfoResponse) Status 

func (r GetRawApiWarSeason801WarInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetRawApiWarSeason801WarInfoResponse) StatusCode 

func (r GetRawApiWarSeason801WarInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRawApiWarSeasonCurrentWarIDResponse 

type GetRawApiWarSeasonCurrentWarIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WarId
}

func ParseGetRawApiWarSeasonCurrentWarIDResponse 

func ParseGetRawApiWarSeasonCurrentWarIDResponse(rsp *http.Response) (*GetRawApiWarSeasonCurrentWarIDResponse, error)

ParseGetRawApiWarSeasonCurrentWarIDResponse parses an HTTP response from a GetRawApiWarSeasonCurrentWarIDWithResponse call

func (*GetRawApiWarSeasonCurrentWarIDResponse) Data 

func (resp *GetRawApiWarSeasonCurrentWarIDResponse) Data() (*WarId, error)

Data implements the interface required for client processing

func (GetRawApiWarSeasonCurrentWarIDResponse) Status 

func (r GetRawApiWarSeasonCurrentWarIDResponse) Status() string

Status returns HTTPResponse.Status

func (GetRawApiWarSeasonCurrentWarIDResponse) StatusCode 

func (r GetRawApiWarSeasonCurrentWarIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResponse added in v0.0.3 

type GetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *string
}

func ParseGetResponse added in v0.0.3 

func ParseGetResponse(rsp *http.Response) (*GetResponse, error)

ParseGetResponse parses an HTTP response from a GetWithResponse call

func (GetResponse) Status added in v0.0.3 

func (r GetResponse) Status() string

Status returns HTTPResponse.Status

func (GetResponse) StatusCode added in v0.0.3 

func (r GetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Hazard 

type Hazard struct {
	// Description The description of the environmental hazard.
	Description *string `json:"description,omitempty"`

	// Name The name of this environmental hazard.
	Name *string `json:"name,omitempty"`
}

Hazard Describes an environmental hazard that can be present on a Planet.

type HomeWorld 

type HomeWorld struct {
	// PlanetIndices A list of Index identifiers.
	PlanetIndices *[]int32 `json:"planetIndices,omitempty"`

	// Race The identifier of the race (faction) this describes the homeworld of.
	Race *int32 `json:"race,omitempty"`
}

HomeWorld Represents information about the homeworld(s) of a given race.

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JointOperation 

type JointOperation struct {
	HqNodeIndex *int32 `json:"hqNodeIndex,omitempty"`
	Id          *int32 `json:"id,omitempty"`
	PlanetIndex *int32 `json:"planetIndex,omitempty"`
}

JointOperation Represents a joint operation.

type NewsFeedItem 

type NewsFeedItem struct {
	// Id The identifier of this newsfeed item.
	Id *int32 `json:"id,omitempty"`

	// Message The message containing a human readable text.
	Message *string `json:"message,omitempty"`

	// Published A unix timestamp (in seconds) when this item was published.
	Published *int64 `json:"published,omitempty"`

	// Type A numerical type, purpose unknown.
	Type *int32 `json:"type,omitempty"`
}

NewsFeedItem Represents an item in the newsfeed of Super Earth.

type Planet 

type Planet struct {
	// Attacking A list of Index integers that this planet is currently attacking.
	Attacking *[]int32 `json:"attacking,omitempty"`

	// Biome The biome this planet has.
	Biome *Planet_Biome `json:"biome,omitempty"`

	// CurrentOwner The faction that currently controls the planet.
	CurrentOwner *string `json:"currentOwner,omitempty"`

	// Disabled Whether or not this planet is disabled, as assigned by ArrowHead.
	Disabled *bool `json:"disabled,omitempty"`

	// Event Information on the active event ongoing on this planet, if one is active.
	Event *Planet_Event `json:"event"`

	// Hash A hash assigned to the planet by ArrowHead, purpose unknown.
	Hash *int64 `json:"hash,omitempty"`

	// Hazards All Hazards that are applicable to this planet.
	Hazards *[]Hazard `json:"hazards,omitempty"`

	// Health The current planet this planet has.
	Health *int64 `json:"health,omitempty"`

	// Index The unique identifier ArrowHead assigned to this planet.
	Index *int32 `json:"index,omitempty"`

	// InitialOwner The faction that originally owned the planet.
	InitialOwner *string `json:"initialOwner,omitempty"`

	// MaxHealth The maximum health pool of this planet.
	MaxHealth *int64 `json:"maxHealth,omitempty"`

	// Name The name of the planet, as shown in game.
	Name *Planet_Name `json:"name,omitempty"`

	// Position The coordinates of this planet on the galactic war map.
	Position *Planet_Position `json:"position,omitempty"`

	// RegenPerSecond How much the planet regenerates per second if left alone.
	RegenPerSecond *float64 `json:"regenPerSecond,omitempty"`

	// Sector The name of the sector the planet is in, as shown in game.
	Sector *string `json:"sector,omitempty"`

	// Statistics A set of statistics scoped to this planet.
	Statistics *Planet_Statistics `json:"statistics,omitempty"`

	// Waypoints A list of Index of all the planets to which this planet is connected.
	Waypoints *[]int32 `json:"waypoints,omitempty"`
}

Planet Contains all aggregated information AH has about a planet.

type PlanetAttack 

type PlanetAttack struct {
	// Source Where the attack originates from.
	Source *int32 `json:"source,omitempty"`

	// Target The planet under attack.
	Target *int32 `json:"target,omitempty"`
}

PlanetAttack Represents an attack on a PlanetInfo.

type PlanetCoordinates 

type PlanetCoordinates struct {
	// X The X coordinate
	X *float64 `json:"x,omitempty"`

	// Y The Y coordinate
	Y *float64 `json:"y,omitempty"`
}

PlanetCoordinates Represents a set of coordinates returned by ArrowHead's API.

type PlanetEvent 

type PlanetEvent struct {
	// CampaignId The unique identifier of a related campaign.
	CampaignId *int32 `json:"campaignId,omitempty"`

	// EventType A numerical identifier that indicates what type of event this is.
	EventType *int32 `json:"eventType,omitempty"`

	// ExpireTime When the event will end.
	ExpireTime *int64 `json:"expireTime,omitempty"`

	// Health The current health of the event.
	Health *int64 `json:"health,omitempty"`

	// Id The unique identifier of this event.
	Id *int32 `json:"id,omitempty"`

	// JointOperationIds A list of identifiers of related joint operations.
	JointOperationIds *[]int32 `json:"jointOperationIds,omitempty"`

	// MaxHealth The current maximum health of the event.
	MaxHealth *int64 `json:"maxHealth,omitempty"`

	// PlanetIndex The index of the planet.
	PlanetIndex *int32 `json:"planetIndex,omitempty"`

	// Race The identifier of the faction that owns the planet currently.
	Race *int32 `json:"race,omitempty"`

	// StartTime When this event started.
	StartTime *int64 `json:"startTime,omitempty"`
}

PlanetEvent An ongoing event on a planet.

type PlanetInfo 

type PlanetInfo struct {
	// Disabled Whether this planet is currently considered active in the galactic war.
	Disabled *bool `json:"disabled,omitempty"`

	// Index The numerical identifier for this planet, used as reference by other properties throughout the API (like Waypoints).
	Index *int32 `json:"index,omitempty"`

	// InitialOwner The identifier of the faction that initially owned this planet.
	InitialOwner *int32 `json:"initialOwner,omitempty"`

	// MaxHealth The 'health' of this planet, indicates how much liberation it needs to switch sides.
	MaxHealth *int64 `json:"maxHealth,omitempty"`

	// Position A set of X/Y coordinates specifying the position of this planet on the galaxy map.
	Position *PlanetInfo_Position `json:"position,omitempty"`

	// Sector The identifier of the sector this planet is located in.
	Sector *int32 `json:"sector,omitempty"`

	// SettingsHash Purpose unknown at this time.
	SettingsHash *int64 `json:"settingsHash,omitempty"`

	// Waypoints A list of links to other planets (supply lines).
	Waypoints *[]int32 `json:"waypoints,omitempty"`
}

PlanetInfo Represents information of a planet from the 'WarInfo' endpoint returned by ArrowHead's API.

type PlanetInfo_Position 

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

PlanetInfo_Position A set of X/Y coordinates specifying the position of this planet on the galaxy map.

func (PlanetInfo_Position) AsPlanetCoordinates 

func (t PlanetInfo_Position) AsPlanetCoordinates() (PlanetCoordinates, error)

AsPlanetCoordinates returns the union data inside the PlanetInfo_Position as a PlanetCoordinates

func (*PlanetInfo_Position) FromPlanetCoordinates 

func (t *PlanetInfo_Position) FromPlanetCoordinates(v PlanetCoordinates) error

FromPlanetCoordinates overwrites any union data inside the PlanetInfo_Position as the provided PlanetCoordinates

func (PlanetInfo_Position) MarshalJSON 

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

func (*PlanetInfo_Position) MergePlanetCoordinates 

func (t *PlanetInfo_Position) MergePlanetCoordinates(v PlanetCoordinates) error

MergePlanetCoordinates performs a merge with any union data inside the PlanetInfo_Position, using the provided PlanetCoordinates

func (*PlanetInfo_Position) UnmarshalJSON 

func (t *PlanetInfo_Position) UnmarshalJSON(b []byte) error

type PlanetName0 added in v0.0.3 

type PlanetName0 = string

PlanetName0 defines model for .

type PlanetName1 added in v0.0.3 

type PlanetName1 struct {
	// DeDE The message in de-DE
	DeDE *string `json:"de-DE,omitempty"`

	// EnUS The message in en-US
	EnUS *string `json:"en-US,omitempty"`

	// EsES The message in es-ES
	EsES *string `json:"es-ES,omitempty"`

	// FrFR The message in fr-FR
	FrFR *string `json:"fr-FR,omitempty"`

	// ItIT The message in it-IT
	ItIT *string `json:"it-IT,omitempty"`

	// PlPL The message in pl-PL
	PlPL *string `json:"pl-PL,omitempty"`

	// RuRU The message in ru-RU
	RuRU *string `json:"ru-RU,omitempty"`

	// ZhHans The message in zh-Hans
	ZhHans *string `json:"zh-Hans,omitempty"`

	// ZhHant The message in zh-Hant
	ZhHant *string `json:"zh-Hant,omitempty"`
}

PlanetName1 When passing in ivl-IV as Accept-Language, all available languages are returned

type PlanetStats 

type PlanetStats struct {
	// Accurracy A percentage indicating average accuracy of Helldivers.
	Accurracy *uint64 `json:"accurracy,omitempty"`

	// AutomatonKills The total amount of automatons killed since start of the season.
	AutomatonKills *uint64 `json:"automatonKills,omitempty"`

	// BugKills The total amount of bugs killed since start of the season.
	BugKills *uint64 `json:"bugKills,omitempty"`

	// BulletsFired The total amount of bullets fired
	BulletsFired *uint64 `json:"bulletsFired,omitempty"`

	// BulletsHit The total amount of bullets hit
	BulletsHit *uint64 `json:"bulletsHit,omitempty"`

	// Deaths The amount of casualties on the side of humanity.
	Deaths *uint64 `json:"deaths,omitempty"`

	// Friendlies The amount of friendly fire casualties.
	Friendlies *uint64 `json:"friendlies,omitempty"`

	// IlluminateKills The total amount of Illuminate killed since start of the season.
	IlluminateKills *uint64 `json:"illuminateKills,omitempty"`

	// MissionSuccessRate A percentage indicating how many started missions end in success.
	MissionSuccessRate *uint64 `json:"missionSuccessRate,omitempty"`

	// MissionTime The total amount of time spent planetside (in seconds).
	MissionTime *uint64 `json:"missionTime,omitempty"`

	// MissionsLost The amount of missions lost.
	MissionsLost *uint64 `json:"missionsLost,omitempty"`

	// MissionsWon The amount of missions won.
	MissionsWon *uint64 `json:"missionsWon,omitempty"`

	// PlanetIndex The Index for which planet these stats are.
	PlanetIndex *int32 `json:"planetIndex,omitempty"`

	// Revives The amount of revives(?).
	Revives *uint64 `json:"revives,omitempty"`

	// TimePlayed The total amount of time played (including off-planet) in seconds.
	TimePlayed *uint64 `json:"timePlayed,omitempty"`
}

PlanetStats Similar to GalaxyStats, but scoped to a specific planet.

type PlanetStatus 

type PlanetStatus struct {
	// Health The current health / liberation of a planet.
	Health *int64 `json:"health,omitempty"`

	// Index The identifier of the PlanetInfo this status refers to.
	Index *int32 `json:"index,omitempty"`

	// Owner The faction currently owning the planet.
	Owner *int32 `json:"owner,omitempty"`

	// Players The amount of helldivers currently active on this planet.
	Players *uint64 `json:"players,omitempty"`

	// RegenPerSecond If left alone, how much the health of the planet would regenerate.
	RegenPerSecond *float64 `json:"regenPerSecond,omitempty"`
}

PlanetStatus Represents the 'current' status of a planet in the galactic war.

type Planet_Biome 

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

Planet_Biome The biome this planet has.

func (Planet_Biome) AsBiome 

func (t Planet_Biome) AsBiome() (Biome, error)

AsBiome returns the union data inside the Planet_Biome as a Biome

func (*Planet_Biome) FromBiome 

func (t *Planet_Biome) FromBiome(v Biome) error

FromBiome overwrites any union data inside the Planet_Biome as the provided Biome

func (Planet_Biome) MarshalJSON 

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

func (*Planet_Biome) MergeBiome 

func (t *Planet_Biome) MergeBiome(v Biome) error

MergeBiome performs a merge with any union data inside the Planet_Biome, using the provided Biome

func (*Planet_Biome) UnmarshalJSON 

func (t *Planet_Biome) UnmarshalJSON(b []byte) error

type Planet_Event 

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

Planet_Event Information on the active event ongoing on this planet, if one is active.

func (Planet_Event) AsEvent 

func (t Planet_Event) AsEvent() (Event, error)

AsEvent returns the union data inside the Planet_Event as a Event

func (*Planet_Event) FromEvent 

func (t *Planet_Event) FromEvent(v Event) error

FromEvent overwrites any union data inside the Planet_Event as the provided Event

func (Planet_Event) MarshalJSON 

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

func (*Planet_Event) MergeEvent 

func (t *Planet_Event) MergeEvent(v Event) error

MergeEvent performs a merge with any union data inside the Planet_Event, using the provided Event

func (*Planet_Event) UnmarshalJSON 

func (t *Planet_Event) UnmarshalJSON(b []byte) error

type Planet_Name added in v0.0.3 

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

Planet_Name The name of the planet, as shown in game.

func (Planet_Name) AsPlanetName0 added in v0.0.3 

func (t Planet_Name) AsPlanetName0() (PlanetName0, error)

AsPlanetName0 returns the union data inside the Planet_Name as a PlanetName0

func (Planet_Name) AsPlanetName1 added in v0.0.3 

func (t Planet_Name) AsPlanetName1() (PlanetName1, error)

AsPlanetName1 returns the union data inside the Planet_Name as a PlanetName1

func (*Planet_Name) FromPlanetName0 added in v0.0.3 

func (t *Planet_Name) FromPlanetName0(v PlanetName0) error

FromPlanetName0 overwrites any union data inside the Planet_Name as the provided PlanetName0

func (*Planet_Name) FromPlanetName1 added in v0.0.3 

func (t *Planet_Name) FromPlanetName1(v PlanetName1) error

FromPlanetName1 overwrites any union data inside the Planet_Name as the provided PlanetName1

func (Planet_Name) MarshalJSON added in v0.0.3 

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

func (*Planet_Name) MergePlanetName0 added in v0.0.3 

func (t *Planet_Name) MergePlanetName0(v PlanetName0) error

MergePlanetName0 performs a merge with any union data inside the Planet_Name, using the provided PlanetName0

func (*Planet_Name) MergePlanetName1 added in v0.0.3 

func (t *Planet_Name) MergePlanetName1(v PlanetName1) error

MergePlanetName1 performs a merge with any union data inside the Planet_Name, using the provided PlanetName1

func (*Planet_Name) UnmarshalJSON added in v0.0.3 

func (t *Planet_Name) UnmarshalJSON(b []byte) error

type Planet_Position 

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

Planet_Position The coordinates of this planet on the galactic war map.

func (Planet_Position) AsPosition 

func (t Planet_Position) AsPosition() (Position, error)

AsPosition returns the union data inside the Planet_Position as a Position

func (*Planet_Position) FromPosition 

func (t *Planet_Position) FromPosition(v Position) error

FromPosition overwrites any union data inside the Planet_Position as the provided Position

func (Planet_Position) MarshalJSON 

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

func (*Planet_Position) MergePosition 

func (t *Planet_Position) MergePosition(v Position) error

MergePosition performs a merge with any union data inside the Planet_Position, using the provided Position

func (*Planet_Position) UnmarshalJSON 

func (t *Planet_Position) UnmarshalJSON(b []byte) error

type Planet_Statistics 

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

Planet_Statistics A set of statistics scoped to this planet.

func (Planet_Statistics) AsStatistics 

func (t Planet_Statistics) AsStatistics() (Statistics, error)

AsStatistics returns the union data inside the Planet_Statistics as a Statistics

func (*Planet_Statistics) FromStatistics 

func (t *Planet_Statistics) FromStatistics(v Statistics) error

FromStatistics overwrites any union data inside the Planet_Statistics as the provided Statistics

func (Planet_Statistics) MarshalJSON 

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

func (*Planet_Statistics) MergeStatistics 

func (t *Planet_Statistics) MergeStatistics(v Statistics) error

MergeStatistics performs a merge with any union data inside the Planet_Statistics, using the provided Statistics

func (*Planet_Statistics) UnmarshalJSON 

func (t *Planet_Statistics) UnmarshalJSON(b []byte) error

type Position 

type Position struct {
	// X The X coordinate.
	X *float64 `json:"x,omitempty"`

	// Y The Y coordinate.
	Y *float64 `json:"y,omitempty"`
}

Position Represents a position on the galactic war map.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Reward 

type Reward struct {
	// Amount The amount of Type the players will receive upon completion.
	Amount *int32 `json:"amount,omitempty"`

	// Id32 Internal identifier of this Reward.
	Id32 *int32 `json:"id32,omitempty"`

	// Type The type of reward, currently only one value is known: 1 which represents Medals
	Type *int32 `json:"type,omitempty"`
}

Reward Represents the reward of an Assignment.

type Reward2 

type Reward2 struct {
	// Amount The amount of Type that will be awarded.
	Amount *int32 `json:"amount,omitempty"`

	// Type The type of reward (medals, super credits, ...).
	Type *int32 `json:"type,omitempty"`
}

Reward2 The reward for completing an Assignment.

type Setting 

type Setting struct {
	// Flags Flags, suspected to be a binary OR'd value, purpose unknown.
	Flags *int32 `json:"flags,omitempty"`

	// OverrideBrief The briefing (description) of this assignment.
	OverrideBrief *string `json:"overrideBrief,omitempty"`

	// OverrideTitle The title of this assignment.
	OverrideTitle *string `json:"overrideTitle,omitempty"`

	// Reward Contains information on the rewards players willr eceive upon completion.
	Reward *Setting_Reward `json:"reward,omitempty"`

	// TaskDescription A description of what is expected of Helldivers to complete the assignment.
	TaskDescription *string `json:"taskDescription,omitempty"`

	// Tasks A list of Tasks describing the assignment requirements.
	Tasks *[]Task `json:"tasks,omitempty"`

	// Type The type of assignment, values unknown at the moment.
	Type *int32 `json:"type,omitempty"`
}

Setting Contains the details of an Assignment like reward and requirements.

type Setting_Reward 

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

Setting_Reward Contains information on the rewards players willr eceive upon completion.

func (Setting_Reward) AsReward 

func (t Setting_Reward) AsReward() (Reward, error)

AsReward returns the union data inside the Setting_Reward as a Reward

func (*Setting_Reward) FromReward 

func (t *Setting_Reward) FromReward(v Reward) error

FromReward overwrites any union data inside the Setting_Reward as the provided Reward

func (Setting_Reward) MarshalJSON 

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

func (*Setting_Reward) MergeReward 

func (t *Setting_Reward) MergeReward(v Reward) error

MergeReward performs a merge with any union data inside the Setting_Reward, using the provided Reward

func (*Setting_Reward) UnmarshalJSON 

func (t *Setting_Reward) UnmarshalJSON(b []byte) error

type Statistics 

type Statistics struct {
	// Accuracy A percentage indicating average accuracy of Helldivers.
	Accuracy *uint64 `json:"accuracy,omitempty"`

	// AutomatonKills The total amount of automatons killed since start of the season.
	AutomatonKills *uint64 `json:"automatonKills,omitempty"`

	// BulletsFired The total amount of bullets fired
	BulletsFired *uint64 `json:"bulletsFired,omitempty"`

	// BulletsHit The total amount of bullets hit
	BulletsHit *uint64 `json:"bulletsHit,omitempty"`

	// Deaths The amount of casualties on the side of humanity.
	Deaths *uint64 `json:"deaths,omitempty"`

	// Friendlies The amount of friendly fire casualties.
	Friendlies *uint64 `json:"friendlies,omitempty"`

	// IlluminateKills The total amount of Illuminate killed since start of the season.
	IlluminateKills *uint64 `json:"illuminateKills,omitempty"`

	// MissionSuccessRate A percentage indicating how many started missions end in success.
	MissionSuccessRate *uint64 `json:"missionSuccessRate,omitempty"`

	// MissionTime The total amount of time spent planetside (in seconds).
	MissionTime *uint64 `json:"missionTime,omitempty"`

	// MissionsLost The amount of missions lost.
	MissionsLost *uint64 `json:"missionsLost,omitempty"`

	// MissionsWon The amount of missions won.
	MissionsWon *uint64 `json:"missionsWon,omitempty"`

	// PlayerCount The total amount of players present (at the time of the snapshot).
	PlayerCount *uint64 `json:"playerCount,omitempty"`

	// Revives The amount of revives(?).
	Revives *uint64 `json:"revives,omitempty"`

	// TerminidKills The total amount of bugs killed since start of the season.
	TerminidKills *uint64 `json:"terminidKills,omitempty"`

	// TimePlayed The total amount of time played (including off-planet) in seconds.
	TimePlayed *uint64 `json:"timePlayed,omitempty"`
}

Statistics Contains statistics of missions, kills, success rate etc.

type SteamNews 

type SteamNews struct {
	// Author The author who posted this message on Steam.
	Author *string `json:"author,omitempty"`

	// Content The message posted by Steam, currently in Steam's weird markdown format.
	Content *string `json:"content,omitempty"`

	// Id The identifier assigned by Steam to this news item.
	Id *string `json:"id,omitempty"`

	// PublishedAt When this message was posted.
	PublishedAt *time.Time `json:"publishedAt,omitempty"`

	// Title The title of the Steam news item.
	Title *string `json:"title,omitempty"`

	// Url The URL to Steam where this news item was posted.
	Url *string `json:"url,omitempty"`
}

SteamNews Represents a new article from Steam's news feed.

type Task 

type Task struct {
	// Type A numerical value, purpose unknown.
	Type *int32 `json:"type,omitempty"`

	// ValueTypes A list of numerical values, purpose unknown.
	ValueTypes *[]int32 `json:"valueTypes,omitempty"`

	// Values A list of numerical values, purpose unknown.
	Values *[]int32 `json:"values,omitempty"`
}

Task Represents a task in an Assignment. It's exact values are not known, therefore little of it's purpose is clear.

type Task2 

type Task2 struct {
	// Type The type of task this represents.
	Type *int32 `json:"type,omitempty"`

	// ValueTypes A list of numbers, purpose unknown
	ValueTypes *[]int32 `json:"valueTypes,omitempty"`

	// Values A list of numbers, purpose unknown.
	Values *[]int32 `json:"values,omitempty"`
}

Task2 Represents a task in an Assignment that needs to be completed to finish the assignment.

type War 

type War struct {
	// ClientVersion The minimum game client version required to play in this war.
	ClientVersion *string `json:"clientVersion,omitempty"`

	// Ended When this war will end (or has ended).
	Ended *time.Time `json:"ended,omitempty"`

	// Factions A list of factions currently involved in the war.
	Factions *[]string `json:"factions,omitempty"`

	// ImpactMultiplier A fraction used to calculate the impact of a mission on the war effort.
	ImpactMultiplier *float64 `json:"impactMultiplier,omitempty"`

	// Now The time the snapshot of the war was taken, also doubles as the timestamp of which all other data dates from.
	Now *time.Time `json:"now,omitempty"`

	// Started When this war was started.
	Started *time.Time `json:"started,omitempty"`

	// Statistics The statistics available for the galaxy wide war effort.
	Statistics *War_Statistics `json:"statistics,omitempty"`
}

War Global information of the ongoing war.

type WarId 

type WarId struct {
	Id *int32 `json:"id,omitempty"`
}

WarId Represents the ID returned from the WarID endpoint.

type WarInfo 

type WarInfo struct {
	// EndDate A unix timestamp (in seconds) when this season will end.
	EndDate *int64 `json:"endDate,omitempty"`

	// HomeWorlds A list of homeworlds for the races (factions) involved in this war.
	HomeWorlds *[]HomeWorld `json:"homeWorlds,omitempty"`

	// MinimumClientVersion A version string indicating the minimum game client version the API supports.
	MinimumClientVersion *string `json:"minimumClientVersion,omitempty"`

	// PlanetInfos A list of planets involved in this season's war.
	PlanetInfos *[]PlanetInfo `json:"planetInfos,omitempty"`

	// StartDate A unix timestamp (in seconds) when this season started.
	StartDate *int64 `json:"startDate,omitempty"`

	// WarId The identifier of the war season this WarInfo represents.
	WarId *int32 `json:"warId,omitempty"`
}

WarInfo Represents mostly static information of the current galactic war.

type WarStatus 

type WarStatus struct {
	// Campaigns A list of ongoing campaigns in the galactic war.
	Campaigns *[]Campaign `json:"campaigns,omitempty"`

	// ImpactMultiplier This is the factor by which influence at the end of a mission is multiplied to calculate the impact on liberation
	ImpactMultiplier *float64 `json:"impactMultiplier,omitempty"`

	// JointOperations A list of JointOperations.
	JointOperations *[]JointOperation `json:"jointOperations,omitempty"`

	// PlanetAttacks A list of attacks currently ongoing.
	PlanetAttacks *[]PlanetAttack `json:"planetAttacks,omitempty"`

	// PlanetEvents A list of ongoing PlanetEvents.
	PlanetEvents *[]PlanetEvent `json:"planetEvents,omitempty"`

	// PlanetStatus A list of statuses for planets.
	PlanetStatus *[]PlanetStatus `json:"planetStatus,omitempty"`

	// StoryBeatId32 Internal identifier, purpose unknown.
	StoryBeatId32 *int64 `json:"storyBeatId32,omitempty"`

	// Time The time this snapshot was taken.
	Time *int64 `json:"time,omitempty"`

	// WarId The war season this snapshot refers to.
	WarId *int32 `json:"warId,omitempty"`
}

WarStatus Represents a snapshot of the current status of the galactic war.

type WarSummary 

type WarSummary struct {
	// GalaxyStats Contains galaxy wide statistics aggregated from all planets.
	GalaxyStats *WarSummary_GalaxyStats `json:"galaxy_stats,omitempty"`

	// PlanetsStats Contains statistics for specific planets.
	PlanetsStats *[]PlanetStats `json:"planets_stats,omitempty"`
}

WarSummary Gets general statistics about the galaxy and specific planets.

type WarSummary_GalaxyStats 

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

WarSummary_GalaxyStats Contains galaxy wide statistics aggregated from all planets.

func (WarSummary_GalaxyStats) AsGalaxyStats 

func (t WarSummary_GalaxyStats) AsGalaxyStats() (GalaxyStats, error)

AsGalaxyStats returns the union data inside the WarSummary_GalaxyStats as a GalaxyStats

func (*WarSummary_GalaxyStats) FromGalaxyStats 

func (t *WarSummary_GalaxyStats) FromGalaxyStats(v GalaxyStats) error

FromGalaxyStats overwrites any union data inside the WarSummary_GalaxyStats as the provided GalaxyStats

func (WarSummary_GalaxyStats) MarshalJSON 

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

func (*WarSummary_GalaxyStats) MergeGalaxyStats 

func (t *WarSummary_GalaxyStats) MergeGalaxyStats(v GalaxyStats) error

MergeGalaxyStats performs a merge with any union data inside the WarSummary_GalaxyStats, using the provided GalaxyStats

func (*WarSummary_GalaxyStats) UnmarshalJSON 

func (t *WarSummary_GalaxyStats) UnmarshalJSON(b []byte) error

type War_Statistics 

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

War_Statistics The statistics available for the galaxy wide war effort.

func (War_Statistics) AsStatistics 

func (t War_Statistics) AsStatistics() (Statistics, error)

AsStatistics returns the union data inside the War_Statistics as a Statistics

func (*War_Statistics) FromStatistics 

func (t *War_Statistics) FromStatistics(v Statistics) error

FromStatistics overwrites any union data inside the War_Statistics as the provided Statistics

func (War_Statistics) MarshalJSON 

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

func (*War_Statistics) MergeStatistics 

func (t *War_Statistics) MergeStatistics(v Statistics) error

MergeStatistics performs a merge with any union data inside the War_Statistics, using the provided Statistics

func (*War_Statistics) UnmarshalJSON 

func (t *War_Statistics) UnmarshalJSON(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.