api

type APIError struct {
	// "{\"error\":{\"message\":\"Waypoint X1-KF5-E24Z is not accessible. Either the waypoint is uncharted or the agent has no ships present at the location.\",\"code\":4001,\"data\":{\"waypointSymbol\":\"X1-KF5-E24Z\"}}}"
	Err struct {
		Message string          `json:"message"`
		Code    int             `json:"code"`
		Data    json.RawMessage `json:"data"`
	} `json:"error"`
}

type ActivityLevel string

type Agent struct {
	// AccountId Account ID that is tied to this agent. Only included on your own agent.
	AccountId *string `json:"accountId,omitempty"`

	// Credits The number of credits the agent has available. Credits can be negative if funds have been overdrawn.
	Credits int64 `json:"credits"`

	// Headquarters The headquarters of the agent.
	Headquarters string `json:"headquarters"`

	// ShipCount How many ships are owned by the agent.
	ShipCount int `json:"shipCount"`

	// StartingFaction The faction the agent started with.
	StartingFaction string `json:"startingFaction"`

	// Symbol Symbol of the agent.
	Symbol string `json:"symbol"`
}

type Chart struct {
	// SubmittedBy The agent that submitted the chart for this waypoint.
	SubmittedBy *string `json:"submittedBy,omitempty"`

	// SubmittedOn The time the chart for this waypoint was submitted.
	SubmittedOn *time.Time `json:"submittedOn,omitempty"`

	// WaypointSymbol The symbol of the waypoint.
	WaypointSymbol *WaypointSymbol `json:"waypointSymbol,omitempty"`
}

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

type Construction struct {
	// IsComplete Whether the waypoint has been constructed.
	IsComplete bool `json:"isComplete"`

	// Materials The materials required to construct the waypoint.
	Materials []ConstructionMaterial `json:"materials"`

	// Symbol The symbol of the waypoint.
	Symbol string `json:"symbol"`
}

type ConstructionMaterial struct {
	// Fulfilled The number of units fulfilled toward the required amount.
	Fulfilled int `json:"fulfilled"`

	// Required The number of units required.
	Required int `json:"required"`

	// TradeSymbol The good's symbol.
	TradeSymbol TradeSymbol `json:"tradeSymbol"`
}

type Contract struct {
	// Accepted Whether the contract has been accepted by the agent
	Accepted bool `json:"accepted"`

	// DeadlineToAccept The time at which the contract is no longer available to be accepted
	DeadlineToAccept *time.Time `json:"deadlineToAccept,omitempty"`

	// Expiration Deprecated in favor of deadlineToAccept
	// Deprecated:
	Expiration time.Time `json:"expiration"`

	// FactionSymbol The symbol of the faction that this contract is for.
	FactionSymbol string `json:"factionSymbol"`

	// Fulfilled Whether the contract has been fulfilled
	Fulfilled bool `json:"fulfilled"`

	// Id ID of the contract.
	Id string `json:"id"`

	// Terms The terms to fulfill the contract.
	Terms ContractTerms `json:"terms"`

	// Type Type of contract.
	Type ContractType `json:"type"`
}

type ContractDeliverGood struct {
	// DestinationSymbol The destination where goods need to be delivered.
	DestinationSymbol string `json:"destinationSymbol"`

	// TradeSymbol The symbol of the trade good to deliver.
	TradeSymbol string `json:"tradeSymbol"`

	// UnitsFulfilled The number of units fulfilled on this contract.
	UnitsFulfilled int `json:"unitsFulfilled"`

	// UnitsRequired The number of units that need to be delivered on this contract.
	UnitsRequired int `json:"unitsRequired"`
}

type ContractPayment struct {
	// OnAccepted The amount of credits received up front for accepting the contract.
	OnAccepted int `json:"onAccepted"`

	// OnFulfilled The amount of credits received when the contract is fulfilled.
	OnFulfilled int `json:"onFulfilled"`
}

type ContractTerms struct {
	// Deadline The deadline for the contract.
	Deadline time.Time `json:"deadline"`

	// Deliver The cargo that needs to be delivered to fulfill the contract.
	Deliver *[]ContractDeliverGood `json:"deliver,omitempty"`

	// Payment Payments for the contract.
	Payment ContractPayment `json:"payment"`
}

type ContractType string

type Cooldown struct {
	// Expiration The date and time when the cooldown expires in ISO 8601 format
	Expiration *time.Time `json:"expiration,omitempty"`

	// RemainingSeconds The remaining duration of the cooldown in seconds
	RemainingSeconds int `json:"remainingSeconds"`

	// ShipSymbol The symbol of the ship that is on cooldown
	ShipSymbol string `json:"shipSymbol"`

	// TotalSeconds The total duration of the cooldown in seconds
	TotalSeconds int `json:"totalSeconds"`
}

type Date struct {
	time.Time
}

type DeliverContractJSONBody struct {
	// ShipSymbol Symbol of a ship located in the destination to deliver a contract and that has a good to deliver in its cargo.
	ShipSymbol string `json:"shipSymbol"`

	// TradeSymbol The symbol of the good to deliver.
	TradeSymbol string `json:"tradeSymbol"`

	// Units Amount of units to deliver.
	Units int `json:"units"`
}

type DeliverContractJSONRequestBody DeliverContractJSONBody

type ExtractResourcesJSONBody struct {
	// Survey A resource survey of a waypoint, detailing a specific extraction location and the types of resources that can be found there.
	Survey *Survey `json:"survey,omitempty"`
}

type ExtractResourcesJSONRequestBody ExtractResourcesJSONBody

type ExtractResourcesWithSurveyJSONRequestBody = Survey

type Extraction struct {
	// ShipSymbol Symbol of the ship that executed the extraction.
	ShipSymbol string `json:"shipSymbol"`

	// Yield A yield from the extraction operation.
	Yield ExtractionYield `json:"yield"`
}

type ExtractionYield struct {
	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// Units The number of units extracted that were placed into the ship's cargo hold.
	Units int `json:"units"`
}

type Faction struct {
	// Description Description of the faction.
	Description string `json:"description"`

	// Headquarters The waypoint in which the faction's HQ is located in.
	Headquarters string `json:"headquarters"`

	// IsRecruiting Whether or not the faction is currently recruiting new agents.
	IsRecruiting bool `json:"isRecruiting"`

	// Name Name of the faction.
	Name string `json:"name"`

	// Symbol The symbol of the faction.
	Symbol FactionSymbol `json:"symbol"`

	// Traits List of traits that define this faction.
	Traits []FactionTrait `json:"traits"`
}

type FactionSymbol string

type FactionTrait struct {
	// Description A description of the trait.
	Description string `json:"description"`

	// Name The name of the trait.
	Name string `json:"name"`

	// Symbol The unique identifier of the trait.
	Symbol FactionTraitSymbol `json:"symbol"`
}

type FactionTraitSymbol string

