swagger

package module

v0.2.1 Latest Latest Go to latest Published: May 19, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

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

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

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

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

Repository

codeberg.org/vlbeaudoin/spacetraders-v2-sdk-go

Links

Open Source Insights

README ¶

Go API client for swagger

SpaceTraders is an open-universe game and learning platform that offers a set of HTTP endpoints to control a fleet of ships and explore a multiplayer universe. The API is documented using OpenAPI. You can send your first request right here in your browser to check the status of the game server. json http { \"method\": \"GET\", \"url\": \"https://api.spacetraders.io/v2\", } Unlike a traditional game, SpaceTraders does not have a first-party client or app to play the game. Instead, you can use the API to build your own client, write a script to automate your ships, or try an app built by the community. We have a Discord channel where you can share your projects, ask questions, and get help from other players.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "codeberg.org/vlbeaudoin/spacetraders-v2-sdk-go"

Documentation for API Endpoints

All URIs are relative to https://api.spacetraders.io/v2

Class	Method	HTTP request	Description
AgentsApi	GetMyAgent	Get /my/agent	My Agent Details
ContractsApi	AcceptContract	Post /my/contracts/{contractId}/accept	Accept Contract
ContractsApi	DeliverContract	Post /my/contracts/{contractId}/deliver	Deliver Contract
ContractsApi	FulfillContract	Post /my/contracts/{contractId}/fulfill	Fulfill Contract
ContractsApi	GetContract	Get /my/contracts/{contractId}	Get Contract
ContractsApi	GetContracts	Get /my/contracts	List Contracts
DefaultApi	Register	Post /register	Register New Agent
FactionsApi	GetFaction	Get /factions/{factionSymbol}	Get Faction
FactionsApi	GetFactions	Get /factions	List Factions
FleetApi	CreateChart	Post /my/ships/{shipSymbol}/chart	Create Chart
FleetApi	CreateShipShipScan	Post /my/ships/{shipSymbol}/scan/ships	Scan Ships
FleetApi	CreateShipSystemScan	Post /my/ships/{shipSymbol}/scan/systems	Scan Systems
FleetApi	CreateShipWaypointScan	Post /my/ships/{shipSymbol}/scan/waypoints	Scan Waypoints
FleetApi	CreateSurvey	Post /my/ships/{shipSymbol}/survey	Create Survey
FleetApi	DockShip	Post /my/ships/{shipSymbol}/dock	Dock Ship
FleetApi	ExtractResources	Post /my/ships/{shipSymbol}/extract	Extract Resources
FleetApi	GetMyShip	Get /my/ships/{shipSymbol}	Get Ship
FleetApi	GetMyShipCargo	Get /my/ships/{shipSymbol}/cargo	Get Ship Cargo
FleetApi	GetMyShips	Get /my/ships	List Ships
FleetApi	GetShipCooldown	Get /my/ships/{shipSymbol}/cooldown	Get Ship Cooldown
FleetApi	GetShipNav	Get /my/ships/{shipSymbol}/nav	Get Ship Nav
FleetApi	Jettison	Post /my/ships/{shipSymbol}/jettison	Jettison Cargo
FleetApi	JumpShip	Post /my/ships/{shipSymbol}/jump	Jump Ship
FleetApi	NavigateShip	Post /my/ships/{shipSymbol}/navigate	Navigate Ship
FleetApi	OrbitShip	Post /my/ships/{shipSymbol}/orbit	Orbit Ship
FleetApi	PatchShipNav	Patch /my/ships/{shipSymbol}/nav	Patch Ship Nav
FleetApi	PurchaseCargo	Post /my/ships/{shipSymbol}/purchase	Purchase Cargo
FleetApi	PurchaseShip	Post /my/ships	Purchase Ship
FleetApi	RefuelShip	Post /my/ships/{shipSymbol}/refuel	Refuel Ship
FleetApi	SellCargo	Post /my/ships/{shipSymbol}/sell	Sell Cargo
FleetApi	ShipRefine	Post /my/ships/{shipSymbol}/refine	Ship Refine
FleetApi	TransferCargo	Post /my/ships/{shipSymbol}/transfer	Transfer Cargo
FleetApi	WarpShip	Post /my/ships/{shipSymbol}/warp	Warp Ship
SystemsApi	GetJumpGate	Get /systems/{systemSymbol}/waypoints/{waypointSymbol}/jump-gate	Get Jump Gate
SystemsApi	GetMarket	Get /systems/{systemSymbol}/waypoints/{waypointSymbol}/market	Get Market
SystemsApi	GetShipyard	Get /systems/{systemSymbol}/waypoints/{waypointSymbol}/shipyard	Get Shipyard
SystemsApi	GetSystem	Get /systems/{systemSymbol}	Get System
SystemsApi	GetSystemWaypoints	Get /systems/{systemSymbol}/waypoints	List Waypoints
SystemsApi	GetSystems	Get /systems	List Systems
SystemsApi	GetWaypoint	Get /systems/{systemSymbol}/waypoints/{waypointSymbol}	Get Waypoint

Documentation For Models

Documentation For Authorization

AgentToken

Author

joel@spacetraders.io

Documentation ¶

Overview ¶

* SpaceTraders API * * SpaceTraders is an open-universe game and learning platform that offers a set of HTTP endpoints to control a fleet of ships and explore a multiplayer universe. The API is documented using [OpenAPI](https://github.com/SpaceTradersAPI/api-docs). You can send your first request right here in your browser to check the status of the game server. ```json http { \"method\": \"GET\", \"url\": \"https://api.spacetraders.io/v2\", } ``` Unlike a traditional game, SpaceTraders does not have a first-party client or app to play the game. Instead, you can use the API to build your own client, write a script to automate your ships, or try an app built by the community. We have a [Discord channel](https://discord.com/invite/jh6zurdWk5) where you can share your projects, ask questions, and get help from other players. * * API version: 2.0.0 * Contact: joel@spacetraders.io * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Agent
type AgentsApiService
- func (a *AgentsApiService) GetMyAgent(ctx context.Context) (InlineResponse2009, *http.Response, error)
type BasicAuth
type Chart
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ConnectedSystem
type Contract
type ContractDeliverGood
type ContractIdDeliverBody
type ContractPayment
type ContractTerms
type ContractsApiDeliverContractOpts
type ContractsApiGetContractsOpts
type ContractsApiService
- func (a *ContractsApiService) AcceptContract(ctx context.Context, contractId string) (InlineResponse20012, *http.Response, error)
- func (a *ContractsApiService) DeliverContract(ctx context.Context, contractId string, ...) (InlineResponse20013, *http.Response, error)
- func (a *ContractsApiService) FulfillContract(ctx context.Context, contractId string) (InlineResponse20014, *http.Response, error)
- func (a *ContractsApiService) GetContract(ctx context.Context, contractId string) (InlineResponse20011, *http.Response, error)
- func (a *ContractsApiService) GetContracts(ctx context.Context, localVarOptionals *ContractsApiGetContractsOpts) (InlineResponse20010, *http.Response, error)
type Cooldown
type DefaultApiRegisterOpts
type DefaultApiService
- func (a *DefaultApiService) Register(ctx context.Context, localVarOptionals *DefaultApiRegisterOpts) (InlineResponse201, *http.Response, error)
type DockShip200Response
type Extraction
type ExtractionYield
type Faction
type FactionTrait
type FactionsApiGetFactionsOpts
type FactionsApiService
- func (a *FactionsApiService) GetFaction(ctx context.Context, factionSymbol string) (InlineResponse2008, *http.Response, error)
- func (a *FactionsApiService) GetFactions(ctx context.Context, localVarOptionals *FactionsApiGetFactionsOpts) (InlineResponse2007, *http.Response, error)
type FleetApiExtractResourcesOpts
type FleetApiGetMyShipsOpts
type FleetApiJettisonOpts
type FleetApiJumpShipOpts
type FleetApiNavigateShipOpts
type FleetApiPatchShipNavOpts
type FleetApiPurchaseCargoOpts
type FleetApiPurchaseShipOpts
type FleetApiSellCargoOpts
type FleetApiService
- func (a *FleetApiService) CreateChart(ctx context.Context, shipSymbol string) (InlineResponse2012, *http.Response, error)
- func (a *FleetApiService) CreateShipShipScan(ctx context.Context, shipSymbol string) (InlineResponse2017, *http.Response, error)
- func (a *FleetApiService) CreateShipSystemScan(ctx context.Context, shipSymbol string) (InlineResponse2015, *http.Response, error)
- func (a *FleetApiService) CreateShipWaypointScan(ctx context.Context, shipSymbol string) (InlineResponse2016, *http.Response, error)
- func (a *FleetApiService) CreateSurvey(ctx context.Context, shipSymbol string) (InlineResponse2013, *http.Response, error)
- func (a *FleetApiService) DockShip(ctx context.Context, shipSymbol string) (DockShip200Response, *http.Response, error)
- func (a *FleetApiService) ExtractResources(ctx context.Context, shipSymbol string, ...) (InlineResponse2014, *http.Response, error)
- func (a *FleetApiService) GetMyShip(ctx context.Context, shipSymbol string) (InlineResponse20016, *http.Response, error)
- func (a *FleetApiService) GetMyShipCargo(ctx context.Context, shipSymbol string) (InlineResponse20017, *http.Response, error)
- func (a *FleetApiService) GetMyShips(ctx context.Context, localVarOptionals *FleetApiGetMyShipsOpts) (InlineResponse20015, *http.Response, error)
- func (a *FleetApiService) GetShipCooldown(ctx context.Context, shipSymbol string) (InlineResponse20018, *http.Response, error)
- func (a *FleetApiService) GetShipNav(ctx context.Context, shipSymbol string) (InlineResponse20022, *http.Response, error)
- func (a *FleetApiService) Jettison(ctx context.Context, shipSymbol string, ...) (InlineResponse20019, *http.Response, error)
- func (a *FleetApiService) JumpShip(ctx context.Context, shipSymbol string, ...) (InlineResponse20020, *http.Response, error)
- func (a *FleetApiService) NavigateShip(ctx context.Context, shipSymbol string, ...) (InlineResponse20021, *http.Response, error)
- func (a *FleetApiService) OrbitShip(ctx context.Context, shipSymbol string) (OrbitShip200Response, *http.Response, error)
- func (a *FleetApiService) PatchShipNav(ctx context.Context, shipSymbol string, ...) (InlineResponse20022, *http.Response, error)
- func (a *FleetApiService) PurchaseCargo(ctx context.Context, shipSymbol string, ...) (PurchaseCargo201Response, *http.Response, error)
- func (a *FleetApiService) PurchaseShip(ctx context.Context, localVarOptionals *FleetApiPurchaseShipOpts) (InlineResponse2011, *http.Response, error)
- func (a *FleetApiService) RefuelShip(ctx context.Context, shipSymbol string) (InlineResponse20023, *http.Response, error)
- func (a *FleetApiService) SellCargo(ctx context.Context, shipSymbol string, ...) (SellCargo201Response, *http.Response, error)
- func (a *FleetApiService) ShipRefine(ctx context.Context, shipSymbol string, ...) (ShipRefine200Response, *http.Response, error)
- func (a *FleetApiService) TransferCargo(ctx context.Context, shipSymbol string, ...) (TransferCargo200Response, *http.Response, error)
- func (a *FleetApiService) WarpShip(ctx context.Context, shipSymbol string, ...) (InlineResponse20021, *http.Response, error)
type FleetApiShipRefineOpts
type FleetApiTransferCargoOpts
type FleetApiWarpShipOpts
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type InlineResponse200
type InlineResponse2001
type InlineResponse20010
type InlineResponse20011
type InlineResponse20012
type InlineResponse20012Data
type InlineResponse20013
type InlineResponse20013Data
type InlineResponse20014
type InlineResponse20015
type InlineResponse20016
type InlineResponse20017
type InlineResponse20018
type InlineResponse20019
type InlineResponse20019Data
type InlineResponse2002
type InlineResponse20020
type InlineResponse20020Data
type InlineResponse20021
type InlineResponse20021Data
type InlineResponse20022
type InlineResponse20023
type InlineResponse20023Data
type InlineResponse2003
type InlineResponse2004
type InlineResponse2005
type InlineResponse2006
type InlineResponse2007
type InlineResponse2008
type InlineResponse2009
type InlineResponse201
type InlineResponse2011
type InlineResponse2011Data
type InlineResponse2012
type InlineResponse2012Data
type InlineResponse2013
type InlineResponse2013Data
type InlineResponse2014
type InlineResponse2014Data
type InlineResponse2015
type InlineResponse2015Data
type InlineResponse2016
type InlineResponse2016Data
type InlineResponse2017
type InlineResponse2017Data
type InlineResponse201Data
type JumpGate
type Market
type MarketTradeGood
type MarketTransaction
type Meta
type MyShipsBody
type OrbitShip200Response
type OrbitShip200ResponseData
type PurchaseCargo201Response
type PurchaseCargoRequest
type RegisterBody
type ScannedShip
type ScannedShipEngine
type ScannedShipFrame
type ScannedShipMounts
type ScannedShipReactor
type ScannedSystem
type ScannedWaypoint
type SellCargo201Response
type SellCargo201ResponseData
type SellCargoRequest
type Ship
type ShipCargo
type ShipCargoItem
type ShipCrew
type ShipEngine
type ShipFrame
type ShipFuel
type ShipFuelConsumed
type ShipModule
type ShipMount
type ShipNav
type ShipNavFlightMode
type ShipNavRoute
type ShipNavRouteWaypoint
type ShipNavStatus
type ShipReactor
type ShipRefine200Response
type ShipRefine200ResponseData
type ShipRefine200ResponseDataProduced
type ShipRegistration
type ShipRequirements
type ShipRole
type ShipSymbolExtractBody
type ShipSymbolJettisonBody
type ShipSymbolJumpBody
type ShipSymbolNavBody
type ShipSymbolNavigateBody
type ShipSymbolRefineBody
type ShipSymbolWarpBody
type ShipType
type Shipyard
type ShipyardShip
type ShipyardShipTypes
type ShipyardTransaction
type Survey
type SurveyDeposit
type System
type SystemFaction
type SystemType
type SystemWaypoint
type SystemsApiGetSystemWaypointsOpts
type SystemsApiGetSystemsOpts
type SystemsApiService
- func (a *SystemsApiService) GetJumpGate(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2006, *http.Response, error)
- func (a *SystemsApiService) GetMarket(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2004, *http.Response, error)
- func (a *SystemsApiService) GetShipyard(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2005, *http.Response, error)
- func (a *SystemsApiService) GetSystem(ctx context.Context, systemSymbol string) (InlineResponse2001, *http.Response, error)
- func (a *SystemsApiService) GetSystemWaypoints(ctx context.Context, systemSymbol string, ...) (InlineResponse2002, *http.Response, error)
- func (a *SystemsApiService) GetSystems(ctx context.Context, localVarOptionals *SystemsApiGetSystemsOpts) (InlineResponse200, *http.Response, error)
- func (a *SystemsApiService) GetWaypoint(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2003, *http.Response, error)
type TradeGood
type TradeSymbol
type TransferCargo200Response
type TransferCargoRequest
type Waypoint
type WaypointFaction
type WaypointOrbital
type WaypointTrait
type WaypointType

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AgentsApi *AgentsApiService

	ContractsApi *ContractsApiService

	DefaultApi *DefaultApiService

	FactionsApi *FactionsApiService

	FleetApi *FleetApiService

	SystemsApi *SystemsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the SpaceTraders API API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Agent ¶

type Agent struct {
	AccountId string `json:"accountId"`
	Symbol    string `json:"symbol"`
	// The headquarters of the agent.
	Headquarters string `json:"headquarters"`
	// The number of credits the agent has available. Credits can be negative if funds have been overdrawn.
	Credits int32 `json:"credits"`
}

type AgentsApiService ¶

type AgentsApiService service

func (*AgentsApiService) GetMyAgent ¶

func (a *AgentsApiService) GetMyAgent(ctx context.Context) (InlineResponse2009, *http.Response, error)

AgentsApiService My Agent Details Fetch your agent's details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineResponse2009

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Chart ¶

type Chart struct {
	WaypointSymbol string    `json:"waypointSymbol,omitempty"`
	SubmittedBy    string    `json:"submittedBy,omitempty"`
	SubmittedOn    time.Time `json:"submittedOn,omitempty"`
}

The chart of a system or waypoint, which makes the location visible to other agents.

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConnectedSystem ¶

type ConnectedSystem struct {
	Symbol       string      `json:"symbol"`
	SectorSymbol string      `json:"sectorSymbol"`
	Type_        *SystemType `json:"type"`
	// The symbol of the faction that owns the connected jump gate in the system.
	FactionSymbol string `json:"factionSymbol,omitempty"`
	X             int32  `json:"x"`
	Y             int32  `json:"y"`
	Distance      int32  `json:"distance"`
}

type Contract ¶

type Contract struct {
	Id string `json:"id"`
	// The symbol of the faction that this contract is for.
	FactionSymbol string         `json:"factionSymbol"`
	Type_         string         `json:"type"`
	Terms         *ContractTerms `json:"terms"`
	// Whether the contract has been accepted by the agent
	Accepted bool `json:"accepted"`
	// Whether the contract has been fulfilled
	Fulfilled bool `json:"fulfilled"`
	// The time at which the contract expires
	Expiration time.Time `json:"expiration"`
}

type ContractDeliverGood ¶

type ContractDeliverGood struct {
	// The symbol of the trade good to deliver.
	TradeSymbol string `json:"tradeSymbol"`
	// The destination where goods need to be delivered.
	DestinationSymbol string `json:"destinationSymbol"`
	// The number of units that need to be delivered on this contract.
	UnitsRequired int32 `json:"unitsRequired"`
	// The number of units fulfilled on this contract.
	UnitsFulfilled int32 `json:"unitsFulfilled"`
}

The details of a delivery contract. Includes the type of good, units needed, and the destination.

type ContractIdDeliverBody ¶

type ContractIdDeliverBody struct {
	ShipSymbol  string `json:"shipSymbol"`
	TradeSymbol string `json:"tradeSymbol"`
	Units       int32  `json:"units"`
}

type ContractPayment ¶

type ContractPayment struct {
	// The amount of credits received up front for accepting the contract.
	OnAccepted int32 `json:"onAccepted"`
	// The amount of credits received when the contract is fulfilled.
	OnFulfilled int32 `json:"onFulfilled"`
}

type ContractTerms ¶

type ContractTerms struct {
	// The deadline for the contract.
	Deadline time.Time             `json:"deadline"`
	Payment  *ContractPayment      `json:"payment"`
	Deliver  []ContractDeliverGood `json:"deliver,omitempty"`
}

type ContractsApiDeliverContractOpts ¶

type ContractsApiDeliverContractOpts struct {
	Body optional.Interface
}

type ContractsApiGetContractsOpts ¶

type ContractsApiGetContractsOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type ContractsApiService ¶

type ContractsApiService service

func (*ContractsApiService) AcceptContract ¶

func (a *ContractsApiService) AcceptContract(ctx context.Context, contractId string) (InlineResponse20012, *http.Response, error)

ContractsApiService Accept Contract Accept a contract.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractId

@return InlineResponse20012

func (*ContractsApiService) DeliverContract ¶

func (a *ContractsApiService) DeliverContract(ctx context.Context, contractId string, localVarOptionals *ContractsApiDeliverContractOpts) (InlineResponse20013, *http.Response, error)

func (*ContractsApiService) FulfillContract ¶

func (a *ContractsApiService) FulfillContract(ctx context.Context, contractId string) (InlineResponse20014, *http.Response, error)

ContractsApiService Fulfill Contract Fulfill a contract

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractId The ID of the contract

@return InlineResponse20014

func (*ContractsApiService) GetContract ¶

func (a *ContractsApiService) GetContract(ctx context.Context, contractId string) (InlineResponse20011, *http.Response, error)

ContractsApiService Get Contract Get the details of a contract by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractId The contract ID

@return InlineResponse20011

func (*ContractsApiService) GetContracts ¶

func (a *ContractsApiService) GetContracts(ctx context.Context, localVarOptionals *ContractsApiGetContractsOpts) (InlineResponse20010, *http.Response, error)

type Cooldown ¶

type Cooldown struct {
	// The symbol of the ship that is on cooldown
	ShipSymbol string `json:"shipSymbol"`
	// The total duration of the cooldown in seconds
	TotalSeconds int32 `json:"totalSeconds"`
	// The remaining duration of the cooldown in seconds
	RemainingSeconds int32 `json:"remainingSeconds"`
	// The date and time when the cooldown expires in ISO 8601 format
	Expiration time.Time `json:"expiration"`
}

A cooldown is a period of time in which a ship cannot perform certain actions.

type DefaultApiRegisterOpts ¶

type DefaultApiRegisterOpts struct {
	Body optional.Interface
}

type DefaultApiService ¶

type DefaultApiService service

func (*DefaultApiService) Register ¶

func (a *DefaultApiService) Register(ctx context.Context, localVarOptionals *DefaultApiRegisterOpts) (InlineResponse201, *http.Response, error)

type DockShip200Response ¶

type DockShip200Response struct {
	Data *OrbitShip200ResponseData `json:"data"`
}

type Extraction ¶

type Extraction struct {
	ShipSymbol string           `json:"shipSymbol"`
	Yield      *ExtractionYield `json:"yield"`
}

type ExtractionYield ¶

type ExtractionYield struct {
	Symbol string `json:"symbol"`
	// The number of units extracted that were placed into the ship's cargo hold.
	Units int32 `json:"units"`
}

type Faction ¶

type Faction struct {
	Symbol       string         `json:"symbol"`
	Name         string         `json:"name"`
	Description  string         `json:"description"`
	Headquarters string         `json:"headquarters"`
	Traits       []FactionTrait `json:"traits"`
}

type FactionTrait ¶

type FactionTrait struct {
	// The unique identifier of the trait.
	Symbol string `json:"symbol"`
	// The name of the trait.
	Name string `json:"name"`
	// A description of the trait.
	Description string `json:"description"`
}

type FactionsApiGetFactionsOpts ¶

type FactionsApiGetFactionsOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type FactionsApiService ¶

type FactionsApiService service

func (*FactionsApiService) GetFaction ¶

func (a *FactionsApiService) GetFaction(ctx context.Context, factionSymbol string) (InlineResponse2008, *http.Response, error)

FactionsApiService Get Faction View the details of a faction.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param factionSymbol The faction symbol

@return InlineResponse2008

func (*FactionsApiService) GetFactions ¶

func (a *FactionsApiService) GetFactions(ctx context.Context, localVarOptionals *FactionsApiGetFactionsOpts) (InlineResponse2007, *http.Response, error)

type FleetApiExtractResourcesOpts ¶

type FleetApiExtractResourcesOpts struct {
	Body optional.Interface
}

type FleetApiGetMyShipsOpts ¶

type FleetApiGetMyShipsOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type FleetApiJettisonOpts ¶

type FleetApiJettisonOpts struct {
	Body optional.Interface
}

type FleetApiJumpShipOpts ¶

type FleetApiJumpShipOpts struct {
	Body optional.Interface
}

type FleetApiNavigateShipOpts ¶

type FleetApiNavigateShipOpts struct {
	Body optional.Interface
}

type FleetApiPatchShipNavOpts ¶

type FleetApiPatchShipNavOpts struct {
	Body optional.Interface
}

type FleetApiPurchaseCargoOpts ¶

type FleetApiPurchaseCargoOpts struct {
	Body optional.Interface
}

type FleetApiPurchaseShipOpts ¶

type FleetApiPurchaseShipOpts struct {
	Body optional.Interface
}

type FleetApiSellCargoOpts ¶

type FleetApiSellCargoOpts struct {
	Body optional.Interface
}

type FleetApiService ¶

type FleetApiService service

func (*FleetApiService) CreateChart ¶

func (a *FleetApiService) CreateChart(ctx context.Context, shipSymbol string) (InlineResponse2012, *http.Response, error)

FleetApiService Create Chart Command a ship to chart the current waypoint. Waypoints in the universe are uncharted by default. These locations will not show up in the API until they have been charted by a ship. Charting a location will record your agent as the one who created the chart.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol The symbol of the ship

@return InlineResponse2012

func (*FleetApiService) CreateShipShipScan ¶

func (a *FleetApiService) CreateShipShipScan(ctx context.Context, shipSymbol string) (InlineResponse2017, *http.Response, error)

FleetApiService Scan Ships Activate your ship's sensor arrays to scan for ship information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol

@return InlineResponse2017

func (*FleetApiService) CreateShipSystemScan ¶

func (a *FleetApiService) CreateShipSystemScan(ctx context.Context, shipSymbol string) (InlineResponse2015, *http.Response, error)

FleetApiService Scan Systems Activate your ship's sensor arrays to scan for system information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol

@return InlineResponse2015

func (*FleetApiService) CreateShipWaypointScan ¶

func (a *FleetApiService) CreateShipWaypointScan(ctx context.Context, shipSymbol string) (InlineResponse2016, *http.Response, error)

FleetApiService Scan Waypoints Activate your ship's sensor arrays to scan for waypoint information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol

@return InlineResponse2016

func (*FleetApiService) CreateSurvey ¶

func (a *FleetApiService) CreateSurvey(ctx context.Context, shipSymbol string) (InlineResponse2013, *http.Response, error)

FleetApiService Create Survey If you want to target specific yields for an extraction, you can survey a waypoint, such as an asteroid field, and send the survey in the body of the extract request. Each survey may have multiple deposits, and if a symbol shows up more than once, that indicates a higher chance of extracting that resource. Your ship will enter a cooldown between consecutive survey requests. Surveys will eventually expire after a period of time. Multiple ships can use the same survey for extraction.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol The symbol of the ship

@return InlineResponse2013

func (*FleetApiService) DockShip ¶

func (a *FleetApiService) DockShip(ctx context.Context, shipSymbol string) (DockShip200Response, *http.Response, error)

FleetApiService Dock Ship Attempt to dock your ship at it's current location. Docking will only succeed if the waypoint is a dockable location, and your ship is capable of docking at the time of the request. The endpoint is idempotent - successive calls will succeed even if the ship is already docked.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol The symbol of the ship

@return DockShip200Response

func (*FleetApiService) ExtractResources ¶

func (a *FleetApiService) ExtractResources(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiExtractResourcesOpts) (InlineResponse2014, *http.Response, error)

func (*FleetApiService) GetMyShip ¶

func (a *FleetApiService) GetMyShip(ctx context.Context, shipSymbol string) (InlineResponse20016, *http.Response, error)

FleetApiService Get Ship Retrieve the details of your ship.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol

@return InlineResponse20016

func (*FleetApiService) GetMyShipCargo ¶

func (a *FleetApiService) GetMyShipCargo(ctx context.Context, shipSymbol string) (InlineResponse20017, *http.Response, error)

FleetApiService Get Ship Cargo Retrieve the cargo of your ship.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol The symbol of the ship

@return InlineResponse20017

func (*FleetApiService) GetMyShips ¶

func (a *FleetApiService) GetMyShips(ctx context.Context, localVarOptionals *FleetApiGetMyShipsOpts) (InlineResponse20015, *http.Response, error)

func (*FleetApiService) GetShipCooldown ¶

func (a *FleetApiService) GetShipCooldown(ctx context.Context, shipSymbol string) (InlineResponse20018, *http.Response, error)

FleetApiService Get Ship Cooldown Retrieve the details of your ship's reactor cooldown. Some actions such as activating your jump drive, scanning, or extracting resources taxes your reactor and results in a cooldown. Your ship cannot perform additional actions until your cooldown has expired. The duration of your cooldown is relative to the power consumption of the related modules or mounts for the action taken. Response returns a 204 status code (no-content) when the ship has no cooldown.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol

@return InlineResponse20018

func (*FleetApiService) GetShipNav ¶

func (a *FleetApiService) GetShipNav(ctx context.Context, shipSymbol string) (InlineResponse20022, *http.Response, error)

FleetApiService Get Ship Nav Get the current nav status of a ship.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol The ship symbol

@return InlineResponse20022

func (*FleetApiService) Jettison ¶

func (a *FleetApiService) Jettison(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiJettisonOpts) (InlineResponse20019, *http.Response, error)

func (*FleetApiService) JumpShip ¶

func (a *FleetApiService) JumpShip(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiJumpShipOpts) (InlineResponse20020, *http.Response, error)

func (*FleetApiService) NavigateShip ¶

func (a *FleetApiService) NavigateShip(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiNavigateShipOpts) (InlineResponse20021, *http.Response, error)

func (*FleetApiService) OrbitShip ¶

func (a *FleetApiService) OrbitShip(ctx context.Context, shipSymbol string) (OrbitShip200Response, *http.Response, error)

FleetApiService Orbit Ship Attempt to move your ship into orbit at it's current location. The request will only succeed if your ship is capable of moving into orbit at the time of the request. The endpoint is idempotent - successive calls will succeed even if the ship is already in orbit.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol The symbol of the ship

@return OrbitShip200Response

func (*FleetApiService) PatchShipNav ¶

func (a *FleetApiService) PatchShipNav(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiPatchShipNavOpts) (InlineResponse20022, *http.Response, error)

func (*FleetApiService) PurchaseCargo ¶

func (a *FleetApiService) PurchaseCargo(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiPurchaseCargoOpts) (PurchaseCargo201Response, *http.Response, error)

func (*FleetApiService) PurchaseShip ¶

func (a *FleetApiService) PurchaseShip(ctx context.Context, localVarOptionals *FleetApiPurchaseShipOpts) (InlineResponse2011, *http.Response, error)

func (*FleetApiService) RefuelShip ¶

func (a *FleetApiService) RefuelShip(ctx context.Context, shipSymbol string) (InlineResponse20023, *http.Response, error)

FleetApiService Refuel Ship Refuel your ship from the local market.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param shipSymbol

@return InlineResponse20023

func (*FleetApiService) SellCargo ¶

func (a *FleetApiService) SellCargo(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiSellCargoOpts) (SellCargo201Response, *http.Response, error)

func (*FleetApiService) ShipRefine ¶

func (a *FleetApiService) ShipRefine(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiShipRefineOpts) (ShipRefine200Response, *http.Response, error)

func (*FleetApiService) TransferCargo ¶

func (a *FleetApiService) TransferCargo(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiTransferCargoOpts) (TransferCargo200Response, *http.Response, error)

func (*FleetApiService) WarpShip ¶

func (a *FleetApiService) WarpShip(ctx context.Context, shipSymbol string, localVarOptionals *FleetApiWarpShipOpts) (InlineResponse20021, *http.Response, error)

type FleetApiShipRefineOpts ¶

type FleetApiShipRefineOpts struct {
	Body optional.Interface
}

type FleetApiTransferCargoOpts ¶

type FleetApiTransferCargoOpts struct {
	Body optional.Interface
}

type FleetApiWarpShipOpts ¶

type FleetApiWarpShipOpts struct {
	Body optional.Interface
}

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InlineResponse200 ¶

type InlineResponse200 struct {
	Data []System `json:"data"`
	Meta *Meta    `json:"meta"`
}

type InlineResponse2001 ¶

type InlineResponse2001 struct {
	Data *System `json:"data"`
}

type InlineResponse20010 ¶

type InlineResponse20010 struct {
	Data []Contract `json:"data"`
	Meta *Meta      `json:"meta"`
}

type InlineResponse20011 ¶

type InlineResponse20011 struct {
	Data *Contract `json:"data"`
}

type InlineResponse20012 ¶

type InlineResponse20012 struct {
	Data *InlineResponse20012Data `json:"data"`
}

type InlineResponse20012Data ¶

type InlineResponse20012Data struct {
	Agent    *Agent    `json:"agent"`
	Contract *Contract `json:"contract"`
}

type InlineResponse20013 ¶

type InlineResponse20013 struct {
	Data *InlineResponse20013Data `json:"data"`
}

type InlineResponse20013Data ¶

type InlineResponse20013Data struct {
	Contract *Contract  `json:"contract"`
	Cargo    *ShipCargo `json:"cargo"`
}

type InlineResponse20014 ¶

type InlineResponse20014 struct {
	Data *InlineResponse20012Data `json:"data"`
}

type InlineResponse20015 ¶

type InlineResponse20015 struct {
	Data []Ship `json:"data"`
	Meta *Meta  `json:"meta"`
}

type InlineResponse20016 ¶

type InlineResponse20016 struct {
	Data *Ship `json:"data"`
}

type InlineResponse20017 ¶

type InlineResponse20017 struct {
	Data *ShipCargo `json:"data"`
}

type InlineResponse20018 ¶

type InlineResponse20018 struct {
	Data *Cooldown `json:"data"`
}

type InlineResponse20019 ¶

type InlineResponse20019 struct {
	Data *InlineResponse20019Data `json:"data"`
}

type InlineResponse20019Data ¶

type InlineResponse20019Data struct {
	Cargo *ShipCargo `json:"cargo"`
}

type InlineResponse2002 ¶

type InlineResponse2002 struct {
	Data []Waypoint `json:"data"`
	Meta *Meta      `json:"meta"`
}

type InlineResponse20020 ¶

type InlineResponse20020 struct {
	Data *InlineResponse20020Data `json:"data"`
}

type InlineResponse20020Data ¶

type InlineResponse20020Data struct {
	Cooldown *Cooldown `json:"cooldown"`
	Nav      *ShipNav  `json:"nav,omitempty"`
}

type InlineResponse20021 ¶

type InlineResponse20021 struct {
	Data *InlineResponse20021Data `json:"data"`
}

type InlineResponse20021Data ¶

type InlineResponse20021Data struct {
	Fuel *ShipFuel `json:"fuel"`
	Nav  *ShipNav  `json:"nav"`
}

type InlineResponse20022 ¶

type InlineResponse20022 struct {
	Data *ShipNav `json:"data"`
}

type InlineResponse20023 ¶

type InlineResponse20023 struct {
	Data *InlineResponse20023Data `json:"data"`
}

type InlineResponse20023Data ¶

type InlineResponse20023Data struct {
	Agent *Agent    `json:"agent"`
	Fuel  *ShipFuel `json:"fuel"`
}

type InlineResponse2003 ¶

type InlineResponse2003 struct {
	Data *Waypoint `json:"data"`
}

type InlineResponse2004 ¶

type InlineResponse2004 struct {
	Data *Market `json:"data"`
}

type InlineResponse2005 ¶

type InlineResponse2005 struct {
	Data *Shipyard `json:"data"`
}

type InlineResponse2006 ¶

type InlineResponse2006 struct {
	Data *JumpGate `json:"data"`
}

type InlineResponse2007 ¶

type InlineResponse2007 struct {
	Data []Faction `json:"data"`
	Meta *Meta     `json:"meta"`
}

type InlineResponse2008 ¶

type InlineResponse2008 struct {
	Data *Faction `json:"data"`
}

type InlineResponse2009 ¶

type InlineResponse2009 struct {
	Data *Agent `json:"data"`
}

type InlineResponse201 ¶

type InlineResponse201 struct {
	Data *InlineResponse201Data `json:"data"`
}

type InlineResponse2011 ¶

type InlineResponse2011 struct {
	Data *InlineResponse2011Data `json:"data"`
}

type InlineResponse2011Data ¶

type InlineResponse2011Data struct {
	Agent       *Agent               `json:"agent"`
	Ship        *Ship                `json:"ship"`
	Transaction *ShipyardTransaction `json:"transaction"`
}

type InlineResponse2012 ¶

type InlineResponse2012 struct {
	Data *InlineResponse2012Data `json:"data"`
}

type InlineResponse2012Data ¶

type InlineResponse2012Data struct {
	Chart    *Chart    `json:"chart"`
	Waypoint *Waypoint `json:"waypoint"`
}

type InlineResponse2013 ¶

type InlineResponse2013 struct {
	Data *InlineResponse2013Data `json:"data"`
}

type InlineResponse2013Data ¶

type InlineResponse2013Data struct {
	Cooldown *Cooldown `json:"cooldown"`
	Surveys  []Survey  `json:"surveys"`
}

type InlineResponse2014 ¶

type InlineResponse2014 struct {
	Data *InlineResponse2014Data `json:"data"`
}

type InlineResponse2014Data ¶

type InlineResponse2014Data struct {
	Cooldown   *Cooldown   `json:"cooldown"`
	Extraction *Extraction `json:"extraction"`
	Cargo      *ShipCargo  `json:"cargo"`
}

type InlineResponse2015 ¶

type InlineResponse2015 struct {
	Data *InlineResponse2015Data `json:"data"`
}

type InlineResponse2015Data ¶

type InlineResponse2015Data struct {
	Cooldown *Cooldown       `json:"cooldown"`
	Systems  []ScannedSystem `json:"systems"`
}

type InlineResponse2016 ¶

type InlineResponse2016 struct {
	Data *InlineResponse2016Data `json:"data"`
}

type InlineResponse2016Data ¶

type InlineResponse2016Data struct {
	Cooldown  *Cooldown         `json:"cooldown"`
	Waypoints []ScannedWaypoint `json:"waypoints"`
}

type InlineResponse2017 ¶

type InlineResponse2017 struct {
	Data *InlineResponse2017Data `json:"data"`
}

type InlineResponse2017Data ¶

type InlineResponse2017Data struct {
	Cooldown *Cooldown     `json:"cooldown"`
	Ships    []ScannedShip `json:"ships"`
}

type InlineResponse201Data ¶

type InlineResponse201Data struct {
	Agent    *Agent    `json:"agent"`
	Contract *Contract `json:"contract"`
	Faction  *Faction  `json:"faction"`
	Ship     *Ship     `json:"ship"`
	// A Bearer token for accessing secured API endpoints.
	Token string `json:"token"`
}

type JumpGate ¶

type JumpGate struct {
	// The maximum jump range of the gate.
	JumpRange float64 `json:"jumpRange"`
	// The symbol of the faction that owns the gate.
	FactionSymbol string `json:"factionSymbol,omitempty"`
	// The systems within range of the gate that have a corresponding gate.
	ConnectedSystems []ConnectedSystem `json:"connectedSystems"`
}

type Market ¶

type Market struct {
	// The symbol of the market. The symbol is the same as the waypoint where the market is located.
	Symbol string `json:"symbol"`
	// The list of goods that are exported from this market.
	Exports []TradeGood `json:"exports"`
	// The list of goods that are sought as imports in this market.
	Imports []TradeGood `json:"imports"`
	// The list of goods that are bought and sold between agents at this market.
	Exchange []TradeGood `json:"exchange"`
	// The list of recent transactions at this market. Visible only when a ship is present at the market.
	Transactions []MarketTransaction `json:"transactions,omitempty"`
	// The list of goods that are traded at this market. Visible only when a ship is present at the market.
	TradeGoods []MarketTradeGood `json:"tradeGoods,omitempty"`
}

type MarketTradeGood ¶

type MarketTradeGood struct {
	// The symbol of the trade good.
	Symbol string `json:"symbol"`
	// The typical volume flowing through the market for this type of good. The larger the trade volume, the more stable prices will be.
	TradeVolume int32 `json:"tradeVolume"`
	// A rough estimate of the total supply of this good in the marketplace.
	Supply string `json:"supply"`
	// The price at which this good can be purchased from the market.
	PurchasePrice int32 `json:"purchasePrice"`
	// The price at which this good can be sold to the market.
	SellPrice int32 `json:"sellPrice"`
}

type MarketTransaction ¶

type MarketTransaction struct {
	// The symbol of the waypoint where the transaction took place.
	WaypointSymbol string `json:"waypointSymbol"`
	// The symbol of the ship that made the transaction.
	ShipSymbol string `json:"shipSymbol"`
	// The symbol of the trade good.
	TradeSymbol string `json:"tradeSymbol"`
	// The type of transaction.
	Type_ string `json:"type"`
	// The number of units of the transaction.
	Units int32 `json:"units"`
	// The price per unit of the transaction.
	PricePerUnit int32 `json:"pricePerUnit"`
	// The total price of the transaction.
	TotalPrice int32 `json:"totalPrice"`
	// The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`
}

type Meta ¶

type Meta struct {
	Total int32 `json:"total"`
	Page  int32 `json:"page"`
	Limit int32 `json:"limit"`
}

type MyShipsBody ¶

type MyShipsBody struct {
	ShipType *ShipType `json:"shipType"`
	// The symbol of the waypoint you want to purchase the ship at.
	WaypointSymbol string `json:"waypointSymbol"`
}

type OrbitShip200Response ¶

type OrbitShip200Response struct {
	Data *OrbitShip200ResponseData `json:"data"`
}

type OrbitShip200ResponseData ¶

type OrbitShip200ResponseData struct {
	Nav *ShipNav `json:"nav"`
}

type PurchaseCargo201Response ¶

type PurchaseCargo201Response struct {
	Data *SellCargo201ResponseData `json:"data"`
}

type PurchaseCargoRequest ¶

type PurchaseCargoRequest struct {
	Symbol string `json:"symbol"`
	Units  int32  `json:"units"`
}

type RegisterBody ¶

type RegisterBody struct {
	// The faction you choose determines your headquarters.
	Faction string `json:"faction"`
	// How other agents will see your ships and information.
	Symbol string `json:"symbol"`
	// Your email address. This is used if you reserved your call sign between resets.
	Email string `json:"email,omitempty"`
}

type ScannedShip ¶

type ScannedShip struct {
	// The globally unique identifier of the ship.
	Symbol       string              `json:"symbol"`
	Registration *ShipRegistration   `json:"registration"`
	Nav          *ShipNav            `json:"nav"`
	Frame        *ScannedShipFrame   `json:"frame,omitempty"`
	Reactor      *ScannedShipReactor `json:"reactor,omitempty"`
	Engine       *ScannedShipEngine  `json:"engine"`
	Mounts       []ScannedShipMounts `json:"mounts,omitempty"`
}

The ship that was scanned. Details include information about the ship that could be detected by the scanner.

type ScannedShipEngine ¶

type ScannedShipEngine struct {
	Symbol string `json:"symbol"`
}

The engine of the ship.

type ScannedShipFrame ¶

type ScannedShipFrame struct {
	Symbol string `json:"symbol"`
}

The frame of the ship.

type ScannedShipMounts ¶

type ScannedShipMounts struct {
	Symbol string `json:"symbol"`
}

A mount on the ship.

type ScannedShipReactor ¶

type ScannedShipReactor struct {
	Symbol string `json:"symbol"`
}

The reactor of the ship.

type ScannedSystem ¶

type ScannedSystem struct {
	Symbol       string      `json:"symbol"`
	SectorSymbol string      `json:"sectorSymbol"`
	Type_        *SystemType `json:"type"`
	X            int32       `json:"x"`
	Y            int32       `json:"y"`
	Distance     int32       `json:"distance"`
}

type ScannedWaypoint ¶

type ScannedWaypoint struct {
	Symbol       string            `json:"symbol"`
	Type_        *WaypointType     `json:"type"`
	SystemSymbol string            `json:"systemSymbol"`
	X            int32             `json:"x"`
	Y            int32             `json:"y"`
	Orbitals     []WaypointOrbital `json:"orbitals"`
	Faction      *WaypointFaction  `json:"faction,omitempty"`
	// The traits of the waypoint.
	Traits []WaypointTrait `json:"traits"`
	Chart  *Chart          `json:"chart,omitempty"`
}

A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.

type SellCargo201Response ¶

type SellCargo201Response struct {
	Data *SellCargo201ResponseData `json:"data"`
}

type SellCargo201ResponseData ¶

type SellCargo201ResponseData struct {
	Agent       *Agent             `json:"agent"`
	Cargo       *ShipCargo         `json:"cargo"`
	Transaction *MarketTransaction `json:"transaction"`
}

type SellCargoRequest ¶

type SellCargoRequest struct {
	Symbol string `json:"symbol"`
	Units  int32  `json:"units"`
}

type Ship ¶

type Ship struct {
	// The globally unique identifier of the ship in the following format: `[AGENT_SYMBOL]_[HEX_ID]`
	Symbol       string            `json:"symbol"`
	Registration *ShipRegistration `json:"registration"`
	Nav          *ShipNav          `json:"nav"`
	Crew         *ShipCrew         `json:"crew"`
	Frame        *ShipFrame        `json:"frame"`
	Reactor      *ShipReactor      `json:"reactor"`
	Engine       *ShipEngine       `json:"engine"`
	Modules      []ShipModule      `json:"modules"`
	Mounts       []ShipMount       `json:"mounts"`
	Cargo        *ShipCargo        `json:"cargo"`
	Fuel         *ShipFuel         `json:"fuel"`
}

A ship

type ShipCargo ¶

type ShipCargo struct {
	// The max number of items that can be stored in the cargo hold.
	Capacity int32 `json:"capacity"`
	// The number of items currently stored in the cargo hold.
	Units int32 `json:"units"`
	// The items currently in the cargo hold.
	Inventory []ShipCargoItem `json:"inventory"`
}

type ShipCargoItem ¶

type ShipCargoItem struct {
	// The unique identifier of the cargo item type.
	Symbol string `json:"symbol"`
	// The name of the cargo item type.
	Name string `json:"name"`
	// The description of the cargo item type.
	Description string `json:"description"`
	// The number of units of the cargo item.
	Units int32 `json:"units"`
}

The type of cargo item and the number of units.

type ShipCrew ¶

type ShipCrew struct {
	// The current number of crew members on the ship.
	Current int32 `json:"current"`
	// The minimum number of crew members required to maintain the ship.
	Required int32 `json:"required"`
	// The maximum number of crew members the ship can support.
	Capacity int32 `json:"capacity"`
	// The rotation of crew shifts. A stricter shift improves the ship's performance. A more relaxed shift improves the crew's morale.
	Rotation string `json:"rotation"`
	// A rough measure of the crew's morale. A higher morale means the crew is happier and more productive. A lower morale means the ship is more prone to accidents.
	Morale int32 `json:"morale"`
	// The amount of credits per crew member paid per hour. Wages are paid when a ship docks at a civilized waypoint.
	Wages int32 `json:"wages"`
}

The ship's crew service and maintain the ship's systems and equipment.

type ShipEngine ¶

type ShipEngine struct {
	Symbol       string            `json:"symbol"`
	Name         string            `json:"name"`
	Description  string            `json:"description"`
	Condition    int32             `json:"condition,omitempty"`
	Speed        float64           `json:"speed"`
	Requirements *ShipRequirements `json:"requirements"`
}

The engine determines how quickly a ship travels between waypoints.

type ShipFrame ¶

type ShipFrame struct {
	Symbol         string            `json:"symbol"`
	Name           string            `json:"name"`
	Description    string            `json:"description"`
	Condition      int32             `json:"condition,omitempty"`
	ModuleSlots    int32             `json:"moduleSlots"`
	MountingPoints int32             `json:"mountingPoints"`
	FuelCapacity   int32             `json:"fuelCapacity"`
	Requirements   *ShipRequirements `json:"requirements"`
}

The frame of the ship. The frame determines the number of modules and mounting points of the ship, as well as base fuel capacity. As the condition of the frame takes more wear, the ship will become more sluggish and less maneuverable.

type ShipFuel ¶

type ShipFuel struct {
	// The current amount of fuel in the ship's tanks.
	Current int32 `json:"current"`
	// The maximum amount of fuel the ship's tanks can hold.
	Capacity int32             `json:"capacity"`
	Consumed *ShipFuelConsumed `json:"consumed,omitempty"`
}

Details of the ship's fuel tanks including how much fuel was consumed during the last transit or action.

type ShipFuelConsumed ¶

type ShipFuelConsumed struct {
	// The amount of fuel consumed by the most recent transit or action.
	Amount int32 `json:"amount"`
	// The time at which the fuel was consumed.
	Timestamp time.Time `json:"timestamp"`
}

type ShipModule ¶

type ShipModule struct {
	Symbol       string            `json:"symbol"`
	Capacity     int32             `json:"capacity,omitempty"`
	Range_       int32             `json:"range,omitempty"`
	Name         string            `json:"name"`
	Description  string            `json:"description,omitempty"`
	Requirements *ShipRequirements `json:"requirements"`
}

A module can be installed in a ship and provides a set of capabilities such as storage space or quarters for crew. Module installations are permanent.

type ShipMount ¶

type ShipMount struct {
	Symbol       string            `json:"symbol"`
	Name         string            `json:"name"`
	Description  string            `json:"description,omitempty"`
	Strength     int32             `json:"strength,omitempty"`
	Deposits     []string          `json:"deposits,omitempty"`
	Requirements *ShipRequirements `json:"requirements"`
}

A mount is installed on the exterier of a ship.

type ShipNav ¶

type ShipNav struct {
	// The system symbol of the ship's current location.
	SystemSymbol string `json:"systemSymbol"`
	// The waypoint symbol of the ship's current location, or if the ship is in-transit, the waypoint symbol of the ship's destination.
	WaypointSymbol string             `json:"waypointSymbol"`
	Route          *ShipNavRoute      `json:"route"`
	Status         *ShipNavStatus     `json:"status"`
	FlightMode     *ShipNavFlightMode `json:"flightMode"`
}

The navigation information of the ship.

type ShipNavFlightMode ¶

type ShipNavFlightMode string

ShipNavFlightMode : The ship's set speed when traveling between waypoints or systems.

const (
	DRIFT_ShipNavFlightMode   ShipNavFlightMode = "DRIFT"
	STEALTH_ShipNavFlightMode ShipNavFlightMode = "STEALTH"
	CRUISE_ShipNavFlightMode  ShipNavFlightMode = "CRUISE"
	BURN_ShipNavFlightMode    ShipNavFlightMode = "BURN"
)

List of ShipNavFlightMode

type ShipNavRoute ¶

type ShipNavRoute struct {
	Destination *ShipNavRouteWaypoint `json:"destination"`
	Departure   *ShipNavRouteWaypoint `json:"departure"`
	// The date time of the ship's departure.
	DepartureTime time.Time `json:"departureTime"`
	// The date time of the ship's arrival. If the ship is in-transit, this is the expected time of arrival.
	Arrival time.Time `json:"arrival"`
}

The routing information for the ship's most recent transit or current location.

type ShipNavRouteWaypoint ¶

type ShipNavRouteWaypoint struct {
	Symbol       string        `json:"symbol"`
	Type_        *WaypointType `json:"type"`
	SystemSymbol string        `json:"systemSymbol"`
	X            int32         `json:"x"`
	Y            int32         `json:"y"`
}

The destination or departure of a ships nav route.

type ShipNavStatus ¶

type ShipNavStatus string

ShipNavStatus : The current status of the ship

const (
	IN_TRANSIT_ShipNavStatus ShipNavStatus = "IN_TRANSIT"
	IN_ORBIT_ShipNavStatus   ShipNavStatus = "IN_ORBIT"
	DOCKED_ShipNavStatus     ShipNavStatus = "DOCKED"
)

List of ShipNavStatus

type ShipReactor ¶

type ShipReactor struct {
	Symbol       string            `json:"symbol"`
	Name         string            `json:"name"`
	Description  string            `json:"description"`
	Condition    int32             `json:"condition,omitempty"`
	PowerOutput  int32             `json:"powerOutput"`
	Requirements *ShipRequirements `json:"requirements"`
}

The reactor of the ship. The reactor is responsible for powering the ship's systems and weapons.

type ShipRefine200Response ¶

type ShipRefine200Response struct {
	Data *ShipRefine200ResponseData `json:"data"`
}

type ShipRefine200ResponseData ¶

type ShipRefine200ResponseData struct {
	Cargo    *ShipCargo                          `json:"cargo"`
	Cooldown *Cooldown                           `json:"cooldown"`
	Produced []ShipRefine200ResponseDataProduced `json:"produced"`
	Consumed []ShipRefine200ResponseDataProduced `json:"consumed"`
}

type ShipRefine200ResponseDataProduced ¶

type ShipRefine200ResponseDataProduced struct {
	TradeSymbol string `json:"tradeSymbol,omitempty"`
	Units       int32  `json:"units,omitempty"`
}

type ShipRegistration ¶

type ShipRegistration struct {
	// The agent's registered name of the ship
	Name string `json:"name"`
	// The symbol of the faction the ship is registered with
	FactionSymbol string    `json:"factionSymbol"`
	Role          *ShipRole `json:"role"`
}

The public registration information of the ship

type ShipRequirements ¶

type ShipRequirements struct {
	// The amount of power required from the reactor.
	Power int32 `json:"power,omitempty"`
	// The number of crew required for operation.
	Crew int32 `json:"crew,omitempty"`
	// The number of module slots required for installation.
	Slots int32 `json:"slots,omitempty"`
}

The requirements for installation on a ship

type ShipRole ¶

type ShipRole string

ShipRole : The registered role of the ship

const (
	FABRICATOR_ShipRole  ShipRole = "FABRICATOR"
	HARVESTER_ShipRole   ShipRole = "HARVESTER"
	HAULER_ShipRole      ShipRole = "HAULER"
	INTERCEPTOR_ShipRole ShipRole = "INTERCEPTOR"
	EXCAVATOR_ShipRole   ShipRole = "EXCAVATOR"
	TRANSPORT_ShipRole   ShipRole = "TRANSPORT"
	REPAIR_ShipRole      ShipRole = "REPAIR"
	SURVEYOR_ShipRole    ShipRole = "SURVEYOR"
	COMMAND_ShipRole     ShipRole = "COMMAND"
	CARRIER_ShipRole     ShipRole = "CARRIER"
	PATROL_ShipRole      ShipRole = "PATROL"
	SATELLITE_ShipRole   ShipRole = "SATELLITE"
	EXPLORER_ShipRole    ShipRole = "EXPLORER"
	REFINERY_ShipRole    ShipRole = "REFINERY"
)

List of ShipRole

type ShipSymbolExtractBody ¶

type ShipSymbolExtractBody struct {
	Survey *Survey `json:"survey,omitempty"`
}

type ShipSymbolJettisonBody ¶

type ShipSymbolJettisonBody struct {
	Symbol string `json:"symbol"`
	Units  int32  `json:"units"`
}

type ShipSymbolJumpBody ¶

type ShipSymbolJumpBody struct {
	// The system symbol to jump to.
	SystemSymbol string `json:"systemSymbol"`
}

type ShipSymbolNavBody ¶

type ShipSymbolNavBody struct {
	FlightMode *ShipNavFlightMode `json:"flightMode,omitempty"`
}

type ShipSymbolNavigateBody ¶

type ShipSymbolNavigateBody struct {
	// The target destination.
	WaypointSymbol string `json:"waypointSymbol"`
}

type ShipSymbolRefineBody ¶

type ShipSymbolRefineBody struct {
	Produce string `json:"produce"`
}

type ShipSymbolWarpBody ¶

type ShipSymbolWarpBody struct {
	// The target destination.
	WaypointSymbol string `json:"waypointSymbol"`
}

type ShipType ¶

type ShipType string

const (
	PROBE_ShipType              ShipType = "SHIP_PROBE"
	MINING_DRONE_ShipType       ShipType = "SHIP_MINING_DRONE"
	INTERCEPTOR_ShipType        ShipType = "SHIP_INTERCEPTOR"
	LIGHT_HAULER_ShipType       ShipType = "SHIP_LIGHT_HAULER"
	COMMAND_FRIGATE_ShipType    ShipType = "SHIP_COMMAND_FRIGATE"
	EXPLORER_ShipType           ShipType = "SHIP_EXPLORER"
	HEAVY_FREIGHTER_ShipType    ShipType = "SHIP_HEAVY_FREIGHTER"
	LIGHT_SHUTTLE_ShipType      ShipType = "SHIP_LIGHT_SHUTTLE"
	ORE_HOUND_ShipType          ShipType = "SHIP_ORE_HOUND"
	REFINING_FREIGHTER_ShipType ShipType = "SHIP_REFINING_FREIGHTER"
)

List of ShipType

type Shipyard ¶

type Shipyard struct {
	// The symbol of the shipyard. The symbol is the same as the waypoint where the shipyard is located.
	Symbol string `json:"symbol"`
	// The list of ship types available for purchase at this shipyard.
	ShipTypes []ShipyardShipTypes `json:"shipTypes"`
	// The list of recent transactions at this shipyard.
	Transactions []ShipyardTransaction `json:"transactions,omitempty"`
	// The ships that are currently available for purchase at the shipyard.
	Ships []ShipyardShip `json:"ships,omitempty"`
}

type ShipyardShip ¶

type ShipyardShip struct {
	Type_         *ShipType    `json:"type,omitempty"`
	Name          string       `json:"name"`
	Description   string       `json:"description"`
	PurchasePrice int32        `json:"purchasePrice"`
	Frame         *ShipFrame   `json:"frame"`
	Reactor       *ShipReactor `json:"reactor"`
	Engine        *ShipEngine  `json:"engine"`
	Modules       []ShipModule `json:"modules"`
	Mounts        []ShipMount  `json:"mounts"`
}

type ShipyardShipTypes ¶

type ShipyardShipTypes struct {
	Type_ *ShipType `json:"type,omitempty"`
}

type ShipyardTransaction ¶

type ShipyardTransaction struct {
	// The symbol of the waypoint where the transaction took place.
	WaypointSymbol string `json:"waypointSymbol"`
	// The symbol of the ship that was purchased.
	ShipSymbol string `json:"shipSymbol"`
	// The price of the transaction.
	Price int32 `json:"price"`
	// The symbol of the agent that made the transaction.
	AgentSymbol string `json:"agentSymbol"`
	// The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`
}

type Survey ¶

type Survey struct {
	// A unique signature for the location of this survey. This signature is verified when attempting an extraction using this survey.
	Signature string `json:"signature"`
	// The symbol of the waypoint that this survey is for.
	Symbol string `json:"symbol"`
	// A list of deposits that can be found at this location.
	Deposits []SurveyDeposit `json:"deposits"`
	// The date and time when the survey expires. After this date and time, the survey will no longer be available for extraction.
	Expiration time.Time `json:"expiration"`
	// The size of the deposit. This value indicates how much can be extracted from the survey before it is exhausted.
	Size string `json:"size"`
}

A resource survey of a waypoint, detailing a specific extraction location and the types of resources that can be found there.

type SurveyDeposit ¶

type SurveyDeposit struct {
	// The symbol of the deposit.
	Symbol string `json:"symbol"`
}

A surveyed deposit of a mineral or resource available for extraction.

type System ¶

type System struct {
	Symbol       string           `json:"symbol"`
	SectorSymbol string           `json:"sectorSymbol"`
	Type_        *SystemType      `json:"type"`
	X            int32            `json:"x"`
	Y            int32            `json:"y"`
	Waypoints    []SystemWaypoint `json:"waypoints"`
	Factions     []SystemFaction  `json:"factions"`
}

type SystemFaction ¶

type SystemFaction struct {
	Symbol string `json:"symbol"`
}

type SystemType ¶

type SystemType string

SystemType : The type of waypoint.

const (
	NEUTRON_STAR_SystemType SystemType = "NEUTRON_STAR"
	RED_STAR_SystemType     SystemType = "RED_STAR"
	ORANGE_STAR_SystemType  SystemType = "ORANGE_STAR"
	BLUE_STAR_SystemType    SystemType = "BLUE_STAR"
	YOUNG_STAR_SystemType   SystemType = "YOUNG_STAR"
	WHITE_DWARF_SystemType  SystemType = "WHITE_DWARF"
	BLACK_HOLE_SystemType   SystemType = "BLACK_HOLE"
	HYPERGIANT_SystemType   SystemType = "HYPERGIANT"
	NEBULA_SystemType       SystemType = "NEBULA"
	UNSTABLE_SystemType     SystemType = "UNSTABLE"
)

List of SystemType

type SystemWaypoint ¶

type SystemWaypoint struct {
	Symbol string        `json:"symbol"`
	Type_  *WaypointType `json:"type"`
	X      int32         `json:"x"`
	Y      int32         `json:"y"`
}

type SystemsApiGetSystemWaypointsOpts ¶

type SystemsApiGetSystemWaypointsOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type SystemsApiGetSystemsOpts ¶

type SystemsApiGetSystemsOpts struct {
	Page  optional.Int32
	Limit optional.Int32
}

type SystemsApiService ¶

type SystemsApiService service

func (*SystemsApiService) GetJumpGate ¶

func (a *SystemsApiService) GetJumpGate(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2006, *http.Response, error)

SystemsApiService Get Jump Gate Get jump gate details for a waypoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param systemSymbol The system symbol
@param waypointSymbol The waypoint symbol

@return InlineResponse2006

func (*SystemsApiService) GetMarket ¶

func (a *SystemsApiService) GetMarket(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2004, *http.Response, error)

SystemsApiService Get Market Retrieve imports, exports and exchange data from a marketplace. Imports can be sold, exports can be purchased, and exchange goods can be purchased or sold. Send a ship to the waypoint to access trade good prices and recent transactions.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param systemSymbol The system symbol
@param waypointSymbol The waypoint symbol

@return InlineResponse2004

func (*SystemsApiService) GetShipyard ¶

func (a *SystemsApiService) GetShipyard(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2005, *http.Response, error)

SystemsApiService Get Shipyard Get the shipyard for a waypoint. Send a ship to the waypoint to access ships that are currently available for purchase and recent transactions.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param systemSymbol The system symbol
@param waypointSymbol The waypoint symbol

@return InlineResponse2005

func (*SystemsApiService) GetSystem ¶

func (a *SystemsApiService) GetSystem(ctx context.Context, systemSymbol string) (InlineResponse2001, *http.Response, error)

SystemsApiService Get System Get the details of a system.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param systemSymbol The system symbol

@return InlineResponse2001

func (*SystemsApiService) GetSystemWaypoints ¶

func (a *SystemsApiService) GetSystemWaypoints(ctx context.Context, systemSymbol string, localVarOptionals *SystemsApiGetSystemWaypointsOpts) (InlineResponse2002, *http.Response, error)

func (*SystemsApiService) GetSystems ¶

func (a *SystemsApiService) GetSystems(ctx context.Context, localVarOptionals *SystemsApiGetSystemsOpts) (InlineResponse200, *http.Response, error)

func (*SystemsApiService) GetWaypoint ¶

func (a *SystemsApiService) GetWaypoint(ctx context.Context, systemSymbol string, waypointSymbol string) (InlineResponse2003, *http.Response, error)

SystemsApiService Get Waypoint View the details of a waypoint.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param systemSymbol The system symbol
@param waypointSymbol The waypoint symbol

@return InlineResponse2003

type TradeGood ¶

type TradeGood struct {
	Symbol      *TradeSymbol `json:"symbol"`
	Name        string       `json:"name"`
	Description string       `json:"description"`
}

type TradeSymbol ¶

type TradeSymbol string

const (
	PRECIOUS_STONES_TradeSymbol            TradeSymbol = "PRECIOUS_STONES"
	QUARTZ_SAND_TradeSymbol                TradeSymbol = "QUARTZ_SAND"
	SILICON_CRYSTALS_TradeSymbol           TradeSymbol = "SILICON_CRYSTALS"
	AMMONIA_ICE_TradeSymbol                TradeSymbol = "AMMONIA_ICE"
	LIQUID_HYDROGEN_TradeSymbol            TradeSymbol = "LIQUID_HYDROGEN"
	LIQUID_NITROGEN_TradeSymbol            TradeSymbol = "LIQUID_NITROGEN"
	ICE_WATER_TradeSymbol                  TradeSymbol = "ICE_WATER"
	EXOTIC_MATTER_TradeSymbol              TradeSymbol = "EXOTIC_MATTER"
	ADVANCED_CIRCUITRY_TradeSymbol         TradeSymbol = "ADVANCED_CIRCUITRY"
	GRAVITON_EMITTERS_TradeSymbol          TradeSymbol = "GRAVITON_EMITTERS"
	IRON_TradeSymbol                       TradeSymbol = "IRON"
	IRON_ORE_TradeSymbol                   TradeSymbol = "IRON_ORE"
	COPPER_TradeSymbol                     TradeSymbol = "COPPER"
	COPPER_ORE_TradeSymbol                 TradeSymbol = "COPPER_ORE"
	ALUMINUM_TradeSymbol                   TradeSymbol = "ALUMINUM"
	ALUMINUM_ORE_TradeSymbol               TradeSymbol = "ALUMINUM_ORE"
	SILVER_TradeSymbol                     TradeSymbol = "SILVER"
	SILVER_ORE_TradeSymbol                 TradeSymbol = "SILVER_ORE"
	GOLD_TradeSymbol                       TradeSymbol = "GOLD"
	GOLD_ORE_TradeSymbol                   TradeSymbol = "GOLD_ORE"
	PLATINUM_TradeSymbol                   TradeSymbol = "PLATINUM"
	PLATINUM_ORE_TradeSymbol               TradeSymbol = "PLATINUM_ORE"
	DIAMONDS_TradeSymbol                   TradeSymbol = "DIAMONDS"
	URANITE_TradeSymbol                    TradeSymbol = "URANITE"
	URANITE_ORE_TradeSymbol                TradeSymbol = "URANITE_ORE"
	MERITIUM_TradeSymbol                   TradeSymbol = "MERITIUM"
	MERITIUM_ORE_TradeSymbol               TradeSymbol = "MERITIUM_ORE"
	HYDROCARBON_TradeSymbol                TradeSymbol = "HYDROCARBON"
	ANTIMATTER_TradeSymbol                 TradeSymbol = "ANTIMATTER"
	FERTILIZERS_TradeSymbol                TradeSymbol = "FERTILIZERS"
	FABRICS_TradeSymbol                    TradeSymbol = "FABRICS"
	FOOD_TradeSymbol                       TradeSymbol = "FOOD"
	JEWELRY_TradeSymbol                    TradeSymbol = "JEWELRY"
	MACHINERY_TradeSymbol                  TradeSymbol = "MACHINERY"
	FIREARMS_TradeSymbol                   TradeSymbol = "FIREARMS"
	ASSAULT_RIFLES_TradeSymbol             TradeSymbol = "ASSAULT_RIFLES"
	MILITARY_EQUIPMENT_TradeSymbol         TradeSymbol = "MILITARY_EQUIPMENT"
	EXPLOSIVES_TradeSymbol                 TradeSymbol = "EXPLOSIVES"
	LAB_INSTRUMENTS_TradeSymbol            TradeSymbol = "LAB_INSTRUMENTS"
	AMMUNITION_TradeSymbol                 TradeSymbol = "AMMUNITION"
	ELECTRONICS_TradeSymbol                TradeSymbol = "ELECTRONICS"
	SHIP_PLATING_TradeSymbol               TradeSymbol = "SHIP_PLATING"
	EQUIPMENT_TradeSymbol                  TradeSymbol = "EQUIPMENT"
	FUEL_TradeSymbol                       TradeSymbol = "FUEL"
	MEDICINE_TradeSymbol                   TradeSymbol = "MEDICINE"
	DRUGS_TradeSymbol                      TradeSymbol = "DRUGS"
	CLOTHING_TradeSymbol                   TradeSymbol = "CLOTHING"
	MICROPROCESSORS_TradeSymbol            TradeSymbol = "MICROPROCESSORS"
	PLASTICS_TradeSymbol                   TradeSymbol = "PLASTICS"
	POLYNUCLEOTIDES_TradeSymbol            TradeSymbol = "POLYNUCLEOTIDES"
	BIOCOMPOSITES_TradeSymbol              TradeSymbol = "BIOCOMPOSITES"
	NANOBOTS_TradeSymbol                   TradeSymbol = "NANOBOTS"
	AI_MAINFRAMES_TradeSymbol              TradeSymbol = "AI_MAINFRAMES"
	QUANTUM_DRIVES_TradeSymbol             TradeSymbol = "QUANTUM_DRIVES"
	ROBOTIC_DRONES_TradeSymbol             TradeSymbol = "ROBOTIC_DRONES"
	CYBER_IMPLANTS_TradeSymbol             TradeSymbol = "CYBER_IMPLANTS"
	GENE_THERAPEUTICS_TradeSymbol          TradeSymbol = "GENE_THERAPEUTICS"
	NEURAL_CHIPS_TradeSymbol               TradeSymbol = "NEURAL_CHIPS"
	MOOD_REGULATORS_TradeSymbol            TradeSymbol = "MOOD_REGULATORS"
	VIRAL_AGENTS_TradeSymbol               TradeSymbol = "VIRAL_AGENTS"
	MICRO_FUSION_GENERATORS_TradeSymbol    TradeSymbol = "MICRO_FUSION_GENERATORS"
	SUPERGRAINS_TradeSymbol                TradeSymbol = "SUPERGRAINS"
	LASER_RIFLES_TradeSymbol               TradeSymbol = "LASER_RIFLES"
	HOLOGRAPHICS_TradeSymbol               TradeSymbol = "HOLOGRAPHICS"
	SHIP_SALVAGE_TradeSymbol               TradeSymbol = "SHIP_SALVAGE"
	RELIC_TECH_TradeSymbol                 TradeSymbol = "RELIC_TECH"
	NOVEL_LIFEFORMS_TradeSymbol            TradeSymbol = "NOVEL_LIFEFORMS"
	BOTANICAL_SPECIMENS_TradeSymbol        TradeSymbol = "BOTANICAL_SPECIMENS"
	CULTURAL_ARTIFACTS_TradeSymbol         TradeSymbol = "CULTURAL_ARTIFACTS"
	REACTOR_SOLAR_I_TradeSymbol            TradeSymbol = "REACTOR_SOLAR_I"
	REACTOR_FUSION_I_TradeSymbol           TradeSymbol = "REACTOR_FUSION_I"
	REACTOR_FISSION_I_TradeSymbol          TradeSymbol = "REACTOR_FISSION_I"
	REACTOR_CHEMICAL_I_TradeSymbol         TradeSymbol = "REACTOR_CHEMICAL_I"
	REACTOR_ANTIMATTER_I_TradeSymbol       TradeSymbol = "REACTOR_ANTIMATTER_I"
	ENGINE_IMPULSE_DRIVE_I_TradeSymbol     TradeSymbol = "ENGINE_IMPULSE_DRIVE_I"
	ENGINE_ION_DRIVE_I_TradeSymbol         TradeSymbol = "ENGINE_ION_DRIVE_I"
	ENGINE_ION_DRIVE_II_TradeSymbol        TradeSymbol = "ENGINE_ION_DRIVE_II"
	ENGINE_HYPER_DRIVE_I_TradeSymbol       TradeSymbol = "ENGINE_HYPER_DRIVE_I"
	MODULE_MINERAL_PROCESSOR_I_TradeSymbol TradeSymbol = "MODULE_MINERAL_PROCESSOR_I"
	MODULE_CARGO_HOLD_I_TradeSymbol        TradeSymbol = "MODULE_CARGO_HOLD_I"
	MODULE_CREW_QUARTERS_I_TradeSymbol     TradeSymbol = "MODULE_CREW_QUARTERS_I"
	MODULE_ENVOY_QUARTERS_I_TradeSymbol    TradeSymbol = "MODULE_ENVOY_QUARTERS_I"
	MODULE_PASSENGER_CABIN_I_TradeSymbol   TradeSymbol = "MODULE_PASSENGER_CABIN_I"
	MODULE_MICRO_REFINERY_I_TradeSymbol    TradeSymbol = "MODULE_MICRO_REFINERY_I"
	MODULE_ORE_REFINERY_I_TradeSymbol      TradeSymbol = "MODULE_ORE_REFINERY_I"
	MODULE_FUEL_REFINERY_I_TradeSymbol     TradeSymbol = "MODULE_FUEL_REFINERY_I"
	MODULE_SCIENCE_LAB_I_TradeSymbol       TradeSymbol = "MODULE_SCIENCE_LAB_I"
	MODULE_JUMP_DRIVE_I_TradeSymbol        TradeSymbol = "MODULE_JUMP_DRIVE_I"
	MODULE_JUMP_DRIVE_II_TradeSymbol       TradeSymbol = "MODULE_JUMP_DRIVE_II"
	MODULE_JUMP_DRIVE_III_TradeSymbol      TradeSymbol = "MODULE_JUMP_DRIVE_III"
	MODULE_WARP_DRIVE_I_TradeSymbol        TradeSymbol = "MODULE_WARP_DRIVE_I"
	MODULE_WARP_DRIVE_II_TradeSymbol       TradeSymbol = "MODULE_WARP_DRIVE_II"
	MODULE_WARP_DRIVE_III_TradeSymbol      TradeSymbol = "MODULE_WARP_DRIVE_III"
	MODULE_SHIELD_GENERATOR_I_TradeSymbol  TradeSymbol = "MODULE_SHIELD_GENERATOR_I"
	MODULE_SHIELD_GENERATOR_II_TradeSymbol TradeSymbol = "MODULE_SHIELD_GENERATOR_II"
	MOUNT_GAS_SIPHON_I_TradeSymbol         TradeSymbol = "MOUNT_GAS_SIPHON_I"
	MOUNT_GAS_SIPHON_II_TradeSymbol        TradeSymbol = "MOUNT_GAS_SIPHON_II"
	MOUNT_GAS_SIPHON_III_TradeSymbol       TradeSymbol = "MOUNT_GAS_SIPHON_III"
	MOUNT_SURVEYOR_I_TradeSymbol           TradeSymbol = "MOUNT_SURVEYOR_I"
	MOUNT_SURVEYOR_II_TradeSymbol          TradeSymbol = "MOUNT_SURVEYOR_II"
	MOUNT_SURVEYOR_III_TradeSymbol         TradeSymbol = "MOUNT_SURVEYOR_III"
	MOUNT_SENSOR_ARRAY_I_TradeSymbol       TradeSymbol = "MOUNT_SENSOR_ARRAY_I"
	MOUNT_SENSOR_ARRAY_II_TradeSymbol      TradeSymbol = "MOUNT_SENSOR_ARRAY_II"
	MOUNT_SENSOR_ARRAY_III_TradeSymbol     TradeSymbol = "MOUNT_SENSOR_ARRAY_III"
	MOUNT_MINING_LASER_I_TradeSymbol       TradeSymbol = "MOUNT_MINING_LASER_I"
	MOUNT_MINING_LASER_II_TradeSymbol      TradeSymbol = "MOUNT_MINING_LASER_II"
	MOUNT_MINING_LASER_III_TradeSymbol     TradeSymbol = "MOUNT_MINING_LASER_III"
	MOUNT_LASER_CANNON_I_TradeSymbol       TradeSymbol = "MOUNT_LASER_CANNON_I"
	MOUNT_MISSILE_LAUNCHER_I_TradeSymbol   TradeSymbol = "MOUNT_MISSILE_LAUNCHER_I"
	MOUNT_TURRET_I_TradeSymbol             TradeSymbol = "MOUNT_TURRET_I"
)

List of TradeSymbol

type TransferCargo200Response ¶

type TransferCargo200Response struct {
	Data *InlineResponse20019Data `json:"data"`
}

type TransferCargoRequest ¶

type TransferCargoRequest struct {
	TradeSymbol string `json:"tradeSymbol"`
	Units       int32  `json:"units"`
	ShipSymbol  string `json:"shipSymbol"`
}

type Waypoint ¶

type Waypoint struct {
	Symbol       string            `json:"symbol"`
	Type_        *WaypointType     `json:"type"`
	SystemSymbol string            `json:"systemSymbol"`
	X            int32             `json:"x"`
	Y            int32             `json:"y"`
	Orbitals     []WaypointOrbital `json:"orbitals"`
	Faction      *WaypointFaction  `json:"faction,omitempty"`
	// The traits of the waypoint.
	Traits []WaypointTrait `json:"traits"`
	Chart  *Chart          `json:"chart,omitempty"`
}

A waypoint is a location that ships can travel to such as a Planet, Moon or Space Station.

type WaypointFaction ¶

type WaypointFaction struct {
	Symbol string `json:"symbol"`
}

type WaypointOrbital ¶

type WaypointOrbital struct {
	Symbol string `json:"symbol"`
}

An orbital is another waypoint that orbits a parent waypoint.

type WaypointTrait ¶

type WaypointTrait struct {
	// The unique identifier of the trait.
	Symbol string `json:"symbol"`
	// The name of the trait.
	Name string `json:"name"`
	// A description of the trait.
	Description string `json:"description"`
}

type WaypointType ¶

type WaypointType string

WaypointType : The type of waypoint.

const (
	PLANET_WaypointType          WaypointType = "PLANET"
	GAS_GIANT_WaypointType       WaypointType = "GAS_GIANT"
	MOON_WaypointType            WaypointType = "MOON"
	ORBITAL_STATION_WaypointType WaypointType = "ORBITAL_STATION"
	JUMP_GATE_WaypointType       WaypointType = "JUMP_GATE"
	ASTEROID_FIELD_WaypointType  WaypointType = "ASTEROID_FIELD"
	NEBULA_WaypointType          WaypointType = "NEBULA"
	DEBRIS_FIELD_WaypointType    WaypointType = "DEBRIS_FIELD"
	GRAVITY_WELL_WaypointType    WaypointType = "GRAVITY_WELL"
)

List of WaypointType

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL