planefinder

package module
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

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

Index

Constants

View Source
const ServerURL = "https://api.planefinder.net/api"

ServerURL is the base URL of the planefinder API. Pass it to NewClient or NewClientWithResponses.

Variables

This section is empty.

Functions

func NewGetAirlineSummaryRequest

func NewGetAirlineSummaryRequest(server string, icao string) (*http.Request, error)

NewGetAirlineSummaryRequest constructs an http.Request for the GetAirlineSummary method

func NewGetAirportSummaryRequest

func NewGetAirportSummaryRequest(server string, code string) (*http.Request, error)

NewGetAirportSummaryRequest constructs an http.Request for the GetAirportSummary method

func NewGetHistoricAircraftPositionsRequest

func NewGetHistoricAircraftPositionsRequest(server string, timestamp int, params *GetHistoricAircraftPositionsParams) (*http.Request, error)

NewGetHistoricAircraftPositionsRequest constructs an http.Request for the GetHistoricAircraftPositions method

func NewGetHistoricFlightRecordsRequest

func NewGetHistoricFlightRecordsRequest(server string, params *GetHistoricFlightRecordsParams) (*http.Request, error)

NewGetHistoricFlightRecordsRequest constructs an http.Request for the GetHistoricFlightRecords method

func NewGetHistoricFlightTrackRequest

func NewGetHistoricFlightTrackRequest(server string, flightId string) (*http.Request, error)

NewGetHistoricFlightTrackRequest constructs an http.Request for the GetHistoricFlightTrack method

func NewGetLiveAircraftPositionsExtendedRequest

func NewGetLiveAircraftPositionsExtendedRequest(server string, params *GetLiveAircraftPositionsExtendedParams) (*http.Request, error)

NewGetLiveAircraftPositionsExtendedRequest constructs an http.Request for the GetLiveAircraftPositionsExtended method

func NewGetLiveAircraftPositionsRequest

func NewGetLiveAircraftPositionsRequest(server string, params *GetLiveAircraftPositionsParams) (*http.Request, error)

NewGetLiveAircraftPositionsRequest constructs an http.Request for the GetLiveAircraftPositions method

func NewGetMetarsExtendedRequest

func NewGetMetarsExtendedRequest(server string, icao string, params *GetMetarsExtendedParams) (*http.Request, error)

NewGetMetarsExtendedRequest constructs an http.Request for the GetMetarsExtended method

func NewGetMetarsRequest

func NewGetMetarsRequest(server string, icao string, params *GetMetarsParams) (*http.Request, error)

NewGetMetarsRequest constructs an http.Request for the GetMetars method

func NewGetTafsExtendedRequest

func NewGetTafsExtendedRequest(server string, icao string, params *GetTafsExtendedParams) (*http.Request, error)

NewGetTafsExtendedRequest constructs an http.Request for the GetTafsExtended method

func NewGetTafsRequest

func NewGetTafsRequest(server string, icao string, params *GetTafsParams) (*http.Request, error)

NewGetTafsRequest constructs an http.Request for the GetTafs method

Types

type AirlineResource

type AirlineResource struct {
	// AtcCallsign ATC voice callsign
	//
	// Examples: SPEEDBIRD
	AtcCallsign string `json:"atcCallsign"`

	// Country Country of registration
	//
	// Examples: United Kingdom
	Country string `json:"country"`

	// CountryCode ISO 3166-1 alpha-2 country code
	//
	// Examples: GB
	CountryCode string `json:"countryCode"`

	// Iata IATA airline code
	//
	// Examples: BA
	Iata string `json:"iata"`

	// Icao ICAO airline designator
	//
	// Examples: BAW
	Icao string `json:"icao"`

	// Name Airline name
	//
	// Examples: British Airways
	Name string `json:"name"`
}

AirlineResource defines model for AirlineResource.

type AirportResource

type AirportResource struct {
	// City City name
	//
	// Examples: London
	City string `json:"city"`

	// Country Country name
	//
	// Examples: United Kingdom
	Country string `json:"country"`

	// CountryCode ISO 3166-1 alpha-2 country code
	//
	// Examples: GB
	CountryCode string `json:"countryCode"`

	// Elevation Elevation (in feet)
	//
	// Examples: 83
	Elevation *int `json:"elevation"`

	// Iata IATA airport code
	//
	// Examples: LHR
	Iata string `json:"iata"`

	// Icao ICAO airport code
	//
	// Examples: EGLL
	Icao string `json:"icao"`

	// Latitude Latitude in decimal degrees
	//
	// Examples: 51.4775
	Latitude *float32 `json:"latitude"`

	// Longitude Longitude in decimal degrees
	//
	// Examples: -0.461389
	Longitude *float32 `json:"longitude"`

	// Name Full airport name
	//
	// Examples: Heathrow Airport
	Name string `json:"name"`

	// Timezone Timezone information for the airport
	Timezone *struct {
		// Code Timezone abbreviation
		//
		// Examples: BST
		Code string `json:"code"`

		// Name IANA timezone name
		//
		// Examples: Europe/London
		Name string `json:"name"`

		// Offset UTC offset in seconds
		//
		// Examples: 3600
		Offset string `json:"offset"`
	} `json:"timezone"`
}

AirportResource defines model for AirportResource.

type ApiAccessSuspended

type ApiAccessSuspended struct {
	// Message Error overview.
	//
	// Examples: Your API access has been suspended. Please contact support for assistance.
	Message string `json:"message"`
}

ApiAccessSuspended defines model for ApiAccessSuspended.

type Client

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

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

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

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

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

Creates a new Client, with reasonable defaults

func (*Client) GetAirlineSummary

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

GetAirlineSummary Airline Summary

Returns metadata for an airline identified by its ICAO designator.

Corresponds with GET /v1/airline/{icao}/summary (the `GetAirlineSummary` operationId).

func (*Client) GetAirportSummary

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

GetAirportSummary Airport Summary

Returns metadata for an airport identified by its IATA or ICAO code.

Corresponds with GET /v1/airport/{code}/summary (the `GetAirportSummary` operationId).

func (*Client) GetHistoricAircraftPositions

func (c *Client) GetHistoricAircraftPositions(ctx context.Context, timestamp int, params *GetHistoricAircraftPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetHistoricAircraftPositions Historic Aircraft Positions

Returns aircraft positions at a given snapshot timestamp.

Results can be filtered. For more information please consult the [documentation](/docs/historic-data).

Corresponds with GET /v1/historic/aircraft/{timestamp} (the `GetHistoricAircraftPositions` operationId).

func (*Client) GetHistoricFlightRecords

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

GetHistoricFlightRecords Historic Flight Records

Returns a list of historic flights for the flight number, callsign, reg, or ICAO 24-bit hex provided. Multiple comma-separated values are accepted.

For more information please consult the [documentation](/docs/historic-data#historic-flight-records).

Corresponds with GET /v1/historic/flights (the `GetHistoricFlightRecords` operationId).

func (*Client) GetHistoricFlightTrack

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

GetHistoricFlightTrack Historic Flight Track

Returns a summary of the requested flight, including metadata and full flight track (positions)

For more information please consult the [documentation](/docs/historic-data#historic-flight-track).

Corresponds with GET /v1/historic/flight/{flightId} (the `GetHistoricFlightTrack` operationId).

func (*Client) GetLiveAircraftPositions

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

GetLiveAircraftPositions Live Aircraft Positions

Returns real-time aircraft telemetry data. Results can be filtered.

For more information please consult the [documentation](/docs/live-data).

Corresponds with GET /v1/live/aircraft (the `GetLiveAircraftPositions` operationId).

func (*Client) GetLiveAircraftPositionsExtended

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

GetLiveAircraftPositionsExtended Live Aircraft Positions (Extended)

Returns extended aircraft telemetry including additional flight details. Results can be filtered.

For more information please consult the [documentation](/docs/live-data).

Corresponds with GET /v1/live/aircraft/extended (the `GetLiveAircraftPositionsExtended` operationId).

func (*Client) GetMetars

func (c *Client) GetMetars(ctx context.Context, icao string, params *GetMetarsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMetars METAR Reports

Returns all available METAR observations for a station identified by its ICAO code.

Corresponds with GET /v1/weather/metars/{icao} (the `GetMetars` operationId).

func (*Client) GetMetarsExtended

func (c *Client) GetMetarsExtended(ctx context.Context, icao string, params *GetMetarsExtendedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMetarsExtended METAR Reports (Extended)

Returns all available METAR observations for a station, including decoded reports.

Corresponds with GET /v1/weather/metars/{icao}/extended (the `GetMetarsExtended` operationId).

func (*Client) GetTafs

func (c *Client) GetTafs(ctx context.Context, icao string, params *GetTafsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetTafs TAF Reports

Returns all available TAF forecasts for a station identified by its ICAO code.

Corresponds with GET /v1/weather/tafs/{icao} (the `GetTafs` operationId).

func (*Client) GetTafsExtended

func (c *Client) GetTafsExtended(ctx context.Context, icao string, params *GetTafsExtendedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetTafsExtended TAF Reports (Extended)

Returns all available TAF forecasts for a station, including decoded reports.

Corresponds with GET /v1/weather/tafs/{icao}/extended (the `GetTafsExtended` operationId).

type ClientInterface

type ClientInterface interface {

	// GetAirlineSummary Airline Summary
	//
	// Returns metadata for an airline identified by its ICAO designator.
	//
	// Corresponds with GET /v1/airline/{icao}/summary (the `GetAirlineSummary` operationId).
	GetAirlineSummary(ctx context.Context, icao string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAirportSummary Airport Summary
	//
	// Returns metadata for an airport identified by its IATA or ICAO code.
	//
	// Corresponds with GET /v1/airport/{code}/summary (the `GetAirportSummary` operationId).
	GetAirportSummary(ctx context.Context, code string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricAircraftPositions Historic Aircraft Positions
	//
	// Returns aircraft positions at a given snapshot timestamp.
	//
	// Results can be filtered. For more information please consult the [documentation](/docs/historic-data).
	//
	// Corresponds with GET /v1/historic/aircraft/{timestamp} (the `GetHistoricAircraftPositions` operationId).
	GetHistoricAircraftPositions(ctx context.Context, timestamp int, params *GetHistoricAircraftPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricFlightTrack Historic Flight Track
	//
	// Returns a summary of the requested flight, including metadata and full flight track (positions)
	//
	// For more information please consult the [documentation](/docs/historic-data#historic-flight-track).
	//
	// Corresponds with GET /v1/historic/flight/{flightId} (the `GetHistoricFlightTrack` operationId).
	GetHistoricFlightTrack(ctx context.Context, flightId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricFlightRecords Historic Flight Records
	//
	// Returns a list of historic flights for the flight number, callsign, reg, or ICAO 24-bit hex provided. Multiple comma-separated values are accepted.
	//
	// For more information please consult the [documentation](/docs/historic-data#historic-flight-records).
	//
	// Corresponds with GET /v1/historic/flights (the `GetHistoricFlightRecords` operationId).
	GetHistoricFlightRecords(ctx context.Context, params *GetHistoricFlightRecordsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLiveAircraftPositions Live Aircraft Positions
	//
	// Returns real-time aircraft telemetry data. Results can be filtered.
	//
	// For more information please consult the [documentation](/docs/live-data).
	//
	// Corresponds with GET /v1/live/aircraft (the `GetLiveAircraftPositions` operationId).
	GetLiveAircraftPositions(ctx context.Context, params *GetLiveAircraftPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLiveAircraftPositionsExtended Live Aircraft Positions (Extended)
	//
	// Returns extended aircraft telemetry including additional flight details. Results can be filtered.
	//
	// For more information please consult the [documentation](/docs/live-data).
	//
	// Corresponds with GET /v1/live/aircraft/extended (the `GetLiveAircraftPositionsExtended` operationId).
	GetLiveAircraftPositionsExtended(ctx context.Context, params *GetLiveAircraftPositionsExtendedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMetars METAR Reports
	//
	// Returns all available METAR observations for a station identified by its ICAO code.
	//
	// Corresponds with GET /v1/weather/metars/{icao} (the `GetMetars` operationId).
	GetMetars(ctx context.Context, icao string, params *GetMetarsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMetarsExtended METAR Reports (Extended)
	//
	// Returns all available METAR observations for a station, including decoded reports.
	//
	// Corresponds with GET /v1/weather/metars/{icao}/extended (the `GetMetarsExtended` operationId).
	GetMetarsExtended(ctx context.Context, icao string, params *GetMetarsExtendedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTafs TAF Reports
	//
	// Returns all available TAF forecasts for a station identified by its ICAO code.
	//
	// Corresponds with GET /v1/weather/tafs/{icao} (the `GetTafs` operationId).
	GetTafs(ctx context.Context, icao string, params *GetTafsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTafsExtended TAF Reports (Extended)
	//
	// Returns all available TAF forecasts for a station, including decoded reports.
	//
	// Corresponds with GET /v1/weather/tafs/{icao}/extended (the `GetTafsExtended` operationId).
	GetTafsExtended(ctx context.Context, icao string, params *GetTafsExtendedParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithAuthentication

func WithAuthentication(apiKey string) ClientOption

WithAuthentication returns a ClientOption that authenticates each request by setting the Authorization header to "Bearer <apiKey>".

https://api.planefinder.net/docs/getting-started

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

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

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

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

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

func (*ClientWithResponses) GetAirlineSummaryWithResponse

func (c *ClientWithResponses) GetAirlineSummaryWithResponse(ctx context.Context, icao string, reqEditors ...RequestEditorFn) (*GetAirlineSummaryResponse, error)

GetAirlineSummaryWithResponse Airline Summary

Returns metadata for an airline identified by its ICAO designator.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/airline/{icao}/summary (the `GetAirlineSummary` operationId).

func (*ClientWithResponses) GetAirportSummaryWithResponse

func (c *ClientWithResponses) GetAirportSummaryWithResponse(ctx context.Context, code string, reqEditors ...RequestEditorFn) (*GetAirportSummaryResponse, error)

GetAirportSummaryWithResponse Airport Summary

Returns metadata for an airport identified by its IATA or ICAO code.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/airport/{code}/summary (the `GetAirportSummary` operationId).

func (*ClientWithResponses) GetHistoricAircraftPositionsWithResponse

func (c *ClientWithResponses) GetHistoricAircraftPositionsWithResponse(ctx context.Context, timestamp int, params *GetHistoricAircraftPositionsParams, reqEditors ...RequestEditorFn) (*GetHistoricAircraftPositionsResponse, error)

GetHistoricAircraftPositionsWithResponse Historic Aircraft Positions

Returns aircraft positions at a given snapshot timestamp.

Results can be filtered. For more information please consult the [documentation](/docs/historic-data).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/historic/aircraft/{timestamp} (the `GetHistoricAircraftPositions` operationId).

func (*ClientWithResponses) GetHistoricFlightRecordsWithResponse

func (c *ClientWithResponses) GetHistoricFlightRecordsWithResponse(ctx context.Context, params *GetHistoricFlightRecordsParams, reqEditors ...RequestEditorFn) (*GetHistoricFlightRecordsResponse, error)

GetHistoricFlightRecordsWithResponse Historic Flight Records

Returns a list of historic flights for the flight number, callsign, reg, or ICAO 24-bit hex provided. Multiple comma-separated values are accepted.

For more information please consult the [documentation](/docs/historic-data#historic-flight-records).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/historic/flights (the `GetHistoricFlightRecords` operationId).

func (*ClientWithResponses) GetHistoricFlightTrackWithResponse

func (c *ClientWithResponses) GetHistoricFlightTrackWithResponse(ctx context.Context, flightId string, reqEditors ...RequestEditorFn) (*GetHistoricFlightTrackResponse, error)

GetHistoricFlightTrackWithResponse Historic Flight Track

Returns a summary of the requested flight, including metadata and full flight track (positions)

For more information please consult the [documentation](/docs/historic-data#historic-flight-track).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/historic/flight/{flightId} (the `GetHistoricFlightTrack` operationId).

func (*ClientWithResponses) GetLiveAircraftPositionsExtendedWithResponse

func (c *ClientWithResponses) GetLiveAircraftPositionsExtendedWithResponse(ctx context.Context, params *GetLiveAircraftPositionsExtendedParams, reqEditors ...RequestEditorFn) (*GetLiveAircraftPositionsExtendedResponse, error)

GetLiveAircraftPositionsExtendedWithResponse Live Aircraft Positions (Extended)

Returns extended aircraft telemetry including additional flight details. Results can be filtered.

For more information please consult the [documentation](/docs/live-data).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/live/aircraft/extended (the `GetLiveAircraftPositionsExtended` operationId).

func (*ClientWithResponses) GetLiveAircraftPositionsWithResponse

func (c *ClientWithResponses) GetLiveAircraftPositionsWithResponse(ctx context.Context, params *GetLiveAircraftPositionsParams, reqEditors ...RequestEditorFn) (*GetLiveAircraftPositionsResponse, error)

GetLiveAircraftPositionsWithResponse Live Aircraft Positions

Returns real-time aircraft telemetry data. Results can be filtered.

For more information please consult the [documentation](/docs/live-data).

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/live/aircraft (the `GetLiveAircraftPositions` operationId).

func (*ClientWithResponses) GetMetarsExtendedWithResponse

func (c *ClientWithResponses) GetMetarsExtendedWithResponse(ctx context.Context, icao string, params *GetMetarsExtendedParams, reqEditors ...RequestEditorFn) (*GetMetarsExtendedResponse, error)

GetMetarsExtendedWithResponse METAR Reports (Extended)

Returns all available METAR observations for a station, including decoded reports.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/weather/metars/{icao}/extended (the `GetMetarsExtended` operationId).

func (*ClientWithResponses) GetMetarsWithResponse

func (c *ClientWithResponses) GetMetarsWithResponse(ctx context.Context, icao string, params *GetMetarsParams, reqEditors ...RequestEditorFn) (*GetMetarsResponse, error)

GetMetarsWithResponse METAR Reports

Returns all available METAR observations for a station identified by its ICAO code.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/weather/metars/{icao} (the `GetMetars` operationId).

func (*ClientWithResponses) GetTafsExtendedWithResponse

func (c *ClientWithResponses) GetTafsExtendedWithResponse(ctx context.Context, icao string, params *GetTafsExtendedParams, reqEditors ...RequestEditorFn) (*GetTafsExtendedResponse, error)

GetTafsExtendedWithResponse TAF Reports (Extended)

Returns all available TAF forecasts for a station, including decoded reports.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/weather/tafs/{icao}/extended (the `GetTafsExtended` operationId).

func (*ClientWithResponses) GetTafsWithResponse

func (c *ClientWithResponses) GetTafsWithResponse(ctx context.Context, icao string, params *GetTafsParams, reqEditors ...RequestEditorFn) (*GetTafsResponse, error)

GetTafsWithResponse TAF Reports

Returns all available TAF forecasts for a station identified by its ICAO code.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/weather/tafs/{icao} (the `GetTafs` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// GetAirlineSummaryWithResponse Airline Summary
	//
	// Returns metadata for an airline identified by its ICAO designator.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/airline/{icao}/summary (the `GetAirlineSummary` operationId).
	GetAirlineSummaryWithResponse(ctx context.Context, icao string, reqEditors ...RequestEditorFn) (*GetAirlineSummaryResponse, error)

	// GetAirportSummaryWithResponse Airport Summary
	//
	// Returns metadata for an airport identified by its IATA or ICAO code.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/airport/{code}/summary (the `GetAirportSummary` operationId).
	GetAirportSummaryWithResponse(ctx context.Context, code string, reqEditors ...RequestEditorFn) (*GetAirportSummaryResponse, error)

	// GetHistoricAircraftPositionsWithResponse Historic Aircraft Positions
	//
	// Returns aircraft positions at a given snapshot timestamp.
	//
	// Results can be filtered. For more information please consult the [documentation](/docs/historic-data).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/historic/aircraft/{timestamp} (the `GetHistoricAircraftPositions` operationId).
	GetHistoricAircraftPositionsWithResponse(ctx context.Context, timestamp int, params *GetHistoricAircraftPositionsParams, reqEditors ...RequestEditorFn) (*GetHistoricAircraftPositionsResponse, error)

	// GetHistoricFlightTrackWithResponse Historic Flight Track
	//
	// Returns a summary of the requested flight, including metadata and full flight track (positions)
	//
	// For more information please consult the [documentation](/docs/historic-data#historic-flight-track).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/historic/flight/{flightId} (the `GetHistoricFlightTrack` operationId).
	GetHistoricFlightTrackWithResponse(ctx context.Context, flightId string, reqEditors ...RequestEditorFn) (*GetHistoricFlightTrackResponse, error)

	// GetHistoricFlightRecordsWithResponse Historic Flight Records
	//
	// Returns a list of historic flights for the flight number, callsign, reg, or ICAO 24-bit hex provided. Multiple comma-separated values are accepted.
	//
	// For more information please consult the [documentation](/docs/historic-data#historic-flight-records).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/historic/flights (the `GetHistoricFlightRecords` operationId).
	GetHistoricFlightRecordsWithResponse(ctx context.Context, params *GetHistoricFlightRecordsParams, reqEditors ...RequestEditorFn) (*GetHistoricFlightRecordsResponse, error)

	// GetLiveAircraftPositionsWithResponse Live Aircraft Positions
	//
	// Returns real-time aircraft telemetry data. Results can be filtered.
	//
	// For more information please consult the [documentation](/docs/live-data).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/live/aircraft (the `GetLiveAircraftPositions` operationId).
	GetLiveAircraftPositionsWithResponse(ctx context.Context, params *GetLiveAircraftPositionsParams, reqEditors ...RequestEditorFn) (*GetLiveAircraftPositionsResponse, error)

	// GetLiveAircraftPositionsExtendedWithResponse Live Aircraft Positions (Extended)
	//
	// Returns extended aircraft telemetry including additional flight details. Results can be filtered.
	//
	// For more information please consult the [documentation](/docs/live-data).
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/live/aircraft/extended (the `GetLiveAircraftPositionsExtended` operationId).
	GetLiveAircraftPositionsExtendedWithResponse(ctx context.Context, params *GetLiveAircraftPositionsExtendedParams, reqEditors ...RequestEditorFn) (*GetLiveAircraftPositionsExtendedResponse, error)

	// GetMetarsWithResponse METAR Reports
	//
	// Returns all available METAR observations for a station identified by its ICAO code.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/weather/metars/{icao} (the `GetMetars` operationId).
	GetMetarsWithResponse(ctx context.Context, icao string, params *GetMetarsParams, reqEditors ...RequestEditorFn) (*GetMetarsResponse, error)

	// GetMetarsExtendedWithResponse METAR Reports (Extended)
	//
	// Returns all available METAR observations for a station, including decoded reports.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/weather/metars/{icao}/extended (the `GetMetarsExtended` operationId).
	GetMetarsExtendedWithResponse(ctx context.Context, icao string, params *GetMetarsExtendedParams, reqEditors ...RequestEditorFn) (*GetMetarsExtendedResponse, error)

	// GetTafsWithResponse TAF Reports
	//
	// Returns all available TAF forecasts for a station identified by its ICAO code.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/weather/tafs/{icao} (the `GetTafs` operationId).
	GetTafsWithResponse(ctx context.Context, icao string, params *GetTafsParams, reqEditors ...RequestEditorFn) (*GetTafsResponse, error)

	// GetTafsExtendedWithResponse TAF Reports (Extended)
	//
	// Returns all available TAF forecasts for a station, including decoded reports.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/weather/tafs/{icao}/extended (the `GetTafsExtended` operationId).
	GetTafsExtendedWithResponse(ctx context.Context, icao string, params *GetTafsExtendedParams, reqEditors ...RequestEditorFn) (*GetTafsExtendedResponse, error)
}

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

type CloudLayer

type CloudLayer struct {
	// Cover Cloud cover amount code
	//
	// Examples: FEW
	Cover *string `json:"cover"`

	// HeightFt Cloud base height in feet
	//
	// Examples: 2500
	HeightFt *int `json:"heightFt"`

	// HeightM Cloud base height in metres
	//
	// Examples: 762
	HeightM *int `json:"heightM"`

	// Type Significant cloud type code, if present
	//
	// Examples: CB
	Type *string `json:"type"`
}

CloudLayer defines model for CloudLayer.

type ForecastTemperature

type ForecastTemperature struct {
	// Celsius Forecast temperature in degrees Celsius
	//
	// Examples: 22
	Celsius *int `json:"celsius"`

	// Day Day of month when this temperature is forecast
	//
	// Examples: 16
	Day *int `json:"day"`

	// Fahrenheit Forecast temperature in degrees Fahrenheit
	//
	// Examples: 72
	Fahrenheit *int `json:"fahrenheit"`

	// Hour Hour UTC when this temperature is forecast
	//
	// Examples: 14
	Hour *int `json:"hour"`
}

ForecastTemperature defines model for ForecastTemperature.

type GetAirlineSummaryResponse

type GetAirlineSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data AirlineResource `json:"data"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ModelNotFoundException
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetAirlineSummaryResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetAirlineSummaryResponse429Headers
}

func ParseGetAirlineSummaryResponse

func ParseGetAirlineSummaryResponse(rsp *http.Response) (*GetAirlineSummaryResponse, error)

ParseGetAirlineSummaryResponse parses an HTTP response from a GetAirlineSummaryWithResponse call

func (GetAirlineSummaryResponse) ContentType

func (r GetAirlineSummaryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAirlineSummaryResponse) GetBody

func (r GetAirlineSummaryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAirlineSummaryResponse) GetJSON200

func (r GetAirlineSummaryResponse) GetJSON200() *struct {
	Data AirlineResource `json:"data"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAirlineSummaryResponse) GetJSON401

func (r GetAirlineSummaryResponse) GetJSON401() *Unauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetAirlineSummaryResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetAirlineSummaryResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetAirlineSummaryResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetAirlineSummaryResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetAirlineSummaryResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetAirlineSummaryResponse) Status

func (r GetAirlineSummaryResponse) Status() string

Status returns HTTPResponse.Status

func (GetAirlineSummaryResponse) StatusCode

func (r GetAirlineSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAirlineSummaryResponse200Headers

type GetAirlineSummaryResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetAirlineSummaryResponse200Headers the declared response headers of an HTTP 200 response for GetAirlineSummary

type GetAirlineSummaryResponse429Headers

type GetAirlineSummaryResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetAirlineSummaryResponse429Headers the declared response headers of an HTTP 429 response for GetAirlineSummary

type GetAirportSummaryResponse

type GetAirportSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data AirportResource `json:"data"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ModelNotFoundException
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetAirportSummaryResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetAirportSummaryResponse429Headers
}

func ParseGetAirportSummaryResponse

func ParseGetAirportSummaryResponse(rsp *http.Response) (*GetAirportSummaryResponse, error)

ParseGetAirportSummaryResponse parses an HTTP response from a GetAirportSummaryWithResponse call

func (GetAirportSummaryResponse) ContentType

func (r GetAirportSummaryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetAirportSummaryResponse) GetBody

func (r GetAirportSummaryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAirportSummaryResponse) GetJSON200

func (r GetAirportSummaryResponse) GetJSON200() *struct {
	Data AirportResource `json:"data"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetAirportSummaryResponse) GetJSON401

func (r GetAirportSummaryResponse) GetJSON401() *Unauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetAirportSummaryResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetAirportSummaryResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetAirportSummaryResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetAirportSummaryResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetAirportSummaryResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetAirportSummaryResponse) Status

func (r GetAirportSummaryResponse) Status() string

Status returns HTTPResponse.Status

func (GetAirportSummaryResponse) StatusCode

func (r GetAirportSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAirportSummaryResponse200Headers

type GetAirportSummaryResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetAirportSummaryResponse200Headers the declared response headers of an HTTP 200 response for GetAirportSummary

type GetAirportSummaryResponse429Headers

type GetAirportSummaryResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetAirportSummaryResponse429Headers the declared response headers of an HTTP 429 response for GetAirportSummary

type GetHistoricAircraftPositionsParams

type GetHistoricAircraftPositionsParams struct {
	// Adshex ICAO 24-bit hex address. Accepts a comma-separated list.
	Adshex *string `form:"adshex,omitempty" json:"adshex,omitempty"`

	// Reg Aircraft registration. Accepts a comma-separated list.
	Reg *string `form:"reg,omitempty" json:"reg,omitempty"`

	// Callsign Callsign. Accepts a comma-separated list.
	Callsign *string `form:"callsign,omitempty" json:"callsign,omitempty"`

	// FlightNumber Flight number. Accepts a comma-separated list.
	FlightNumber *string `form:"flight_number,omitempty" json:"flight_number,omitempty"`

	// OperatorIcao Operator ICAO airline code. Accepts a comma-separated list.
	OperatorIcao *string `form:"operator_icao,omitempty" json:"operator_icao,omitempty"`

	// MinLat Southern latitude bound of a bounding box (-90 to 90). All four bounds must be provided together.
	MinLat *float32 `form:"min_lat,omitempty" json:"min_lat,omitempty"`

	// MaxLat Northern latitude bound of a bounding box (-90 to 90). All four bounds must be provided together.
	MaxLat *float32 `form:"max_lat,omitempty" json:"max_lat,omitempty"`

	// MinLon Western longitude bound of a bounding box (-180 to 180). All four bounds must be provided together.
	MinLon *float32 `form:"min_lon,omitempty" json:"min_lon,omitempty"`

	// MaxLon Eastern longitude bound of a bounding box (-180 to 180). All four bounds must be provided together.
	MaxLon *float32 `form:"max_lon,omitempty" json:"max_lon,omitempty"`

	// MinAltitude Minimum altitude filter in feet.
	MinAltitude *int `form:"min_altitude,omitempty" json:"min_altitude,omitempty"`

	// MaxAltitude Maximum altitude filter in feet.
	MaxAltitude *int `form:"max_altitude,omitempty" json:"max_altitude,omitempty"`

	// Squawk 4-digit transponder squawk code.
	Squawk *string `form:"squawk,omitempty" json:"squawk,omitempty"`

	// Type ICAO aircraft type designator. Accepts a comma-separated list.
	Type       *string                                       `form:"type,omitempty" json:"type,omitempty"`
	Class      *GetHistoricAircraftPositionsParamsClass      `form:"class,omitempty" json:"class,omitempty"`
	DataSource *GetHistoricAircraftPositionsParamsDataSource `form:"data_source,omitempty" json:"data_source,omitempty"`

	// PerPage Number of results per page. Maximum is plan-dependent; requests above the limit are silently clamped.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`

	// Cursor Pagination cursor from the previous response's `meta.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetHistoricAircraftPositionsParams defines parameters for GetHistoricAircraftPositions.

type GetHistoricAircraftPositionsParamsClass

type GetHistoricAircraftPositionsParamsClass string

GetHistoricAircraftPositionsParamsClass defines parameters for GetHistoricAircraftPositions.

const (
	GetHistoricAircraftPositionsParamsClassBUSINESS    GetHistoricAircraftPositionsParamsClass = "BUSINESS"
	GetHistoricAircraftPositionsParamsClassCARGO       GetHistoricAircraftPositionsParamsClass = "CARGO"
	GetHistoricAircraftPositionsParamsClassCOMMERCIAL  GetHistoricAircraftPositionsParamsClass = "COMMERCIAL"
	GetHistoricAircraftPositionsParamsClassGENERAL     GetHistoricAircraftPositionsParamsClass = "GENERAL"
	GetHistoricAircraftPositionsParamsClassHELICOPTER  GetHistoricAircraftPositionsParamsClass = "HELICOPTER"
	GetHistoricAircraftPositionsParamsClassLessThannil GetHistoricAircraftPositionsParamsClass = "<nil>"
	GetHistoricAircraftPositionsParamsClassMILITARY    GetHistoricAircraftPositionsParamsClass = "MILITARY"
	GetHistoricAircraftPositionsParamsClassUNKNOWN     GetHistoricAircraftPositionsParamsClass = "UNKNOWN"
	GetHistoricAircraftPositionsParamsClassUNMANNED    GetHistoricAircraftPositionsParamsClass = "UNMANNED"
)

Defines values for GetHistoricAircraftPositionsParamsClass.

func (GetHistoricAircraftPositionsParamsClass) Valid

Valid indicates whether the value is a known member of the GetHistoricAircraftPositionsParamsClass enum.

type GetHistoricAircraftPositionsParamsDataSource

type GetHistoricAircraftPositionsParamsDataSource string

GetHistoricAircraftPositionsParamsDataSource defines parameters for GetHistoricAircraftPositions.

const (
	GetHistoricAircraftPositionsParamsDataSourceADSB        GetHistoricAircraftPositionsParamsDataSource = "ADSB"
	GetHistoricAircraftPositionsParamsDataSourceFLARM       GetHistoricAircraftPositionsParamsDataSource = "FLARM"
	GetHistoricAircraftPositionsParamsDataSourceLessThannil GetHistoricAircraftPositionsParamsDataSource = "<nil>"
	GetHistoricAircraftPositionsParamsDataSourceMLAT        GetHistoricAircraftPositionsParamsDataSource = "MLAT"
	GetHistoricAircraftPositionsParamsDataSourcePILOTAWARE  GetHistoricAircraftPositionsParamsDataSource = "PILOTAWARE"
	GetHistoricAircraftPositionsParamsDataSourceUAT         GetHistoricAircraftPositionsParamsDataSource = "UAT"
	GetHistoricAircraftPositionsParamsDataSourceUNKNOWN     GetHistoricAircraftPositionsParamsDataSource = "UNKNOWN"
)

Defines values for GetHistoricAircraftPositionsParamsDataSource.

func (GetHistoricAircraftPositionsParamsDataSource) Valid

Valid indicates whether the value is a known member of the GetHistoricAircraftPositionsParamsDataSource enum.

type GetHistoricAircraftPositionsResponse

type GetHistoricAircraftPositionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []HistoricPositionsResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetHistoricAircraftPositionsResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetHistoricAircraftPositionsResponse429Headers
}

func ParseGetHistoricAircraftPositionsResponse

func ParseGetHistoricAircraftPositionsResponse(rsp *http.Response) (*GetHistoricAircraftPositionsResponse, error)

ParseGetHistoricAircraftPositionsResponse parses an HTTP response from a GetHistoricAircraftPositionsWithResponse call

func (GetHistoricAircraftPositionsResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetHistoricAircraftPositionsResponse) GetBody

GetBody returns the raw response body bytes

func (GetHistoricAircraftPositionsResponse) GetJSON200

func (r GetHistoricAircraftPositionsResponse) GetJSON200() *struct {
	Data  []HistoricPositionsResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricAircraftPositionsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetHistoricAircraftPositionsResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetHistoricAircraftPositionsResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetHistoricAircraftPositionsResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetHistoricAircraftPositionsResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetHistoricAircraftPositionsResponse) Status

Status returns HTTPResponse.Status

func (GetHistoricAircraftPositionsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetHistoricAircraftPositionsResponse200Headers

type GetHistoricAircraftPositionsResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetHistoricAircraftPositionsResponse200Headers the declared response headers of an HTTP 200 response for GetHistoricAircraftPositions

type GetHistoricAircraftPositionsResponse429Headers

type GetHistoricAircraftPositionsResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetHistoricAircraftPositionsResponse429Headers the declared response headers of an HTTP 429 response for GetHistoricAircraftPositions

type GetHistoricFlightRecordsParams

type GetHistoricFlightRecordsParams struct {
	// Adshex ICAO 24-bit hex address. Accepts a comma-separated list. At least one identifier field is required.
	Adshex *string `form:"adshex,omitempty" json:"adshex,omitempty"`

	// FlightNumber IATA flight number. Accepts a comma-separated list. At least one identifier field is required.
	FlightNumber *string `form:"flight_number,omitempty" json:"flight_number,omitempty"`

	// Callsign ATC callsign. Accepts a comma-separated list. At least one identifier field is required.
	Callsign *string `form:"callsign,omitempty" json:"callsign,omitempty"`

	// Reg Aircraft registration. Accepts a comma-separated list. At least one identifier field is required.
	Reg *string `form:"reg,omitempty" json:"reg,omitempty"`

	// From Filter flights whose `first_seen` timestamp is on or after this value (Unix timestamp, inclusive).
	From *int `form:"from,omitempty" json:"from,omitempty"`

	// To Filter flights whose `first_seen` timestamp is on or before this value (Unix timestamp, inclusive).
	To *int `form:"to,omitempty" json:"to,omitempty"`

	// PerPage Number of results per page. Maximum is plan-dependent; requests above the limit are silently clamped.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`

	// Cursor Pagination cursor from the previous response's `meta.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetHistoricFlightRecordsParams defines parameters for GetHistoricFlightRecords.

type GetHistoricFlightRecordsResponse

type GetHistoricFlightRecordsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []HistoricFlightRecordsResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetHistoricFlightRecordsResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetHistoricFlightRecordsResponse429Headers
}

func ParseGetHistoricFlightRecordsResponse

func ParseGetHistoricFlightRecordsResponse(rsp *http.Response) (*GetHistoricFlightRecordsResponse, error)

ParseGetHistoricFlightRecordsResponse parses an HTTP response from a GetHistoricFlightRecordsWithResponse call

func (GetHistoricFlightRecordsResponse) ContentType

func (r GetHistoricFlightRecordsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetHistoricFlightRecordsResponse) GetBody

func (r GetHistoricFlightRecordsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricFlightRecordsResponse) GetJSON200

func (r GetHistoricFlightRecordsResponse) GetJSON200() *struct {
	Data  []HistoricFlightRecordsResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricFlightRecordsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetHistoricFlightRecordsResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetHistoricFlightRecordsResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetHistoricFlightRecordsResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetHistoricFlightRecordsResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetHistoricFlightRecordsResponse) Status

Status returns HTTPResponse.Status

func (GetHistoricFlightRecordsResponse) StatusCode

func (r GetHistoricFlightRecordsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricFlightRecordsResponse200Headers

type GetHistoricFlightRecordsResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetHistoricFlightRecordsResponse200Headers the declared response headers of an HTTP 200 response for GetHistoricFlightRecords

type GetHistoricFlightRecordsResponse429Headers

type GetHistoricFlightRecordsResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetHistoricFlightRecordsResponse429Headers the declared response headers of an HTTP 429 response for GetHistoricFlightRecords

type GetHistoricFlightTrackResponse

type GetHistoricFlightTrackResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data HistoricFlightResource `json:"data"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *struct {
		// Message Error overview.
		//
		// Examples: This flight is outside the historic data range available on your plan.
		Message string `json:"message"`
	}
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *struct {
		// Message Error overview.
		Message string `json:"message"`
	}
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetHistoricFlightTrackResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetHistoricFlightTrackResponse429Headers
}

func ParseGetHistoricFlightTrackResponse

func ParseGetHistoricFlightTrackResponse(rsp *http.Response) (*GetHistoricFlightTrackResponse, error)

ParseGetHistoricFlightTrackResponse parses an HTTP response from a GetHistoricFlightTrackWithResponse call

func (GetHistoricFlightTrackResponse) ContentType

func (r GetHistoricFlightTrackResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetHistoricFlightTrackResponse) GetBody

func (r GetHistoricFlightTrackResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoricFlightTrackResponse) GetJSON200

func (r GetHistoricFlightTrackResponse) GetJSON200() *struct {
	Data HistoricFlightResource `json:"data"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoricFlightTrackResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetHistoricFlightTrackResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetHistoricFlightTrackResponse) GetJSON403

func (r GetHistoricFlightTrackResponse) GetJSON403() *struct {
	// Message Error overview.
	//
	// Examples: This flight is outside the historic data range available on your plan.
	Message string `json:"message"`
}

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetHistoricFlightTrackResponse) GetJSON404

func (r GetHistoricFlightTrackResponse) GetJSON404() *struct {
	// Message Error overview.
	Message string `json:"message"`
}

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetHistoricFlightTrackResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetHistoricFlightTrackResponse) Status

Status returns HTTPResponse.Status

func (GetHistoricFlightTrackResponse) StatusCode

func (r GetHistoricFlightTrackResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricFlightTrackResponse200Headers

type GetHistoricFlightTrackResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetHistoricFlightTrackResponse200Headers the declared response headers of an HTTP 200 response for GetHistoricFlightTrack

type GetHistoricFlightTrackResponse429Headers

type GetHistoricFlightTrackResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetHistoricFlightTrackResponse429Headers the declared response headers of an HTTP 429 response for GetHistoricFlightTrack

type GetLiveAircraftPositionsExtendedParams

type GetLiveAircraftPositionsExtendedParams struct {
	// Adshex ICAO 24-bit hex address. Accepts a comma-separated list.
	Adshex *string `form:"adshex,omitempty" json:"adshex,omitempty"`

	// Reg Aircraft registration. Accepts a comma-separated list.
	Reg *string `form:"reg,omitempty" json:"reg,omitempty"`

	// Callsign ATC callsign. Accepts a comma-separated list.
	Callsign *string `form:"callsign,omitempty" json:"callsign,omitempty"`

	// FlightNumber IATA flight number. Accepts a comma-separated list.
	FlightNumber *string `form:"flight_number,omitempty" json:"flight_number,omitempty"`

	// OperatorIcao Operator ICAO airline code. Accepts a comma-separated list.
	OperatorIcao *string `form:"operator_icao,omitempty" json:"operator_icao,omitempty"`

	// MinLat Southern latitude bound of a bounding box (-90 to 90). All four bounds must be provided together.
	MinLat *float32 `form:"min_lat,omitempty" json:"min_lat,omitempty"`

	// MaxLat Northern latitude bound of a bounding box (-90 to 90). All four bounds must be provided together.
	MaxLat *float32 `form:"max_lat,omitempty" json:"max_lat,omitempty"`

	// MinLon Western longitude bound of a bounding box (-180 to 180). All four bounds must be provided together.
	MinLon *float32 `form:"min_lon,omitempty" json:"min_lon,omitempty"`

	// MaxLon Eastern longitude bound of a bounding box (-180 to 180). All four bounds must be provided together.
	MaxLon *float32 `form:"max_lon,omitempty" json:"max_lon,omitempty"`

	// MinAltitude Minimum altitude filter in feet.
	MinAltitude *int `form:"min_altitude,omitempty" json:"min_altitude,omitempty"`

	// MaxAltitude Maximum altitude filter in feet.
	MaxAltitude *int `form:"max_altitude,omitempty" json:"max_altitude,omitempty"`

	// Squawk 4-digit transponder squawk code.
	Squawk *string `form:"squawk,omitempty" json:"squawk,omitempty"`

	// Type ICAO aircraft type designator. Accepts a comma-separated list.
	Type       *string                                           `form:"type,omitempty" json:"type,omitempty"`
	Class      *GetLiveAircraftPositionsExtendedParamsClass      `form:"class,omitempty" json:"class,omitempty"`
	DataSource *GetLiveAircraftPositionsExtendedParamsDataSource `form:"data_source,omitempty" json:"data_source,omitempty"`

	// PerPage Number of results per page. Maximum is plan-dependent; requests above the limit are silently clamped.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`

	// Cursor Pagination cursor from the previous response's `meta.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetLiveAircraftPositionsExtendedParams defines parameters for GetLiveAircraftPositionsExtended.

type GetLiveAircraftPositionsExtendedParamsClass

type GetLiveAircraftPositionsExtendedParamsClass string

GetLiveAircraftPositionsExtendedParamsClass defines parameters for GetLiveAircraftPositionsExtended.

const (
	GetLiveAircraftPositionsExtendedParamsClassBUSINESS    GetLiveAircraftPositionsExtendedParamsClass = "BUSINESS"
	GetLiveAircraftPositionsExtendedParamsClassCARGO       GetLiveAircraftPositionsExtendedParamsClass = "CARGO"
	GetLiveAircraftPositionsExtendedParamsClassCOMMERCIAL  GetLiveAircraftPositionsExtendedParamsClass = "COMMERCIAL"
	GetLiveAircraftPositionsExtendedParamsClassGENERAL     GetLiveAircraftPositionsExtendedParamsClass = "GENERAL"
	GetLiveAircraftPositionsExtendedParamsClassHELICOPTER  GetLiveAircraftPositionsExtendedParamsClass = "HELICOPTER"
	GetLiveAircraftPositionsExtendedParamsClassLessThannil GetLiveAircraftPositionsExtendedParamsClass = "<nil>"
	GetLiveAircraftPositionsExtendedParamsClassMILITARY    GetLiveAircraftPositionsExtendedParamsClass = "MILITARY"
	GetLiveAircraftPositionsExtendedParamsClassUNKNOWN     GetLiveAircraftPositionsExtendedParamsClass = "UNKNOWN"
	GetLiveAircraftPositionsExtendedParamsClassUNMANNED    GetLiveAircraftPositionsExtendedParamsClass = "UNMANNED"
)

Defines values for GetLiveAircraftPositionsExtendedParamsClass.

func (GetLiveAircraftPositionsExtendedParamsClass) Valid

Valid indicates whether the value is a known member of the GetLiveAircraftPositionsExtendedParamsClass enum.

type GetLiveAircraftPositionsExtendedParamsDataSource

type GetLiveAircraftPositionsExtendedParamsDataSource string

GetLiveAircraftPositionsExtendedParamsDataSource defines parameters for GetLiveAircraftPositionsExtended.

const (
	GetLiveAircraftPositionsExtendedParamsDataSourceADSB        GetLiveAircraftPositionsExtendedParamsDataSource = "ADSB"
	GetLiveAircraftPositionsExtendedParamsDataSourceFLARM       GetLiveAircraftPositionsExtendedParamsDataSource = "FLARM"
	GetLiveAircraftPositionsExtendedParamsDataSourceLessThannil GetLiveAircraftPositionsExtendedParamsDataSource = "<nil>"
	GetLiveAircraftPositionsExtendedParamsDataSourceMLAT        GetLiveAircraftPositionsExtendedParamsDataSource = "MLAT"
	GetLiveAircraftPositionsExtendedParamsDataSourcePILOTAWARE  GetLiveAircraftPositionsExtendedParamsDataSource = "PILOTAWARE"
	GetLiveAircraftPositionsExtendedParamsDataSourceUAT         GetLiveAircraftPositionsExtendedParamsDataSource = "UAT"
	GetLiveAircraftPositionsExtendedParamsDataSourceUNKNOWN     GetLiveAircraftPositionsExtendedParamsDataSource = "UNKNOWN"
)

Defines values for GetLiveAircraftPositionsExtendedParamsDataSource.

func (GetLiveAircraftPositionsExtendedParamsDataSource) Valid

Valid indicates whether the value is a known member of the GetLiveAircraftPositionsExtendedParamsDataSource enum.

type GetLiveAircraftPositionsExtendedResponse

type GetLiveAircraftPositionsExtendedResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []LiveExtendedPositionsResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetLiveAircraftPositionsExtendedResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetLiveAircraftPositionsExtendedResponse429Headers
}

func ParseGetLiveAircraftPositionsExtendedResponse

func ParseGetLiveAircraftPositionsExtendedResponse(rsp *http.Response) (*GetLiveAircraftPositionsExtendedResponse, error)

ParseGetLiveAircraftPositionsExtendedResponse parses an HTTP response from a GetLiveAircraftPositionsExtendedWithResponse call

func (GetLiveAircraftPositionsExtendedResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLiveAircraftPositionsExtendedResponse) GetBody

GetBody returns the raw response body bytes

func (GetLiveAircraftPositionsExtendedResponse) GetJSON200

func (r GetLiveAircraftPositionsExtendedResponse) GetJSON200() *struct {
	Data  []LiveExtendedPositionsResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLiveAircraftPositionsExtendedResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetLiveAircraftPositionsExtendedResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetLiveAircraftPositionsExtendedResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetLiveAircraftPositionsExtendedResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetLiveAircraftPositionsExtendedResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetLiveAircraftPositionsExtendedResponse) Status

Status returns HTTPResponse.Status

func (GetLiveAircraftPositionsExtendedResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetLiveAircraftPositionsExtendedResponse200Headers

type GetLiveAircraftPositionsExtendedResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetLiveAircraftPositionsExtendedResponse200Headers the declared response headers of an HTTP 200 response for GetLiveAircraftPositionsExtended

type GetLiveAircraftPositionsExtendedResponse429Headers

type GetLiveAircraftPositionsExtendedResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetLiveAircraftPositionsExtendedResponse429Headers the declared response headers of an HTTP 429 response for GetLiveAircraftPositionsExtended

type GetLiveAircraftPositionsParams

type GetLiveAircraftPositionsParams struct {
	// Adshex ICAO 24-bit hex address. Accepts a comma-separated list.
	Adshex *string `form:"adshex,omitempty" json:"adshex,omitempty"`

	// Reg Aircraft registration. Accepts a comma-separated list.
	Reg *string `form:"reg,omitempty" json:"reg,omitempty"`

	// Callsign ATC callsign. Accepts a comma-separated list.
	Callsign *string `form:"callsign,omitempty" json:"callsign,omitempty"`

	// FlightNumber IATA flight number. Accepts a comma-separated list.
	FlightNumber *string `form:"flight_number,omitempty" json:"flight_number,omitempty"`

	// OperatorIcao Operator ICAO airline code. Accepts a comma-separated list.
	OperatorIcao *string `form:"operator_icao,omitempty" json:"operator_icao,omitempty"`

	// MinLat Southern latitude bound of a bounding box (-90 to 90). All four bounds must be provided together.
	MinLat *float32 `form:"min_lat,omitempty" json:"min_lat,omitempty"`

	// MaxLat Northern latitude bound of a bounding box (-90 to 90). All four bounds must be provided together.
	MaxLat *float32 `form:"max_lat,omitempty" json:"max_lat,omitempty"`

	// MinLon Western longitude bound of a bounding box (-180 to 180). All four bounds must be provided together.
	MinLon *float32 `form:"min_lon,omitempty" json:"min_lon,omitempty"`

	// MaxLon Eastern longitude bound of a bounding box (-180 to 180). All four bounds must be provided together.
	MaxLon *float32 `form:"max_lon,omitempty" json:"max_lon,omitempty"`

	// MinAltitude Minimum altitude filter in feet.
	MinAltitude *int `form:"min_altitude,omitempty" json:"min_altitude,omitempty"`

	// MaxAltitude Maximum altitude filter in feet.
	MaxAltitude *int `form:"max_altitude,omitempty" json:"max_altitude,omitempty"`

	// Squawk 4-digit transponder squawk code.
	Squawk *string `form:"squawk,omitempty" json:"squawk,omitempty"`

	// Type ICAO aircraft type designator. Accepts a comma-separated list.
	Type       *string                                   `form:"type,omitempty" json:"type,omitempty"`
	Class      *GetLiveAircraftPositionsParamsClass      `form:"class,omitempty" json:"class,omitempty"`
	DataSource *GetLiveAircraftPositionsParamsDataSource `form:"data_source,omitempty" json:"data_source,omitempty"`

	// PerPage Number of results per page. Maximum is plan-dependent; requests above the limit are silently clamped.
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`

	// Cursor Pagination cursor from the previous response's `meta.next_cursor`.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

GetLiveAircraftPositionsParams defines parameters for GetLiveAircraftPositions.

type GetLiveAircraftPositionsParamsClass

type GetLiveAircraftPositionsParamsClass string

GetLiveAircraftPositionsParamsClass defines parameters for GetLiveAircraftPositions.

const (
	GetLiveAircraftPositionsParamsClassBUSINESS    GetLiveAircraftPositionsParamsClass = "BUSINESS"
	GetLiveAircraftPositionsParamsClassCARGO       GetLiveAircraftPositionsParamsClass = "CARGO"
	GetLiveAircraftPositionsParamsClassCOMMERCIAL  GetLiveAircraftPositionsParamsClass = "COMMERCIAL"
	GetLiveAircraftPositionsParamsClassGENERAL     GetLiveAircraftPositionsParamsClass = "GENERAL"
	GetLiveAircraftPositionsParamsClassHELICOPTER  GetLiveAircraftPositionsParamsClass = "HELICOPTER"
	GetLiveAircraftPositionsParamsClassLessThannil GetLiveAircraftPositionsParamsClass = "<nil>"
	GetLiveAircraftPositionsParamsClassMILITARY    GetLiveAircraftPositionsParamsClass = "MILITARY"
	GetLiveAircraftPositionsParamsClassUNKNOWN     GetLiveAircraftPositionsParamsClass = "UNKNOWN"
	GetLiveAircraftPositionsParamsClassUNMANNED    GetLiveAircraftPositionsParamsClass = "UNMANNED"
)

Defines values for GetLiveAircraftPositionsParamsClass.

func (GetLiveAircraftPositionsParamsClass) Valid

Valid indicates whether the value is a known member of the GetLiveAircraftPositionsParamsClass enum.

type GetLiveAircraftPositionsParamsDataSource

type GetLiveAircraftPositionsParamsDataSource string

GetLiveAircraftPositionsParamsDataSource defines parameters for GetLiveAircraftPositions.

const (
	GetLiveAircraftPositionsParamsDataSourceADSB        GetLiveAircraftPositionsParamsDataSource = "ADSB"
	GetLiveAircraftPositionsParamsDataSourceFLARM       GetLiveAircraftPositionsParamsDataSource = "FLARM"
	GetLiveAircraftPositionsParamsDataSourceLessThannil GetLiveAircraftPositionsParamsDataSource = "<nil>"
	GetLiveAircraftPositionsParamsDataSourceMLAT        GetLiveAircraftPositionsParamsDataSource = "MLAT"
	GetLiveAircraftPositionsParamsDataSourcePILOTAWARE  GetLiveAircraftPositionsParamsDataSource = "PILOTAWARE"
	GetLiveAircraftPositionsParamsDataSourceUAT         GetLiveAircraftPositionsParamsDataSource = "UAT"
	GetLiveAircraftPositionsParamsDataSourceUNKNOWN     GetLiveAircraftPositionsParamsDataSource = "UNKNOWN"
)

Defines values for GetLiveAircraftPositionsParamsDataSource.

func (GetLiveAircraftPositionsParamsDataSource) Valid

Valid indicates whether the value is a known member of the GetLiveAircraftPositionsParamsDataSource enum.

type GetLiveAircraftPositionsResponse

type GetLiveAircraftPositionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []LivePositionsResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetLiveAircraftPositionsResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetLiveAircraftPositionsResponse429Headers
}

func ParseGetLiveAircraftPositionsResponse

func ParseGetLiveAircraftPositionsResponse(rsp *http.Response) (*GetLiveAircraftPositionsResponse, error)

ParseGetLiveAircraftPositionsResponse parses an HTTP response from a GetLiveAircraftPositionsWithResponse call

func (GetLiveAircraftPositionsResponse) ContentType

func (r GetLiveAircraftPositionsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLiveAircraftPositionsResponse) GetBody

func (r GetLiveAircraftPositionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLiveAircraftPositionsResponse) GetJSON200

func (r GetLiveAircraftPositionsResponse) GetJSON200() *struct {
	Data  []LivePositionsResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLiveAircraftPositionsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetLiveAircraftPositionsResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetLiveAircraftPositionsResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetLiveAircraftPositionsResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetLiveAircraftPositionsResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetLiveAircraftPositionsResponse) Status

Status returns HTTPResponse.Status

func (GetLiveAircraftPositionsResponse) StatusCode

func (r GetLiveAircraftPositionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLiveAircraftPositionsResponse200Headers

type GetLiveAircraftPositionsResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetLiveAircraftPositionsResponse200Headers the declared response headers of an HTTP 200 response for GetLiveAircraftPositions

type GetLiveAircraftPositionsResponse429Headers

type GetLiveAircraftPositionsResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetLiveAircraftPositionsResponse429Headers the declared response headers of an HTTP 429 response for GetLiveAircraftPositions

type GetMetarsExtendedParams

type GetMetarsExtendedParams struct {
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

GetMetarsExtendedParams defines parameters for GetMetarsExtended.

type GetMetarsExtendedResponse

type GetMetarsExtendedResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []MetarExtendedResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ModelNotFoundException
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetMetarsExtendedResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetMetarsExtendedResponse429Headers
}

func ParseGetMetarsExtendedResponse

func ParseGetMetarsExtendedResponse(rsp *http.Response) (*GetMetarsExtendedResponse, error)

ParseGetMetarsExtendedResponse parses an HTTP response from a GetMetarsExtendedWithResponse call

func (GetMetarsExtendedResponse) ContentType

func (r GetMetarsExtendedResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetMetarsExtendedResponse) GetBody

func (r GetMetarsExtendedResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMetarsExtendedResponse) GetJSON200

func (r GetMetarsExtendedResponse) GetJSON200() *struct {
	Data  []MetarExtendedResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMetarsExtendedResponse) GetJSON401

func (r GetMetarsExtendedResponse) GetJSON401() *Unauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMetarsExtendedResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetMetarsExtendedResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetMetarsExtendedResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMetarsExtendedResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetMetarsExtendedResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetMetarsExtendedResponse) Status

func (r GetMetarsExtendedResponse) Status() string

Status returns HTTPResponse.Status

func (GetMetarsExtendedResponse) StatusCode

func (r GetMetarsExtendedResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMetarsExtendedResponse200Headers

type GetMetarsExtendedResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetMetarsExtendedResponse200Headers the declared response headers of an HTTP 200 response for GetMetarsExtended

type GetMetarsExtendedResponse429Headers

type GetMetarsExtendedResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetMetarsExtendedResponse429Headers the declared response headers of an HTTP 429 response for GetMetarsExtended

type GetMetarsParams

type GetMetarsParams struct {
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

GetMetarsParams defines parameters for GetMetars.

type GetMetarsResponse

type GetMetarsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []MetarResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ModelNotFoundException
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetMetarsResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetMetarsResponse429Headers
}

func ParseGetMetarsResponse

func ParseGetMetarsResponse(rsp *http.Response) (*GetMetarsResponse, error)

ParseGetMetarsResponse parses an HTTP response from a GetMetarsWithResponse call

func (GetMetarsResponse) ContentType

func (r GetMetarsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetMetarsResponse) GetBody

func (r GetMetarsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMetarsResponse) GetJSON200

func (r GetMetarsResponse) GetJSON200() *struct {
	Data  []MetarResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMetarsResponse) GetJSON401

func (r GetMetarsResponse) GetJSON401() *Unauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMetarsResponse) GetJSON402

func (r GetMetarsResponse) GetJSON402() *InsufficientCredits

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetMetarsResponse) GetJSON403

func (r GetMetarsResponse) GetJSON403() *ApiAccessSuspended

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetMetarsResponse) GetJSON404

func (r GetMetarsResponse) GetJSON404() *ModelNotFoundException

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMetarsResponse) GetJSON422

func (r GetMetarsResponse) GetJSON422() *ValidationException

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetMetarsResponse) GetJSON429

func (r GetMetarsResponse) GetJSON429() *RateLimitExceeded

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetMetarsResponse) Status

func (r GetMetarsResponse) Status() string

Status returns HTTPResponse.Status

func (GetMetarsResponse) StatusCode

func (r GetMetarsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMetarsResponse200Headers

type GetMetarsResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetMetarsResponse200Headers the declared response headers of an HTTP 200 response for GetMetars

type GetMetarsResponse429Headers

type GetMetarsResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetMetarsResponse429Headers the declared response headers of an HTTP 429 response for GetMetars

type GetTafsExtendedParams

type GetTafsExtendedParams struct {
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

GetTafsExtendedParams defines parameters for GetTafsExtended.

type GetTafsExtendedResponse

type GetTafsExtendedResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []TafExtendedResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ModelNotFoundException
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetTafsExtendedResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetTafsExtendedResponse429Headers
}

func ParseGetTafsExtendedResponse

func ParseGetTafsExtendedResponse(rsp *http.Response) (*GetTafsExtendedResponse, error)

ParseGetTafsExtendedResponse parses an HTTP response from a GetTafsExtendedWithResponse call

func (GetTafsExtendedResponse) ContentType

func (r GetTafsExtendedResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTafsExtendedResponse) GetBody

func (r GetTafsExtendedResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTafsExtendedResponse) GetJSON200

func (r GetTafsExtendedResponse) GetJSON200() *struct {
	Data  []TafExtendedResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTafsExtendedResponse) GetJSON401

func (r GetTafsExtendedResponse) GetJSON401() *Unauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetTafsExtendedResponse) GetJSON402

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetTafsExtendedResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetTafsExtendedResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetTafsExtendedResponse) GetJSON422

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetTafsExtendedResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetTafsExtendedResponse) Status

func (r GetTafsExtendedResponse) Status() string

Status returns HTTPResponse.Status

func (GetTafsExtendedResponse) StatusCode

func (r GetTafsExtendedResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTafsExtendedResponse200Headers

type GetTafsExtendedResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetTafsExtendedResponse200Headers the declared response headers of an HTTP 200 response for GetTafsExtended

type GetTafsExtendedResponse429Headers

type GetTafsExtendedResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetTafsExtendedResponse429Headers the declared response headers of an HTTP 429 response for GetTafsExtended

type GetTafsParams

type GetTafsParams struct {
	PerPage *int `form:"per_page,omitempty" json:"per_page,omitempty"`
}

GetTafsParams defines parameters for GetTafs.

type GetTafsResponse

type GetTafsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *struct {
		Data  []TafResource `json:"data"`
		Links struct {
			First *string `json:"first"`
			Last  *string `json:"last"`
			Next  *string `json:"next"`
			Prev  *string `json:"prev"`
		} `json:"links"`
		Meta struct {
			// NextCursor The "cursor" that points to the next set of items.
			NextCursor *string `json:"next_cursor"`

			// Path Base path for paginator generated URLs.
			Path *string `json:"path"`

			// PerPage Number of items shown per page.
			PerPage int `json:"per_page"`

			// PrevCursor The "cursor" that points to the previous set of items.
			PrevCursor *string `json:"prev_cursor"`
		} `json:"meta"`
	}
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Unauthorized
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *InsufficientCredits
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ApiAccessSuspended
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ModelNotFoundException
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ValidationException
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitExceeded
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetTafsResponse200Headers
	// Headers429 the parsed response headers for an HTTP 429 response
	Headers429 *GetTafsResponse429Headers
}

func ParseGetTafsResponse

func ParseGetTafsResponse(rsp *http.Response) (*GetTafsResponse, error)

ParseGetTafsResponse parses an HTTP response from a GetTafsWithResponse call

func (GetTafsResponse) ContentType

func (r GetTafsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTafsResponse) GetBody

func (r GetTafsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTafsResponse) GetJSON200

func (r GetTafsResponse) GetJSON200() *struct {
	Data  []TafResource `json:"data"`
	Links struct {
		First *string `json:"first"`
		Last  *string `json:"last"`
		Next  *string `json:"next"`
		Prev  *string `json:"prev"`
	} `json:"links"`
	Meta struct {
		// NextCursor The "cursor" that points to the next set of items.
		NextCursor *string `json:"next_cursor"`

		// Path Base path for paginator generated URLs.
		Path *string `json:"path"`

		// PerPage Number of items shown per page.
		PerPage int `json:"per_page"`

		// PrevCursor The "cursor" that points to the previous set of items.
		PrevCursor *string `json:"prev_cursor"`
	} `json:"meta"`
}

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTafsResponse) GetJSON401

func (r GetTafsResponse) GetJSON401() *Unauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetTafsResponse) GetJSON402

func (r GetTafsResponse) GetJSON402() *InsufficientCredits

GetJSON402 returns the response for an HTTP 402 `application/json` response

func (GetTafsResponse) GetJSON403

func (r GetTafsResponse) GetJSON403() *ApiAccessSuspended

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetTafsResponse) GetJSON404

func (r GetTafsResponse) GetJSON404() *ModelNotFoundException

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetTafsResponse) GetJSON422

func (r GetTafsResponse) GetJSON422() *ValidationException

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetTafsResponse) GetJSON429

func (r GetTafsResponse) GetJSON429() *RateLimitExceeded

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (GetTafsResponse) Status

func (r GetTafsResponse) Status() string

Status returns HTTPResponse.Status

func (GetTafsResponse) StatusCode

func (r GetTafsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTafsResponse200Headers

type GetTafsResponse200Headers struct {
	PfCreditsRemaining  *int
	PfCreditsSpent      *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetTafsResponse200Headers the declared response headers of an HTTP 200 response for GetTafs

type GetTafsResponse429Headers

type GetTafsResponse429Headers struct {
	RetryAfter          *int
	XRateLimitLimit     *int
	XRateLimitRemaining *int
}

GetTafsResponse429Headers the declared response headers of an HTTP 429 response for GetTafs

type HistoricFlightPositionResource

type HistoricFlightPositionResource struct {
	// Altitude Altitude in feet
	//
	// Examples: 37975
	Altitude *int `json:"altitude"`

	// DataSource Data source identifier
	//
	// Examples: ADSB
	DataSource *PositionsDataSource `json:"dataSource"`

	// Heading Heading in degrees (0-360)
	//
	// Examples: 291
	Heading *int `json:"heading"`

	// Lat Latitude in decimal degrees
	//
	// Examples: 54.436615
	Lat float32 `json:"lat"`

	// Lon Longitude in decimal degrees
	//
	// Examples: -9.494045
	Lon float32 `json:"lon"`

	// Speed Ground speed in knots
	//
	// Examples: 457
	Speed *int `json:"speed"`

	// Squawk Transponder squawk code
	//
	// Examples: 1417
	Squawk *string `json:"squawk"`

	// Timestamp Position update unix timestamp
	//
	// Examples: 1700000043
	Timestamp *int `json:"timestamp"`
}

HistoricFlightPositionResource defines model for HistoricFlightPositionResource.

type HistoricFlightRecordsResource

type HistoricFlightRecordsResource struct {
	// Adshex ICAO 24-bit hex code
	//
	// Examples: 400684
	Adshex string `json:"adshex"`

	// ArrivalAirport Arrival airport
	//
	// Examples: JFK
	ArrivalAirport string `json:"arrivalAirport"`

	// Blocked Whether aircraft is blocked from public tracking
	//
	// Examples: false
	Blocked *bool `json:"blocked,omitempty"`

	// Callsign Callsign
	//
	// Examples: BAW183
	Callsign *string `json:"callsign"`

	// Class Aircraft class
	//
	// Examples: COMMERCIAL
	Class *string `json:"class"`

	// DepartureAirport Departure airport
	//
	// Examples: LHR
	DepartureAirport string `json:"departureAirport"`

	// FirstSeen First time this flight was observed (unix timestamp)
	//
	// Examples: 1746815700
	FirstSeen int `json:"firstSeen"`

	// FlightId Flight identifier
	//
	// Examples: 5-17252880
	FlightId string `json:"flightId"`

	// FlightNumber Flight number
	//
	// Examples: BA183
	FlightNumber *string `json:"flightNumber"`

	// LastSeen Last time this flight was observed (unix timestamp). Can return null for very old flights.
	//
	// Examples: 1746877740
	LastSeen *int `json:"lastSeen"`

	// OperatorICAO ICAO operator code
	//
	// Examples: BAW
	OperatorICAO *string `json:"operatorICAO"`

	// Reg Aircraft registration (tail number)
	//
	// Examples: G-VIIL
	Reg *string `json:"reg"`

	// Type Aircraft type code
	//
	// Examples: B772
	Type *string `json:"type"`
}

HistoricFlightRecordsResource defines model for HistoricFlightRecordsResource.

type HistoricFlightResource

type HistoricFlightResource struct {
	Flight    HistoricFlightRecordsResource    `json:"flight"`
	Positions []HistoricFlightPositionResource `json:"positions"`
}

HistoricFlightResource defines model for HistoricFlightResource.

type HistoricPositionsResource

type HistoricPositionsResource struct {
	// Adshex ICAO 24-bit hex code
	//
	// Examples: 400684
	Adshex string `json:"adshex"`

	// Altitude Altitude in feet
	//
	// Examples: 36000
	Altitude *int `json:"altitude"`

	// ArrivalAirport Arrival airport IATA code
	//
	// Examples: JFK
	ArrivalAirport string `json:"arrivalAirport"`

	// Blocked Whether aircraft is blocked from public tracking
	//
	// Examples: false
	Blocked *bool `json:"blocked,omitempty"`

	// Callsign Callsign at the time of the snapshot
	//
	// Examples: BAW183
	Callsign *string `json:"callsign"`

	// Class Aircraft class
	//
	// Examples: COMMERCIAL
	Class *string `json:"class"`

	// DataSource Data source identifier
	//
	// Examples: ADSB
	DataSource *PositionsDataSource `json:"dataSource"`

	// DepartureAirport Departure airport IATA code
	//
	// Examples: LHR
	DepartureAirport string `json:"departureAirport"`

	// FlightId Flight identifier
	//
	// Examples: 5-17252880
	FlightId string `json:"flightId"`

	// FlightNumber Flight number
	//
	// Examples: BA183
	FlightNumber *string `json:"flightNumber"`

	// Heading Heading in degrees (0-360)
	//
	// Examples: 200
	Heading *int `json:"heading"`

	// Lat Latitude in decimal degrees
	//
	// Examples: 42.1422
	Lat float32 `json:"lat"`

	// Lon Longitude in decimal degrees
	//
	// Examples: -71.2335
	Lon float32 `json:"lon"`

	// OperatorICAO ICAO operator code
	//
	// Examples: BAW
	OperatorICAO *string `json:"operatorICAO"`

	// Reg Aircraft registration (tail number)
	//
	// Examples: G-VIIL
	Reg *string `json:"reg"`

	// Speed Ground speed in knots
	//
	// Examples: 414
	Speed *int `json:"speed"`

	// Squawk Transponder squawk code
	//
	// Examples: 0756
	Squawk *string `json:"squawk"`

	// Timestamp Position update unix timestamp
	//
	// Examples: 1746841078
	Timestamp *int `json:"timestamp"`

	// Type Aircraft type code
	//
	// Examples: B772
	Type *string `json:"type"`
}

HistoricPositionsResource defines model for HistoricPositionsResource.

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InsufficientCredits

type InsufficientCredits struct {
	// Message Error overview.
	//
	// Examples: Insufficient credits
	Message string `json:"message"`
}

InsufficientCredits defines model for InsufficientCredits.

type LiveExtendedPositionsResource

type LiveExtendedPositionsResource struct {
	// Adshex ICAO 24-bit hex code
	//
	// Examples: 4005C1
	Adshex string `json:"adshex"`

	// Altitude Altitude in feet
	//
	// Examples: 37975
	Altitude *int `json:"altitude"`

	// ArrivalAirport Arrival airport IATA code
	//
	// Examples: JFK
	ArrivalAirport *string `json:"arrivalAirport"`

	// Barometer Barometric pressure setting
	//
	// Examples: 1013
	Barometer *float32 `json:"barometer"`

	// Bds40SeenTime BDS 4,0 message last seen timestamp
	//
	// Examples: 1773088465
	Bds40SeenTime *int `json:"bds40SeenTime"`

	// Bds50SeenTime BDS 5,0 message last seen timestamp
	//
	// Examples: 1773088474
	Bds50SeenTime *int `json:"bds50SeenTime"`

	// Bds60SeenTime BDS 6,0 message last seen timestamp
	//
	// Examples: 1773088470
	Bds60SeenTime *int `json:"bds60SeenTime"`

	// Bds62SeenTime BDS 6,2 message last seen timestamp
	//
	// Examples: 1773088469
	Bds62SeenTime *int `json:"bds62SeenTime"`

	// Blocked Whether aircraft is blocked from public tracking
	//
	// Examples: false
	Blocked *bool `json:"blocked,omitempty"`

	// Callsign Callsign
	//
	// Examples: BAW183
	Callsign *string `json:"callsign"`

	// Category Aircraft category
	//
	// Examples: A5
	Category *string `json:"category"`

	// Class Aircraft class
	//
	// Examples: COMMERCIAL
	Class *string `json:"class"`

	// DataSource Data source identifier
	//
	// Examples: ADSB
	DataSource PositionsDataSource `json:"dataSource"`

	// DepartureAirport Departure airport IATA code
	//
	// Examples: LHR
	DepartureAirport *string `json:"departureAirport"`

	// FlightNumber Flight number
	//
	// Examples: BA183
	FlightNumber *string `json:"flightNumber"`

	// GroundSpeed Ground speed in knots
	//
	// Examples: 456
	GroundSpeed *int `json:"groundSpeed"`

	// Heading Heading in degrees (0-360)
	//
	// Examples: 291
	Heading *int `json:"heading"`

	// IndicatedAirSpeed Indicated airspeed in knots
	//
	// Examples: 270
	IndicatedAirSpeed *int `json:"indicatedAirSpeed"`

	// LastMovement Timestamp of last position update
	//
	// Examples: 1773088473
	LastMovement *int `json:"lastMovement"`

	// LastSeen Timestamp of last signal received
	//
	// Examples: 1773088473
	LastSeen *int `json:"lastSeen"`

	// Lat Latitude in decimal degrees
	//
	// Examples: 54.436615
	Lat float32 `json:"lat"`

	// Lon Longitude in decimal degrees
	//
	// Examples: -9.494045
	Lon float32 `json:"lon"`

	// Mach Mach number
	//
	// Examples: 0.848
	Mach *float32 `json:"mach"`

	// MagneticHeading Magnetic heading in degrees
	//
	// Examples: 295
	MagneticHeading *float32 `json:"magneticHeading"`

	// OnGround Whether aircraft is on the ground
	//
	// Examples: false
	OnGround *bool `json:"onGround"`

	// OperatorICAO ICAO operator code
	//
	// Examples: BAW
	OperatorICAO string `json:"operatorICAO"`

	// OutsideAirTemperature Outside air temperature in Celsius
	//
	// Examples: -51.12
	OutsideAirTemperature *float32 `json:"outsideAirTemperature"`

	// Reg Aircraft registration (tail number)
	//
	// Examples: G-RAES
	Reg *string `json:"reg"`

	// RollAngle Roll angle in degrees
	//
	// Examples: 0
	RollAngle *float32 `json:"rollAngle"`

	// SelectedAltitude Selected altitude in feet
	//
	// Examples: 38000
	SelectedAltitude *int `json:"selectedAltitude"`

	// Speed Ground speed in knots
	//
	// Examples: 457
	Speed *int `json:"speed"`

	// Squawk Transponder squawk code
	//
	// Examples: 1417
	Squawk *string `json:"squawk"`

	// TargetHeading Target heading in degrees
	//
	// Examples: 295
	TargetHeading *float32 `json:"targetHeading"`

	// TrackAngle Track angle in degrees
	//
	// Examples: 290
	TrackAngle *float32 `json:"trackAngle"`

	// TrueAirSpeed True airspeed in knots
	//
	// Examples: 490
	TrueAirSpeed *int `json:"trueAirSpeed"`

	// Type Aircraft type code
	//
	// Examples: B772
	Type *string `json:"type"`

	// VertRate Vertical rate in feet per minute
	//
	// Examples: 256
	VertRate *int `json:"vertRate"`

	// WindDirection Wind direction in degrees
	//
	// Examples: 330
	WindDirection *int `json:"windDirection"`

	// WindSpeed Wind speed in knots
	//
	// Examples: 57
	WindSpeed *int `json:"windSpeed"`
}

LiveExtendedPositionsResource defines model for LiveExtendedPositionsResource.

type LivePositionsResource

type LivePositionsResource struct {
	// Adshex ICAO 24-bit hex code
	//
	// Examples: 4005C1
	Adshex string `json:"adshex"`

	// Altitude Altitude in feet
	//
	// Examples: 37975
	Altitude *int `json:"altitude"`

	// ArrivalAirport Arrival airport IATA code
	//
	// Examples: JFK
	ArrivalAirport *string `json:"arrivalAirport"`

	// Blocked Whether aircraft is blocked from public tracking
	//
	// Examples: false
	Blocked *bool `json:"blocked,omitempty"`

	// Callsign Callsign
	//
	// Examples: BAW183
	Callsign *string `json:"callsign"`

	// Category Aircraft category
	//
	// Examples: A5
	Category *string `json:"category"`

	// Class Aircraft class
	//
	// Examples: COMMERCIAL
	Class *string `json:"class"`

	// DataSource Data source identifier
	//
	// Examples: ADSB
	DataSource PositionsDataSource `json:"dataSource"`

	// DepartureAirport Departure airport IATA code
	//
	// Examples: LHR
	DepartureAirport *string `json:"departureAirport"`

	// FlightNumber Flight number
	//
	// Examples: BA183
	FlightNumber *string `json:"flightNumber"`

	// Heading Heading in degrees (0-360)
	//
	// Examples: 291
	Heading *int `json:"heading"`

	// LastMovement Timestamp of last position update
	//
	// Examples: 1773088473
	LastMovement *int `json:"lastMovement"`

	// LastSeen Timestamp of last signal received
	//
	// Examples: 1773088473
	LastSeen *int `json:"lastSeen"`

	// Lat Latitude in decimal degrees
	//
	// Examples: 54.436615
	Lat float32 `json:"lat"`

	// Lon Longitude in decimal degrees
	//
	// Examples: -9.494045
	Lon float32 `json:"lon"`

	// OperatorICAO ICAO operator code
	//
	// Examples: BAW
	OperatorICAO string `json:"operatorICAO"`

	// Reg Aircraft registration (tail number)
	//
	// Examples: G-RAES
	Reg *string `json:"reg"`

	// Speed Ground speed in knots
	//
	// Examples: 457
	Speed *int `json:"speed"`

	// Squawk Transponder squawk code
	//
	// Examples: 1417
	Squawk *string `json:"squawk"`

	// Type Aircraft type code
	//
	// Examples: B772
	Type *string `json:"type"`

	// VertRate Vertical rate in feet per minute
	//
	// Examples: 256
	VertRate *int `json:"vertRate"`
}

LivePositionsResource defines model for LivePositionsResource.

type MetarExtendedResource

type MetarExtendedResource struct {
	Decoded *MetarObservation `json:"decoded"`

	// Icao ICAO station identifier
	//
	// Examples: EGLL
	Icao string `json:"icao"`

	// ObservedAt Observation time as a Unix timestamp (UTC)
	//
	// Examples: 1747310400
	ObservedAt *int `json:"observedAt"`

	// Raw Raw METAR string
	//
	// Examples: EGLL 151220Z 27010KT 9999 FEW025 16/08 Q1018 NOSIG
	Raw *string `json:"raw"`
}

MetarExtendedResource defines model for MetarExtendedResource.

type MetarObservation

type MetarObservation struct {
	// Clouds Cloud layer observations, ordered from lowest to highest
	Clouds []CloudLayer `json:"clouds"`

	// PresentWeather Current weather phenomena (e.g. rain, fog, snow)
	PresentWeather []WeatherCondition `json:"presentWeather"`
	Pressure       *Pressure          `json:"pressure"`

	// RecentWeather Weather phenomena observed in the recent past (RE group)
	RecentWeather []WeatherCondition `json:"recentWeather"`

	// Remarks Free-text remarks section following RMK
	//
	// Examples: AO2 SLP166 T02780222
	Remarks *string `json:"remarks"`

	// RunwayVisualRange Runway visual range observations, one entry per reported runway
	RunwayVisualRange []RunwayVisualRange `json:"runwayVisualRange"`
	Runways           *RunwayState        `json:"runways"`
	Temperature       *Temperature        `json:"temperature"`

	// Trends Short-term forecast trends appended to the METAR (NOSIG, BECMG, TEMPO)
	Trends     []WeatherTrend `json:"trends"`
	Visibility *Visibility    `json:"visibility"`
	Wind       *Wind          `json:"wind"`
	WindShear  *WindShear     `json:"windShear"`
}

MetarObservation defines model for MetarObservation.

type MetarResource

type MetarResource struct {
	// Icao ICAO station identifier
	//
	// Examples: EGLL
	Icao string `json:"icao"`

	// ObservedAt Observation time as a Unix timestamp (UTC)
	//
	// Examples: 1747310400
	ObservedAt *int `json:"observedAt"`

	// Raw Raw METAR string
	//
	// Examples: EGLL 151220Z 27010KT 9999 FEW025 16/08 Q1018 NOSIG
	Raw *string `json:"raw"`
}

MetarResource defines model for MetarResource.

type ModelNotFoundException

type ModelNotFoundException struct {
	// Message Error overview.
	Message string `json:"message"`
}

ModelNotFoundException defines model for ModelNotFoundException.

type PositionsDataSource

type PositionsDataSource string

PositionsDataSource defines model for PositionsDataSource.

const (
	PositionsDataSourceADSB       PositionsDataSource = "ADSB"
	PositionsDataSourceFLARM      PositionsDataSource = "FLARM"
	PositionsDataSourceMLAT       PositionsDataSource = "MLAT"
	PositionsDataSourcePILOTAWARE PositionsDataSource = "PILOTAWARE"
	PositionsDataSourceUAT        PositionsDataSource = "UAT"
	PositionsDataSourceUNKNOWN    PositionsDataSource = "UNKNOWN"
)

Defines values for PositionsDataSource.

func (PositionsDataSource) Valid

func (e PositionsDataSource) Valid() bool

Valid indicates whether the value is a known member of the PositionsDataSource enum.

type Pressure

type Pressure struct {
	// HPa QNH pressure in hectopascals
	//
	// Examples: 1018
	HPa float32 `json:"hPa"`

	// InHg QNH pressure in inches of mercury
	//
	// Examples: 30.07
	InHg *float32 `json:"inHg"`
}

Pressure defines model for Pressure.

type RateLimitExceeded

type RateLimitExceeded struct {
	// Message Error overview.
	//
	// Examples: Too Many Attempts.
	Message string `json:"message"`
}

RateLimitExceeded defines model for RateLimitExceeded.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RunwayReport

type RunwayReport struct {
	// Deposits Deposit type code (0 = clear and dry, 1 = damp, … 9 = frozen ruts)
	//
	// Examples: 5
	Deposits *string `json:"deposits"`

	// DepositsDepth Deposit depth in mm, or a special code string for coded values
	//
	// Examples: 5
	DepositsDepth *string `json:"depositsDepth"`

	// DepositsExtent Extent of contamination code (1 = ≤10%, 2 = 11–25%, 5 = 26–50%, 9 = 51–100%)
	//
	// Examples: 2
	DepositsExtent *string `json:"depositsExtent"`

	// Friction Friction coefficient (0.00–0.90) or a braking-action code string
	//
	// Examples: 0.36
	Friction *string `json:"friction"`

	// Runway Runway designator
	//
	// Examples: 28L
	Runway *string `json:"runway"`
}

RunwayReport defines model for RunwayReport.

type RunwayState

type RunwayState struct {
	// ClosedDueToSnow True when the aerodrome is closed due to snow (SNOCLO reported)
	//
	// Examples: false
	ClosedDueToSnow bool `json:"closedDueToSnow"`

	// Reports Runway-by-runway surface condition reports
	Reports []RunwayReport `json:"reports"`
}

RunwayState defines model for RunwayState.

type RunwayVisualRange

type RunwayVisualRange struct {
	// Runway Runway designator
	//
	// Examples: 27L
	Runway *string `json:"runway"`

	// Tendency Trend of RVR change over the observation period
	//
	// Examples: increasing
	Tendency *RunwayVisualRangeTendency `json:"tendency"`

	// VisibilityM RVR in metres when a single fixed value is reported
	//
	// Examples: 800
	VisibilityM *int `json:"visibilityM"`

	// VisibilityMaxM Maximum RVR in metres when a variable range is reported
	//
	// Examples: 1200
	VisibilityMaxM *int `json:"visibilityMaxM"`

	// VisibilityMinM Minimum RVR in metres when a variable range is reported
	//
	// Examples: 400
	VisibilityMinM *int `json:"visibilityMinM"`
}

RunwayVisualRange defines model for RunwayVisualRange.

type RunwayVisualRangeTendency

type RunwayVisualRangeTendency string

RunwayVisualRangeTendency Trend of RVR change over the observation period

Examples: increasing

const (
	RunwayVisualRangeTendencyDecreasing  RunwayVisualRangeTendency = "decreasing"
	RunwayVisualRangeTendencyIncreasing  RunwayVisualRangeTendency = "increasing"
	RunwayVisualRangeTendencyLessThannil RunwayVisualRangeTendency = "<nil>"
	RunwayVisualRangeTendencyNoChange    RunwayVisualRangeTendency = "noChange"
)

Defines values for RunwayVisualRangeTendency.

func (RunwayVisualRangeTendency) Valid

func (e RunwayVisualRangeTendency) Valid() bool

Valid indicates whether the value is a known member of the RunwayVisualRangeTendency enum.

type TafExtendedResource

type TafExtendedResource struct {
	Decoded *TafForecast `json:"decoded"`

	// Icao ICAO station identifier
	//
	// Examples: EGLL
	Icao string `json:"icao"`

	// IssuedAt Issue time as a Unix timestamp (UTC)
	//
	// Examples: 1747306800
	IssuedAt *int `json:"issuedAt"`

	// Raw Raw TAF string
	//
	// Examples: TAF EGLL 151100Z 1512/1618 27010KT 9999 FEW025
	Raw *string `json:"raw"`
}

TafExtendedResource defines model for TafExtendedResource.

type TafForecast

type TafForecast struct {
	// ForecastTemperatureMax Maximum temperature forecasts, one entry per TX group
	ForecastTemperatureMax []ForecastTemperature `json:"forecastTemperatureMax"`

	// ForecastTemperatureMin Minimum temperature forecasts, one entry per TN group
	ForecastTemperatureMin []ForecastTemperature `json:"forecastTemperatureMin"`

	// Trends Forecast periods (BECMG, TEMPO, INTER, PROB, and validity windows)
	Trends []WeatherTrend `json:"trends"`
}

TafForecast defines model for TafForecast.

type TafResource

type TafResource struct {
	// Icao ICAO station identifier
	//
	// Examples: EGLL
	Icao string `json:"icao"`

	// IssuedAt Issue time as a Unix timestamp (UTC)
	//
	// Examples: 1747306800
	IssuedAt *int `json:"issuedAt"`

	// Raw Raw TAF string
	//
	// Examples: TAF EGLL 151100Z 1512/1618 27010KT 9999 FEW025
	Raw *string `json:"raw"`
}

TafResource defines model for TafResource.

type Temperature

type Temperature struct {
	// Celsius Air temperature in degrees Celsius
	//
	// Examples: 16
	Celsius int `json:"celsius"`

	// DewPointCelsius Dew point temperature in degrees Celsius
	//
	// Examples: 8
	DewPointCelsius *int `json:"dewPointCelsius"`

	// DewPointFahrenheit Dew point temperature in degrees Fahrenheit
	//
	// Examples: 46
	DewPointFahrenheit *int `json:"dewPointFahrenheit"`

	// Fahrenheit Air temperature in degrees Fahrenheit
	//
	// Examples: 61
	Fahrenheit *int `json:"fahrenheit"`

	// HeatIndexCelsius Heat index in degrees Celsius; only present when temperature and humidity conditions warrant
	//
	// Examples: 32
	HeatIndexCelsius *int `json:"heatIndexCelsius"`

	// HeatIndexFahrenheit Heat index in degrees Fahrenheit
	//
	// Examples: 90
	HeatIndexFahrenheit *int `json:"heatIndexFahrenheit"`

	// Humidity Relative humidity as a percentage
	//
	// Examples: 58
	Humidity *int `json:"humidity"`

	// WindChillCelsius Wind chill temperature in degrees Celsius; only present when temperature and wind conditions warrant
	//
	// Examples: -5
	WindChillCelsius *int `json:"windChillCelsius"`

	// WindChillFahrenheit Wind chill temperature in degrees Fahrenheit
	//
	// Examples: 23
	WindChillFahrenheit *int `json:"windChillFahrenheit"`
}

Temperature defines model for Temperature.

type TrendPeriod

type TrendPeriod struct {
	// Day Day of month for AT/FM/TL periods
	//
	// Examples: 15
	Day *int `json:"day"`

	// FromDay Day of month for the start of a DDhh/DDhh validity window
	//
	// Examples: 15
	FromDay *int `json:"fromDay"`

	// FromHour Hour UTC for the start of the validity window
	//
	// Examples: 12
	FromHour *int `json:"fromHour"`

	// Hour Hour UTC for AT/FM/TL periods
	//
	// Examples: 14
	Hour *int `json:"hour"`

	// Minute Minute UTC for AT/FM/TL periods
	//
	// Examples: 30
	Minute *int `json:"minute"`

	// ToDay Day of month for the end of the validity window
	//
	// Examples: 16
	ToDay *int `json:"toDay"`

	// ToHour Hour UTC for the end of the validity window
	//
	// Examples: 18
	ToHour *int `json:"toHour"`

	// Type Period type for AT/FM/TL groups
	//
	// Examples: FM
	Type *string `json:"type"`
}

TrendPeriod defines model for TrendPeriod.

type Unauthorized

type Unauthorized struct {
	// Message Error overview.
	//
	// Examples: Unauthenticated.
	Message string `json:"message"`
}

Unauthorized defines model for Unauthorized.

type ValidationException

type ValidationException struct {
	// Errors A detailed description of each field that failed validation.
	Errors map[string][]string `json:"errors"`

	// Message Errors overview.
	Message string `json:"message"`
}

ValidationException defines model for ValidationException.

type Visibility

type Visibility struct {
	// Cavok True when ceiling and visibility are OK (CAVOK reported)
	//
	// Examples: false
	Cavok bool `json:"cavok"`

	// Meters Prevailing visibility in metres
	//
	// Examples: 9999
	Meters *int `json:"meters"`

	// MinimumDirection Compass direction of the minimum visibility
	//
	// Examples: SW
	MinimumDirection *string `json:"minimumDirection"`

	// MinimumMeters Minimum directional visibility in metres, when reported
	//
	// Examples: 1200
	MinimumMeters *int `json:"minimumMeters"`
}

Visibility defines model for Visibility.

type WeatherCondition

type WeatherCondition struct {
	// Characteristics Weather characteristic code (e.g. SH for showers, TS for thunderstorm)
	//
	// Examples: SH
	Characteristics *string `json:"characteristics"`

	// Intensity Intensity modifier for the weather phenomenon
	//
	// Examples: light
	Intensity *WeatherConditionIntensity `json:"intensity"`

	// Types One or more weather type codes (e.g. RA for rain, SN for snow)
	//
	// Examples: ["RA"]
	Types *string `json:"types"`
}

WeatherCondition defines model for WeatherCondition.

type WeatherConditionIntensity

type WeatherConditionIntensity string

WeatherConditionIntensity Intensity modifier for the weather phenomenon

Examples: light

const (
	WeatherConditionIntensityHeavy       WeatherConditionIntensity = "heavy"
	WeatherConditionIntensityInVicinity  WeatherConditionIntensity = "inVicinity"
	WeatherConditionIntensityLessThannil WeatherConditionIntensity = "<nil>"
	WeatherConditionIntensityLight       WeatherConditionIntensity = "light"
)

Defines values for WeatherConditionIntensity.

func (WeatherConditionIntensity) Valid

func (e WeatherConditionIntensity) Valid() bool

Valid indicates whether the value is a known member of the WeatherConditionIntensity enum.

type WeatherTrend

type WeatherTrend struct {
	// Clouds Cloud cover forecast during this trend
	Clouds []CloudLayer `json:"clouds"`

	// Flag Trend type flag
	//
	// Examples: TEMPO
	Flag   *string      `json:"flag"`
	Period *TrendPeriod `json:"period"`

	// PresentWeather Weather phenomena forecast during this trend
	PresentWeather []WeatherCondition `json:"presentWeather"`

	// Probability Probability percentage when a PROB group is present
	//
	// Examples: 30
	Probability *int `json:"probability"`

	// RunwayVisualRange Runway visual range forecast during this trend
	RunwayVisualRange []RunwayVisualRange `json:"runwayVisualRange"`
	Visibility        *Visibility         `json:"visibility"`
	Wind              *Wind               `json:"wind"`
}

WeatherTrend defines model for WeatherTrend.

type Wind

type Wind struct {
	// Direction Wind direction in degrees true (0–360)
	//
	// Examples: 270
	Direction *int `json:"direction"`

	// DirectionLabel Compass point label for wind direction
	//
	// Examples: W
	DirectionLabel *string `json:"directionLabel"`

	// GustSpeedKt Gust speed in knots
	//
	// Examples: 16
	GustSpeedKt *float32 `json:"gustSpeedKt"`

	// GustSpeedMs Gust speed in metres per second
	//
	// Examples: 8.23
	GustSpeedMs *float32 `json:"gustSpeedMs"`

	// SpeedKt Wind speed in knots
	//
	// Examples: 10
	SpeedKt *float32 `json:"speedKt"`

	// SpeedMs Wind speed in metres per second
	//
	// Examples: 5.14
	SpeedMs *float32 `json:"speedMs"`

	// VariableFrom Lower bound of variable wind direction in degrees
	//
	// Examples: 240
	VariableFrom *int `json:"variableFrom"`

	// VariableFromLabel Compass label for the lower bound of variable direction
	//
	// Examples: WSW
	VariableFromLabel *string `json:"variableFromLabel"`

	// VariableTo Upper bound of variable wind direction in degrees
	//
	// Examples: 300
	VariableTo *int `json:"variableTo"`

	// VariableToLabel Compass label for the upper bound of variable direction
	//
	// Examples: WNW
	VariableToLabel *string `json:"variableToLabel"`

	// Varies True when wind direction is variable (VRB reported)
	//
	// Examples: false
	Varies bool `json:"varies"`
}

Wind defines model for Wind.

type WindShear

type WindShear struct {
	// AllRunways True when wind shear affects all runways
	//
	// Examples: false
	AllRunways bool `json:"allRunways"`

	// Runways Designators of individual runways affected by wind shear
	//
	// Examples: ["10L","28R"]
	Runways WindShear_Runways `json:"runways"`
}

WindShear defines model for WindShear.

type WindShearRunways0

type WindShearRunways0 = string

WindShearRunways0 defines model for WindShear.Runways.0.

type WindShearRunways1

type WindShearRunways1 = []string

WindShearRunways1 defines model for WindShear.Runways.1.

type WindShear_Runways

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

WindShear_Runways Designators of individual runways affected by wind shear

Examples: ["10L","28R"]

func (WindShear_Runways) AsWindShearRunways0

func (t WindShear_Runways) AsWindShearRunways0() (WindShearRunways0, error)

AsWindShearRunways0 returns the union data inside the WindShear_Runways as a WindShearRunways0

func (WindShear_Runways) AsWindShearRunways1

func (t WindShear_Runways) AsWindShearRunways1() (WindShearRunways1, error)

AsWindShearRunways1 returns the union data inside the WindShear_Runways as a WindShearRunways1

func (*WindShear_Runways) FromWindShearRunways0

func (t *WindShear_Runways) FromWindShearRunways0(v WindShearRunways0) error

FromWindShearRunways0 overwrites any union data inside the WindShear_Runways as the provided WindShearRunways0

func (*WindShear_Runways) FromWindShearRunways1

func (t *WindShear_Runways) FromWindShearRunways1(v WindShearRunways1) error

FromWindShearRunways1 overwrites any union data inside the WindShear_Runways as the provided WindShearRunways1

func (WindShear_Runways) MarshalJSON

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

func (*WindShear_Runways) MergeWindShearRunways0

func (t *WindShear_Runways) MergeWindShearRunways0(v WindShearRunways0) error

MergeWindShearRunways0 performs a merge with any union data inside the WindShear_Runways, using the provided WindShearRunways0

func (*WindShear_Runways) MergeWindShearRunways1

func (t *WindShear_Runways) MergeWindShearRunways1(v WindShearRunways1) error

MergeWindShearRunways1 performs a merge with any union data inside the WindShear_Runways, using the provided WindShearRunways1

func (*WindShear_Runways) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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