type GetAgentsParams struct {
	// Page What entry offset to request
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// Limit How many entries to return per page
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

type GetContractsParams struct {
	// Page What entry offset to request
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// Limit How many entries to return per page
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

type GetFactionsParams struct {
	// Page What entry offset to request
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// Limit How many entries to return per page
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

type GetMyShipsParams struct {
	// Page What entry offset to request
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// Limit How many entries to return per page
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

type GetSystemWaypointsParams struct {
	// Page What entry offset to request
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// Limit How many entries to return per page
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Type Filter waypoints by type.
	Type *WaypointType `form:"type,omitempty" json:"type,omitempty"`

	// Traits Filter waypoints by one or more traits.
	Traits *struct {
		// contains filtered or unexported fields
	} `form:"traits,omitempty" json:"traits,omitempty"`
}

type GetSystemWaypointsParamsTraits1 = []WaypointTraitSymbol

type GetSystemsParams struct {
	// Page What entry offset to request
	Page *int `form:"page,omitempty" json:"page,omitempty"`

	// Limit How many entries to return per page
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
}

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

type InstallMountJSONRequestBody InstallMountJSONBody

type JettisonJSONBody struct {
	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// Units Amount of units to jettison of this good.
	Units int `json:"units"`
}

type JettisonJSONRequestBody JettisonJSONBody

type JumpGate struct {
	// Connections All the gates that are connected to this waypoint.
	Connections []string `json:"connections"`

	// Symbol The symbol of the waypoint.
	Symbol WaypointSymbol `json:"symbol"`
}

type JumpShipJSONBody struct {
	// WaypointSymbol The symbol of the waypoint to jump to. The destination must be a connected waypoint.
	WaypointSymbol string `json:"waypointSymbol"`
}

type JumpShipJSONRequestBody JumpShipJSONBody

type Market struct {
	// Exchange The list of goods that are bought and sold between agents at this market.
	Exchange []TradeGood `json:"exchange"`

	// Exports The list of goods that are exported from this market.
	Exports []TradeGood `json:"exports"`

	// Imports The list of goods that are sought as imports in this market.
	Imports []TradeGood `json:"imports"`

	// Symbol The symbol of the market. The symbol is the same as the waypoint where the market is located.
	Symbol string `json:"symbol"`

	// TradeGoods 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"`

	// Transactions The list of recent transactions at this market. Visible only when a ship is present at the market.
	Transactions *[]MarketTransaction `json:"transactions,omitempty"`
}

type MarketTradeGood struct {
	// Activity The activity level of a trade good. If the good is an import, this represents how strong consumption is. If the good is an export, this represents how strong the production is for the good. When activity is strong, consumption or production is near maximum capacity. When activity is weak, consumption or production is near minimum capacity.
	Activity *ActivityLevel `json:"activity,omitempty"`

	// PurchasePrice The price at which this good can be purchased from the market.
	PurchasePrice int `json:"purchasePrice"`

	// SellPrice The price at which this good can be sold to the market.
	SellPrice int `json:"sellPrice"`

	// Supply The supply level of a trade good.
	Supply SupplyLevel `json:"supply"`

	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// TradeVolume This is the maximum number of units that can be purchased or sold at this market in a single trade for this good. Trade volume also gives an indication of price volatility. A market with a low trade volume will have large price swings, while high trade volume will be more resilient to price changes.
	TradeVolume int `json:"tradeVolume"`

	// Type The type of trade good (export, import, or exchange).
	Type MarketTradeGoodType `json:"type"`
}

type MarketTradeGoodType string

type MarketTransaction struct {
	// PricePerUnit The price per unit of the transaction.
	PricePerUnit int `json:"pricePerUnit"`

	// ShipSymbol The symbol of the ship that made the transaction.
	ShipSymbol string `json:"shipSymbol"`

	// Timestamp The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`

	// TotalPrice The total price of the transaction.
	TotalPrice int `json:"totalPrice"`

	// TradeSymbol The symbol of the trade good.
	TradeSymbol string `json:"tradeSymbol"`

	// Type The type of transaction.
	Type MarketTransactionType `json:"type"`

	// Units The number of units of the transaction.
	Units int `json:"units"`

	// WaypointSymbol The symbol of the waypoint.
	WaypointSymbol WaypointSymbol `json:"waypointSymbol"`
}

type MarketTransactionType string

type Meta struct {
	// Limit The amount of items in each page. Limits how many items can be fetched at once.
	Limit int `json:"limit"`

	// Page A page denotes an amount of items, offset from the first item. Each page holds an amount of items equal to the `limit`.
	Page int `json:"page"`

	// Total Shows the total amount of items of this kind that exist.
	Total int `json:"total"`
}

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

type NavigateShipJSONRequestBody NavigateShipJSONBody

type PatchShipNavJSONBody struct {
	// FlightMode The ship's set speed when traveling between waypoints or systems.
	FlightMode *ShipNavFlightMode `json:"flightMode,omitempty"`
}

type PatchShipNavJSONRequestBody PatchShipNavJSONBody

type PurchaseCargoJSONBody struct {
	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// Units Amounts of units to purchase.
	Units int `json:"units"`
}

type PurchaseCargoJSONRequestBody PurchaseCargoJSONBody

type PurchaseShipJSONBody struct {
	// ShipType Type of ship
	ShipType ShipType `json:"shipType"`

	// WaypointSymbol The symbol of the waypoint you want to purchase the ship at.
	WaypointSymbol string `json:"waypointSymbol"`
}

type PurchaseShipJSONRequestBody PurchaseShipJSONBody

type RefuelShipJSONBody struct {
	// FromCargo Wether to use the FUEL thats in your cargo or not. Default: false
	FromCargo *bool `json:"fromCargo,omitempty"`

	// Units The amount of fuel to fill in the ship's tanks. When not specified, the ship will be refueled to its maximum fuel capacity. If the amount specified is greater than the ship's remaining capacity, the ship will only be refueled to its maximum fuel capacity. The amount specified is not in market units but in ship fuel units.
	Units *int `json:"units,omitempty"`
}

type RefuelShipJSONRequestBody RefuelShipJSONBody

type RegisterJSONBody struct {
	// Email Your email address. This is used if you reserved your call sign between resets.
	Email *string `json:"email,omitempty"`

	// Faction The symbol of the faction.
	Faction FactionSymbol `json:"faction"`

	// Symbol Your desired agent symbol. This will be a unique name used to represent your agent, and will be the prefix for your ships.
	Symbol string `json:"symbol"`
}

type RegisterJSONRequestBody RegisterJSONBody

type RemoveMountJSONBody struct {
	// Symbol The symbol of the mount to remove.
	Symbol string `json:"symbol"`
}

type RemoveMountJSONRequestBody RemoveMountJSONBody

type RepairTransaction struct {
	// ShipSymbol The symbol of the ship.
	ShipSymbol string `json:"shipSymbol"`

	// Timestamp The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`

	// TotalPrice The total price of the transaction.
	TotalPrice int `json:"totalPrice"`

	// WaypointSymbol The symbol of the waypoint.
	WaypointSymbol WaypointSymbol `json:"waypointSymbol"`
}

type ScannedShip struct {
	// Engine The engine of the ship.
	Engine struct {
		// Symbol The symbol of the engine.
		Symbol string `json:"symbol"`
	} `json:"engine"`

	// Frame The frame of the ship.
	Frame *struct {
		// Symbol The symbol of the frame.
		Symbol string `json:"symbol"`
	} `json:"frame,omitempty"`

	// Mounts List of mounts installed in the ship.
	Mounts *[]struct {
		// Symbol The symbol of the mount.
		Symbol string `json:"symbol"`
	} `json:"mounts,omitempty"`

	// Nav The navigation information of the ship.
	Nav ShipNav `json:"nav"`

	// Reactor The reactor of the ship.
	Reactor *struct {
		// Symbol The symbol of the reactor.
		Symbol string `json:"symbol"`
	} `json:"reactor,omitempty"`

	// Registration The public registration information of the ship
	Registration ShipRegistration `json:"registration"`

	// Symbol The globally unique identifier of the ship.
	Symbol string `json:"symbol"`
}

type ScannedSystem struct {
	// Distance The system's distance from the scanning ship.
	Distance int `json:"distance"`

	// SectorSymbol Symbol of the system's sector.
	SectorSymbol string `json:"sectorSymbol"`

	// Symbol Symbol of the system.
	Symbol string `json:"symbol"`

	// Type The type of system.
	Type SystemType `json:"type"`

	// X Position in the universe in the x axis.
	X int `json:"x"`

	// Y Position in the universe in the y axis.
	Y int `json:"y"`
}

type ScannedWaypoint struct {
	// Chart The chart of a system or waypoint, which makes the location visible to other agents.
	Chart *Chart `json:"chart,omitempty"`

	// Faction The faction that controls the waypoint.
	Faction *WaypointFaction `json:"faction,omitempty"`

	// Orbitals List of waypoints that orbit this waypoint.
	Orbitals []WaypointOrbital `json:"orbitals"`

	// Symbol The symbol of the waypoint.
	Symbol WaypointSymbol `json:"symbol"`

	// SystemSymbol The symbol of the system.
	SystemSymbol SystemSymbol `json:"systemSymbol"`

	// Traits The traits of the waypoint.
	Traits []WaypointTrait `json:"traits"`

	// Type The type of waypoint.
	Type WaypointType `json:"type"`

	// X Position in the universe in the x axis.
	X int `json:"x"`

	// Y Position in the universe in the y axis.
	Y int `json:"y"`
}

type ScrapTransaction struct {
	// ShipSymbol The symbol of the ship.
	ShipSymbol string `json:"shipSymbol"`

	// Timestamp The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`

	// TotalPrice The total price of the transaction.
	TotalPrice int `json:"totalPrice"`

	// WaypointSymbol The symbol of the waypoint.
	WaypointSymbol WaypointSymbol `json:"waypointSymbol"`
}

type SellCargoJSONBody struct {
	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// Units Amounts of units to sell of the selected good.
	Units int `json:"units"`
}

type SellCargoJSONRequestBody SellCargoJSONBody

type Ship struct {
	// Cargo Ship cargo details.
	Cargo ShipCargo `json:"cargo"`

	// Cooldown A cooldown is a period of time in which a ship cannot perform certain actions.
	Cooldown Cooldown `json:"cooldown"`

	// Crew The ship's crew service and maintain the ship's systems and equipment.
	Crew ShipCrew `json:"crew"`

	// Engine The engine determines how quickly a ship travels between waypoints.
	Engine ShipEngine `json:"engine"`

	// Frame 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.
	Frame ShipFrame `json:"frame"`

	// Fuel Details of the ship's fuel tanks including how much fuel was consumed during the last transit or action.
	Fuel ShipFuel `json:"fuel"`

	// Modules Modules installed in this ship.
	Modules []ShipModule `json:"modules"`

	// Mounts Mounts installed in this ship.
	Mounts []ShipMount `json:"mounts"`

	// Nav The navigation information of the ship.
	Nav ShipNav `json:"nav"`

	// Reactor The reactor of the ship. The reactor is responsible for powering the ship's systems and weapons.
	Reactor ShipReactor `json:"reactor"`

	// Registration The public registration information of the ship
	Registration ShipRegistration `json:"registration"`

	// Symbol The globally unique identifier of the ship in the following format: `[AGENT_SYMBOL]-[HEX_ID]`
	Symbol string `json:"symbol"`
}

type ShipCargo struct {
	// Capacity The max number of items that can be stored in the cargo hold.
	Capacity int `json:"capacity"`

	// Inventory The items currently in the cargo hold.
	Inventory []ShipCargoItem `json:"inventory"`

	// Units The number of items currently stored in the cargo hold.
	Units int `json:"units"`
}

type ShipCargoItem struct {
	// Description The description of the cargo item type.
	Description string `json:"description"`

	// Name The name of the cargo item type.
	Name string `json:"name"`

	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// Units The number of units of the cargo item.
	Units int `json:"units"`
}

type ShipComponentCondition = float64

type ShipComponentIntegrity = float64

type ShipConditionEvent struct {
	Component ShipConditionEventComponent `json:"component"`

	// Description A description of the event.
	Description string `json:"description"`

	// Name The name of the event.
	Name   string                   `json:"name"`
	Symbol ShipConditionEventSymbol `json:"symbol"`
}

type ShipConditionEventComponent string

type ShipConditionEventSymbol string

type ShipCrew struct {
	// Capacity The maximum number of crew members the ship can support.
	Capacity int `json:"capacity"`

	// Current The current number of crew members on the ship.
	Current int `json:"current"`

	// Morale 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 int `json:"morale"`

	// Required The minimum number of crew members required to maintain the ship.
	Required int `json:"required"`

	// Rotation The rotation of crew shifts. A stricter shift improves the ship's performance. A more relaxed shift improves the crew's morale.
	Rotation ShipCrewRotation `json:"rotation"`

	// Wages The amount of credits per crew member paid per hour. Wages are paid when a ship docks at a civilized waypoint.
	Wages int `json:"wages"`
}

type ShipCrewRotation string

type ShipEngine struct {
	// Condition The repairable condition of a component. A value of 0 indicates the component needs significant repairs, while a value of 1 indicates the component is in near perfect condition. As the condition of a component is repaired, the overall integrity of the component decreases.
	Condition ShipComponentCondition `json:"condition"`

	// Description The description of the engine.
	Description string `json:"description"`

	// Integrity The overall integrity of the component, which determines the performance of the component. A value of 0 indicates that the component is almost completely degraded, while a value of 1 indicates that the component is in near perfect condition. The integrity of the component is non-repairable, and represents permanent wear over time.
	Integrity ShipComponentIntegrity `json:"integrity"`

	// Name The name of the engine.
	Name string `json:"name"`

	// Requirements The requirements for installation on a ship
	Requirements ShipRequirements `json:"requirements"`

	// Speed The speed stat of this engine. The higher the speed, the faster a ship can travel from one point to another. Reduces the time of arrival when navigating the ship.
	Speed int `json:"speed"`

	// Symbol The symbol of the engine.
	Symbol ShipEngineSymbol `json:"symbol"`
}

type ShipEngineSymbol string

type ShipFrame struct {
	// Condition The repairable condition of a component. A value of 0 indicates the component needs significant repairs, while a value of 1 indicates the component is in near perfect condition. As the condition of a component is repaired, the overall integrity of the component decreases.
	Condition ShipComponentCondition `json:"condition"`

	// Description Description of the frame.
	Description string `json:"description"`

	// FuelCapacity The maximum amount of fuel that can be stored in this ship. When refueling, the ship will be refueled to this amount.
	FuelCapacity int `json:"fuelCapacity"`

	// Integrity The overall integrity of the component, which determines the performance of the component. A value of 0 indicates that the component is almost completely degraded, while a value of 1 indicates that the component is in near perfect condition. The integrity of the component is non-repairable, and represents permanent wear over time.
	Integrity ShipComponentIntegrity `json:"integrity"`

	// ModuleSlots The amount of slots that can be dedicated to modules installed in the ship. Each installed module take up a number of slots, and once there are no more slots, no new modules can be installed.
	ModuleSlots int `json:"moduleSlots"`

	// MountingPoints The amount of slots that can be dedicated to mounts installed in the ship. Each installed mount takes up a number of points, and once there are no more points remaining, no new mounts can be installed.
	MountingPoints int `json:"mountingPoints"`

	// Name Name of the frame.
	Name string `json:"name"`

	// Requirements The requirements for installation on a ship
	Requirements ShipRequirements `json:"requirements"`

	// Symbol Symbol of the frame.
	Symbol ShipFrameSymbol `json:"symbol"`
}

type ShipFrameSymbol string

type ShipFuel struct {
	// Capacity The maximum amount of fuel the ship's tanks can hold.
	Capacity int `json:"capacity"`

	// Consumed An object that only shows up when an action has consumed fuel in the process. Shows the fuel consumption data.
	Consumed *struct {
		// Amount The amount of fuel consumed by the most recent transit or action.
		Amount int `json:"amount"`

		// Timestamp The time at which the fuel was consumed.
		Timestamp time.Time `json:"timestamp"`
	} `json:"consumed,omitempty"`

	// Current The current amount of fuel in the ship's tanks.
	Current int `json:"current"`
}

type ShipModificationTransaction struct {
	// ShipSymbol The symbol of the ship that made the transaction.
	ShipSymbol string `json:"shipSymbol"`

	// Timestamp The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`

	// TotalPrice The total price of the transaction.
	TotalPrice int `json:"totalPrice"`

	// TradeSymbol The symbol of the trade good.
	TradeSymbol string `json:"tradeSymbol"`

	// WaypointSymbol The symbol of the waypoint where the transaction took place.
	WaypointSymbol string `json:"waypointSymbol"`
}

type ShipModule struct {
	// Capacity Modules that provide capacity, such as cargo hold or crew quarters will show this value to denote how much of a bonus the module grants.
	Capacity *int `json:"capacity,omitempty"`

	// Description Description of this module.
	Description string `json:"description"`

	// Name Name of this module.
	Name string `json:"name"`

	// Range Modules that have a range will such as a sensor array show this value to denote how far can the module reach with its capabilities.
	Range *int `json:"range,omitempty"`

	// Requirements The requirements for installation on a ship
	Requirements ShipRequirements `json:"requirements"`

	// Symbol The symbol of the module.
	Symbol ShipModuleSymbol `json:"symbol"`
}

type ShipModuleSymbol string

type ShipMount struct {
	// Deposits Mounts that have this value denote what goods can be produced from using the mount.
	Deposits *[]ShipMountDeposits `json:"deposits,omitempty"`

	// Description Description of this mount.
	Description *string `json:"description,omitempty"`

	// Name Name of this mount.
	Name string `json:"name"`

	// Requirements The requirements for installation on a ship
	Requirements ShipRequirements `json:"requirements"`

	// Strength Mounts that have this value, such as mining lasers, denote how powerful this mount's capabilities are.
	Strength *int `json:"strength,omitempty"`

	// Symbol Symbo of this mount.
	Symbol ShipMountSymbol `json:"symbol"`
}

type ShipMountDeposits string

type ShipMountSymbol string

type ShipNav struct {
	// FlightMode The ship's set speed when traveling between waypoints or systems.
	FlightMode ShipNavFlightMode `json:"flightMode"`

	// Route The routing information for the ship's most recent transit or current location.
	Route ShipNavRoute `json:"route"`

	// Status The current status of the ship
	Status ShipNavStatus `json:"status"`

	// SystemSymbol The symbol of the system.
	SystemSymbol SystemSymbol `json:"systemSymbol"`

	// WaypointSymbol The symbol of the waypoint.
	WaypointSymbol WaypointSymbol `json:"waypointSymbol"`
}

type ShipNavFlightMode string

type ShipNavRoute struct {
	// Arrival 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"`

	// DepartureTime The date time of the ship's departure.
	DepartureTime time.Time `json:"departureTime"`

	// Destination The destination or departure of a ships nav route.
	Destination ShipNavRouteWaypoint `json:"destination"`

	// Origin The destination or departure of a ships nav route.
	Origin ShipNavRouteWaypoint `json:"origin"`
}

type ShipNavRouteWaypoint struct {
	// Symbol The symbol of the waypoint.
	Symbol string `json:"symbol"`

	// SystemSymbol The symbol of the system.
	SystemSymbol SystemSymbol `json:"systemSymbol"`

	// Type The type of waypoint.
	Type WaypointType `json:"type"`

	// X Position in the universe in the x axis.
	X int `json:"x"`

	// Y Position in the universe in the y axis.
	Y int `json:"y"`
}

type ShipNavStatus string

type ShipReactor struct {
	// Condition The repairable condition of a component. A value of 0 indicates the component needs significant repairs, while a value of 1 indicates the component is in near perfect condition. As the condition of a component is repaired, the overall integrity of the component decreases.
	Condition ShipComponentCondition `json:"condition"`

	// Description Description of the reactor.
	Description string `json:"description"`

	// Integrity The overall integrity of the component, which determines the performance of the component. A value of 0 indicates that the component is almost completely degraded, while a value of 1 indicates that the component is in near perfect condition. The integrity of the component is non-repairable, and represents permanent wear over time.
	Integrity ShipComponentIntegrity `json:"integrity"`

	// Name Name of the reactor.
	Name string `json:"name"`

	// PowerOutput The amount of power provided by this reactor. The more power a reactor provides to the ship, the lower the cooldown it gets when using a module or mount that taxes the ship's power.
	PowerOutput int `json:"powerOutput"`

	// Requirements The requirements for installation on a ship
	Requirements ShipRequirements `json:"requirements"`

	// Symbol Symbol of the reactor.
	Symbol ShipReactorSymbol `json:"symbol"`
}

type ShipReactorSymbol string

type ShipRefineJSONBody struct {
	// Produce The type of good to produce out of the refining process.
	Produce ShipRefineJSONBodyProduce `json:"produce"`
}

type ShipRefineJSONBodyProduce string

type ShipRefineJSONRequestBody ShipRefineJSONBody

type ShipRegistration struct {
	// FactionSymbol The symbol of the faction the ship is registered with
	FactionSymbol string `json:"factionSymbol"`

	// Name The agent's registered name of the ship
	Name string `json:"name"`

	// Role The registered role of the ship
	Role ShipRole `json:"role"`
}

type ShipRequirements struct {
	// Crew The number of crew required for operation.
	Crew *int `json:"crew,omitempty"`

	// Power The amount of power required from the reactor.
	Power *int `json:"power,omitempty"`

	// Slots The number of module slots required for installation.
	Slots *int `json:"slots,omitempty"`
}

type ShipRole string

type ShipType string

type Shipyard struct {
	// ModificationsFee The fee to modify a ship at this shipyard. This includes installing or removing modules and mounts on a ship. In the case of mounts, the fee is a flat rate per mount. In the case of modules, the fee is per slot the module occupies.
	ModificationsFee int `json:"modificationsFee"`

	// ShipTypes The list of ship types available for purchase at this shipyard.
	ShipTypes []struct {
		// Type Type of ship
		Type ShipType `json:"type"`
	} `json:"shipTypes"`

	// Ships The ships that are currently available for purchase at the shipyard.
	Ships *[]ShipyardShip `json:"ships,omitempty"`

	// Symbol The symbol of the shipyard. The symbol is the same as the waypoint where the shipyard is located.
	Symbol string `json:"symbol"`

	// Transactions The list of recent transactions at this shipyard.
	Transactions *[]ShipyardTransaction `json:"transactions,omitempty"`
}

type ShipyardShip struct {
	// Activity The activity level of a trade good. If the good is an import, this represents how strong consumption is. If the good is an export, this represents how strong the production is for the good. When activity is strong, consumption or production is near maximum capacity. When activity is weak, consumption or production is near minimum capacity.
	Activity *ActivityLevel `json:"activity,omitempty"`
	Crew     struct {
		Capacity int `json:"capacity"`
		Required int `json:"required"`
	} `json:"crew"`
	Description string `json:"description"`

	// Engine The engine determines how quickly a ship travels between waypoints.
	Engine ShipEngine `json:"engine"`

	// Frame 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.
	Frame         ShipFrame    `json:"frame"`
	Modules       []ShipModule `json:"modules"`
	Mounts        []ShipMount  `json:"mounts"`
	Name          string       `json:"name"`
	PurchasePrice int          `json:"purchasePrice"`

	// Reactor The reactor of the ship. The reactor is responsible for powering the ship's systems and weapons.
	Reactor ShipReactor `json:"reactor"`

	// Supply The supply level of a trade good.
	Supply SupplyLevel `json:"supply"`

	// Type Type of ship
	Type ShipType `json:"type"`
}

type ShipyardTransaction struct {
	// AgentSymbol The symbol of the agent that made the transaction.
	AgentSymbol string `json:"agentSymbol"`

	// Price The price of the transaction.
	Price int `json:"price"`

	// ShipSymbol The symbol of the ship that was the subject of the transaction.
	// Deprecated:
	ShipSymbol string `json:"shipSymbol"`

	// ShipType The symbol of the ship that was the subject of the transaction.
	ShipType string `json:"shipType"`

	// Timestamp The timestamp of the transaction.
	Timestamp time.Time `json:"timestamp"`

	// WaypointSymbol The symbol of the waypoint.
	WaypointSymbol WaypointSymbol `json:"waypointSymbol"`
}

type Siphon struct {
	// ShipSymbol Symbol of the ship that executed the siphon.
	ShipSymbol string `json:"shipSymbol"`

	// Yield A yield from the siphon operation.
	Yield SiphonYield `json:"yield"`
}

type SiphonYield struct {
	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`

	// Units The number of units siphoned that were placed into the ship's cargo hold.
	Units int `json:"units"`
}

type Status struct {
	Status    string `json:"status"`
	Version   string `json:"version"`
	LastReset Date   `json:"resetDate"`
	Resets    struct {
		Next      time.Time `json:"next"`
		Frequency string    `json:"frequency"`
	} `json:"serverResets"`
	Statistics struct {
		Agents    int64 `json:"agents"`
		Ships     int64 `json:"ships"`
		Waypoints int64 `json:"waypoints"`
		Systems   int64 `json:"systems"`
	} `json:"stats"`
	Announcements []struct {
		Title string `json:"title"`
		Body  string `json:"body"`
	} `json:"announcements"`
}

type SupplyConstructionJSONBody struct {
	// ShipSymbol Symbol of the ship to use.
	ShipSymbol string `json:"shipSymbol"`

	// TradeSymbol The symbol of the good to supply.
	TradeSymbol string `json:"tradeSymbol"`

	// Units Amount of units to supply.
	Units int `json:"units"`
}

type SupplyConstructionJSONRequestBody SupplyConstructionJSONBody

type SupplyLevel string

type Survey struct {
	// Deposits A list of deposits that can be found at this location. A ship will extract one of these deposits when using this survey in an extraction request. If multiple deposits of the same type are present, the chance of extracting that deposit is increased.
	Deposits []SurveyDeposit `json:"deposits"`

	// Expiration 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"`

	// Signature A unique signature for the location of this survey. This signature is verified when attempting an extraction using this survey.
	Signature string `json:"signature"`

	// Size The size of the deposit. This value indicates how much can be extracted from the survey before it is exhausted.
	Size SurveySize `json:"size"`

	// Symbol The symbol of the waypoint that this survey is for.
	Symbol string `json:"symbol"`
}

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

type SurveySize string

type System struct {
	// Factions Factions that control this system.
	Factions []SystemFaction `json:"factions"`

	// SectorSymbol The symbol of the sector.
	SectorSymbol string `json:"sectorSymbol"`

	// Symbol The symbol of the system.
	Symbol string `json:"symbol"`

	// Type The type of system.
	Type SystemType `json:"type"`

	// Waypoints Waypoints in this system.
	Waypoints []SystemWaypoint `json:"waypoints"`

	// X Relative position of the system in the sector in the x axis.
	X int `json:"x"`

	// Y Relative position of the system in the sector in the y axis.
	Y int `json:"y"`
}

type SystemFaction struct {
	// Symbol The symbol of the faction.
	Symbol FactionSymbol `json:"symbol"`
}

type SystemSymbol = string

type SystemType string

type SystemWaypoint struct {
	// Orbitals Waypoints that orbit this waypoint.
	Orbitals []WaypointOrbital `json:"orbitals"`

	// Orbits The symbol of the parent waypoint, if this waypoint is in orbit around another waypoint. Otherwise this value is undefined.
	Orbits *string `json:"orbits,omitempty"`

	// Symbol The symbol of the waypoint.
	Symbol WaypointSymbol `json:"symbol"`

	// Type The type of waypoint.
	Type WaypointType `json:"type"`

	// X Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe.
	X int `json:"x"`

	// Y Relative position of the waypoint on the system's y axis. This is not an absolute position in the universe.
	Y int `json:"y"`
}

type TradeGood struct {
	// Description The description of the good.
	Description string `json:"description"`

	// Name The name of the good.
	Name string `json:"name"`

	// Symbol The good's symbol.
	Symbol TradeSymbol `json:"symbol"`
}

type TradeSymbol string

type TransferCargoJSONBody struct {
	// ShipSymbol The symbol of the ship to transfer to.
	ShipSymbol string `json:"shipSymbol"`

	// TradeSymbol The good's symbol.
	TradeSymbol TradeSymbol `json:"tradeSymbol"`

	// Units Amount of units to transfer.
	Units int `json:"units"`
}

type TransferCargoJSONRequestBody TransferCargoJSONBody

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

type WarpShipJSONRequestBody WarpShipJSONBody

type Waypoint struct {
	// Chart The chart of a system or waypoint, which makes the location visible to other agents.
	Chart *Chart `json:"chart,omitempty"`

	// Faction The faction that controls the waypoint.
	Faction *WaypointFaction `json:"faction,omitempty"`

	// IsUnderConstruction True if the waypoint is under construction.
	IsUnderConstruction bool `json:"isUnderConstruction"`

	// Modifiers The modifiers of the waypoint.
	Modifiers *[]WaypointModifier `json:"modifiers,omitempty"`

	// Orbitals Waypoints that orbit this waypoint.
	Orbitals []WaypointOrbital `json:"orbitals"`

	// Orbits The symbol of the parent waypoint, if this waypoint is in orbit around another waypoint. Otherwise this value is undefined.
	Orbits *string `json:"orbits,omitempty"`

	// Symbol The symbol of the waypoint.
	Symbol WaypointSymbol `json:"symbol"`

	// SystemSymbol The symbol of the system.
	SystemSymbol SystemSymbol `json:"systemSymbol"`

	// Traits The traits of the waypoint.
	Traits []WaypointTrait `json:"traits"`

	// Type The type of waypoint.
	Type WaypointType `json:"type"`

	// X Relative position of the waypoint on the system's x axis. This is not an absolute position in the universe.
	X int `json:"x"`

	// Y Relative position of the waypoint on the system's y axis. This is not an absolute position in the universe.
	Y int `json:"y"`
}

type WaypointFaction struct {
	// Symbol The symbol of the faction.
	Symbol FactionSymbol `json:"symbol"`
}

type WaypointModifier struct {
	// Description A description of the trait.
	Description string `json:"description"`

	// Name The name of the trait.
	Name string `json:"name"`

	// Symbol The unique identifier of the modifier.
	Symbol WaypointModifierSymbol `json:"symbol"`
}

type WaypointModifierSymbol string

type WaypointOrbital struct {
	// Symbol The symbol of the orbiting waypoint.
	Symbol string `json:"symbol"`
}

type WaypointSymbol = string

type WaypointTrait struct {
	// Description A description of the trait.
	Description string `json:"description"`

	// Name The name of the trait.
	Name string `json:"name"`

	// Symbol The unique identifier of the trait.
	Symbol WaypointTraitSymbol `json:"symbol"`
}

type WaypointTraitSymbol string

type WaypointType string