vesselapi

package module
v4.0.0 Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2026 License: MIT Imports: 14 Imported by: 0

README

vesselapi-go

CI Go Reference Go Report Card

Go client for the Vessel Tracking API: maritime vessel tracking, port events, emissions, and navigation data.

Resources: Documentation | API Explorer | Dashboard | Contact Support

Install

go get github.com/vessel-api/vesselapi-go/v4

Requires Go 1.24+ (raised in v4: the generated client depends on oapi-codegen/runtime v1.6.0, which requires Go 1.24).

Quick Start

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	vesselapi "github.com/vessel-api/vesselapi-go/v4"
)

func main() {
	client, err := vesselapi.NewVesselClient(os.Getenv("VESSELAPI_API_KEY"))
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()

	// Search for a vessel by name.
	result, err := client.Search.Vessels(ctx, &vesselapi.GetSearchVesselsParams{
		FilterName: vesselapi.Ptr("Ever Given"),
	})
	if err != nil {
		log.Fatal(err)
	}
	for _, v := range vesselapi.Deref(result.Vessels) {
		fmt.Printf("%s (IMO %d)\n", vesselapi.Deref(v.Name), vesselapi.Deref(v.Imo))
	}

	// Get a port by UN/LOCODE.
	port, err := client.Ports.Get(ctx, "NLRTM")
	if err != nil {
		log.Fatal(err)
	}
	// Every field on a response is optional, so check before dereferencing.
	if port.Port != nil {
		fmt.Println(vesselapi.Deref(port.Port.Name))
	}

	// Auto-paginate through port events.
	it := client.PortEvents.ListAll(ctx, &vesselapi.GetPorteventsParams{
		PaginationLimit: vesselapi.Ptr(10),
	})
	for it.Next() {
		event := it.Value()
		fmt.Printf("%s at %s\n", vesselapi.Deref(event.Event), vesselapi.Deref(event.Timestamp))
	}
	if err := it.Err(); err != nil {
		log.Fatal(err)
	}
}

Available Services

Service Methods Description
Vessels Get, Position, Casualties, Emissions, ETA, Positions Vessel details, positions, and records (docs)
Ports Get, Inbound Port lookup by UN/LOCODE and inbound vessels (docs)
PortEvents List, ByPort, ByPorts, ByVessel, LastByVessel, ByVessels Vessel arrival/departure events (docs)
Emissions List EU MRV emissions data (docs)
Search Vessels, Ports, DGPS, LightAids, MODUs, RadioBeacons Full-text search across entity types
Location VesselsBoundingBox, VesselsRadius, PortsBoundingBox, PortsRadius, DGPSBoundingBox, DGPSRadius, LightAidsBoundingBox, LightAidsRadius, MODUsBoundingBox, MODUsRadius, RadioBeaconsBoundingBox, RadioBeaconsRadius Geo queries by bounding box or radius (docs)

33 methods total, one per API endpoint, plus 28 auto-pagination iterators.

Vessel Lookup & Location

// Get vessel details by IMO number (nil defaults to IMO; pass FilterIdType for MMSI).
vessel, err := client.Vessels.Get(ctx, "9811000", nil)
if err != nil {
	log.Fatal(err)
}
if vessel.Vessel != nil {
	fmt.Printf("%s (%s)\n", vesselapi.Deref(vessel.Vessel.Name), vesselapi.Deref(vessel.Vessel.VesselType))
}

// Get the vessel's latest AIS position. A vessel that exists may have no
// stored position, which comes back as 404 rather than an empty result, so
// treat it as an outcome rather than a failure.
pos, err := client.Vessels.Position(ctx, "9811000", nil)
var posErr *vesselapi.APIError
switch {
case errors.As(err, &posErr) && posErr.IsNotFound():
	fmt.Println("No position currently stored for this vessel.")
case err != nil:
	log.Fatal(err)
}
if err == nil && pos.VesselPosition != nil {
	fmt.Printf("Position: %f, %f\n",
		vesselapi.Deref(pos.VesselPosition.Latitude),
		vesselapi.Deref(pos.VesselPosition.Longitude),
	)
}

// Find all vessels within 10 km of Rotterdam.
nearby, err := client.Location.VesselsRadius(ctx, &vesselapi.GetLocationVesselsRadiusParams{
	FilterLatitude:  51.9225,
	FilterLongitude: 4.47917,
	FilterRadius:    10000,
})
if err != nil {
	log.Fatal(err)
}
for _, v := range vesselapi.Deref(nearby.Vessels) {
	fmt.Printf("%s at %f, %f\n",
		vesselapi.Deref(v.VesselName),
		vesselapi.Deref(v.Latitude),
		vesselapi.Deref(v.Longitude),
	)
}

Error Handling

There are two kinds of error. A call rejected before anything is sent returns a *ParamError, and a non-2xx response returns an *APIError.

Required parameters are checked locally, so a missing filter or an out-of-range coordinate fails without a round trip. Match any of them at once:

if errors.Is(err, vesselapi.ErrInvalidParams) {
	// Nothing was sent. Inspect *ParamError for the parameter at fault.
	var paramErr *vesselapi.ParamError
	if errors.As(err, &paramErr) {
		fmt.Println(paramErr.Param, paramErr.Reason)
	}
}

For responses, use errors.As to inspect:

var apiErr *vesselapi.APIError
if errors.As(err, &apiErr) {
	if apiErr.IsNotFound() {
		// Handle 404
	}
	if apiErr.IsRateLimited() {
		// Back off (automatic retries handle most 429s)
	}
	if apiErr.IsAuthError() {
		// Check API key
	}
	if apiErr.IsPaymentRequired() {
		// Out of satellite credits
	}
	if apiErr.IsForbidden() {
		// Key suspended, or feature not on your plan
	}
	fmt.Println(apiErr.StatusCode, apiErr.Message)
}
Status Helper Meaning
401 IsAuthError() API key missing, invalid or revoked
402 IsPaymentRequired() Out of satellite credits, with no stored position to fall back on
403 IsForbidden() Key suspended for sustained quota abuse, or feature not on your plan
404 IsNotFound() Resource does not exist
429 IsRateLimited() Rate or quota limit hit (retried automatically)

APIError also carries the API's machine-readable Code and Type fields. Branch on Code rather than on Message, which is free-form text and may be reworded:

_, err := client.Vessels.Position(ctx, "9811000", &vesselapi.GetVesselIdPositionParams{
	FilterSat: vesselapi.Ptr(true),
})

var apiErr *vesselapi.APIError
if errors.As(err, &apiErr) {
	switch {
	case apiErr.Code == vesselapi.ErrorCodeInsufficientCredits:
		// 402: top up credits, or retry without the satellite fallback.
		pos, err := client.Vessels.Position(ctx, "9811000", nil)
		_, _ = pos, err
	case apiErr.Code == vesselapi.ErrorCodeFeatureNotAvailable:
		// 403: the endpoint is not part of this plan.
	case apiErr.IsForbidden():
		// 403 with ErrorCodeForbidden: key suspended; see the Retry-After header.
	}
}

Code and Type are empty when a response carries no structured error body. 402 is only returned by Vessels.Position when FilterSat is true; 403 can come from any endpoint. Neither status is retried, since retrying cannot succeed.

Auto-Pagination

Every list endpoint has an iterator variant. Most are named All* (AllVessels, AllByPort); a few read better the other way round (ListAll, InboundAll).

it := client.Search.AllVessels(ctx, &vesselapi.GetSearchVesselsParams{
	FilterVesselType: &[]string{"Tanker"},
})
for it.Next() {
	vessel := it.Value()
	// ...
}
if err := it.Err(); err != nil {
	log.Fatal(err)
}

// Collect gathers every page, so it makes as many requests as the result set
// needs. PaginationLimit sets the page size, not a total, and does not bound
// the walk. Use it on result sets you know are small:
port, err := client.Search.AllPorts(ctx, &vesselapi.GetSearchPortsParams{
	FilterCountry: &[]string{"NL"},
}).Collect()

// To take a fixed number, stop the loop yourself:
var first50 []vesselapi.Vessel
tankers := client.Search.AllVessels(ctx, &vesselapi.GetSearchVesselsParams{
	FilterVesselType: &[]string{"Tanker"},
})
for len(first50) < 50 && tankers.Next() {
	first50 = append(first50, tankers.Value())
}
if err := tankers.Err(); err != nil {
	log.Fatal(err)
}

Collect returns whatever it gathered before a failure alongside the error, so check the error before treating the result as complete.

Configuration

client, err := vesselapi.NewVesselClient(apiKey,
	vesselapi.WithVesselBaseURL("https://custom-endpoint.example.com/v1"),
	vesselapi.WithVesselHTTPClient(&http.Client{Timeout: 60 * time.Second}),
	vesselapi.WithVesselUserAgent("my-app/1.0"),
	vesselapi.WithVesselRetry(5), // default: 3
)

Retries use exponential backoff with jitter on 429 and 5xx responses. The Retry-After header is respected.

Documentation

Contributing & Support

Found a bug, have a feature request, or need help? You're welcome to open an issue. For API-level bugs and feature requests, please use the main VesselAPI repository. See the contributing guide for details.

For security vulnerabilities, do not open a public issue. Email security@vesselapi.com instead. See SECURITY.md.

For account or billing questions, contact support@vesselapi.com.

Generation

Types and low-level client are generated by oapi-codegen from openapi/openapi.json, which is committed to this repository. Regenerate with make generate. The wrapper layer, retry logic, pagination and tests are hand-written.

Data Sources & Attribution

Emissions and casualty data: © European Union. Source: European Maritime Safety Agency (EMSA): THETIS-MRV (EU MRV, Regulation (EU) 2015/757) and the European Marine Casualty Information Platform (EMCIP). Reused under the European Commission reuse notice (Commission Decision 2011/833/EU), which authorises reuse for commercial and non-commercial purposes with acknowledgement of the source. Data may be transformed and combined; EMSA does not endorse this service.

License

MIT

Documentation

Overview

Package vesselapi provides a Go client for the Vessel Tracking API.

Usage: 

client, err := vesselapi.NewVesselClient("your-api-key")
if err != nil {
    log.Fatal(err)
}
vessel, err := client.Vessels.Get(ctx, "9363728", nil)

Index

Constants

View Source 
const (
	// Version is the SDK version string.
	Version = "4.0.0"

	// DefaultBaseURL is the default Vessel API base URL.
	DefaultBaseURL = "https://api.vesselapi.com/v1"

	// DefaultUserAgent is the default User-Agent header value.
	DefaultUserAgent = "vesselapi-go/" + Version
)

Variables

View Source 
var ErrInvalidParams = errors.New("invalid parameters")

ErrInvalidParams matches any error returned when a request is rejected before it is sent, because a required parameter is missing or a value is out of range. Match it with errors.Is: 

if errors.Is(err, vesselapi.ErrInvalidParams) {
	// the request was never sent
}

Functions

func Deref 

func Deref[T any](p *T) T

Deref safely dereferences a pointer. Returns the zero value of T if p is nil.

func NewGetEmissionsRequest 

func NewGetEmissionsRequest(server string, params *GetEmissionsParams) (*http.Request, error)

NewGetEmissionsRequest constructs an http.Request for the GetEmissions method

func NewGetLocationDgpsBoundingBoxRequest 

func NewGetLocationDgpsBoundingBoxRequest(server string, params *GetLocationDgpsBoundingBoxParams) (*http.Request, error)

NewGetLocationDgpsBoundingBoxRequest constructs an http.Request for the GetLocationDgpsBoundingBox method

func NewGetLocationDgpsRadiusRequest 

func NewGetLocationDgpsRadiusRequest(server string, params *GetLocationDgpsRadiusParams) (*http.Request, error)

NewGetLocationDgpsRadiusRequest constructs an http.Request for the GetLocationDgpsRadius method

func NewGetLocationLightaidsBoundingBoxRequest 

func NewGetLocationLightaidsBoundingBoxRequest(server string, params *GetLocationLightaidsBoundingBoxParams) (*http.Request, error)

NewGetLocationLightaidsBoundingBoxRequest constructs an http.Request for the GetLocationLightaidsBoundingBox method

func NewGetLocationLightaidsRadiusRequest 

func NewGetLocationLightaidsRadiusRequest(server string, params *GetLocationLightaidsRadiusParams) (*http.Request, error)

NewGetLocationLightaidsRadiusRequest constructs an http.Request for the GetLocationLightaidsRadius method

func NewGetLocationModuBoundingBoxRequest 

func NewGetLocationModuBoundingBoxRequest(server string, params *GetLocationModuBoundingBoxParams) (*http.Request, error)

NewGetLocationModuBoundingBoxRequest constructs an http.Request for the GetLocationModuBoundingBox method

func NewGetLocationModuRadiusRequest 

func NewGetLocationModuRadiusRequest(server string, params *GetLocationModuRadiusParams) (*http.Request, error)

NewGetLocationModuRadiusRequest constructs an http.Request for the GetLocationModuRadius method

func NewGetLocationPortsBoundingBoxRequest 

func NewGetLocationPortsBoundingBoxRequest(server string, params *GetLocationPortsBoundingBoxParams) (*http.Request, error)

NewGetLocationPortsBoundingBoxRequest constructs an http.Request for the GetLocationPortsBoundingBox method

func NewGetLocationPortsRadiusRequest 

func NewGetLocationPortsRadiusRequest(server string, params *GetLocationPortsRadiusParams) (*http.Request, error)

NewGetLocationPortsRadiusRequest constructs an http.Request for the GetLocationPortsRadius method

func NewGetLocationRadiobeaconsBoundingBoxRequest 

func NewGetLocationRadiobeaconsBoundingBoxRequest(server string, params *GetLocationRadiobeaconsBoundingBoxParams) (*http.Request, error)

NewGetLocationRadiobeaconsBoundingBoxRequest constructs an http.Request for the GetLocationRadiobeaconsBoundingBox method

func NewGetLocationRadiobeaconsRadiusRequest 

func NewGetLocationRadiobeaconsRadiusRequest(server string, params *GetLocationRadiobeaconsRadiusParams) (*http.Request, error)

NewGetLocationRadiobeaconsRadiusRequest constructs an http.Request for the GetLocationRadiobeaconsRadius method

func NewGetLocationVesselsBoundingBoxRequest 

func NewGetLocationVesselsBoundingBoxRequest(server string, params *GetLocationVesselsBoundingBoxParams) (*http.Request, error)

NewGetLocationVesselsBoundingBoxRequest constructs an http.Request for the GetLocationVesselsBoundingBox method

func NewGetLocationVesselsRadiusRequest 

func NewGetLocationVesselsRadiusRequest(server string, params *GetLocationVesselsRadiusParams) (*http.Request, error)

NewGetLocationVesselsRadiusRequest constructs an http.Request for the GetLocationVesselsRadius method

func NewGetPortUnlocodeInboundRequest 

func NewGetPortUnlocodeInboundRequest(server string, unlocode string, params *GetPortUnlocodeInboundParams) (*http.Request, error)

NewGetPortUnlocodeInboundRequest constructs an http.Request for the GetPortUnlocodeInbound method

func NewGetPortUnlocodeRequest 

func NewGetPortUnlocodeRequest(server string, unlocode string) (*http.Request, error)

NewGetPortUnlocodeRequest constructs an http.Request for the GetPortUnlocode method

func NewGetPorteventsPortUnlocodeRequest 

func NewGetPorteventsPortUnlocodeRequest(server string, unlocode string, params *GetPorteventsPortUnlocodeParams) (*http.Request, error)

NewGetPorteventsPortUnlocodeRequest constructs an http.Request for the GetPorteventsPortUnlocode method

func NewGetPorteventsPortsRequest 

func NewGetPorteventsPortsRequest(server string, params *GetPorteventsPortsParams) (*http.Request, error)

NewGetPorteventsPortsRequest constructs an http.Request for the GetPorteventsPorts method

func NewGetPorteventsRequest 

func NewGetPorteventsRequest(server string, params *GetPorteventsParams) (*http.Request, error)

NewGetPorteventsRequest constructs an http.Request for the GetPortevents method

func NewGetPorteventsVesselIdLastRequest 

func NewGetPorteventsVesselIdLastRequest(server string, id string, params *GetPorteventsVesselIdLastParams) (*http.Request, error)

NewGetPorteventsVesselIdLastRequest constructs an http.Request for the GetPorteventsVesselIdLast method

func NewGetPorteventsVesselIdRequest 

func NewGetPorteventsVesselIdRequest(server string, id string, params *GetPorteventsVesselIdParams) (*http.Request, error)

NewGetPorteventsVesselIdRequest constructs an http.Request for the GetPorteventsVesselId method

func NewGetPorteventsVesselsRequest 

func NewGetPorteventsVesselsRequest(server string, params *GetPorteventsVesselsParams) (*http.Request, error)

NewGetPorteventsVesselsRequest constructs an http.Request for the GetPorteventsVessels method

func NewGetSearchDgpsRequest 

func NewGetSearchDgpsRequest(server string, params *GetSearchDgpsParams) (*http.Request, error)

NewGetSearchDgpsRequest constructs an http.Request for the GetSearchDgps method

func NewGetSearchLightaidsRequest 

func NewGetSearchLightaidsRequest(server string, params *GetSearchLightaidsParams) (*http.Request, error)

NewGetSearchLightaidsRequest constructs an http.Request for the GetSearchLightaids method

func NewGetSearchModusRequest 

func NewGetSearchModusRequest(server string, params *GetSearchModusParams) (*http.Request, error)

NewGetSearchModusRequest constructs an http.Request for the GetSearchModus method

func NewGetSearchPortsRequest 

func NewGetSearchPortsRequest(server string, params *GetSearchPortsParams) (*http.Request, error)

NewGetSearchPortsRequest constructs an http.Request for the GetSearchPorts method

func NewGetSearchRadiobeaconsRequest 

func NewGetSearchRadiobeaconsRequest(server string, params *GetSearchRadiobeaconsParams) (*http.Request, error)

NewGetSearchRadiobeaconsRequest constructs an http.Request for the GetSearchRadiobeacons method

func NewGetSearchVesselsRequest 

func NewGetSearchVesselsRequest(server string, params *GetSearchVesselsParams) (*http.Request, error)

NewGetSearchVesselsRequest constructs an http.Request for the GetSearchVessels method

func NewGetVesselIdCasualtiesRequest 

func NewGetVesselIdCasualtiesRequest(server string, id string, params *GetVesselIdCasualtiesParams) (*http.Request, error)

NewGetVesselIdCasualtiesRequest constructs an http.Request for the GetVesselIdCasualties method

func NewGetVesselIdEmissionsRequest 

func NewGetVesselIdEmissionsRequest(server string, id string, params *GetVesselIdEmissionsParams) (*http.Request, error)

NewGetVesselIdEmissionsRequest constructs an http.Request for the GetVesselIdEmissions method

func NewGetVesselIdEtaRequest 

func NewGetVesselIdEtaRequest(server string, id string, params *GetVesselIdEtaParams) (*http.Request, error)

NewGetVesselIdEtaRequest constructs an http.Request for the GetVesselIdEta method

func NewGetVesselIdPositionRequest 

func NewGetVesselIdPositionRequest(server string, id string, params *GetVesselIdPositionParams) (*http.Request, error)

NewGetVesselIdPositionRequest constructs an http.Request for the GetVesselIdPosition method

func NewGetVesselIdRequest 

func NewGetVesselIdRequest(server string, id string, params *GetVesselIdParams) (*http.Request, error)

NewGetVesselIdRequest constructs an http.Request for the GetVesselId method

func NewGetVesselsPositionsRequest 

func NewGetVesselsPositionsRequest(server string, params *GetVesselsPositionsParams) (*http.Request, error)

NewGetVesselsPositionsRequest constructs an http.Request for the GetVesselsPositions method

func Ptr 

func Ptr[T any](v T) *T

Ptr returns a pointer to the given value. Useful for constructing request parameters with optional fields.

Types

type APIError 

type APIError struct {
	// StatusCode is the HTTP status code.
	StatusCode int

	// Message is the human-readable error message.
	Message string

	// Body is the raw response body, available for re-parsing if needed.
	Body []byte

	// Code is the machine-readable error code from the response body
	// ("error.code"), for example ErrorCodeInsufficientCredits. Empty when the
	// response carried no structured error. Branch on this rather than on
	// Message, which is free-form text and may be reworded.
	Code ErrorCode

	// Type is the error category from the response body ("error.type"), for
	// example ErrorTypePaymentRequired. Empty when the response carried no
	// structured error.
	Type ErrorType
}

APIError represents an error response from the Vessel API.

func (*APIError) Error 

func (e *APIError) Error() string

func (*APIError) IsAuthError 

func (e *APIError) IsAuthError() bool

IsAuthError returns true if the error is a 401 Unauthorized response.

func (*APIError) IsForbidden 

func (e *APIError) IsForbidden() bool

IsForbidden returns true if the error is a 403 Forbidden response, returned when the API key is suspended for sustained quota abuse (see the Retry-After header) or the feature is not on the caller's plan. Check Code to tell the two apart: ErrorCodeForbidden for a suspended key, ErrorCodeFeatureNotAvailable for a plan restriction.

func (*APIError) IsNotFound 

func (e *APIError) IsNotFound() bool

IsNotFound returns true if the error is a 404 Not Found response.

func (*APIError) IsPaymentRequired 

func (e *APIError) IsPaymentRequired() bool

IsPaymentRequired returns true if the error is a 402 Payment Required response, returned when a satellite position is requested with no satellite credits left and no stored position to fall back on. Top up credits, or retry without the satellite fallback.

func (*APIError) IsRateLimited 

func (e *APIError) IsRateLimited() bool

IsRateLimited returns true if the error is a 429 Too Many Requests response.

type AuthenticationErrorDetail 

type AuthenticationErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: invalid_api_key
	Code *ErrorCode `json:"code,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: api key is invalid or not found
	Message *string `json:"message,omitempty"`

	// Type Type categorizes the error (always "authentication_error" for 401s)
	//
	// Example: authentication_error
	Type *ErrorType `json:"type,omitempty"`
}

AuthenticationErrorDetail defines model for AuthenticationErrorDetail.

type AuthenticationErrorResponse 

type AuthenticationErrorResponse struct {
	Error *AuthenticationErrorDetail `json:"error,omitempty"`
}

AuthenticationErrorResponse defines model for AuthenticationErrorResponse.

type BadRequestErrorDetail 

type BadRequestErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: invalid_mmsi
	Code *ErrorCode `json:"code,omitempty"`

	// DocUrl DocURL is a link to documentation for more information
	//
	// Example: https://vesselapi.com/docs#invalid_mmsi
	DocUrl *string `json:"doc_url,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: Invalid MMSI: abc123
	Message *string `json:"message,omitempty"`

	// Param Param identifies the parameter that caused the error (if applicable)
	//
	// Example: mmsi
	Param *string `json:"param,omitempty"`

	// Type Type categorizes the error (e.g., "invalid_request_error")
	//
	// Example: invalid_request_error
	Type *ErrorType `json:"type,omitempty"`
}

BadRequestErrorDetail defines model for BadRequestErrorDetail.

type BadRequestErrorResponse 

type BadRequestErrorResponse struct {
	Error *BadRequestErrorDetail `json:"error,omitempty"`
}

BadRequestErrorResponse defines model for BadRequestErrorResponse.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.vesselapi.com/v1 for example. This can contain a path relative
	// to the server, such as https://api.vesselapi.com/v1, 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) GetEmissions 

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

GetEmissions List emissions data

Retrieves emissions data with optional filtering by reporting period.

Corresponds with GET /emissions (the `GetEmissions` operationId).

func (*Client) GetLocationDgpsBoundingBox 

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

GetLocationDgpsBoundingBox Get DGPS Stations within a bounding box

Retrieves Dgps stations within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

Corresponds with GET /location/dgps/bounding-box (the `GetLocationDgpsBoundingBox` operationId).

func (*Client) GetLocationDgpsRadius 

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

GetLocationDgpsRadius Get DGPS Stations within a radius

Retrieves Dgps stations within a specified radius of a given point.

Corresponds with GET /location/dgps/radius (the `GetLocationDgpsRadius` operationId).

func (*Client) GetLocationLightaidsBoundingBox 

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

GetLocationLightaidsBoundingBox Get Light Aids to Navigation within a bounding box

Retrieves Light Aids to Navigation within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

Corresponds with GET /location/lightaids/bounding-box (the `GetLocationLightaidsBoundingBox` operationId).

func (*Client) GetLocationLightaidsRadius 

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

GetLocationLightaidsRadius Get Light Aids to Navigation within a radius

Retrieves Light Aids to Navigation within a specified radius of a given point.

Corresponds with GET /location/lightaids/radius (the `GetLocationLightaidsRadius` operationId).

func (*Client) GetLocationModuBoundingBox 

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

GetLocationModuBoundingBox Get Mobile Offshore Drilling Units within a bounding box

Retrieves Mobile Offshore Drilling Units within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

Corresponds with GET /location/modu/bounding-box (the `GetLocationModuBoundingBox` operationId).

func (*Client) GetLocationModuRadius 

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

GetLocationModuRadius Get Mobile Offshore Drilling Units within a radius

Retrieves Mobile Offshore Drilling Units within a specified radius of a given point.

Corresponds with GET /location/modu/radius (the `GetLocationModuRadius` operationId).

func (*Client) GetLocationPortsBoundingBox 

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

GetLocationPortsBoundingBox Get Ports within a bounding box

Retrieves Ports within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

Corresponds with GET /location/ports/bounding-box (the `GetLocationPortsBoundingBox` operationId).

func (*Client) GetLocationPortsRadius 

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

GetLocationPortsRadius Get Ports within a radius

Retrieves Ports within a specified radius of a given point.

Corresponds with GET /location/ports/radius (the `GetLocationPortsRadius` operationId).

func (*Client) GetLocationRadiobeaconsBoundingBox 

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

GetLocationRadiobeaconsBoundingBox Get Radio Beacons within a bounding box

Retrieves Radio Beacons within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

Corresponds with GET /location/radiobeacons/bounding-box (the `GetLocationRadiobeaconsBoundingBox` operationId).

func (*Client) GetLocationRadiobeaconsRadius 

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

GetLocationRadiobeaconsRadius Get Radio Beacons within a radius

Retrieves Radio Beacons within a specified radius of a given point.

Corresponds with GET /location/radiobeacons/radius (the `GetLocationRadiobeaconsRadius` operationId).

func (*Client) GetLocationVesselsBoundingBox 

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

GetLocationVesselsBoundingBox Get vessels within a bounding box

Retrieves vessels within a specified bounding box and time window. Max bbox span: |dLat| + |dLon| ≤ 4 degrees. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.

Corresponds with GET /location/vessels/bounding-box (the `GetLocationVesselsBoundingBox` operationId).

func (*Client) GetLocationVesselsRadius 

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

GetLocationVesselsRadius Get vessels within a radius

Retrieves vessels within a specified radius of a given point and a given time range. Max radius: 100 km. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.

Corresponds with GET /location/vessels/radius (the `GetLocationVesselsRadius` operationId).

func (*Client) GetPortUnlocode 

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

GetPortUnlocode Get Port by UNLOCODE

Retrieves port details by its UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)

Corresponds with GET /port/{unlocode} (the `GetPortUnlocode` operationId).

func (*Client) GetPortUnlocodeInbound 

func (c *Client) GetPortUnlocodeInbound(ctx context.Context, unlocode string, params *GetPortUnlocodeInboundParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetPortUnlocodeInbound Get Inbound Vessels for Port

Retrieves vessels heading to a specific port within an ETA window.

Corresponds with GET /port/{unlocode}/inbound (the `GetPortUnlocodeInbound` operationId).

func (*Client) GetPortevents 

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

GetPortevents Get Port Events in a time range

Get Port Events, such as Arrivals and Departures, in a time range with optional filters

Corresponds with GET /portevents (the `GetPortevents` operationId).

func (*Client) GetPorteventsPortUnlocode 

func (c *Client) GetPorteventsPortUnlocode(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetPorteventsPortUnlocode Get Port Events by port UNLOCODE

Get Port Events, such as Arrivals and Departures by supplying the port UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)

Corresponds with GET /portevents/port/{unlocode} (the `GetPorteventsPortUnlocode` operationId).

func (*Client) GetPorteventsPorts 

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

GetPorteventsPorts Get Port Events by port name

Get Port Events, such as Arrivals and Departures by supplying the port name

Corresponds with GET /portevents/ports (the `GetPorteventsPorts` operationId).

func (*Client) GetPorteventsVesselId 

func (c *Client) GetPorteventsVesselId(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetPorteventsVesselId Get Port Events by Vessel ID

Get all port events (arrivals and departures) for a vessel identified by MMSI or IMO, with optional filtering by event type and time range

Corresponds with GET /portevents/vessel/{id} (the `GetPorteventsVesselId` operationId).

func (*Client) GetPorteventsVesselIdLast 

func (c *Client) GetPorteventsVesselIdLast(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetPorteventsVesselIdLast Get Last Port Event by ID

Get the most recent port event (arrival or departure) for a vessel identified by MMSI or IMO.

Corresponds with GET /portevents/vessel/{id}/last (the `GetPorteventsVesselIdLast` operationId).

func (*Client) GetPorteventsVessels 

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

GetPorteventsVessels Get Port Events by vessel name

Corresponds with GET /portevents/vessels (the `GetPorteventsVessels` operationId).

func (*Client) GetSearchDgps 

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

GetSearchDgps Search for DGPS Stations

Retrieves a list of DGPS stations for the given query parameters.

Corresponds with GET /search/dgps (the `GetSearchDgps` operationId).

func (*Client) GetSearchLightaids 

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

GetSearchLightaids Search for Light Aids to Navigation

Retrieves a list of Light Aids to Navigation for the given query parameters.

Corresponds with GET /search/lightaids (the `GetSearchLightaids` operationId).

func (*Client) GetSearchModus 

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

GetSearchModus Search for MODUs

Retrieves a list of MODUs for the given query parameters.

Corresponds with GET /search/modus (the `GetSearchModus` operationId).

func (*Client) GetSearchPorts 

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

GetSearchPorts Search for Ports

Retrieves a list of ports matching the given filters. At least one filter parameter is required.

Corresponds with GET /search/ports (the `GetSearchPorts` operationId).

func (*Client) GetSearchRadiobeacons 

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

GetSearchRadiobeacons Search for Radio Beacons

Retrieves a list of Radio Beacons for the given query parameters.

Corresponds with GET /search/radiobeacons (the `GetSearchRadiobeacons` operationId).

func (*Client) GetSearchVessels 

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

GetSearchVessels Search for Vessels

Retrieves a list of vessels matching the given filters. At least one filter parameter (or the unified `q` parameter) is required.

Corresponds with GET /search/vessels (the `GetSearchVessels` operationId).

func (*Client) GetVesselId 

func (c *Client) GetVesselId(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVesselId Get vessel information by MMSI or IMO

Retrieves static vessel data including name, type, dimensions, and registration information for a vessel identified by its MMSI or IMO number

Corresponds with GET /vessel/{id} (the `GetVesselId` operationId).

func (*Client) GetVesselIdCasualties 

func (c *Client) GetVesselIdCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVesselIdCasualties Get marine casualties involving a vessel

Retrieves marine casualty records involving the specified vessel.

Corresponds with GET /vessel/{id}/casualties (the `GetVesselIdCasualties` operationId).

func (*Client) GetVesselIdEmissions 

func (c *Client) GetVesselIdEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVesselIdEmissions Get emissions data for a vessel

Retrieves emissions reports for the specified vessel including CO2 emissions, fuel consumption, and efficiency metrics

Corresponds with GET /vessel/{id}/emissions (the `GetVesselIdEmissions` operationId).

func (*Client) GetVesselIdEta 

func (c *Client) GetVesselIdEta(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVesselIdEta Get vessel latest ETA

Retrieves the most recent Estimated Time of Arrival (ETA) reported by the vessel.

Corresponds with GET /vessel/{id}/eta (the `GetVesselIdEta` operationId).

func (*Client) GetVesselIdPosition 

func (c *Client) GetVesselIdPosition(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetVesselIdPosition Get last known vessel position

Retrieves the most recent AIS position report for a vessel, including coordinates, vessel identifiers, and timestamps. Use sat=true to enable satellite AIS fallback when terrestrial data is stale — requires satellite credits.

Corresponds with GET /vessel/{id}/position (the `GetVesselIdPosition` operationId).

func (*Client) GetVesselsPositions 

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

GetVesselsPositions Get positions for multiple vessels

Retrieves AIS position data for multiple vessels identified by MMSI or IMO numbers within a specified time range (defaults to past 2 hours). Provide multiple IDs either as a comma-separated list in one filter.ids param, or by repeating filter.ids; both forms (and a mix) are accepted.

Corresponds with GET /vessels/positions (the `GetVesselsPositions` operationId).

type ClientInterface 

type ClientInterface interface {

	// GetEmissions List emissions data
	//
	// Retrieves emissions data with optional filtering by reporting period.
	//
	// Corresponds with GET /emissions (the `GetEmissions` operationId).
	GetEmissions(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationDgpsBoundingBox Get DGPS Stations within a bounding box
	//
	// Retrieves Dgps stations within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Corresponds with GET /location/dgps/bounding-box (the `GetLocationDgpsBoundingBox` operationId).
	GetLocationDgpsBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationDgpsRadius Get DGPS Stations within a radius
	//
	// Retrieves Dgps stations within a specified radius of a given point.
	//
	// Corresponds with GET /location/dgps/radius (the `GetLocationDgpsRadius` operationId).
	GetLocationDgpsRadius(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationLightaidsBoundingBox Get Light Aids to Navigation within a bounding box
	//
	// Retrieves Light Aids to Navigation within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Corresponds with GET /location/lightaids/bounding-box (the `GetLocationLightaidsBoundingBox` operationId).
	GetLocationLightaidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationLightaidsRadius Get Light Aids to Navigation within a radius
	//
	// Retrieves Light Aids to Navigation within a specified radius of a given point.
	//
	// Corresponds with GET /location/lightaids/radius (the `GetLocationLightaidsRadius` operationId).
	GetLocationLightaidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationModuBoundingBox Get Mobile Offshore Drilling Units within a bounding box
	//
	// Retrieves Mobile Offshore Drilling Units within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Corresponds with GET /location/modu/bounding-box (the `GetLocationModuBoundingBox` operationId).
	GetLocationModuBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationModuRadius Get Mobile Offshore Drilling Units within a radius
	//
	// Retrieves Mobile Offshore Drilling Units within a specified radius of a given point.
	//
	// Corresponds with GET /location/modu/radius (the `GetLocationModuRadius` operationId).
	GetLocationModuRadius(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationPortsBoundingBox Get Ports within a bounding box
	//
	// Retrieves Ports within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Corresponds with GET /location/ports/bounding-box (the `GetLocationPortsBoundingBox` operationId).
	GetLocationPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationPortsRadius Get Ports within a radius
	//
	// Retrieves Ports within a specified radius of a given point.
	//
	// Corresponds with GET /location/ports/radius (the `GetLocationPortsRadius` operationId).
	GetLocationPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationRadiobeaconsBoundingBox Get Radio Beacons within a bounding box
	//
	// Retrieves Radio Beacons within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Corresponds with GET /location/radiobeacons/bounding-box (the `GetLocationRadiobeaconsBoundingBox` operationId).
	GetLocationRadiobeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationRadiobeaconsRadius Get Radio Beacons within a radius
	//
	// Retrieves Radio Beacons within a specified radius of a given point.
	//
	// Corresponds with GET /location/radiobeacons/radius (the `GetLocationRadiobeaconsRadius` operationId).
	GetLocationRadiobeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationVesselsBoundingBox Get vessels within a bounding box
	//
	// Retrieves vessels within a specified bounding box and time window. Max bbox span: |dLat| + |dLon| ≤ 4 degrees. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.
	//
	// Corresponds with GET /location/vessels/bounding-box (the `GetLocationVesselsBoundingBox` operationId).
	GetLocationVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocationVesselsRadius Get vessels within a radius
	//
	// Retrieves vessels within a specified radius of a given point and a given time range. Max radius: 100 km. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.
	//
	// Corresponds with GET /location/vessels/radius (the `GetLocationVesselsRadius` operationId).
	GetLocationVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPortUnlocode Get Port by UNLOCODE
	//
	// Retrieves port details by its UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)
	//
	// Corresponds with GET /port/{unlocode} (the `GetPortUnlocode` operationId).
	GetPortUnlocode(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPortUnlocodeInbound Get Inbound Vessels for Port
	//
	// Retrieves vessels heading to a specific port within an ETA window.
	//
	// Corresponds with GET /port/{unlocode}/inbound (the `GetPortUnlocodeInbound` operationId).
	GetPortUnlocodeInbound(ctx context.Context, unlocode string, params *GetPortUnlocodeInboundParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPortevents Get Port Events in a time range
	//
	// Get Port Events, such as Arrivals and Departures, in a time range with optional filters
	//
	// Corresponds with GET /portevents (the `GetPortevents` operationId).
	GetPortevents(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPorteventsPortUnlocode Get Port Events by port UNLOCODE
	//
	// Get Port Events, such as Arrivals and Departures by supplying the port UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)
	//
	// Corresponds with GET /portevents/port/{unlocode} (the `GetPorteventsPortUnlocode` operationId).
	GetPorteventsPortUnlocode(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPorteventsPorts Get Port Events by port name
	//
	// Get Port Events, such as Arrivals and Departures by supplying the port name
	//
	// Corresponds with GET /portevents/ports (the `GetPorteventsPorts` operationId).
	GetPorteventsPorts(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPorteventsVesselId Get Port Events by Vessel ID
	//
	// Get all port events (arrivals and departures) for a vessel identified by MMSI or IMO, with optional filtering by event type and time range
	//
	// Corresponds with GET /portevents/vessel/{id} (the `GetPorteventsVesselId` operationId).
	GetPorteventsVesselId(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPorteventsVesselIdLast Get Last Port Event by ID
	//
	// Get the most recent port event (arrival or departure) for a vessel identified by MMSI or IMO.
	//
	// Corresponds with GET /portevents/vessel/{id}/last (the `GetPorteventsVesselIdLast` operationId).
	GetPorteventsVesselIdLast(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPorteventsVessels Get Port Events by vessel name
	//
	// Corresponds with GET /portevents/vessels (the `GetPorteventsVessels` operationId).
	GetPorteventsVessels(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchDgps Search for DGPS Stations
	//
	// Retrieves a list of DGPS stations for the given query parameters.
	//
	// Corresponds with GET /search/dgps (the `GetSearchDgps` operationId).
	GetSearchDgps(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchLightaids Search for Light Aids to Navigation
	//
	// Retrieves a list of Light Aids to Navigation for the given query parameters.
	//
	// Corresponds with GET /search/lightaids (the `GetSearchLightaids` operationId).
	GetSearchLightaids(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchModus Search for MODUs
	//
	// Retrieves a list of MODUs for the given query parameters.
	//
	// Corresponds with GET /search/modus (the `GetSearchModus` operationId).
	GetSearchModus(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchPorts Search for Ports
	//
	// Retrieves a list of ports matching the given filters. At least one filter parameter is required.
	//
	// Corresponds with GET /search/ports (the `GetSearchPorts` operationId).
	GetSearchPorts(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchRadiobeacons Search for Radio Beacons
	//
	// Retrieves a list of Radio Beacons for the given query parameters.
	//
	// Corresponds with GET /search/radiobeacons (the `GetSearchRadiobeacons` operationId).
	GetSearchRadiobeacons(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSearchVessels Search for Vessels
	//
	// Retrieves a list of vessels matching the given filters. At least one filter parameter (or the unified `q` parameter) is required.
	//
	// Corresponds with GET /search/vessels (the `GetSearchVessels` operationId).
	GetSearchVessels(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVesselId Get vessel information by MMSI or IMO
	//
	// Retrieves static vessel data including name, type, dimensions, and registration information for a vessel identified by its MMSI or IMO number
	//
	// Corresponds with GET /vessel/{id} (the `GetVesselId` operationId).
	GetVesselId(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVesselIdCasualties Get marine casualties involving a vessel
	//
	// Retrieves marine casualty records involving the specified vessel.
	//
	// Corresponds with GET /vessel/{id}/casualties (the `GetVesselIdCasualties` operationId).
	GetVesselIdCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVesselIdEmissions Get emissions data for a vessel
	//
	// Retrieves emissions reports for the specified vessel including CO2 emissions, fuel consumption, and efficiency metrics
	//
	// Corresponds with GET /vessel/{id}/emissions (the `GetVesselIdEmissions` operationId).
	GetVesselIdEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVesselIdEta Get vessel latest ETA
	//
	// Retrieves the most recent Estimated Time of Arrival (ETA) reported by the vessel.
	//
	// Corresponds with GET /vessel/{id}/eta (the `GetVesselIdEta` operationId).
	GetVesselIdEta(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVesselIdPosition Get last known vessel position
	//
	// Retrieves the most recent AIS position report for a vessel, including coordinates, vessel identifiers, and timestamps. Use sat=true to enable satellite AIS fallback when terrestrial data is stale — requires satellite credits.
	//
	// Corresponds with GET /vessel/{id}/position (the `GetVesselIdPosition` operationId).
	GetVesselIdPosition(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetVesselsPositions Get positions for multiple vessels
	//
	// Retrieves AIS position data for multiple vessels identified by MMSI or IMO numbers within a specified time range (defaults to past 2 hours). Provide multiple IDs either as a comma-separated list in one filter.ids param, or by repeating filter.ids; both forms (and a mix) are accepted.
	//
	// Corresponds with GET /vessels/positions (the `GetVesselsPositions` operationId).
	GetVesselsPositions(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

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

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

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

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

func (*ClientWithResponses) GetEmissionsWithResponse 

func (c *ClientWithResponses) GetEmissionsWithResponse(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*GetEmissionsResponse, error)

GetEmissionsWithResponse List emissions data

Retrieves emissions data with optional filtering by reporting period.

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

Corresponds with GET /emissions (the `GetEmissions` operationId).

func (*ClientWithResponses) GetLocationDgpsBoundingBoxWithResponse 

func (c *ClientWithResponses) GetLocationDgpsBoundingBoxWithResponse(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsBoundingBoxResponse, error)

GetLocationDgpsBoundingBoxWithResponse Get DGPS Stations within a bounding box

Retrieves Dgps stations within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

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

Corresponds with GET /location/dgps/bounding-box (the `GetLocationDgpsBoundingBox` operationId).

func (*ClientWithResponses) GetLocationDgpsRadiusWithResponse 

func (c *ClientWithResponses) GetLocationDgpsRadiusWithResponse(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsRadiusResponse, error)

GetLocationDgpsRadiusWithResponse Get DGPS Stations within a radius

Retrieves Dgps stations within a specified radius of a given point.

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

Corresponds with GET /location/dgps/radius (the `GetLocationDgpsRadius` operationId).

func (*ClientWithResponses) GetLocationLightaidsBoundingBoxWithResponse 

func (c *ClientWithResponses) GetLocationLightaidsBoundingBoxWithResponse(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsBoundingBoxResponse, error)

GetLocationLightaidsBoundingBoxWithResponse Get Light Aids to Navigation within a bounding box

Retrieves Light Aids to Navigation within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

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

Corresponds with GET /location/lightaids/bounding-box (the `GetLocationLightaidsBoundingBox` operationId).

func (*ClientWithResponses) GetLocationLightaidsRadiusWithResponse 

func (c *ClientWithResponses) GetLocationLightaidsRadiusWithResponse(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsRadiusResponse, error)

GetLocationLightaidsRadiusWithResponse Get Light Aids to Navigation within a radius

Retrieves Light Aids to Navigation within a specified radius of a given point.

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

Corresponds with GET /location/lightaids/radius (the `GetLocationLightaidsRadius` operationId).

func (*ClientWithResponses) GetLocationModuBoundingBoxWithResponse 

func (c *ClientWithResponses) GetLocationModuBoundingBoxWithResponse(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationModuBoundingBoxResponse, error)

GetLocationModuBoundingBoxWithResponse Get Mobile Offshore Drilling Units within a bounding box

Retrieves Mobile Offshore Drilling Units within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

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

Corresponds with GET /location/modu/bounding-box (the `GetLocationModuBoundingBox` operationId).

func (*ClientWithResponses) GetLocationModuRadiusWithResponse 

func (c *ClientWithResponses) GetLocationModuRadiusWithResponse(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationModuRadiusResponse, error)

GetLocationModuRadiusWithResponse Get Mobile Offshore Drilling Units within a radius

Retrieves Mobile Offshore Drilling Units within a specified radius of a given point.

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

Corresponds with GET /location/modu/radius (the `GetLocationModuRadius` operationId).

func (*ClientWithResponses) GetLocationPortsBoundingBoxWithResponse 

func (c *ClientWithResponses) GetLocationPortsBoundingBoxWithResponse(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationPortsBoundingBoxResponse, error)

GetLocationPortsBoundingBoxWithResponse Get Ports within a bounding box

Retrieves Ports within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

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

Corresponds with GET /location/ports/bounding-box (the `GetLocationPortsBoundingBox` operationId).

func (*ClientWithResponses) GetLocationPortsRadiusWithResponse 

func (c *ClientWithResponses) GetLocationPortsRadiusWithResponse(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationPortsRadiusResponse, error)

GetLocationPortsRadiusWithResponse Get Ports within a radius

Retrieves Ports within a specified radius of a given point.

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

Corresponds with GET /location/ports/radius (the `GetLocationPortsRadius` operationId).

func (*ClientWithResponses) GetLocationRadiobeaconsBoundingBoxWithResponse 

func (c *ClientWithResponses) GetLocationRadiobeaconsBoundingBoxWithResponse(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsBoundingBoxResponse, error)

GetLocationRadiobeaconsBoundingBoxWithResponse Get Radio Beacons within a bounding box

Retrieves Radio Beacons within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees

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

Corresponds with GET /location/radiobeacons/bounding-box (the `GetLocationRadiobeaconsBoundingBox` operationId).

func (*ClientWithResponses) GetLocationRadiobeaconsRadiusWithResponse 

func (c *ClientWithResponses) GetLocationRadiobeaconsRadiusWithResponse(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsRadiusResponse, error)

GetLocationRadiobeaconsRadiusWithResponse Get Radio Beacons within a radius

Retrieves Radio Beacons within a specified radius of a given point.

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

Corresponds with GET /location/radiobeacons/radius (the `GetLocationRadiobeaconsRadius` operationId).

func (*ClientWithResponses) GetLocationVesselsBoundingBoxWithResponse 

func (c *ClientWithResponses) GetLocationVesselsBoundingBoxWithResponse(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsBoundingBoxResponse, error)

GetLocationVesselsBoundingBoxWithResponse Get vessels within a bounding box

Retrieves vessels within a specified bounding box and time window. Max bbox span: |dLat| + |dLon| ≤ 4 degrees. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.

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

Corresponds with GET /location/vessels/bounding-box (the `GetLocationVesselsBoundingBox` operationId).

func (*ClientWithResponses) GetLocationVesselsRadiusWithResponse 

func (c *ClientWithResponses) GetLocationVesselsRadiusWithResponse(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsRadiusResponse, error)

GetLocationVesselsRadiusWithResponse Get vessels within a radius

Retrieves vessels within a specified radius of a given point and a given time range. Max radius: 100 km. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.

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

Corresponds with GET /location/vessels/radius (the `GetLocationVesselsRadius` operationId).

func (*ClientWithResponses) GetPortUnlocodeInboundWithResponse 

func (c *ClientWithResponses) GetPortUnlocodeInboundWithResponse(ctx context.Context, unlocode string, params *GetPortUnlocodeInboundParams, reqEditors ...RequestEditorFn) (*GetPortUnlocodeInboundResponse, error)

GetPortUnlocodeInboundWithResponse Get Inbound Vessels for Port

Retrieves vessels heading to a specific port within an ETA window.

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

Corresponds with GET /port/{unlocode}/inbound (the `GetPortUnlocodeInbound` operationId).

func (*ClientWithResponses) GetPortUnlocodeWithResponse 

func (c *ClientWithResponses) GetPortUnlocodeWithResponse(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*GetPortUnlocodeResponse, error)

GetPortUnlocodeWithResponse Get Port by UNLOCODE

Retrieves port details by its UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)

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

Corresponds with GET /port/{unlocode} (the `GetPortUnlocode` operationId).

func (*ClientWithResponses) GetPorteventsPortUnlocodeWithResponse 

func (c *ClientWithResponses) GetPorteventsPortUnlocodeWithResponse(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortUnlocodeResponse, error)

GetPorteventsPortUnlocodeWithResponse Get Port Events by port UNLOCODE

Get Port Events, such as Arrivals and Departures by supplying the port UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)

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

Corresponds with GET /portevents/port/{unlocode} (the `GetPorteventsPortUnlocode` operationId).

func (*ClientWithResponses) GetPorteventsPortsWithResponse 

func (c *ClientWithResponses) GetPorteventsPortsWithResponse(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortsResponse, error)

GetPorteventsPortsWithResponse Get Port Events by port name

Get Port Events, such as Arrivals and Departures by supplying the port name

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

Corresponds with GET /portevents/ports (the `GetPorteventsPorts` operationId).

func (*ClientWithResponses) GetPorteventsVesselIdLastWithResponse 

func (c *ClientWithResponses) GetPorteventsVesselIdLastWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdLastResponse, error)

GetPorteventsVesselIdLastWithResponse Get Last Port Event by ID

Get the most recent port event (arrival or departure) for a vessel identified by MMSI or IMO.

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

Corresponds with GET /portevents/vessel/{id}/last (the `GetPorteventsVesselIdLast` operationId).

func (*ClientWithResponses) GetPorteventsVesselIdWithResponse 

func (c *ClientWithResponses) GetPorteventsVesselIdWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdResponse, error)

GetPorteventsVesselIdWithResponse Get Port Events by Vessel ID

Get all port events (arrivals and departures) for a vessel identified by MMSI or IMO, with optional filtering by event type and time range

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

Corresponds with GET /portevents/vessel/{id} (the `GetPorteventsVesselId` operationId).

func (*ClientWithResponses) GetPorteventsVesselsWithResponse 

func (c *ClientWithResponses) GetPorteventsVesselsWithResponse(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselsResponse, error)

GetPorteventsVesselsWithResponse Get Port Events by vessel name

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

Corresponds with GET /portevents/vessels (the `GetPorteventsVessels` operationId).

func (*ClientWithResponses) GetPorteventsWithResponse 

func (c *ClientWithResponses) GetPorteventsWithResponse(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*GetPorteventsResponse, error)

GetPorteventsWithResponse Get Port Events in a time range

Get Port Events, such as Arrivals and Departures, in a time range with optional filters

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

Corresponds with GET /portevents (the `GetPortevents` operationId).

func (*ClientWithResponses) GetSearchDgpsWithResponse 

func (c *ClientWithResponses) GetSearchDgpsWithResponse(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*GetSearchDgpsResponse, error)

GetSearchDgpsWithResponse Search for DGPS Stations

Retrieves a list of DGPS stations for the given query parameters.

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

Corresponds with GET /search/dgps (the `GetSearchDgps` operationId).

func (*ClientWithResponses) GetSearchLightaidsWithResponse 

func (c *ClientWithResponses) GetSearchLightaidsWithResponse(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*GetSearchLightaidsResponse, error)

GetSearchLightaidsWithResponse Search for Light Aids to Navigation

Retrieves a list of Light Aids to Navigation for the given query parameters.

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

Corresponds with GET /search/lightaids (the `GetSearchLightaids` operationId).

func (*ClientWithResponses) GetSearchModusWithResponse 

func (c *ClientWithResponses) GetSearchModusWithResponse(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*GetSearchModusResponse, error)

GetSearchModusWithResponse Search for MODUs

Retrieves a list of MODUs for the given query parameters.

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

Corresponds with GET /search/modus (the `GetSearchModus` operationId).

func (*ClientWithResponses) GetSearchPortsWithResponse 

func (c *ClientWithResponses) GetSearchPortsWithResponse(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*GetSearchPortsResponse, error)

GetSearchPortsWithResponse Search for Ports

Retrieves a list of ports matching the given filters. At least one filter parameter is required.

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

Corresponds with GET /search/ports (the `GetSearchPorts` operationId).

func (*ClientWithResponses) GetSearchRadiobeaconsWithResponse 

func (c *ClientWithResponses) GetSearchRadiobeaconsWithResponse(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*GetSearchRadiobeaconsResponse, error)

GetSearchRadiobeaconsWithResponse Search for Radio Beacons

Retrieves a list of Radio Beacons for the given query parameters.

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

Corresponds with GET /search/radiobeacons (the `GetSearchRadiobeacons` operationId).

func (*ClientWithResponses) GetSearchVesselsWithResponse 

func (c *ClientWithResponses) GetSearchVesselsWithResponse(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*GetSearchVesselsResponse, error)

GetSearchVesselsWithResponse Search for Vessels

Retrieves a list of vessels matching the given filters. At least one filter parameter (or the unified `q` parameter) is required.

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

Corresponds with GET /search/vessels (the `GetSearchVessels` operationId).

func (*ClientWithResponses) GetVesselIdCasualtiesWithResponse 

func (c *ClientWithResponses) GetVesselIdCasualtiesWithResponse(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*GetVesselIdCasualtiesResponse, error)

GetVesselIdCasualtiesWithResponse Get marine casualties involving a vessel

Retrieves marine casualty records involving the specified vessel.

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

Corresponds with GET /vessel/{id}/casualties (the `GetVesselIdCasualties` operationId).

func (*ClientWithResponses) GetVesselIdEmissionsWithResponse 

func (c *ClientWithResponses) GetVesselIdEmissionsWithResponse(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*GetVesselIdEmissionsResponse, error)

GetVesselIdEmissionsWithResponse Get emissions data for a vessel

Retrieves emissions reports for the specified vessel including CO2 emissions, fuel consumption, and efficiency metrics

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

Corresponds with GET /vessel/{id}/emissions (the `GetVesselIdEmissions` operationId).

func (*ClientWithResponses) GetVesselIdEtaWithResponse 

func (c *ClientWithResponses) GetVesselIdEtaWithResponse(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*GetVesselIdEtaResponse, error)

GetVesselIdEtaWithResponse Get vessel latest ETA

Retrieves the most recent Estimated Time of Arrival (ETA) reported by the vessel.

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

Corresponds with GET /vessel/{id}/eta (the `GetVesselIdEta` operationId).

func (*ClientWithResponses) GetVesselIdPositionWithResponse 

func (c *ClientWithResponses) GetVesselIdPositionWithResponse(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*GetVesselIdPositionResponse, error)

GetVesselIdPositionWithResponse Get last known vessel position

Retrieves the most recent AIS position report for a vessel, including coordinates, vessel identifiers, and timestamps. Use sat=true to enable satellite AIS fallback when terrestrial data is stale — requires satellite credits.

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

Corresponds with GET /vessel/{id}/position (the `GetVesselIdPosition` operationId).

func (*ClientWithResponses) GetVesselIdWithResponse 

func (c *ClientWithResponses) GetVesselIdWithResponse(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*GetVesselIdResponse, error)

GetVesselIdWithResponse Get vessel information by MMSI or IMO

Retrieves static vessel data including name, type, dimensions, and registration information for a vessel identified by its MMSI or IMO number

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

Corresponds with GET /vessel/{id} (the `GetVesselId` operationId).

func (*ClientWithResponses) GetVesselsPositionsWithResponse 

func (c *ClientWithResponses) GetVesselsPositionsWithResponse(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*GetVesselsPositionsResponse, error)

GetVesselsPositionsWithResponse Get positions for multiple vessels

Retrieves AIS position data for multiple vessels identified by MMSI or IMO numbers within a specified time range (defaults to past 2 hours). Provide multiple IDs either as a comma-separated list in one filter.ids param, or by repeating filter.ids; both forms (and a mix) are accepted.

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

Corresponds with GET /vessels/positions (the `GetVesselsPositions` operationId).

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {

	// GetEmissionsWithResponse List emissions data
	//
	// Retrieves emissions data with optional filtering by reporting period.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /emissions (the `GetEmissions` operationId).
	GetEmissionsWithResponse(ctx context.Context, params *GetEmissionsParams, reqEditors ...RequestEditorFn) (*GetEmissionsResponse, error)

	// GetLocationDgpsBoundingBoxWithResponse Get DGPS Stations within a bounding box
	//
	// Retrieves Dgps stations within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/dgps/bounding-box (the `GetLocationDgpsBoundingBox` operationId).
	GetLocationDgpsBoundingBoxWithResponse(ctx context.Context, params *GetLocationDgpsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsBoundingBoxResponse, error)

	// GetLocationDgpsRadiusWithResponse Get DGPS Stations within a radius
	//
	// Retrieves Dgps stations within a specified radius of a given point.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/dgps/radius (the `GetLocationDgpsRadius` operationId).
	GetLocationDgpsRadiusWithResponse(ctx context.Context, params *GetLocationDgpsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationDgpsRadiusResponse, error)

	// GetLocationLightaidsBoundingBoxWithResponse Get Light Aids to Navigation within a bounding box
	//
	// Retrieves Light Aids to Navigation within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/lightaids/bounding-box (the `GetLocationLightaidsBoundingBox` operationId).
	GetLocationLightaidsBoundingBoxWithResponse(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsBoundingBoxResponse, error)

	// GetLocationLightaidsRadiusWithResponse Get Light Aids to Navigation within a radius
	//
	// Retrieves Light Aids to Navigation within a specified radius of a given point.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/lightaids/radius (the `GetLocationLightaidsRadius` operationId).
	GetLocationLightaidsRadiusWithResponse(ctx context.Context, params *GetLocationLightaidsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationLightaidsRadiusResponse, error)

	// GetLocationModuBoundingBoxWithResponse Get Mobile Offshore Drilling Units within a bounding box
	//
	// Retrieves Mobile Offshore Drilling Units within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/modu/bounding-box (the `GetLocationModuBoundingBox` operationId).
	GetLocationModuBoundingBoxWithResponse(ctx context.Context, params *GetLocationModuBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationModuBoundingBoxResponse, error)

	// GetLocationModuRadiusWithResponse Get Mobile Offshore Drilling Units within a radius
	//
	// Retrieves Mobile Offshore Drilling Units within a specified radius of a given point.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/modu/radius (the `GetLocationModuRadius` operationId).
	GetLocationModuRadiusWithResponse(ctx context.Context, params *GetLocationModuRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationModuRadiusResponse, error)

	// GetLocationPortsBoundingBoxWithResponse Get Ports within a bounding box
	//
	// Retrieves Ports within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/ports/bounding-box (the `GetLocationPortsBoundingBox` operationId).
	GetLocationPortsBoundingBoxWithResponse(ctx context.Context, params *GetLocationPortsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationPortsBoundingBoxResponse, error)

	// GetLocationPortsRadiusWithResponse Get Ports within a radius
	//
	// Retrieves Ports within a specified radius of a given point.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/ports/radius (the `GetLocationPortsRadius` operationId).
	GetLocationPortsRadiusWithResponse(ctx context.Context, params *GetLocationPortsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationPortsRadiusResponse, error)

	// GetLocationRadiobeaconsBoundingBoxWithResponse Get Radio Beacons within a bounding box
	//
	// Retrieves Radio Beacons within a specified bounding box. Max span: |dLat| + |dLon| ≤ 4 degrees
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/radiobeacons/bounding-box (the `GetLocationRadiobeaconsBoundingBox` operationId).
	GetLocationRadiobeaconsBoundingBoxWithResponse(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsBoundingBoxResponse, error)

	// GetLocationRadiobeaconsRadiusWithResponse Get Radio Beacons within a radius
	//
	// Retrieves Radio Beacons within a specified radius of a given point.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/radiobeacons/radius (the `GetLocationRadiobeaconsRadius` operationId).
	GetLocationRadiobeaconsRadiusWithResponse(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationRadiobeaconsRadiusResponse, error)

	// GetLocationVesselsBoundingBoxWithResponse Get vessels within a bounding box
	//
	// Retrieves vessels within a specified bounding box and time window. Max bbox span: |dLat| + |dLon| ≤ 4 degrees. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/vessels/bounding-box (the `GetLocationVesselsBoundingBox` operationId).
	GetLocationVesselsBoundingBoxWithResponse(ctx context.Context, params *GetLocationVesselsBoundingBoxParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsBoundingBoxResponse, error)

	// GetLocationVesselsRadiusWithResponse Get vessels within a radius
	//
	// Retrieves vessels within a specified radius of a given point and a given time range. Max radius: 100 km. Max time window (time.to - time.from): 4 hours; for longer ranges issue sequential 4h calls and stitch results client-side using half-open intervals (one slice's time.to = T, next slice's time.from = T + 1ms) to avoid boundary duplicates. A `nextToken` is only valid when reused with the same `time.from`/`time.to`; the API does not reject mismatched bounds and silently returns rows from the wrong slice.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location/vessels/radius (the `GetLocationVesselsRadius` operationId).
	GetLocationVesselsRadiusWithResponse(ctx context.Context, params *GetLocationVesselsRadiusParams, reqEditors ...RequestEditorFn) (*GetLocationVesselsRadiusResponse, error)

	// GetPortUnlocodeWithResponse Get Port by UNLOCODE
	//
	// Retrieves port details by its UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /port/{unlocode} (the `GetPortUnlocode` operationId).
	GetPortUnlocodeWithResponse(ctx context.Context, unlocode string, reqEditors ...RequestEditorFn) (*GetPortUnlocodeResponse, error)

	// GetPortUnlocodeInboundWithResponse Get Inbound Vessels for Port
	//
	// Retrieves vessels heading to a specific port within an ETA window.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /port/{unlocode}/inbound (the `GetPortUnlocodeInbound` operationId).
	GetPortUnlocodeInboundWithResponse(ctx context.Context, unlocode string, params *GetPortUnlocodeInboundParams, reqEditors ...RequestEditorFn) (*GetPortUnlocodeInboundResponse, error)

	// GetPorteventsWithResponse Get Port Events in a time range
	//
	// Get Port Events, such as Arrivals and Departures, in a time range with optional filters
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portevents (the `GetPortevents` operationId).
	GetPorteventsWithResponse(ctx context.Context, params *GetPorteventsParams, reqEditors ...RequestEditorFn) (*GetPorteventsResponse, error)

	// GetPorteventsPortUnlocodeWithResponse Get Port Events by port UNLOCODE
	//
	// Get Port Events, such as Arrivals and Departures by supplying the port UN/LOCODE (e.g., NLRTM for Rotterdam, SGSIN for Singapore)
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portevents/port/{unlocode} (the `GetPorteventsPortUnlocode` operationId).
	GetPorteventsPortUnlocodeWithResponse(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortUnlocodeResponse, error)

	// GetPorteventsPortsWithResponse Get Port Events by port name
	//
	// Get Port Events, such as Arrivals and Departures by supplying the port name
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portevents/ports (the `GetPorteventsPorts` operationId).
	GetPorteventsPortsWithResponse(ctx context.Context, params *GetPorteventsPortsParams, reqEditors ...RequestEditorFn) (*GetPorteventsPortsResponse, error)

	// GetPorteventsVesselIdWithResponse Get Port Events by Vessel ID
	//
	// Get all port events (arrivals and departures) for a vessel identified by MMSI or IMO, with optional filtering by event type and time range
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portevents/vessel/{id} (the `GetPorteventsVesselId` operationId).
	GetPorteventsVesselIdWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdResponse, error)

	// GetPorteventsVesselIdLastWithResponse Get Last Port Event by ID
	//
	// Get the most recent port event (arrival or departure) for a vessel identified by MMSI or IMO.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portevents/vessel/{id}/last (the `GetPorteventsVesselIdLast` operationId).
	GetPorteventsVesselIdLastWithResponse(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselIdLastResponse, error)

	// GetPorteventsVesselsWithResponse Get Port Events by vessel name
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /portevents/vessels (the `GetPorteventsVessels` operationId).
	GetPorteventsVesselsWithResponse(ctx context.Context, params *GetPorteventsVesselsParams, reqEditors ...RequestEditorFn) (*GetPorteventsVesselsResponse, error)

	// GetSearchDgpsWithResponse Search for DGPS Stations
	//
	// Retrieves a list of DGPS stations for the given query parameters.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/dgps (the `GetSearchDgps` operationId).
	GetSearchDgpsWithResponse(ctx context.Context, params *GetSearchDgpsParams, reqEditors ...RequestEditorFn) (*GetSearchDgpsResponse, error)

	// GetSearchLightaidsWithResponse Search for Light Aids to Navigation
	//
	// Retrieves a list of Light Aids to Navigation for the given query parameters.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/lightaids (the `GetSearchLightaids` operationId).
	GetSearchLightaidsWithResponse(ctx context.Context, params *GetSearchLightaidsParams, reqEditors ...RequestEditorFn) (*GetSearchLightaidsResponse, error)

	// GetSearchModusWithResponse Search for MODUs
	//
	// Retrieves a list of MODUs for the given query parameters.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/modus (the `GetSearchModus` operationId).
	GetSearchModusWithResponse(ctx context.Context, params *GetSearchModusParams, reqEditors ...RequestEditorFn) (*GetSearchModusResponse, error)

	// GetSearchPortsWithResponse Search for Ports
	//
	// Retrieves a list of ports matching the given filters. At least one filter parameter is required.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/ports (the `GetSearchPorts` operationId).
	GetSearchPortsWithResponse(ctx context.Context, params *GetSearchPortsParams, reqEditors ...RequestEditorFn) (*GetSearchPortsResponse, error)

	// GetSearchRadiobeaconsWithResponse Search for Radio Beacons
	//
	// Retrieves a list of Radio Beacons for the given query parameters.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/radiobeacons (the `GetSearchRadiobeacons` operationId).
	GetSearchRadiobeaconsWithResponse(ctx context.Context, params *GetSearchRadiobeaconsParams, reqEditors ...RequestEditorFn) (*GetSearchRadiobeaconsResponse, error)

	// GetSearchVesselsWithResponse Search for Vessels
	//
	// Retrieves a list of vessels matching the given filters. At least one filter parameter (or the unified `q` parameter) is required.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /search/vessels (the `GetSearchVessels` operationId).
	GetSearchVesselsWithResponse(ctx context.Context, params *GetSearchVesselsParams, reqEditors ...RequestEditorFn) (*GetSearchVesselsResponse, error)

	// GetVesselIdWithResponse Get vessel information by MMSI or IMO
	//
	// Retrieves static vessel data including name, type, dimensions, and registration information for a vessel identified by its MMSI or IMO number
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /vessel/{id} (the `GetVesselId` operationId).
	GetVesselIdWithResponse(ctx context.Context, id string, params *GetVesselIdParams, reqEditors ...RequestEditorFn) (*GetVesselIdResponse, error)

	// GetVesselIdCasualtiesWithResponse Get marine casualties involving a vessel
	//
	// Retrieves marine casualty records involving the specified vessel.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /vessel/{id}/casualties (the `GetVesselIdCasualties` operationId).
	GetVesselIdCasualtiesWithResponse(ctx context.Context, id string, params *GetVesselIdCasualtiesParams, reqEditors ...RequestEditorFn) (*GetVesselIdCasualtiesResponse, error)

	// GetVesselIdEmissionsWithResponse Get emissions data for a vessel
	//
	// Retrieves emissions reports for the specified vessel including CO2 emissions, fuel consumption, and efficiency metrics
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /vessel/{id}/emissions (the `GetVesselIdEmissions` operationId).
	GetVesselIdEmissionsWithResponse(ctx context.Context, id string, params *GetVesselIdEmissionsParams, reqEditors ...RequestEditorFn) (*GetVesselIdEmissionsResponse, error)

	// GetVesselIdEtaWithResponse Get vessel latest ETA
	//
	// Retrieves the most recent Estimated Time of Arrival (ETA) reported by the vessel.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /vessel/{id}/eta (the `GetVesselIdEta` operationId).
	GetVesselIdEtaWithResponse(ctx context.Context, id string, params *GetVesselIdEtaParams, reqEditors ...RequestEditorFn) (*GetVesselIdEtaResponse, error)

	// GetVesselIdPositionWithResponse Get last known vessel position
	//
	// Retrieves the most recent AIS position report for a vessel, including coordinates, vessel identifiers, and timestamps. Use sat=true to enable satellite AIS fallback when terrestrial data is stale — requires satellite credits.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /vessel/{id}/position (the `GetVesselIdPosition` operationId).
	GetVesselIdPositionWithResponse(ctx context.Context, id string, params *GetVesselIdPositionParams, reqEditors ...RequestEditorFn) (*GetVesselIdPositionResponse, error)

	// GetVesselsPositionsWithResponse Get positions for multiple vessels
	//
	// Retrieves AIS position data for multiple vessels identified by MMSI or IMO numbers within a specified time range (defaults to past 2 hours). Provide multiple IDs either as a comma-separated list in one filter.ids param, or by repeating filter.ids; both forms (and a mix) are accepted.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /vessels/positions (the `GetVesselsPositions` operationId).
	GetVesselsPositionsWithResponse(ctx context.Context, params *GetVesselsPositionsParams, reqEditors ...RequestEditorFn) (*GetVesselsPositionsResponse, error)
}

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

type ContractsPortCountry 

type ContractsPortCountry struct {
	// Code Code ISO 2-letter country code
	//
	// Example: SG
	Code *string `json:"code,omitempty"`

	// Name Name Full country name
	//
	// Example: Singapore
	Name *string `json:"name,omitempty"`
}

ContractsPortCountry Country information for port location

type ContractsVesselFormerName 

type ContractsVesselFormerName struct {
	// Name Name Previous name of the vessel
	//
	// Example: EVER GREEN
	Name *string `json:"name,omitempty"`

	// YearUntil YearUntil Year until which this name was used
	//
	// Example: 2018
	YearUntil *string `json:"year_until,omitempty"`
}

ContractsVesselFormerName Historical vessel name record

type DGPSStation 

type DGPSStation struct {
	// AidType AidType Type of navigational aid
	//
	// Example: DGPS
	AidType *string `json:"aid_type,omitempty"`

	// DeleteFlag DeleteFlag Deletion status flag
	DeleteFlag *string `json:"delete_flag,omitempty"`

	// FeatureNumber FeatureNumber NGA feature number identifier
	//
	// Example: 1234.5
	FeatureNumber *float64 `json:"feature_number,omitempty"`

	// Frequency Frequency Broadcast frequency in kHz
	//
	// Example: 290
	Frequency *float64 `json:"frequency,omitempty"`

	// GeopoliticalHeading GeopoliticalHeading Country or major geographic area
	//
	// Example: UNITED STATES
	GeopoliticalHeading *string `json:"geopolitical_heading,omitempty"`

	// Location Location GeoJSON point for geospatial queries
	Location *GeoJSON `json:"location,omitempty"`

	// Name Name Station name
	//
	// Example: Cape Henry DGPS
	Name *string `json:"name,omitempty"`

	// NoticeNumber NoticeNumber Notice to Mariners number
	//
	// Example: 12
	NoticeNumber *int `json:"notice_number,omitempty"`

	// NoticeWeek NoticeWeek Week of the notice
	//
	// Example: 15
	NoticeWeek *string `json:"notice_week,omitempty"`

	// NoticeYear NoticeYear Year of the notice
	//
	// Example: 2024
	NoticeYear *string `json:"notice_year,omitempty"`

	// Position Position Human-readable position description
	//
	// Example: 36°55.5'N 76°00.3'W
	Position *string `json:"position,omitempty"`

	// PostNote PostNote Notes appearing after the main entry
	PostNote *string `json:"post_note,omitempty"`

	// PrecedingNote PrecedingNote Notes appearing before the main entry
	PrecedingNote *string `json:"preceding_note,omitempty"`

	// Range Range Signal range in nautical miles
	//
	// Example: 100
	Range *int `json:"range,omitempty"`

	// RegionHeading RegionHeading Regional geographic subdivision
	//
	// Example: EAST COAST
	RegionHeading *string `json:"region_heading,omitempty"`

	// Remarks Remarks Additional remarks about the station
	Remarks *string `json:"remarks,omitempty"`

	// RemoveFromList RemoveFromList Flag indicating if entry should be removed
	RemoveFromList *string `json:"remove_from_list,omitempty"`

	// StationId StationID Station identifier code
	//
	// Example: 852
	StationId *string `json:"station_id,omitempty"`

	// TransferRate TransferRate Data transfer rate in bits per second
	//
	// Example: 200
	TransferRate *int `json:"transfer_rate,omitempty"`

	// VolumeNumber VolumeNumber NGA publication volume number
	//
	// Example: PUB 117
	VolumeNumber *string `json:"volume_number,omitempty"`
}

DGPSStation Differential GPS (DGPS) correction signal broadcast station

type DGPSStationsWithinLocationResponse 

type DGPSStationsWithinLocationResponse struct {
	DgpsStations *[]DGPSStation `json:"dgpsStations,omitempty"`
	NextToken    *string        `json:"nextToken,omitempty"`
}

DGPSStationsWithinLocationResponse Response containing DGPS stations within location data

type EmissionsService 

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

EmissionsService wraps emissions API endpoints.

func (*EmissionsService) List 

func (s *EmissionsService) List(ctx context.Context, params *GetEmissionsParams) (*VesselEmissionsResponse, error)

List retrieves vessel emissions data.

func (*EmissionsService) ListAll 

func (s *EmissionsService) ListAll(ctx context.Context, params *GetEmissionsParams) *Iterator[VesselEmission]

ListAll returns an iterator over all emissions across all pages.

type ErrorCode 

type ErrorCode string

ErrorCode defines model for ErrorCode. 

const (
	ErrorCodeBoundingBoxTooDense  ErrorCode = "bounding_box_too_dense"
	ErrorCodeConflict             ErrorCode = "conflict"
	ErrorCodeDatabaseError        ErrorCode = "database_error"
	ErrorCodeEndpointRetired      ErrorCode = "endpoint_retired"
	ErrorCodeFeatureNotAvailable  ErrorCode = "feature_not_available"
	ErrorCodeForbidden            ErrorCode = "forbidden"
	ErrorCodeInsufficientCredits  ErrorCode = "insufficient_credits"
	ErrorCodeInternalError        ErrorCode = "internal_error"
	ErrorCodeInvalidAPIKey        ErrorCode = "invalid_api_key"
	ErrorCodeInvalidCoordinates   ErrorCode = "invalid_coordinates"
	ErrorCodeInvalidIMO           ErrorCode = "invalid_imo"
	ErrorCodeInvalidMMSI          ErrorCode = "invalid_mmsi"
	ErrorCodeInvalidParameter     ErrorCode = "invalid_parameter"
	ErrorCodeInvalidTimeRange     ErrorCode = "invalid_time_range"
	ErrorCodeMissingParameter     ErrorCode = "missing_parameter"
	ErrorCodeNotificationInactive ErrorCode = "notification_inactive"
	ErrorCodePrefillPending       ErrorCode = "prefill_pending"
	ErrorCodeRateLimitExceeded    ErrorCode = "rate_limit_exceeded"
	ErrorCodeResourceMissing      ErrorCode = "resource_missing"
	ErrorCodeServiceUnavailable   ErrorCode = "service_unavailable"
)

Defines values for ErrorCode.

func (ErrorCode) Valid 

func (e ErrorCode) Valid() bool

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

type ErrorType 

type ErrorType string

ErrorType defines model for ErrorType. 

const (
	ErrorTypeAPIError            ErrorType = "api_error"
	ErrorTypeAuthenticationError ErrorType = "authentication_error"
	ErrorTypeConflict            ErrorType = "conflict_error"
	ErrorTypeForbidden           ErrorType = "forbidden_error"
	ErrorTypeGone                ErrorType = "gone_error"
	ErrorTypeInvalidRequest      ErrorType = "invalid_request_error"
	ErrorTypeNotFoundError       ErrorType = "not_found_error"
	ErrorTypePaymentRequired     ErrorType = "payment_required_error"
	ErrorTypeRateLimitError      ErrorType = "rate_limit_error"
	ErrorTypeServiceUnavailable  ErrorType = "service_unavailable_error"
)

Defines values for ErrorType.

func (ErrorType) Valid 

func (e ErrorType) Valid() bool

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

type FindDGPSStationsResponse 

type FindDGPSStationsResponse struct {
	DgpsStations *[]DGPSStation `json:"dgpsStations,omitempty"`
	NextToken    *string        `json:"nextToken,omitempty"`
}

FindDGPSStationsResponse Response containing dgps station data

type FindLightAidsResponse 

type FindLightAidsResponse struct {
	LightAids *[]LightAid `json:"lightAids,omitempty"`
	NextToken *string     `json:"nextToken,omitempty"`
}

FindLightAidsResponse Response containing light aid data

type FindMODUsResponse 

type FindMODUsResponse struct {
	Modus     *[]MODU `json:"modus,omitempty"`
	NextToken *string `json:"nextToken,omitempty"`
}

FindMODUsResponse Query parameters for finding modu by name

type FindPortsResponse 

type FindPortsResponse struct {
	NextToken *string `json:"nextToken,omitempty"`
	Ports     *[]Port `json:"ports,omitempty"`
}

FindPortsResponse Response containing port data

type FindRadioBeaconsResponse 

type FindRadioBeaconsResponse struct {
	NextToken    *string        `json:"nextToken,omitempty"`
	RadioBeacons *[]RadioBeacon `json:"radioBeacons,omitempty"`
}

FindRadioBeaconsResponse Response containing radio beacon data

type FindVesselsResponse 

type FindVesselsResponse struct {
	Meta      *VesselSearchMeta `json:"_meta,omitempty"`
	NextToken *string           `json:"nextToken,omitempty"`
	Vessels   *[]Vessel         `json:"vessels,omitempty"`
}

FindVesselsResponse Query parameters for finding vessels by name

type ForbiddenErrorDetail 

type ForbiddenErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: feature_not_available
	Code *ErrorCode `json:"code,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: this feature is not available on the "free" plan
	Message *string `json:"message,omitempty"`

	// Type Type categorizes the error (always "forbidden_error" for 403s)
	//
	// Example: forbidden_error
	Type *ErrorType `json:"type,omitempty"`
}

ForbiddenErrorDetail defines model for ForbiddenErrorDetail.

type ForbiddenErrorResponse 

type ForbiddenErrorResponse struct {
	Error *ForbiddenErrorDetail `json:"error,omitempty"`
}

ForbiddenErrorResponse defines model for ForbiddenErrorResponse.

type GeoJSON 

type GeoJSON struct {
	// Coordinates Coordinates Array of [longitude, latitude] in decimal degrees
	//
	// Example: [103.8215,1.2644]
	Coordinates *[]float64 `json:"coordinates,omitempty"`

	// Type Type GeoJSON geometry type, always "Point" for location data
	//
	// Example: Point
	Type *string `json:"type,omitempty"`
}

GeoJSON GeoJSON Point geometry for geospatial coordinates

type GetEmissionsParams 

type GetEmissionsParams struct {
	// FilterPeriod Reporting year filter (e.g. 2024)
	FilterPeriod *int `form:"filter.period,omitempty" json:"filter.period,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Pagination token for retrieving the next page of results
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetEmissionsParams defines parameters for GetEmissions.

type GetEmissionsResponse 

type GetEmissionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselEmissionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetEmissionsResponse 

func ParseGetEmissionsResponse(rsp *http.Response) (*GetEmissionsResponse, error)

ParseGetEmissionsResponse parses an HTTP response from a GetEmissionsWithResponse call

func (GetEmissionsResponse) ContentType 

func (r GetEmissionsResponse) ContentType() string

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

func (GetEmissionsResponse) GetBody 

func (r GetEmissionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEmissionsResponse) GetJSON200 

func (r GetEmissionsResponse) GetJSON200() *VesselEmissionsResponse

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

func (GetEmissionsResponse) GetJSON400 

func (r GetEmissionsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetEmissionsResponse) GetJSON401 

func (r GetEmissionsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetEmissionsResponse) GetJSON403 

func (r GetEmissionsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetEmissionsResponse) GetJSON429 

func (r GetEmissionsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetEmissionsResponse) GetJSON500 

func (r GetEmissionsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetEmissionsResponse) Status 

func (r GetEmissionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetEmissionsResponse) StatusCode 

func (r GetEmissionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationDgpsBoundingBoxParams 

type GetLocationDgpsBoundingBoxParams struct {
	// FilterLonLeft Longitude of the left (western) edge of the bounding box
	FilterLonLeft float64 `form:"filter.lonLeft" json:"filter.lonLeft"`

	// FilterLonRight Longitude of the right (eastern) edge of the bounding box
	FilterLonRight float64 `form:"filter.lonRight" json:"filter.lonRight"`

	// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
	FilterLatBottom float64 `form:"filter.latBottom" json:"filter.latBottom"`

	// FilterLatTop Latitude of the top (northern) edge of the bounding box
	FilterLatTop float64 `form:"filter.latTop" json:"filter.latTop"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationDgpsBoundingBoxParams defines parameters for GetLocationDgpsBoundingBox.

type GetLocationDgpsBoundingBoxResponse 

type GetLocationDgpsBoundingBoxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DGPSStationsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationDgpsBoundingBoxResponse 

func ParseGetLocationDgpsBoundingBoxResponse(rsp *http.Response) (*GetLocationDgpsBoundingBoxResponse, error)

ParseGetLocationDgpsBoundingBoxResponse parses an HTTP response from a GetLocationDgpsBoundingBoxWithResponse call

func (GetLocationDgpsBoundingBoxResponse) ContentType 

func (r GetLocationDgpsBoundingBoxResponse) ContentType() string

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

func (GetLocationDgpsBoundingBoxResponse) GetBody 

func (r GetLocationDgpsBoundingBoxResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationDgpsBoundingBoxResponse) GetJSON200 

func (r GetLocationDgpsBoundingBoxResponse) GetJSON200() *DGPSStationsWithinLocationResponse

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

func (GetLocationDgpsBoundingBoxResponse) GetJSON400 

func (r GetLocationDgpsBoundingBoxResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationDgpsBoundingBoxResponse) GetJSON401 

func (r GetLocationDgpsBoundingBoxResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationDgpsBoundingBoxResponse) GetJSON403 

func (r GetLocationDgpsBoundingBoxResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationDgpsBoundingBoxResponse) GetJSON429 

func (r GetLocationDgpsBoundingBoxResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationDgpsBoundingBoxResponse) GetJSON500 

func (r GetLocationDgpsBoundingBoxResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationDgpsBoundingBoxResponse) Status 

func (r GetLocationDgpsBoundingBoxResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationDgpsBoundingBoxResponse) StatusCode 

func (r GetLocationDgpsBoundingBoxResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationDgpsRadiusParams 

type GetLocationDgpsRadiusParams struct {
	// FilterLongitude Longitude of the center point
	FilterLongitude float64 `form:"filter.longitude" json:"filter.longitude"`

	// FilterLatitude Latitude of the center point
	FilterLatitude float64 `form:"filter.latitude" json:"filter.latitude"`

	// FilterRadius Search radius in meters (max 100,000 = 100 km)
	FilterRadius float64 `form:"filter.radius" json:"filter.radius"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationDgpsRadiusParams defines parameters for GetLocationDgpsRadius.

type GetLocationDgpsRadiusResponse 

type GetLocationDgpsRadiusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DGPSStationsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationDgpsRadiusResponse 

func ParseGetLocationDgpsRadiusResponse(rsp *http.Response) (*GetLocationDgpsRadiusResponse, error)

ParseGetLocationDgpsRadiusResponse parses an HTTP response from a GetLocationDgpsRadiusWithResponse call

func (GetLocationDgpsRadiusResponse) ContentType 

func (r GetLocationDgpsRadiusResponse) ContentType() string

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

func (GetLocationDgpsRadiusResponse) GetBody 

func (r GetLocationDgpsRadiusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationDgpsRadiusResponse) GetJSON200 

func (r GetLocationDgpsRadiusResponse) GetJSON200() *DGPSStationsWithinLocationResponse

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

func (GetLocationDgpsRadiusResponse) GetJSON400 

func (r GetLocationDgpsRadiusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationDgpsRadiusResponse) GetJSON401 

func (r GetLocationDgpsRadiusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationDgpsRadiusResponse) GetJSON403 

func (r GetLocationDgpsRadiusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationDgpsRadiusResponse) GetJSON429 

func (r GetLocationDgpsRadiusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationDgpsRadiusResponse) GetJSON500 

func (r GetLocationDgpsRadiusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationDgpsRadiusResponse) Status 

func (r GetLocationDgpsRadiusResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationDgpsRadiusResponse) StatusCode 

func (r GetLocationDgpsRadiusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationLightaidsBoundingBoxParams 

type GetLocationLightaidsBoundingBoxParams struct {
	// FilterLonLeft Longitude of the left (western) edge of the bounding box
	FilterLonLeft float64 `form:"filter.lonLeft" json:"filter.lonLeft"`

	// FilterLonRight Longitude of the right (eastern) edge of the bounding box
	FilterLonRight float64 `form:"filter.lonRight" json:"filter.lonRight"`

	// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
	FilterLatBottom float64 `form:"filter.latBottom" json:"filter.latBottom"`

	// FilterLatTop Latitude of the top (northern) edge of the bounding box
	FilterLatTop float64 `form:"filter.latTop" json:"filter.latTop"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationLightaidsBoundingBoxParams defines parameters for GetLocationLightaidsBoundingBox.

type GetLocationLightaidsBoundingBoxResponse 

type GetLocationLightaidsBoundingBoxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LightAidsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationLightaidsBoundingBoxResponse 

func ParseGetLocationLightaidsBoundingBoxResponse(rsp *http.Response) (*GetLocationLightaidsBoundingBoxResponse, error)

ParseGetLocationLightaidsBoundingBoxResponse parses an HTTP response from a GetLocationLightaidsBoundingBoxWithResponse call

func (GetLocationLightaidsBoundingBoxResponse) ContentType 

func (r GetLocationLightaidsBoundingBoxResponse) ContentType() string

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

func (GetLocationLightaidsBoundingBoxResponse) GetBody 

func (r GetLocationLightaidsBoundingBoxResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationLightaidsBoundingBoxResponse) GetJSON200 

func (r GetLocationLightaidsBoundingBoxResponse) GetJSON200() *LightAidsWithinLocationResponse

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

func (GetLocationLightaidsBoundingBoxResponse) GetJSON400 

func (r GetLocationLightaidsBoundingBoxResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationLightaidsBoundingBoxResponse) GetJSON401 

func (r GetLocationLightaidsBoundingBoxResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationLightaidsBoundingBoxResponse) GetJSON403 

func (r GetLocationLightaidsBoundingBoxResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationLightaidsBoundingBoxResponse) GetJSON429 

func (r GetLocationLightaidsBoundingBoxResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationLightaidsBoundingBoxResponse) GetJSON500 

func (r GetLocationLightaidsBoundingBoxResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationLightaidsBoundingBoxResponse) Status 

func (r GetLocationLightaidsBoundingBoxResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationLightaidsBoundingBoxResponse) StatusCode 

func (r GetLocationLightaidsBoundingBoxResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationLightaidsRadiusParams 

type GetLocationLightaidsRadiusParams struct {
	// FilterLongitude Longitude of the center point
	FilterLongitude float64 `form:"filter.longitude" json:"filter.longitude"`

	// FilterLatitude Latitude of the center point
	FilterLatitude float64 `form:"filter.latitude" json:"filter.latitude"`

	// FilterRadius Search radius in meters (max 100,000 = 100 km)
	FilterRadius float64 `form:"filter.radius" json:"filter.radius"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationLightaidsRadiusParams defines parameters for GetLocationLightaidsRadius.

type GetLocationLightaidsRadiusResponse 

type GetLocationLightaidsRadiusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LightAidsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationLightaidsRadiusResponse 

func ParseGetLocationLightaidsRadiusResponse(rsp *http.Response) (*GetLocationLightaidsRadiusResponse, error)

ParseGetLocationLightaidsRadiusResponse parses an HTTP response from a GetLocationLightaidsRadiusWithResponse call

func (GetLocationLightaidsRadiusResponse) ContentType 

func (r GetLocationLightaidsRadiusResponse) ContentType() string

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

func (GetLocationLightaidsRadiusResponse) GetBody 

func (r GetLocationLightaidsRadiusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationLightaidsRadiusResponse) GetJSON200 

func (r GetLocationLightaidsRadiusResponse) GetJSON200() *LightAidsWithinLocationResponse

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

func (GetLocationLightaidsRadiusResponse) GetJSON400 

func (r GetLocationLightaidsRadiusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationLightaidsRadiusResponse) GetJSON401 

func (r GetLocationLightaidsRadiusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationLightaidsRadiusResponse) GetJSON403 

func (r GetLocationLightaidsRadiusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationLightaidsRadiusResponse) GetJSON429 

func (r GetLocationLightaidsRadiusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationLightaidsRadiusResponse) GetJSON500 

func (r GetLocationLightaidsRadiusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationLightaidsRadiusResponse) Status 

func (r GetLocationLightaidsRadiusResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationLightaidsRadiusResponse) StatusCode 

func (r GetLocationLightaidsRadiusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationModuBoundingBoxParams 

type GetLocationModuBoundingBoxParams struct {
	// FilterLonLeft Longitude of the left (western) edge of the bounding box
	FilterLonLeft float64 `form:"filter.lonLeft" json:"filter.lonLeft"`

	// FilterLonRight Longitude of the right (eastern) edge of the bounding box
	FilterLonRight float64 `form:"filter.lonRight" json:"filter.lonRight"`

	// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
	FilterLatBottom float64 `form:"filter.latBottom" json:"filter.latBottom"`

	// FilterLatTop Latitude of the top (northern) edge of the bounding box
	FilterLatTop float64 `form:"filter.latTop" json:"filter.latTop"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationModuBoundingBoxParams defines parameters for GetLocationModuBoundingBox.

type GetLocationModuBoundingBoxResponse 

type GetLocationModuBoundingBoxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MODUsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationModuBoundingBoxResponse 

func ParseGetLocationModuBoundingBoxResponse(rsp *http.Response) (*GetLocationModuBoundingBoxResponse, error)

ParseGetLocationModuBoundingBoxResponse parses an HTTP response from a GetLocationModuBoundingBoxWithResponse call

func (GetLocationModuBoundingBoxResponse) ContentType 

func (r GetLocationModuBoundingBoxResponse) ContentType() string

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

func (GetLocationModuBoundingBoxResponse) GetBody 

func (r GetLocationModuBoundingBoxResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationModuBoundingBoxResponse) GetJSON200 

func (r GetLocationModuBoundingBoxResponse) GetJSON200() *MODUsWithinLocationResponse

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

func (GetLocationModuBoundingBoxResponse) GetJSON400 

func (r GetLocationModuBoundingBoxResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationModuBoundingBoxResponse) GetJSON401 

func (r GetLocationModuBoundingBoxResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationModuBoundingBoxResponse) GetJSON403 

func (r GetLocationModuBoundingBoxResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationModuBoundingBoxResponse) GetJSON429 

func (r GetLocationModuBoundingBoxResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationModuBoundingBoxResponse) GetJSON500 

func (r GetLocationModuBoundingBoxResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationModuBoundingBoxResponse) Status 

func (r GetLocationModuBoundingBoxResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationModuBoundingBoxResponse) StatusCode 

func (r GetLocationModuBoundingBoxResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationModuRadiusParams 

type GetLocationModuRadiusParams struct {
	// FilterLongitude Longitude of the center point
	FilterLongitude float64 `form:"filter.longitude" json:"filter.longitude"`

	// FilterLatitude Latitude of the center point
	FilterLatitude float64 `form:"filter.latitude" json:"filter.latitude"`

	// FilterRadius Search radius in meters (max 100,000 = 100 km)
	FilterRadius float64 `form:"filter.radius" json:"filter.radius"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationModuRadiusParams defines parameters for GetLocationModuRadius.

type GetLocationModuRadiusResponse 

type GetLocationModuRadiusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MODUsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationModuRadiusResponse 

func ParseGetLocationModuRadiusResponse(rsp *http.Response) (*GetLocationModuRadiusResponse, error)

ParseGetLocationModuRadiusResponse parses an HTTP response from a GetLocationModuRadiusWithResponse call

func (GetLocationModuRadiusResponse) ContentType 

func (r GetLocationModuRadiusResponse) ContentType() string

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

func (GetLocationModuRadiusResponse) GetBody 

func (r GetLocationModuRadiusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationModuRadiusResponse) GetJSON200 

func (r GetLocationModuRadiusResponse) GetJSON200() *MODUsWithinLocationResponse

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

func (GetLocationModuRadiusResponse) GetJSON400 

func (r GetLocationModuRadiusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationModuRadiusResponse) GetJSON401 

func (r GetLocationModuRadiusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationModuRadiusResponse) GetJSON403 

func (r GetLocationModuRadiusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationModuRadiusResponse) GetJSON429 

func (r GetLocationModuRadiusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationModuRadiusResponse) GetJSON500 

func (r GetLocationModuRadiusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationModuRadiusResponse) Status 

func (r GetLocationModuRadiusResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationModuRadiusResponse) StatusCode 

func (r GetLocationModuRadiusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationPortsBoundingBoxParams 

type GetLocationPortsBoundingBoxParams struct {
	// FilterLonLeft Longitude of the left (western) edge of the bounding box
	FilterLonLeft float64 `form:"filter.lonLeft" json:"filter.lonLeft"`

	// FilterLonRight Longitude of the right (eastern) edge of the bounding box
	FilterLonRight float64 `form:"filter.lonRight" json:"filter.lonRight"`

	// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
	FilterLatBottom float64 `form:"filter.latBottom" json:"filter.latBottom"`

	// FilterLatTop Latitude of the top (northern) edge of the bounding box
	FilterLatTop float64 `form:"filter.latTop" json:"filter.latTop"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationPortsBoundingBoxParams defines parameters for GetLocationPortsBoundingBox.

type GetLocationPortsBoundingBoxResponse 

type GetLocationPortsBoundingBoxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationPortsBoundingBoxResponse 

func ParseGetLocationPortsBoundingBoxResponse(rsp *http.Response) (*GetLocationPortsBoundingBoxResponse, error)

ParseGetLocationPortsBoundingBoxResponse parses an HTTP response from a GetLocationPortsBoundingBoxWithResponse call

func (GetLocationPortsBoundingBoxResponse) ContentType 

func (r GetLocationPortsBoundingBoxResponse) ContentType() string

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

func (GetLocationPortsBoundingBoxResponse) GetBody 

func (r GetLocationPortsBoundingBoxResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationPortsBoundingBoxResponse) GetJSON200 

func (r GetLocationPortsBoundingBoxResponse) GetJSON200() *PortsWithinLocationResponse

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

func (GetLocationPortsBoundingBoxResponse) GetJSON400 

func (r GetLocationPortsBoundingBoxResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationPortsBoundingBoxResponse) GetJSON401 

func (r GetLocationPortsBoundingBoxResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationPortsBoundingBoxResponse) GetJSON403 

func (r GetLocationPortsBoundingBoxResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationPortsBoundingBoxResponse) GetJSON429 

func (r GetLocationPortsBoundingBoxResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationPortsBoundingBoxResponse) GetJSON500 

func (r GetLocationPortsBoundingBoxResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationPortsBoundingBoxResponse) Status 

func (r GetLocationPortsBoundingBoxResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationPortsBoundingBoxResponse) StatusCode 

func (r GetLocationPortsBoundingBoxResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationPortsRadiusParams 

type GetLocationPortsRadiusParams struct {
	// FilterLongitude Longitude of the center point
	FilterLongitude float64 `form:"filter.longitude" json:"filter.longitude"`

	// FilterLatitude Latitude of the center point
	FilterLatitude float64 `form:"filter.latitude" json:"filter.latitude"`

	// FilterRadius Search radius in meters (max 100,000 = 100 km)
	FilterRadius float64 `form:"filter.radius" json:"filter.radius"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationPortsRadiusParams defines parameters for GetLocationPortsRadius.

type GetLocationPortsRadiusResponse 

type GetLocationPortsRadiusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationPortsRadiusResponse 

func ParseGetLocationPortsRadiusResponse(rsp *http.Response) (*GetLocationPortsRadiusResponse, error)

ParseGetLocationPortsRadiusResponse parses an HTTP response from a GetLocationPortsRadiusWithResponse call

func (GetLocationPortsRadiusResponse) ContentType 

func (r GetLocationPortsRadiusResponse) ContentType() string

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

func (GetLocationPortsRadiusResponse) GetBody 

func (r GetLocationPortsRadiusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationPortsRadiusResponse) GetJSON200 

func (r GetLocationPortsRadiusResponse) GetJSON200() *PortsWithinLocationResponse

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

func (GetLocationPortsRadiusResponse) GetJSON400 

func (r GetLocationPortsRadiusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationPortsRadiusResponse) GetJSON401 

func (r GetLocationPortsRadiusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationPortsRadiusResponse) GetJSON403 

func (r GetLocationPortsRadiusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationPortsRadiusResponse) GetJSON429 

func (r GetLocationPortsRadiusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationPortsRadiusResponse) GetJSON500 

func (r GetLocationPortsRadiusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationPortsRadiusResponse) Status 

func (r GetLocationPortsRadiusResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationPortsRadiusResponse) StatusCode 

func (r GetLocationPortsRadiusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationRadiobeaconsBoundingBoxParams 

type GetLocationRadiobeaconsBoundingBoxParams struct {
	// FilterLonLeft Longitude of the left (western) edge of the bounding box
	FilterLonLeft float64 `form:"filter.lonLeft" json:"filter.lonLeft"`

	// FilterLonRight Longitude of the right (eastern) edge of the bounding box
	FilterLonRight float64 `form:"filter.lonRight" json:"filter.lonRight"`

	// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
	FilterLatBottom float64 `form:"filter.latBottom" json:"filter.latBottom"`

	// FilterLatTop Latitude of the top (northern) edge of the bounding box
	FilterLatTop float64 `form:"filter.latTop" json:"filter.latTop"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationRadiobeaconsBoundingBoxParams defines parameters for GetLocationRadiobeaconsBoundingBox.

type GetLocationRadiobeaconsBoundingBoxResponse 

type GetLocationRadiobeaconsBoundingBoxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RadioBeaconsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationRadiobeaconsBoundingBoxResponse 

func ParseGetLocationRadiobeaconsBoundingBoxResponse(rsp *http.Response) (*GetLocationRadiobeaconsBoundingBoxResponse, error)

ParseGetLocationRadiobeaconsBoundingBoxResponse parses an HTTP response from a GetLocationRadiobeaconsBoundingBoxWithResponse call

func (GetLocationRadiobeaconsBoundingBoxResponse) ContentType 

func (r GetLocationRadiobeaconsBoundingBoxResponse) ContentType() string

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

func (GetLocationRadiobeaconsBoundingBoxResponse) GetBody 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationRadiobeaconsBoundingBoxResponse) GetJSON200 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetJSON200() *RadioBeaconsWithinLocationResponse

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

func (GetLocationRadiobeaconsBoundingBoxResponse) GetJSON400 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationRadiobeaconsBoundingBoxResponse) GetJSON401 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationRadiobeaconsBoundingBoxResponse) GetJSON403 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationRadiobeaconsBoundingBoxResponse) GetJSON429 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationRadiobeaconsBoundingBoxResponse) GetJSON500 

func (r GetLocationRadiobeaconsBoundingBoxResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationRadiobeaconsBoundingBoxResponse) Status 

func (r GetLocationRadiobeaconsBoundingBoxResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationRadiobeaconsBoundingBoxResponse) StatusCode 

func (r GetLocationRadiobeaconsBoundingBoxResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationRadiobeaconsRadiusParams 

type GetLocationRadiobeaconsRadiusParams struct {
	// FilterLongitude Longitude of the center point
	FilterLongitude float64 `form:"filter.longitude" json:"filter.longitude"`

	// FilterLatitude Latitude of the center point
	FilterLatitude float64 `form:"filter.latitude" json:"filter.latitude"`

	// FilterRadius Search radius in meters (max 100,000 = 100 km)
	FilterRadius float64 `form:"filter.radius" json:"filter.radius"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationRadiobeaconsRadiusParams defines parameters for GetLocationRadiobeaconsRadius.

type GetLocationRadiobeaconsRadiusResponse 

type GetLocationRadiobeaconsRadiusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RadioBeaconsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationRadiobeaconsRadiusResponse 

func ParseGetLocationRadiobeaconsRadiusResponse(rsp *http.Response) (*GetLocationRadiobeaconsRadiusResponse, error)

ParseGetLocationRadiobeaconsRadiusResponse parses an HTTP response from a GetLocationRadiobeaconsRadiusWithResponse call

func (GetLocationRadiobeaconsRadiusResponse) ContentType 

func (r GetLocationRadiobeaconsRadiusResponse) ContentType() string

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

func (GetLocationRadiobeaconsRadiusResponse) GetBody 

func (r GetLocationRadiobeaconsRadiusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationRadiobeaconsRadiusResponse) GetJSON200 

func (r GetLocationRadiobeaconsRadiusResponse) GetJSON200() *RadioBeaconsWithinLocationResponse

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

func (GetLocationRadiobeaconsRadiusResponse) GetJSON400 

func (r GetLocationRadiobeaconsRadiusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationRadiobeaconsRadiusResponse) GetJSON401 

func (r GetLocationRadiobeaconsRadiusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationRadiobeaconsRadiusResponse) GetJSON403 

func (r GetLocationRadiobeaconsRadiusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationRadiobeaconsRadiusResponse) GetJSON429 

func (r GetLocationRadiobeaconsRadiusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationRadiobeaconsRadiusResponse) GetJSON500 

func (r GetLocationRadiobeaconsRadiusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationRadiobeaconsRadiusResponse) Status 

func (r GetLocationRadiobeaconsRadiusResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationRadiobeaconsRadiusResponse) StatusCode 

func (r GetLocationRadiobeaconsRadiusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationVesselsBoundingBoxParams 

type GetLocationVesselsBoundingBoxParams struct {
	// FilterLonLeft Longitude of the left (western) edge of the bounding box
	FilterLonLeft float64 `form:"filter.lonLeft" json:"filter.lonLeft"`

	// FilterLonRight Longitude of the right (eastern) edge of the bounding box
	FilterLonRight float64 `form:"filter.lonRight" json:"filter.lonRight"`

	// FilterLatBottom Latitude of the bottom (southern) edge of the bounding box
	FilterLatBottom float64 `form:"filter.latBottom" json:"filter.latBottom"`

	// FilterLatTop Latitude of the top (northern) edge of the bounding box
	FilterLatTop float64 `form:"filter.latTop" json:"filter.latTop"`

	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago). Max window 4 hours.
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time). Max window 4 hours.
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationVesselsBoundingBoxParams defines parameters for GetLocationVesselsBoundingBox.

type GetLocationVesselsBoundingBoxResponse 

type GetLocationVesselsBoundingBoxResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationVesselsBoundingBoxResponse 

func ParseGetLocationVesselsBoundingBoxResponse(rsp *http.Response) (*GetLocationVesselsBoundingBoxResponse, error)

ParseGetLocationVesselsBoundingBoxResponse parses an HTTP response from a GetLocationVesselsBoundingBoxWithResponse call

func (GetLocationVesselsBoundingBoxResponse) ContentType 

func (r GetLocationVesselsBoundingBoxResponse) ContentType() string

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

func (GetLocationVesselsBoundingBoxResponse) GetBody 

func (r GetLocationVesselsBoundingBoxResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationVesselsBoundingBoxResponse) GetJSON200 

func (r GetLocationVesselsBoundingBoxResponse) GetJSON200() *VesselsWithinLocationResponse

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

func (GetLocationVesselsBoundingBoxResponse) GetJSON400 

func (r GetLocationVesselsBoundingBoxResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationVesselsBoundingBoxResponse) GetJSON401 

func (r GetLocationVesselsBoundingBoxResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationVesselsBoundingBoxResponse) GetJSON403 

func (r GetLocationVesselsBoundingBoxResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationVesselsBoundingBoxResponse) GetJSON429 

func (r GetLocationVesselsBoundingBoxResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationVesselsBoundingBoxResponse) GetJSON500 

func (r GetLocationVesselsBoundingBoxResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationVesselsBoundingBoxResponse) Status 

func (r GetLocationVesselsBoundingBoxResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationVesselsBoundingBoxResponse) StatusCode 

func (r GetLocationVesselsBoundingBoxResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationVesselsRadiusParams 

type GetLocationVesselsRadiusParams struct {
	// FilterLongitude Longitude of the center point
	FilterLongitude float64 `form:"filter.longitude" json:"filter.longitude"`

	// FilterLatitude Latitude of the center point
	FilterLatitude float64 `form:"filter.latitude" json:"filter.latitude"`

	// FilterRadius Search radius in meters (max 100,000 = 100 km)
	FilterRadius float64 `form:"filter.radius" json:"filter.radius"`

	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago). Max window 4 hours.
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time). Max window 4 hours.
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetLocationVesselsRadiusParams defines parameters for GetLocationVesselsRadius.

type GetLocationVesselsRadiusResponse 

type GetLocationVesselsRadiusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselsWithinLocationResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetLocationVesselsRadiusResponse 

func ParseGetLocationVesselsRadiusResponse(rsp *http.Response) (*GetLocationVesselsRadiusResponse, error)

ParseGetLocationVesselsRadiusResponse parses an HTTP response from a GetLocationVesselsRadiusWithResponse call

func (GetLocationVesselsRadiusResponse) ContentType 

func (r GetLocationVesselsRadiusResponse) ContentType() string

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

func (GetLocationVesselsRadiusResponse) GetBody 

func (r GetLocationVesselsRadiusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationVesselsRadiusResponse) GetJSON200 

func (r GetLocationVesselsRadiusResponse) GetJSON200() *VesselsWithinLocationResponse

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

func (GetLocationVesselsRadiusResponse) GetJSON400 

func (r GetLocationVesselsRadiusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetLocationVesselsRadiusResponse) GetJSON401 

func (r GetLocationVesselsRadiusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetLocationVesselsRadiusResponse) GetJSON403 

func (r GetLocationVesselsRadiusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetLocationVesselsRadiusResponse) GetJSON429 

func (r GetLocationVesselsRadiusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetLocationVesselsRadiusResponse) GetJSON500 

func (r GetLocationVesselsRadiusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetLocationVesselsRadiusResponse) Status 

func (r GetLocationVesselsRadiusResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationVesselsRadiusResponse) StatusCode 

func (r GetLocationVesselsRadiusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPortUnlocodeInboundParams 

type GetPortUnlocodeInboundParams struct {
	// FilterEtaFrom Start of ETA arrival window in RFC3339 format (defaults to now)
	FilterEtaFrom *string `form:"filter.etaFrom,omitempty" json:"filter.etaFrom,omitempty"`

	// FilterEtaTo End of ETA arrival window in RFC3339 format (defaults to 72 hours ahead)
	FilterEtaTo *string `form:"filter.etaTo,omitempty" json:"filter.etaTo,omitempty"`

	// TimeFrom Report freshness start (defaults to 24 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo Report freshness end (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetPortUnlocodeInboundParams defines parameters for GetPortUnlocodeInbound.

type GetPortUnlocodeInboundResponse 

type GetPortUnlocodeInboundResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortInboundResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPortUnlocodeInboundResponse 

func ParseGetPortUnlocodeInboundResponse(rsp *http.Response) (*GetPortUnlocodeInboundResponse, error)

ParseGetPortUnlocodeInboundResponse parses an HTTP response from a GetPortUnlocodeInboundWithResponse call

func (GetPortUnlocodeInboundResponse) ContentType 

func (r GetPortUnlocodeInboundResponse) ContentType() string

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

func (GetPortUnlocodeInboundResponse) GetBody 

func (r GetPortUnlocodeInboundResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPortUnlocodeInboundResponse) GetJSON200 

func (r GetPortUnlocodeInboundResponse) GetJSON200() *PortInboundResponse

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

func (GetPortUnlocodeInboundResponse) GetJSON400 

func (r GetPortUnlocodeInboundResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPortUnlocodeInboundResponse) GetJSON401 

func (r GetPortUnlocodeInboundResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPortUnlocodeInboundResponse) GetJSON403 

func (r GetPortUnlocodeInboundResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPortUnlocodeInboundResponse) GetJSON404 

func (r GetPortUnlocodeInboundResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetPortUnlocodeInboundResponse) GetJSON429 

func (r GetPortUnlocodeInboundResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPortUnlocodeInboundResponse) GetJSON500 

func (r GetPortUnlocodeInboundResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPortUnlocodeInboundResponse) Status 

func (r GetPortUnlocodeInboundResponse) Status() string

Status returns HTTPResponse.Status

func (GetPortUnlocodeInboundResponse) StatusCode 

func (r GetPortUnlocodeInboundResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPortUnlocodeResponse 

type GetPortUnlocodeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPortUnlocodeResponse 

func ParseGetPortUnlocodeResponse(rsp *http.Response) (*GetPortUnlocodeResponse, error)

ParseGetPortUnlocodeResponse parses an HTTP response from a GetPortUnlocodeWithResponse call

func (GetPortUnlocodeResponse) ContentType 

func (r GetPortUnlocodeResponse) ContentType() string

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

func (GetPortUnlocodeResponse) GetBody 

func (r GetPortUnlocodeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPortUnlocodeResponse) GetJSON200 

func (r GetPortUnlocodeResponse) GetJSON200() *PortResponse

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

func (GetPortUnlocodeResponse) GetJSON400 

func (r GetPortUnlocodeResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPortUnlocodeResponse) GetJSON401 

func (r GetPortUnlocodeResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPortUnlocodeResponse) GetJSON403 

func (r GetPortUnlocodeResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPortUnlocodeResponse) GetJSON404 

func (r GetPortUnlocodeResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetPortUnlocodeResponse) GetJSON429 

func (r GetPortUnlocodeResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPortUnlocodeResponse) GetJSON500 

func (r GetPortUnlocodeResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPortUnlocodeResponse) Status 

func (r GetPortUnlocodeResponse) Status() string

Status returns HTTPResponse.Status

func (GetPortUnlocodeResponse) StatusCode 

func (r GetPortUnlocodeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPorteventsParams 

type GetPorteventsParams struct {
	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// FilterCountry Filter by port country (case-insensitive)
	FilterCountry *string `form:"filter.country,omitempty" json:"filter.country,omitempty"`

	// FilterUnlocode Filter by port UN/LOCODE
	FilterUnlocode *string `form:"filter.unlocode,omitempty" json:"filter.unlocode,omitempty"`

	// FilterEventType Filter by event type
	FilterEventType *GetPorteventsParamsFilterEventType `form:"filter.eventType,omitempty" json:"filter.eventType,omitempty"`

	// FilterVesselName Filter by vessel name (full-text search)
	FilterVesselName *string `form:"filter.vesselName,omitempty" json:"filter.vesselName,omitempty"`

	// FilterPortName Filter by port name (full-text search)
	FilterPortName *string `form:"filter.portName,omitempty" json:"filter.portName,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetPorteventsParams defines parameters for GetPortevents.

type GetPorteventsParamsFilterEventType 

type GetPorteventsParamsFilterEventType string

GetPorteventsParamsFilterEventType defines parameters for GetPortevents. 

const (
	GetPorteventsParamsFilterEventTypeAll       GetPorteventsParamsFilterEventType = "all"
	GetPorteventsParamsFilterEventTypeArrival   GetPorteventsParamsFilterEventType = "arrival"
	GetPorteventsParamsFilterEventTypeDeparture GetPorteventsParamsFilterEventType = "departure"
)

Defines values for GetPorteventsParamsFilterEventType.

func (GetPorteventsParamsFilterEventType) Valid 

func (e GetPorteventsParamsFilterEventType) Valid() bool

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

type GetPorteventsPortUnlocodeParams 

type GetPorteventsPortUnlocodeParams struct {
	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetPorteventsPortUnlocodeParams defines parameters for GetPorteventsPortUnlocode.

type GetPorteventsPortUnlocodeResponse 

type GetPorteventsPortUnlocodeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortEventsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPorteventsPortUnlocodeResponse 

func ParseGetPorteventsPortUnlocodeResponse(rsp *http.Response) (*GetPorteventsPortUnlocodeResponse, error)

ParseGetPorteventsPortUnlocodeResponse parses an HTTP response from a GetPorteventsPortUnlocodeWithResponse call

func (GetPorteventsPortUnlocodeResponse) ContentType 

func (r GetPorteventsPortUnlocodeResponse) ContentType() string

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

func (GetPorteventsPortUnlocodeResponse) GetBody 

func (r GetPorteventsPortUnlocodeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPorteventsPortUnlocodeResponse) GetJSON200 

func (r GetPorteventsPortUnlocodeResponse) GetJSON200() *PortEventsResponse

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

func (GetPorteventsPortUnlocodeResponse) GetJSON400 

func (r GetPorteventsPortUnlocodeResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPorteventsPortUnlocodeResponse) GetJSON401 

func (r GetPorteventsPortUnlocodeResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPorteventsPortUnlocodeResponse) GetJSON403 

func (r GetPorteventsPortUnlocodeResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPorteventsPortUnlocodeResponse) GetJSON404 

func (r GetPorteventsPortUnlocodeResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetPorteventsPortUnlocodeResponse) GetJSON429 

func (r GetPorteventsPortUnlocodeResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPorteventsPortUnlocodeResponse) GetJSON500 

func (r GetPorteventsPortUnlocodeResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPorteventsPortUnlocodeResponse) Status 

func (r GetPorteventsPortUnlocodeResponse) Status() string

Status returns HTTPResponse.Status

func (GetPorteventsPortUnlocodeResponse) StatusCode 

func (r GetPorteventsPortUnlocodeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPorteventsPortsParams 

type GetPorteventsPortsParams struct {
	// FilterPortName Port name
	FilterPortName string `form:"filter.portName" json:"filter.portName"`

	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetPorteventsPortsParams defines parameters for GetPorteventsPorts.

type GetPorteventsPortsResponse 

type GetPorteventsPortsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortEventsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPorteventsPortsResponse 

func ParseGetPorteventsPortsResponse(rsp *http.Response) (*GetPorteventsPortsResponse, error)

ParseGetPorteventsPortsResponse parses an HTTP response from a GetPorteventsPortsWithResponse call

func (GetPorteventsPortsResponse) ContentType 

func (r GetPorteventsPortsResponse) ContentType() string

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

func (GetPorteventsPortsResponse) GetBody 

func (r GetPorteventsPortsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPorteventsPortsResponse) GetJSON200 

func (r GetPorteventsPortsResponse) GetJSON200() *PortEventsResponse

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

func (GetPorteventsPortsResponse) GetJSON400 

func (r GetPorteventsPortsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPorteventsPortsResponse) GetJSON401 

func (r GetPorteventsPortsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPorteventsPortsResponse) GetJSON403 

func (r GetPorteventsPortsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPorteventsPortsResponse) GetJSON429 

func (r GetPorteventsPortsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPorteventsPortsResponse) GetJSON500 

func (r GetPorteventsPortsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPorteventsPortsResponse) Status 

func (r GetPorteventsPortsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPorteventsPortsResponse) StatusCode 

func (r GetPorteventsPortsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPorteventsResponse 

type GetPorteventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortEventsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPorteventsResponse 

func ParseGetPorteventsResponse(rsp *http.Response) (*GetPorteventsResponse, error)

ParseGetPorteventsResponse parses an HTTP response from a GetPorteventsWithResponse call

func (GetPorteventsResponse) ContentType 

func (r GetPorteventsResponse) ContentType() string

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

func (GetPorteventsResponse) GetBody 

func (r GetPorteventsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPorteventsResponse) GetJSON200 

func (r GetPorteventsResponse) GetJSON200() *PortEventsResponse

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

func (GetPorteventsResponse) GetJSON400 

func (r GetPorteventsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPorteventsResponse) GetJSON401 

func (r GetPorteventsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPorteventsResponse) GetJSON403 

func (r GetPorteventsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPorteventsResponse) GetJSON429 

func (r GetPorteventsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPorteventsResponse) GetJSON500 

func (r GetPorteventsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPorteventsResponse) Status 

func (r GetPorteventsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPorteventsResponse) StatusCode 

func (r GetPorteventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPorteventsVesselIdLastParams 

type GetPorteventsVesselIdLastParams struct {
	// FilterIdType Identifier type (mmsi or imo)
	FilterIdType GetPorteventsVesselIdLastParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}

GetPorteventsVesselIdLastParams defines parameters for GetPorteventsVesselIdLast.

type GetPorteventsVesselIdLastParamsFilterIdType 

type GetPorteventsVesselIdLastParamsFilterIdType string

GetPorteventsVesselIdLastParamsFilterIdType defines parameters for GetPorteventsVesselIdLast. 

const (
	GetPorteventsVesselIdLastParamsFilterIdTypeImo  GetPorteventsVesselIdLastParamsFilterIdType = "imo"
	GetPorteventsVesselIdLastParamsFilterIdTypeMmsi GetPorteventsVesselIdLastParamsFilterIdType = "mmsi"
)

Defines values for GetPorteventsVesselIdLastParamsFilterIdType.

func (GetPorteventsVesselIdLastParamsFilterIdType) Valid 

func (e GetPorteventsVesselIdLastParamsFilterIdType) Valid() bool

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

type GetPorteventsVesselIdLastResponse 

type GetPorteventsVesselIdLastResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortEventResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPorteventsVesselIdLastResponse 

func ParseGetPorteventsVesselIdLastResponse(rsp *http.Response) (*GetPorteventsVesselIdLastResponse, error)

ParseGetPorteventsVesselIdLastResponse parses an HTTP response from a GetPorteventsVesselIdLastWithResponse call

func (GetPorteventsVesselIdLastResponse) ContentType 

func (r GetPorteventsVesselIdLastResponse) ContentType() string

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

func (GetPorteventsVesselIdLastResponse) GetBody 

func (r GetPorteventsVesselIdLastResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPorteventsVesselIdLastResponse) GetJSON200 

func (r GetPorteventsVesselIdLastResponse) GetJSON200() *PortEventResponse

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

func (GetPorteventsVesselIdLastResponse) GetJSON400 

func (r GetPorteventsVesselIdLastResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPorteventsVesselIdLastResponse) GetJSON401 

func (r GetPorteventsVesselIdLastResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPorteventsVesselIdLastResponse) GetJSON403 

func (r GetPorteventsVesselIdLastResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPorteventsVesselIdLastResponse) GetJSON404 

func (r GetPorteventsVesselIdLastResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetPorteventsVesselIdLastResponse) GetJSON429 

func (r GetPorteventsVesselIdLastResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPorteventsVesselIdLastResponse) GetJSON500 

func (r GetPorteventsVesselIdLastResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPorteventsVesselIdLastResponse) Status 

func (r GetPorteventsVesselIdLastResponse) Status() string

Status returns HTTPResponse.Status

func (GetPorteventsVesselIdLastResponse) StatusCode 

func (r GetPorteventsVesselIdLastResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPorteventsVesselIdParams 

type GetPorteventsVesselIdParams struct {
	// FilterIdType Identifier type (mmsi or imo)
	FilterIdType GetPorteventsVesselIdParamsFilterIdType `form:"filter.idType" json:"filter.idType"`

	// FilterEventType Filter by event type
	FilterEventType *GetPorteventsVesselIdParamsFilterEventType `form:"filter.eventType,omitempty" json:"filter.eventType,omitempty"`

	// FilterSortOrder Sort order by timestamp
	FilterSortOrder *GetPorteventsVesselIdParamsFilterSortOrder `form:"filter.sortOrder,omitempty" json:"filter.sortOrder,omitempty"`

	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetPorteventsVesselIdParams defines parameters for GetPorteventsVesselId.

type GetPorteventsVesselIdParamsFilterEventType 

type GetPorteventsVesselIdParamsFilterEventType string

GetPorteventsVesselIdParamsFilterEventType defines parameters for GetPorteventsVesselId. 

const (
	GetPorteventsVesselIdParamsFilterEventTypeAll       GetPorteventsVesselIdParamsFilterEventType = "all"
	GetPorteventsVesselIdParamsFilterEventTypeArrival   GetPorteventsVesselIdParamsFilterEventType = "arrival"
	GetPorteventsVesselIdParamsFilterEventTypeDeparture GetPorteventsVesselIdParamsFilterEventType = "departure"
)

Defines values for GetPorteventsVesselIdParamsFilterEventType.

func (GetPorteventsVesselIdParamsFilterEventType) Valid 

func (e GetPorteventsVesselIdParamsFilterEventType) Valid() bool

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

type GetPorteventsVesselIdParamsFilterIdType 

type GetPorteventsVesselIdParamsFilterIdType string

GetPorteventsVesselIdParamsFilterIdType defines parameters for GetPorteventsVesselId. 

const (
	GetPorteventsVesselIdParamsFilterIdTypeImo  GetPorteventsVesselIdParamsFilterIdType = "imo"
	GetPorteventsVesselIdParamsFilterIdTypeMmsi GetPorteventsVesselIdParamsFilterIdType = "mmsi"
)

Defines values for GetPorteventsVesselIdParamsFilterIdType.

func (GetPorteventsVesselIdParamsFilterIdType) Valid 

func (e GetPorteventsVesselIdParamsFilterIdType) Valid() bool

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

type GetPorteventsVesselIdParamsFilterSortOrder 

type GetPorteventsVesselIdParamsFilterSortOrder string

GetPorteventsVesselIdParamsFilterSortOrder defines parameters for GetPorteventsVesselId. 

const (
	Asc  GetPorteventsVesselIdParamsFilterSortOrder = "asc"
	Desc GetPorteventsVesselIdParamsFilterSortOrder = "desc"
)

Defines values for GetPorteventsVesselIdParamsFilterSortOrder.

func (GetPorteventsVesselIdParamsFilterSortOrder) Valid 

func (e GetPorteventsVesselIdParamsFilterSortOrder) Valid() bool

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

type GetPorteventsVesselIdResponse 

type GetPorteventsVesselIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortEventsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPorteventsVesselIdResponse 

func ParseGetPorteventsVesselIdResponse(rsp *http.Response) (*GetPorteventsVesselIdResponse, error)

ParseGetPorteventsVesselIdResponse parses an HTTP response from a GetPorteventsVesselIdWithResponse call

func (GetPorteventsVesselIdResponse) ContentType 

func (r GetPorteventsVesselIdResponse) ContentType() string

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

func (GetPorteventsVesselIdResponse) GetBody 

func (r GetPorteventsVesselIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPorteventsVesselIdResponse) GetJSON200 

func (r GetPorteventsVesselIdResponse) GetJSON200() *PortEventsResponse

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

func (GetPorteventsVesselIdResponse) GetJSON400 

func (r GetPorteventsVesselIdResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPorteventsVesselIdResponse) GetJSON401 

func (r GetPorteventsVesselIdResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPorteventsVesselIdResponse) GetJSON403 

func (r GetPorteventsVesselIdResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPorteventsVesselIdResponse) GetJSON404 

func (r GetPorteventsVesselIdResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetPorteventsVesselIdResponse) GetJSON429 

func (r GetPorteventsVesselIdResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPorteventsVesselIdResponse) GetJSON500 

func (r GetPorteventsVesselIdResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPorteventsVesselIdResponse) Status 

func (r GetPorteventsVesselIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetPorteventsVesselIdResponse) StatusCode 

func (r GetPorteventsVesselIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetPorteventsVesselsParams 

type GetPorteventsVesselsParams struct {
	// FilterVesselName Vessel name
	FilterVesselName string `form:"filter.vesselName" json:"filter.vesselName"`

	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetPorteventsVesselsParams defines parameters for GetPorteventsVessels.

type GetPorteventsVesselsResponse 

type GetPorteventsVesselsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortEventsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetPorteventsVesselsResponse 

func ParseGetPorteventsVesselsResponse(rsp *http.Response) (*GetPorteventsVesselsResponse, error)

ParseGetPorteventsVesselsResponse parses an HTTP response from a GetPorteventsVesselsWithResponse call

func (GetPorteventsVesselsResponse) ContentType 

func (r GetPorteventsVesselsResponse) ContentType() string

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

func (GetPorteventsVesselsResponse) GetBody 

func (r GetPorteventsVesselsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPorteventsVesselsResponse) GetJSON200 

func (r GetPorteventsVesselsResponse) GetJSON200() *PortEventsResponse

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

func (GetPorteventsVesselsResponse) GetJSON400 

func (r GetPorteventsVesselsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetPorteventsVesselsResponse) GetJSON401 

func (r GetPorteventsVesselsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetPorteventsVesselsResponse) GetJSON403 

func (r GetPorteventsVesselsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetPorteventsVesselsResponse) GetJSON429 

func (r GetPorteventsVesselsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetPorteventsVesselsResponse) GetJSON500 

func (r GetPorteventsVesselsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetPorteventsVesselsResponse) Status 

func (r GetPorteventsVesselsResponse) Status() string

Status returns HTTPResponse.Status

func (GetPorteventsVesselsResponse) StatusCode 

func (r GetPorteventsVesselsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchDgpsParams 

type GetSearchDgpsParams struct {
	// FilterName Name of the DGPS station
	FilterName string `form:"filter.name" json:"filter.name"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetSearchDgpsParams defines parameters for GetSearchDgps.

type GetSearchDgpsResponse 

type GetSearchDgpsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FindDGPSStationsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetSearchDgpsResponse 

func ParseGetSearchDgpsResponse(rsp *http.Response) (*GetSearchDgpsResponse, error)

ParseGetSearchDgpsResponse parses an HTTP response from a GetSearchDgpsWithResponse call

func (GetSearchDgpsResponse) ContentType 

func (r GetSearchDgpsResponse) ContentType() string

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

func (GetSearchDgpsResponse) GetBody 

func (r GetSearchDgpsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSearchDgpsResponse) GetJSON200 

func (r GetSearchDgpsResponse) GetJSON200() *FindDGPSStationsResponse

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

func (GetSearchDgpsResponse) GetJSON400 

func (r GetSearchDgpsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSearchDgpsResponse) GetJSON401 

func (r GetSearchDgpsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetSearchDgpsResponse) GetJSON403 

func (r GetSearchDgpsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetSearchDgpsResponse) GetJSON429 

func (r GetSearchDgpsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetSearchDgpsResponse) GetJSON500 

func (r GetSearchDgpsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSearchDgpsResponse) Status 

func (r GetSearchDgpsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchDgpsResponse) StatusCode 

func (r GetSearchDgpsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchLightaidsParams 

type GetSearchLightaidsParams struct {
	// FilterName Name of the Light Aid
	FilterName string `form:"filter.name" json:"filter.name"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetSearchLightaidsParams defines parameters for GetSearchLightaids.

type GetSearchLightaidsResponse 

type GetSearchLightaidsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FindLightAidsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetSearchLightaidsResponse 

func ParseGetSearchLightaidsResponse(rsp *http.Response) (*GetSearchLightaidsResponse, error)

ParseGetSearchLightaidsResponse parses an HTTP response from a GetSearchLightaidsWithResponse call

func (GetSearchLightaidsResponse) ContentType 

func (r GetSearchLightaidsResponse) ContentType() string

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

func (GetSearchLightaidsResponse) GetBody 

func (r GetSearchLightaidsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSearchLightaidsResponse) GetJSON200 

func (r GetSearchLightaidsResponse) GetJSON200() *FindLightAidsResponse

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

func (GetSearchLightaidsResponse) GetJSON400 

func (r GetSearchLightaidsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSearchLightaidsResponse) GetJSON401 

func (r GetSearchLightaidsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetSearchLightaidsResponse) GetJSON403 

func (r GetSearchLightaidsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetSearchLightaidsResponse) GetJSON429 

func (r GetSearchLightaidsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetSearchLightaidsResponse) GetJSON500 

func (r GetSearchLightaidsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSearchLightaidsResponse) Status 

func (r GetSearchLightaidsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchLightaidsResponse) StatusCode 

func (r GetSearchLightaidsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchModusParams 

type GetSearchModusParams struct {
	// FilterName Name of the MODU
	FilterName string `form:"filter.name" json:"filter.name"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetSearchModusParams defines parameters for GetSearchModus.

type GetSearchModusResponse 

type GetSearchModusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FindMODUsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetSearchModusResponse 

func ParseGetSearchModusResponse(rsp *http.Response) (*GetSearchModusResponse, error)

ParseGetSearchModusResponse parses an HTTP response from a GetSearchModusWithResponse call

func (GetSearchModusResponse) ContentType 

func (r GetSearchModusResponse) ContentType() string

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

func (GetSearchModusResponse) GetBody 

func (r GetSearchModusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSearchModusResponse) GetJSON200 

func (r GetSearchModusResponse) GetJSON200() *FindMODUsResponse

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

func (GetSearchModusResponse) GetJSON400 

func (r GetSearchModusResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSearchModusResponse) GetJSON401 

func (r GetSearchModusResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetSearchModusResponse) GetJSON403 

func (r GetSearchModusResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetSearchModusResponse) GetJSON429 

func (r GetSearchModusResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetSearchModusResponse) GetJSON500 

func (r GetSearchModusResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSearchModusResponse) Status 

func (r GetSearchModusResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchModusResponse) StatusCode 

func (r GetSearchModusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchPortsParams 

type GetSearchPortsParams struct {
	// FilterName Name of the port
	FilterName *string `form:"filter.name,omitempty" json:"filter.name,omitempty"`

	// FilterCountry ISO 2-letter country code(s) or country name(s). Repeat the parameter to match multiple.
	FilterCountry *[]string `form:"filter.country,omitempty" json:"filter.country,omitempty"`

	// FilterType Port type classification(s) (case-insensitive). Repeat the parameter to match multiple. Note: not all ports have a type assigned.
	FilterType *[]GetSearchPortsParamsFilterType `form:"filter.type,omitempty" json:"filter.type,omitempty"`

	// FilterSize Port size classification(s). Repeat the parameter to match multiple.
	FilterSize *[]string `form:"filter.size,omitempty" json:"filter.size,omitempty"`

	// FilterRegion Geographic region name (partial match)
	FilterRegion *string `form:"filter.region,omitempty" json:"filter.region,omitempty"`

	// FilterHarborSize Harbor size classification(s). Repeat the parameter to match multiple.
	FilterHarborSize *[]string `form:"filter.harborSize,omitempty" json:"filter.harborSize,omitempty"`

	// FilterHarborUse Primary harbor use(s). Repeat the parameter to match multiple.
	FilterHarborUse *[]string `form:"filter.harborUse,omitempty" json:"filter.harborUse,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetSearchPortsParams defines parameters for GetSearchPorts.

type GetSearchPortsParamsFilterType 

type GetSearchPortsParamsFilterType string

GetSearchPortsParamsFilterType defines parameters for GetSearchPorts. 

const (
	GetSearchPortsParamsFilterTypePort GetSearchPortsParamsFilterType = "Port"
)

Defines values for GetSearchPortsParamsFilterType.

func (GetSearchPortsParamsFilterType) Valid 

func (e GetSearchPortsParamsFilterType) Valid() bool

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

type GetSearchPortsResponse 

type GetSearchPortsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FindPortsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetSearchPortsResponse 

func ParseGetSearchPortsResponse(rsp *http.Response) (*GetSearchPortsResponse, error)

ParseGetSearchPortsResponse parses an HTTP response from a GetSearchPortsWithResponse call

func (GetSearchPortsResponse) ContentType 

func (r GetSearchPortsResponse) ContentType() string

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

func (GetSearchPortsResponse) GetBody 

func (r GetSearchPortsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSearchPortsResponse) GetJSON200 

func (r GetSearchPortsResponse) GetJSON200() *FindPortsResponse

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

func (GetSearchPortsResponse) GetJSON400 

func (r GetSearchPortsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSearchPortsResponse) GetJSON401 

func (r GetSearchPortsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetSearchPortsResponse) GetJSON403 

func (r GetSearchPortsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetSearchPortsResponse) GetJSON429 

func (r GetSearchPortsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetSearchPortsResponse) GetJSON500 

func (r GetSearchPortsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSearchPortsResponse) Status 

func (r GetSearchPortsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchPortsResponse) StatusCode 

func (r GetSearchPortsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchRadiobeaconsParams 

type GetSearchRadiobeaconsParams struct {
	// FilterName Name of the Radio Beacon
	FilterName string `form:"filter.name" json:"filter.name"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetSearchRadiobeaconsParams defines parameters for GetSearchRadiobeacons.

type GetSearchRadiobeaconsResponse 

type GetSearchRadiobeaconsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FindRadioBeaconsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetSearchRadiobeaconsResponse 

func ParseGetSearchRadiobeaconsResponse(rsp *http.Response) (*GetSearchRadiobeaconsResponse, error)

ParseGetSearchRadiobeaconsResponse parses an HTTP response from a GetSearchRadiobeaconsWithResponse call

func (GetSearchRadiobeaconsResponse) ContentType 

func (r GetSearchRadiobeaconsResponse) ContentType() string

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

func (GetSearchRadiobeaconsResponse) GetBody 

func (r GetSearchRadiobeaconsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSearchRadiobeaconsResponse) GetJSON200 

func (r GetSearchRadiobeaconsResponse) GetJSON200() *FindRadioBeaconsResponse

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

func (GetSearchRadiobeaconsResponse) GetJSON400 

func (r GetSearchRadiobeaconsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSearchRadiobeaconsResponse) GetJSON401 

func (r GetSearchRadiobeaconsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetSearchRadiobeaconsResponse) GetJSON403 

func (r GetSearchRadiobeaconsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetSearchRadiobeaconsResponse) GetJSON429 

func (r GetSearchRadiobeaconsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetSearchRadiobeaconsResponse) GetJSON500 

func (r GetSearchRadiobeaconsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSearchRadiobeaconsResponse) Status 

func (r GetSearchRadiobeaconsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchRadiobeaconsResponse) StatusCode 

func (r GetSearchRadiobeaconsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSearchVesselsParams 

type GetSearchVesselsParams struct {
	// Q Unified search across IMO, MMSI, ENI, callsign, and vessel name. Matches a vessel if any of those identifiers matches, so one value can return more than one vessel; the _meta.matchedOn field on the response names the fields that matched. An ENI matches with or without its leading zeros. Name and callsign also accept SQL LIKE wildcards (% and _). Can be combined with filter.* parameters.
	Q *string `form:"q,omitempty" json:"q,omitempty"`

	// FilterName Name of the vessel
	FilterName *string `form:"filter.name,omitempty" json:"filter.name,omitempty"`

	// FilterCallsign Radio callsign of the vessel
	FilterCallsign *string `form:"filter.callsign,omitempty" json:"filter.callsign,omitempty"`

	// FilterFlag ISO 2-letter country code(s) of the flag state. Repeat the parameter to match multiple.
	FilterFlag *[]string `form:"filter.flag,omitempty" json:"filter.flag,omitempty"`

	// FilterVesselType Vessel type classification(s) (case-insensitive). Repeat the parameter to match multiple.
	FilterVesselType *[]string `form:"filter.vesselType,omitempty" json:"filter.vesselType,omitempty"`

	// FilterMmsi MMSI number
	FilterMmsi *int `form:"filter.mmsi,omitempty" json:"filter.mmsi,omitempty"`

	// FilterImo IMO number
	FilterImo *int `form:"filter.imo,omitempty" json:"filter.imo,omitempty"`

	// FilterYearBuiltMin Minimum year built
	FilterYearBuiltMin *int `form:"filter.yearBuiltMin,omitempty" json:"filter.yearBuiltMin,omitempty"`

	// FilterYearBuiltMax Maximum year built
	FilterYearBuiltMax *int `form:"filter.yearBuiltMax,omitempty" json:"filter.yearBuiltMax,omitempty"`

	// FilterEni European Number of Identification, the inland waterway equivalent of an IMO. Leading zeros optional: 4606770 and 04606770 both match.
	FilterEni *string `form:"filter.eni,omitempty" json:"filter.eni,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Token for next page
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetSearchVesselsParams defines parameters for GetSearchVessels.

type GetSearchVesselsResponse 

type GetSearchVesselsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FindVesselsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetSearchVesselsResponse 

func ParseGetSearchVesselsResponse(rsp *http.Response) (*GetSearchVesselsResponse, error)

ParseGetSearchVesselsResponse parses an HTTP response from a GetSearchVesselsWithResponse call

func (GetSearchVesselsResponse) ContentType 

func (r GetSearchVesselsResponse) ContentType() string

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

func (GetSearchVesselsResponse) GetBody 

func (r GetSearchVesselsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSearchVesselsResponse) GetJSON200 

func (r GetSearchVesselsResponse) GetJSON200() *FindVesselsResponse

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

func (GetSearchVesselsResponse) GetJSON400 

func (r GetSearchVesselsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSearchVesselsResponse) GetJSON401 

func (r GetSearchVesselsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetSearchVesselsResponse) GetJSON403 

func (r GetSearchVesselsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetSearchVesselsResponse) GetJSON429 

func (r GetSearchVesselsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetSearchVesselsResponse) GetJSON500 

func (r GetSearchVesselsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSearchVesselsResponse) Status 

func (r GetSearchVesselsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSearchVesselsResponse) StatusCode 

func (r GetSearchVesselsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVesselIdCasualtiesParams 

type GetVesselIdCasualtiesParams struct {
	// FilterIdType Identifier type: 'mmsi' or 'imo'
	FilterIdType GetVesselIdCasualtiesParamsFilterIdType `form:"filter.idType" json:"filter.idType"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Pagination token for retrieving the next page of results
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetVesselIdCasualtiesParams defines parameters for GetVesselIdCasualties.

type GetVesselIdCasualtiesParamsFilterIdType 

type GetVesselIdCasualtiesParamsFilterIdType string

GetVesselIdCasualtiesParamsFilterIdType defines parameters for GetVesselIdCasualties. 

const (
	GetVesselIdCasualtiesParamsFilterIdTypeImo  GetVesselIdCasualtiesParamsFilterIdType = "imo"
	GetVesselIdCasualtiesParamsFilterIdTypeMmsi GetVesselIdCasualtiesParamsFilterIdType = "mmsi"
)

Defines values for GetVesselIdCasualtiesParamsFilterIdType.

func (GetVesselIdCasualtiesParamsFilterIdType) Valid 

func (e GetVesselIdCasualtiesParamsFilterIdType) Valid() bool

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

type GetVesselIdCasualtiesResponse 

type GetVesselIdCasualtiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MarineCasualtiesResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetVesselIdCasualtiesResponse 

func ParseGetVesselIdCasualtiesResponse(rsp *http.Response) (*GetVesselIdCasualtiesResponse, error)

ParseGetVesselIdCasualtiesResponse parses an HTTP response from a GetVesselIdCasualtiesWithResponse call

func (GetVesselIdCasualtiesResponse) ContentType 

func (r GetVesselIdCasualtiesResponse) ContentType() string

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

func (GetVesselIdCasualtiesResponse) GetBody 

func (r GetVesselIdCasualtiesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVesselIdCasualtiesResponse) GetJSON200 

func (r GetVesselIdCasualtiesResponse) GetJSON200() *MarineCasualtiesResponse

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

func (GetVesselIdCasualtiesResponse) GetJSON400 

func (r GetVesselIdCasualtiesResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetVesselIdCasualtiesResponse) GetJSON401 

func (r GetVesselIdCasualtiesResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetVesselIdCasualtiesResponse) GetJSON403 

func (r GetVesselIdCasualtiesResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetVesselIdCasualtiesResponse) GetJSON404 

func (r GetVesselIdCasualtiesResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetVesselIdCasualtiesResponse) GetJSON429 

func (r GetVesselIdCasualtiesResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetVesselIdCasualtiesResponse) GetJSON500 

func (r GetVesselIdCasualtiesResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetVesselIdCasualtiesResponse) Status 

func (r GetVesselIdCasualtiesResponse) Status() string

Status returns HTTPResponse.Status

func (GetVesselIdCasualtiesResponse) StatusCode 

func (r GetVesselIdCasualtiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVesselIdEmissionsParams 

type GetVesselIdEmissionsParams struct {
	// FilterIdType Identifier type: 'mmsi' or 'imo'
	FilterIdType GetVesselIdEmissionsParamsFilterIdType `form:"filter.idType" json:"filter.idType"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Pagination token for retrieving the next page of results
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetVesselIdEmissionsParams defines parameters for GetVesselIdEmissions.

type GetVesselIdEmissionsParamsFilterIdType 

type GetVesselIdEmissionsParamsFilterIdType string

GetVesselIdEmissionsParamsFilterIdType defines parameters for GetVesselIdEmissions. 

const (
	GetVesselIdEmissionsParamsFilterIdTypeImo  GetVesselIdEmissionsParamsFilterIdType = "imo"
	GetVesselIdEmissionsParamsFilterIdTypeMmsi GetVesselIdEmissionsParamsFilterIdType = "mmsi"
)

Defines values for GetVesselIdEmissionsParamsFilterIdType.

func (GetVesselIdEmissionsParamsFilterIdType) Valid 

func (e GetVesselIdEmissionsParamsFilterIdType) Valid() bool

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

type GetVesselIdEmissionsResponse 

type GetVesselIdEmissionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselEmissionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetVesselIdEmissionsResponse 

func ParseGetVesselIdEmissionsResponse(rsp *http.Response) (*GetVesselIdEmissionsResponse, error)

ParseGetVesselIdEmissionsResponse parses an HTTP response from a GetVesselIdEmissionsWithResponse call

func (GetVesselIdEmissionsResponse) ContentType 

func (r GetVesselIdEmissionsResponse) ContentType() string

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

func (GetVesselIdEmissionsResponse) GetBody 

func (r GetVesselIdEmissionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVesselIdEmissionsResponse) GetJSON200 

func (r GetVesselIdEmissionsResponse) GetJSON200() *VesselEmissionsResponse

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

func (GetVesselIdEmissionsResponse) GetJSON400 

func (r GetVesselIdEmissionsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetVesselIdEmissionsResponse) GetJSON401 

func (r GetVesselIdEmissionsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetVesselIdEmissionsResponse) GetJSON403 

func (r GetVesselIdEmissionsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetVesselIdEmissionsResponse) GetJSON404 

func (r GetVesselIdEmissionsResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetVesselIdEmissionsResponse) GetJSON429 

func (r GetVesselIdEmissionsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetVesselIdEmissionsResponse) GetJSON500 

func (r GetVesselIdEmissionsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetVesselIdEmissionsResponse) Status 

func (r GetVesselIdEmissionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetVesselIdEmissionsResponse) StatusCode 

func (r GetVesselIdEmissionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVesselIdEtaParams 

type GetVesselIdEtaParams struct {
	// FilterIdType Identifier type: 'mmsi' or 'imo'
	FilterIdType GetVesselIdEtaParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}

GetVesselIdEtaParams defines parameters for GetVesselIdEta.

type GetVesselIdEtaParamsFilterIdType 

type GetVesselIdEtaParamsFilterIdType string

GetVesselIdEtaParamsFilterIdType defines parameters for GetVesselIdEta. 

const (
	GetVesselIdEtaParamsFilterIdTypeImo  GetVesselIdEtaParamsFilterIdType = "imo"
	GetVesselIdEtaParamsFilterIdTypeMmsi GetVesselIdEtaParamsFilterIdType = "mmsi"
)

Defines values for GetVesselIdEtaParamsFilterIdType.

func (GetVesselIdEtaParamsFilterIdType) Valid 

func (e GetVesselIdEtaParamsFilterIdType) Valid() bool

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

type GetVesselIdEtaResponse 

type GetVesselIdEtaResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselETAResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetVesselIdEtaResponse 

func ParseGetVesselIdEtaResponse(rsp *http.Response) (*GetVesselIdEtaResponse, error)

ParseGetVesselIdEtaResponse parses an HTTP response from a GetVesselIdEtaWithResponse call

func (GetVesselIdEtaResponse) ContentType 

func (r GetVesselIdEtaResponse) ContentType() string

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

func (GetVesselIdEtaResponse) GetBody 

func (r GetVesselIdEtaResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVesselIdEtaResponse) GetJSON200 

func (r GetVesselIdEtaResponse) GetJSON200() *VesselETAResponse

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

func (GetVesselIdEtaResponse) GetJSON400 

func (r GetVesselIdEtaResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetVesselIdEtaResponse) GetJSON401 

func (r GetVesselIdEtaResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetVesselIdEtaResponse) GetJSON403 

func (r GetVesselIdEtaResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetVesselIdEtaResponse) GetJSON404 

func (r GetVesselIdEtaResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetVesselIdEtaResponse) GetJSON429 

func (r GetVesselIdEtaResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetVesselIdEtaResponse) GetJSON500 

func (r GetVesselIdEtaResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetVesselIdEtaResponse) Status 

func (r GetVesselIdEtaResponse) Status() string

Status returns HTTPResponse.Status

func (GetVesselIdEtaResponse) StatusCode 

func (r GetVesselIdEtaResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVesselIdParams 

type GetVesselIdParams struct {
	// FilterIdType Identifier type: 'mmsi' or 'imo'
	FilterIdType GetVesselIdParamsFilterIdType `form:"filter.idType" json:"filter.idType"`
}

GetVesselIdParams defines parameters for GetVesselId.

type GetVesselIdParamsFilterIdType 

type GetVesselIdParamsFilterIdType string

GetVesselIdParamsFilterIdType defines parameters for GetVesselId. 

const (
	GetVesselIdParamsFilterIdTypeImo  GetVesselIdParamsFilterIdType = "imo"
	GetVesselIdParamsFilterIdTypeMmsi GetVesselIdParamsFilterIdType = "mmsi"
)

Defines values for GetVesselIdParamsFilterIdType.

func (GetVesselIdParamsFilterIdType) Valid 

func (e GetVesselIdParamsFilterIdType) Valid() bool

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

type GetVesselIdPositionParams 

type GetVesselIdPositionParams struct {
	// FilterIdType Identifier type: 'mmsi' or 'imo'
	FilterIdType GetVesselIdPositionParamsFilterIdType `form:"filter.idType" json:"filter.idType"`

	// FilterSat Enable satellite AIS fallback (default: false)
	FilterSat *bool `form:"filter.sat,omitempty" json:"filter.sat,omitempty"`
}

GetVesselIdPositionParams defines parameters for GetVesselIdPosition.

type GetVesselIdPositionParamsFilterIdType 

type GetVesselIdPositionParamsFilterIdType string

GetVesselIdPositionParamsFilterIdType defines parameters for GetVesselIdPosition. 

const (
	GetVesselIdPositionParamsFilterIdTypeImo  GetVesselIdPositionParamsFilterIdType = "imo"
	GetVesselIdPositionParamsFilterIdTypeMmsi GetVesselIdPositionParamsFilterIdType = "mmsi"
)

Defines values for GetVesselIdPositionParamsFilterIdType.

func (GetVesselIdPositionParamsFilterIdType) Valid 

func (e GetVesselIdPositionParamsFilterIdType) Valid() bool

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

type GetVesselIdPositionResponse 

type GetVesselIdPositionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselPositionResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON402 the response for an HTTP 402 `application/json` response
	JSON402 *PaymentRequiredErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetVesselIdPositionResponse200Headers
}

func ParseGetVesselIdPositionResponse 

func ParseGetVesselIdPositionResponse(rsp *http.Response) (*GetVesselIdPositionResponse, error)

ParseGetVesselIdPositionResponse parses an HTTP response from a GetVesselIdPositionWithResponse call

func (GetVesselIdPositionResponse) ContentType 

func (r GetVesselIdPositionResponse) ContentType() string

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

func (GetVesselIdPositionResponse) GetBody 

func (r GetVesselIdPositionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVesselIdPositionResponse) GetJSON200 

func (r GetVesselIdPositionResponse) GetJSON200() *VesselPositionResponse

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

func (GetVesselIdPositionResponse) GetJSON400 

func (r GetVesselIdPositionResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetVesselIdPositionResponse) GetJSON401 

func (r GetVesselIdPositionResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetVesselIdPositionResponse) GetJSON402 

func (r GetVesselIdPositionResponse) GetJSON402() *PaymentRequiredErrorResponse

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

func (GetVesselIdPositionResponse) GetJSON403 

func (r GetVesselIdPositionResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetVesselIdPositionResponse) GetJSON404 

func (r GetVesselIdPositionResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetVesselIdPositionResponse) GetJSON429 

func (r GetVesselIdPositionResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetVesselIdPositionResponse) GetJSON500 

func (r GetVesselIdPositionResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetVesselIdPositionResponse) Status 

func (r GetVesselIdPositionResponse) Status() string

Status returns HTTPResponse.Status

func (GetVesselIdPositionResponse) StatusCode 

func (r GetVesselIdPositionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVesselIdPositionResponse200Headers 

type GetVesselIdPositionResponse200Headers struct {
	XDataSource                *string
	XSatelliteCreditCharged    *string
	XSatelliteCreditsRemaining *string
	XSatelliteStatus           *string
}

GetVesselIdPositionResponse200Headers the declared response headers of an HTTP 200 response for GetVesselIdPosition

type GetVesselIdResponse 

type GetVesselIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *NotFoundErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetVesselIdResponse 

func ParseGetVesselIdResponse(rsp *http.Response) (*GetVesselIdResponse, error)

ParseGetVesselIdResponse parses an HTTP response from a GetVesselIdWithResponse call

func (GetVesselIdResponse) ContentType 

func (r GetVesselIdResponse) ContentType() string

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

func (GetVesselIdResponse) GetBody 

func (r GetVesselIdResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVesselIdResponse) GetJSON200 

func (r GetVesselIdResponse) GetJSON200() *VesselResponse

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

func (GetVesselIdResponse) GetJSON400 

func (r GetVesselIdResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetVesselIdResponse) GetJSON401 

func (r GetVesselIdResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetVesselIdResponse) GetJSON403 

func (r GetVesselIdResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetVesselIdResponse) GetJSON404 

func (r GetVesselIdResponse) GetJSON404() *NotFoundErrorResponse

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

func (GetVesselIdResponse) GetJSON429 

func (r GetVesselIdResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetVesselIdResponse) GetJSON500 

func (r GetVesselIdResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetVesselIdResponse) Status 

func (r GetVesselIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetVesselIdResponse) StatusCode 

func (r GetVesselIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetVesselsPositionsParams 

type GetVesselsPositionsParams struct {
	// FilterIds MMSI or IMO number(s): comma-separated in one param, or repeat filter.ids for multiple
	FilterIds string `form:"filter.ids" json:"filter.ids"`

	// FilterIdType Identifier type: 'mmsi' or 'imo'
	FilterIdType GetVesselsPositionsParamsFilterIdType `form:"filter.idType" json:"filter.idType"`

	// TimeFrom Start timestamp in RFC3339 format (defaults to 2 hours ago)
	TimeFrom *string `form:"time.from,omitempty" json:"time.from,omitempty"`

	// TimeTo End timestamp in RFC3339 format (defaults to current time)
	TimeTo *string `form:"time.to,omitempty" json:"time.to,omitempty"`

	// PaginationLimit Maximum number of items to return, must be between 1 and 50
	PaginationLimit *int `form:"pagination.limit,omitempty" json:"pagination.limit,omitempty"`

	// PaginationNextToken Pagination token for retrieving the next page of results
	PaginationNextToken *string `form:"pagination.nextToken,omitempty" json:"pagination.nextToken,omitempty"`
}

GetVesselsPositionsParams defines parameters for GetVesselsPositions.

type GetVesselsPositionsParamsFilterIdType 

type GetVesselsPositionsParamsFilterIdType string

GetVesselsPositionsParamsFilterIdType defines parameters for GetVesselsPositions. 

const (
	GetVesselsPositionsParamsFilterIdTypeImo  GetVesselsPositionsParamsFilterIdType = "imo"
	GetVesselsPositionsParamsFilterIdTypeMmsi GetVesselsPositionsParamsFilterIdType = "mmsi"
)

Defines values for GetVesselsPositionsParamsFilterIdType.

func (GetVesselsPositionsParamsFilterIdType) Valid 

func (e GetVesselsPositionsParamsFilterIdType) Valid() bool

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

type GetVesselsPositionsResponse 

type GetVesselsPositionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *VesselPositionsResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *BadRequestErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthenticationErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ForbiddenErrorResponse
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimitErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *InternalServerErrorResponse
}

func ParseGetVesselsPositionsResponse 

func ParseGetVesselsPositionsResponse(rsp *http.Response) (*GetVesselsPositionsResponse, error)

ParseGetVesselsPositionsResponse parses an HTTP response from a GetVesselsPositionsWithResponse call

func (GetVesselsPositionsResponse) ContentType 

func (r GetVesselsPositionsResponse) ContentType() string

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

func (GetVesselsPositionsResponse) GetBody 

func (r GetVesselsPositionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetVesselsPositionsResponse) GetJSON200 

func (r GetVesselsPositionsResponse) GetJSON200() *VesselPositionsResponse

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

func (GetVesselsPositionsResponse) GetJSON400 

func (r GetVesselsPositionsResponse) GetJSON400() *BadRequestErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetVesselsPositionsResponse) GetJSON401 

func (r GetVesselsPositionsResponse) GetJSON401() *AuthenticationErrorResponse

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

func (GetVesselsPositionsResponse) GetJSON403 

func (r GetVesselsPositionsResponse) GetJSON403() *ForbiddenErrorResponse

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

func (GetVesselsPositionsResponse) GetJSON429 

func (r GetVesselsPositionsResponse) GetJSON429() *RateLimitErrorResponse

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

func (GetVesselsPositionsResponse) GetJSON500 

func (r GetVesselsPositionsResponse) GetJSON500() *InternalServerErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetVesselsPositionsResponse) Status 

func (r GetVesselsPositionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetVesselsPositionsResponse) StatusCode 

func (r GetVesselsPositionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InternalServerErrorDetail 

type InternalServerErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: internal_error
	Code *ErrorCode `json:"code,omitempty"`

	// ErrorId ErrorID is a unique identifier for tracking this error (always present for 500 errors)
	//
	// Example: 550e8400-e29b-41d4-a716-446655440000
	ErrorId *string `json:"error_id,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: An internal error occurred. Please reference error ID 550e8400-e29b-41d4-a716-446655440000 when contacting support if this issue persists.
	Message *string `json:"message,omitempty"`

	// Timestamp Timestamp when the error occurred (ISO 8601 format)
	//
	// Example: 2025-10-31T15:30:45Z
	Timestamp *string `json:"timestamp,omitempty"`

	// Type Type categorizes the error (always "api_error" for 500s)
	//
	// Example: api_error
	Type *ErrorType `json:"type,omitempty"`
}

InternalServerErrorDetail defines model for InternalServerErrorDetail.

type InternalServerErrorResponse 

type InternalServerErrorResponse struct {
	Error *InternalServerErrorDetail `json:"error,omitempty"`
}

InternalServerErrorResponse defines model for InternalServerErrorResponse.

type Iterator 

type Iterator[T any] struct {
	// contains filtered or unexported fields
}

Iterator provides lazy, sequential access to paginated API results. Use Next to advance, Value to read the current item, and Err to check for errors. Collect returns all remaining items.

An Iterator is not safe for concurrent use. Drive it from one goroutine, or guard it yourself.

func (*Iterator[T]) Collect 

func (it *Iterator[T]) Collect() ([]T, error)

Collect consumes the iterator and returns all remaining items.

On failure it returns the items gathered before the error alongside it. Those pages have already been fetched and paid for, and the iterator cannot be rewound, so discarding them would lose them for good. Check the error before treating the result as complete.

func (*Iterator[T]) Err 

func (it *Iterator[T]) Err() error

Err returns the first error encountered during iteration.

func (*Iterator[T]) Next 

func (it *Iterator[T]) Next() bool

Next advances the iterator to the next item. It returns true if there is another item available, or false when iteration is complete or an error has occurred.

func (*Iterator[T]) Value 

func (it *Iterator[T]) Value() T

Value returns the current item. Returns the zero value of T if called before Next() or after iteration is exhausted.

type LightAid 

type LightAid struct {
	// AidType AidType Type of navigational aid (Light, Buoy, Beacon, etc.)
	//
	// Example: Light
	AidType *string `json:"aid_type,omitempty"`

	// Characteristic Characteristic Light flash pattern description (e.g., Fl W 7.5s)
	//
	// Example: Fl W 7.5s
	Characteristic *string `json:"characteristic,omitempty"`

	// CharacteristicNumber CharacteristicNumber Light characteristic code number
	CharacteristicNumber *int `json:"characteristic_number,omitempty"`

	// DeleteFlag DeleteFlag Deletion status flag
	DeleteFlag *string `json:"delete_flag,omitempty"`

	// FeatureNumber FeatureNumber NGA feature number identifier
	//
	// Example: 590
	FeatureNumber *string `json:"feature_number,omitempty"`

	// GeopoliticalHeading GeopoliticalHeading Country or major geographic area
	//
	// Example: UNITED STATES
	GeopoliticalHeading *string `json:"geopolitical_heading,omitempty"`

	// HeightFeetMeters HeightFeetMeters Height of light above water in feet and meters
	//
	// Example: 192ft 59m
	HeightFeetMeters *string `json:"height_feet_meters,omitempty"`

	// LocalHeading LocalHeading Local area description
	//
	// Example: Cape Hatteras
	LocalHeading *string `json:"local_heading,omitempty"`

	// Location Location GeoJSON point for geospatial queries
	Location *GeoJSON `json:"location,omitempty"`

	// Name Name Name of the light aid
	//
	// Example: Cape Hatteras Light
	Name *string `json:"name,omitempty"`

	// NoticeNumber NoticeNumber Notice to Mariners number
	NoticeNumber *int `json:"notice_number,omitempty"`

	// NoticeWeek NoticeWeek Week of the notice
	NoticeWeek *string `json:"notice_week,omitempty"`

	// NoticeYear NoticeYear Year of the notice
	NoticeYear *string `json:"notice_year,omitempty"`

	// Position Position Human-readable position description
	//
	// Example: 35°15.1'N 75°31.6'W
	Position *string `json:"position,omitempty"`

	// PostNote PostNote Notes appearing after the main entry
	PostNote *string `json:"post_note,omitempty"`

	// PrecedingNote PrecedingNote Notes appearing before the main entry
	PrecedingNote *string `json:"preceding_note,omitempty"`

	// Range Range Nominal range of light in nautical miles
	//
	// Example: 24
	Range *string `json:"range,omitempty"`

	// RegionHeading RegionHeading Regional geographic subdivision
	//
	// Example: EAST COAST
	RegionHeading *string `json:"region_heading,omitempty"`

	// Remarks Remarks Additional remarks about the light
	Remarks *string `json:"remarks,omitempty"`

	// RemoveFromList RemoveFromList Flag indicating if entry should be removed
	RemoveFromList *string `json:"remove_from_list,omitempty"`

	// Structure Structure Description of the physical structure
	//
	// Example: Black and white spiral bands
	Structure *string `json:"structure,omitempty"`

	// SubregionHeading SubregionHeading Sub-regional geographic area
	//
	// Example: North Carolina
	SubregionHeading *string `json:"subregion_heading,omitempty"`

	// VolumeNumber VolumeNumber NGA publication volume number
	//
	// Example: PUB 110
	VolumeNumber *string `json:"volume_number,omitempty"`
}

LightAid Navigational light aid including lighthouses, buoys, and beacons

type LightAidsWithinLocationResponse 

type LightAidsWithinLocationResponse struct {
	LightAids *[]LightAid `json:"lightAids,omitempty"`
	NextToken *string     `json:"nextToken,omitempty"`
}

LightAidsWithinLocationResponse Response containing light aids within location data

type LocationService 

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

LocationService wraps location-based API endpoints.

func (*LocationService) AllDGPSBoundingBox 

func (s *LocationService) AllDGPSBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams) *Iterator[DGPSStation]

AllDGPSBoundingBox returns an iterator over all DGPS stations in a bounding box.

func (*LocationService) AllDGPSRadius 

func (s *LocationService) AllDGPSRadius(ctx context.Context, params *GetLocationDgpsRadiusParams) *Iterator[DGPSStation]

AllDGPSRadius returns an iterator over all DGPS stations within a radius.

func (*LocationService) AllLightAidsBoundingBox 

func (s *LocationService) AllLightAidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams) *Iterator[LightAid]

AllLightAidsBoundingBox returns an iterator over all light aids in a bounding box.

func (*LocationService) AllLightAidsRadius 

func (s *LocationService) AllLightAidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams) *Iterator[LightAid]

AllLightAidsRadius returns an iterator over all light aids within a radius.

func (*LocationService) AllMODUsBoundingBox 

func (s *LocationService) AllMODUsBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams) *Iterator[MODU]

AllMODUsBoundingBox returns an iterator over all MODUs in a bounding box.

func (*LocationService) AllMODUsRadius 

func (s *LocationService) AllMODUsRadius(ctx context.Context, params *GetLocationModuRadiusParams) *Iterator[MODU]

AllMODUsRadius returns an iterator over all MODUs within a radius.

func (*LocationService) AllPortsBoundingBox 

func (s *LocationService) AllPortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams) *Iterator[Port]

AllPortsBoundingBox returns an iterator over all ports in a bounding box.

func (*LocationService) AllPortsRadius 

func (s *LocationService) AllPortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams) *Iterator[Port]

AllPortsRadius returns an iterator over all ports within a radius.

func (*LocationService) AllRadioBeaconsBoundingBox 

func (s *LocationService) AllRadioBeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams) *Iterator[RadioBeacon]

AllRadioBeaconsBoundingBox returns an iterator over all radio beacons in a bounding box.

func (*LocationService) AllRadioBeaconsRadius 

func (s *LocationService) AllRadioBeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams) *Iterator[RadioBeacon]

AllRadioBeaconsRadius returns an iterator over all radio beacons within a radius.

func (*LocationService) AllVesselsBoundingBox 

func (s *LocationService) AllVesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams) *Iterator[VesselPosition]

AllVesselsBoundingBox returns an iterator over all vessel positions in a bounding box.

func (*LocationService) AllVesselsRadius 

func (s *LocationService) AllVesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams) *Iterator[VesselPosition]

AllVesselsRadius returns an iterator over all vessel positions within a radius.

func (*LocationService) DGPSBoundingBox 

func (s *LocationService) DGPSBoundingBox(ctx context.Context, params *GetLocationDgpsBoundingBoxParams) (*DGPSStationsWithinLocationResponse, error)

DGPSBoundingBox retrieves DGPS stations within a bounding box.

func (*LocationService) DGPSRadius 

func (s *LocationService) DGPSRadius(ctx context.Context, params *GetLocationDgpsRadiusParams) (*DGPSStationsWithinLocationResponse, error)

DGPSRadius retrieves DGPS stations within a radius.

func (*LocationService) LightAidsBoundingBox 

func (s *LocationService) LightAidsBoundingBox(ctx context.Context, params *GetLocationLightaidsBoundingBoxParams) (*LightAidsWithinLocationResponse, error)

LightAidsBoundingBox retrieves light aids within a bounding box.

func (*LocationService) LightAidsRadius 

func (s *LocationService) LightAidsRadius(ctx context.Context, params *GetLocationLightaidsRadiusParams) (*LightAidsWithinLocationResponse, error)

LightAidsRadius retrieves light aids within a radius.

func (*LocationService) MODUsBoundingBox 

func (s *LocationService) MODUsBoundingBox(ctx context.Context, params *GetLocationModuBoundingBoxParams) (*MODUsWithinLocationResponse, error)

MODUsBoundingBox retrieves MODUs within a bounding box.

func (*LocationService) MODUsRadius 

func (s *LocationService) MODUsRadius(ctx context.Context, params *GetLocationModuRadiusParams) (*MODUsWithinLocationResponse, error)

MODUsRadius retrieves MODUs within a radius.

func (*LocationService) PortsBoundingBox 

func (s *LocationService) PortsBoundingBox(ctx context.Context, params *GetLocationPortsBoundingBoxParams) (*PortsWithinLocationResponse, error)

PortsBoundingBox retrieves ports within a bounding box.

func (*LocationService) PortsRadius 

func (s *LocationService) PortsRadius(ctx context.Context, params *GetLocationPortsRadiusParams) (*PortsWithinLocationResponse, error)

PortsRadius retrieves ports within a radius.

func (*LocationService) RadioBeaconsBoundingBox 

func (s *LocationService) RadioBeaconsBoundingBox(ctx context.Context, params *GetLocationRadiobeaconsBoundingBoxParams) (*RadioBeaconsWithinLocationResponse, error)

RadioBeaconsBoundingBox retrieves radio beacons within a bounding box.

func (*LocationService) RadioBeaconsRadius 

func (s *LocationService) RadioBeaconsRadius(ctx context.Context, params *GetLocationRadiobeaconsRadiusParams) (*RadioBeaconsWithinLocationResponse, error)

RadioBeaconsRadius retrieves radio beacons within a radius.

func (*LocationService) VesselsBoundingBox 

func (s *LocationService) VesselsBoundingBox(ctx context.Context, params *GetLocationVesselsBoundingBoxParams) (*VesselsWithinLocationResponse, error)

VesselsBoundingBox retrieves vessel positions within a bounding box.

func (*LocationService) VesselsRadius 

func (s *LocationService) VesselsRadius(ctx context.Context, params *GetLocationVesselsRadiusParams) (*VesselsWithinLocationResponse, error)

VesselsRadius retrieves vessel positions within a radius.

type MODU 

type MODU struct {
	// Date Date Date of the position report (parsed from API string format YYYY-MM-DD)
	Date *string `json:"date,omitempty"`

	// Distance Distance Distance from reference point in nautical miles
	Distance *float64 `json:"distance,omitempty"`

	// Latitude Latitude Geographic latitude in decimal degrees
	//
	// Example: 28.7381
	Latitude *float64 `json:"latitude,omitempty"`

	// Location Location GeoJSON point for geospatial queries
	Location *GeoJSON `json:"location,omitempty"`

	// Longitude Longitude Geographic longitude in decimal degrees
	//
	// Example: -88.3659
	Longitude *float64 `json:"longitude,omitempty"`

	// Name Name Name of the drilling unit
	//
	// Example: DEEPWATER HORIZON
	Name *string `json:"name,omitempty"`

	// NavigationArea NavigationArea NAVAREA designation
	//
	// Example: IV
	NavigationArea *string `json:"navigation_area,omitempty"`

	// Position Position Human-readable position description
	//
	// Example: Gulf of Mexico
	Position *string `json:"position,omitempty"`

	// Region Region NGA region code
	//
	// Example: 8
	Region *int `json:"region,omitempty"`

	// RigStatus RigStatus Current operational status of the rig
	//
	// Example: Drilling
	RigStatus *string `json:"rig_status,omitempty"`

	// SpecialStatus SpecialStatus Any special status or notes
	SpecialStatus *string `json:"special_status,omitempty"`

	// SubRegion SubRegion NGA sub-region code
	//
	// Example: 81
	SubRegion *int `json:"sub_region,omitempty"`
}

MODU Mobile Offshore Drilling Unit (MODU) location and status information

type MODUsWithinLocationResponse 

type MODUsWithinLocationResponse struct {
	Modus     *[]MODU `json:"modus,omitempty"`
	NextToken *string `json:"nextToken,omitempty"`
}

MODUsWithinLocationResponse Response containing MODUs within location data

type MarineCasualtiesResponse 

type MarineCasualtiesResponse struct {
	Meta       *TypesResolutionMeta `json:"_meta,omitempty"`
	Casualties *[]MarineCasualty    `json:"casualties,omitempty"`
	NextToken  *string              `json:"nextToken,omitempty"`
}

MarineCasualtiesResponse Response containing marine casualty data

type MarineCasualty 

type MarineCasualty struct {
	AtCoding         *[]string `json:"atCoding,omitempty"`
	CasualtyReportNr *string   `json:"casualtyReportNr,omitempty"`
	CfCoding         *[]string `json:"cfCoding,omitempty"`

	// CollectedAt Record metadata (added when the record was stored)
	CollectedAt        *string   `json:"collectedAt,omitempty"`
	CompetentAuthority *[]string `json:"competentAuthority,omitempty"`

	// DateOfOccurrence Event details
	DateOfOccurrence      *string   `json:"dateOfOccurrence,omitempty"`
	Deviation             *[]string `json:"deviation,omitempty"`
	EventType             *[]string `json:"eventType,omitempty"`
	FinishedInvestigation *bool     `json:"finishedInvestigation,omitempty"`
	ImoNr                 *[]string `json:"imoNr,omitempty"`
	InterimReport         *bool     `json:"interimReport,omitempty"`

	// InvestigatingState Investigation
	InvestigatingState *string `json:"investigatingState,omitempty"`

	// LivesLostTotal Consequences
	LivesLostTotal *string `json:"livesLostTotal,omitempty"`

	// NameOfShip Vessel info (arrays since multiple vessels can be involved)
	NameOfShip         *[]string `json:"nameOfShip,omitempty"`
	OccurrenceSeverity *string   `json:"occurrenceSeverity,omitempty"`

	// OccurrenceUuid External IDs
	OccurrenceUuid        *string   `json:"occurrenceUuid,omitempty"`
	OccurrenceWithPersons *[]string `json:"occurrenceWithPersons,omitempty"`

	// OccurrenceWithShips Taxonomy classifications
	OccurrenceWithShips *[]string `json:"occurrenceWithShips,omitempty"`
	PeopleInjuredTotal  *string   `json:"peopleInjuredTotal,omitempty"`
	Pollution           *bool     `json:"pollution,omitempty"`
	ShipCraftType       *[]string `json:"shipCraftType,omitempty"`
	SrCoding            *[]string `json:"srCoding,omitempty"`
}

MarineCasualty defines model for MarineCasualty.

type NotFoundErrorDetail 

type NotFoundErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: resource_missing
	Code *ErrorCode `json:"code,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: Vessel not found: 123456789
	Message *string `json:"message,omitempty"`

	// Type Type categorizes the error (always "not_found_error" for 404s)
	//
	// Example: not_found_error
	Type *ErrorType `json:"type,omitempty"`
}

NotFoundErrorDetail defines model for NotFoundErrorDetail.

type NotFoundErrorResponse 

type NotFoundErrorResponse struct {
	Error *NotFoundErrorDetail `json:"error,omitempty"`
}

NotFoundErrorResponse defines model for NotFoundErrorResponse.

type ParamError 

type ParamError struct {
	// Param is the API parameter name, for example "filter.latTop".
	Param string

	// Reason describes what was wrong with the value.
	Reason string
}

ParamError reports a parameter that failed validation before the request was sent.

The API marks these parameters required, but Go cannot distinguish a field that was never set from one deliberately set to zero or to an empty string, so a missing value cannot be caught at compile time. It is caught here instead, which turns what would have been an HTTP 400 into a local error that names the parameter.

func (*ParamError) Error 

func (e *ParamError) Error() string

func (*ParamError) Is 

func (e *ParamError) Is(target error) bool

Is reports whether target is ErrInvalidParams, so that any validation failure can be matched with a single errors.Is check.

type PaymentRequiredErrorDetail 

type PaymentRequiredErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: insufficient_credits
	Code *ErrorCode `json:"code,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: insufficient satellite credits
	Message *string `json:"message,omitempty"`

	// Type Type categorizes the error (always "payment_required_error" for 402s)
	//
	// Example: payment_required_error
	Type *ErrorType `json:"type,omitempty"`
}

PaymentRequiredErrorDetail defines model for PaymentRequiredErrorDetail.

type PaymentRequiredErrorResponse 

type PaymentRequiredErrorResponse struct {
	Error *PaymentRequiredErrorDetail `json:"error,omitempty"`
}

PaymentRequiredErrorResponse defines model for PaymentRequiredErrorResponse.

type Port 

type Port struct {
	// AnchorageDepth AnchorageDepth Depth at the anchorage area
	//
	// Example: 20
	AnchorageDepth *float64 `json:"anchorage_depth,omitempty"`

	// AnchorageDepthUnit AnchorageDepthUnit Unit for anchorage depth measurement
	//
	// Example: m
	AnchorageDepthUnit *string `json:"anchorage_depth_unit,omitempty"`

	// CargoHandlingDepth CargoHandlingDepth Depth at cargo handling berths
	//
	// Example: 18
	CargoHandlingDepth *float64 `json:"cargo_handling_depth,omitempty"`

	// CargoHandlingDepthUnit CargoHandlingDepthUnit Unit for cargo handling depth measurement
	//
	// Example: m
	CargoHandlingDepthUnit *string `json:"cargo_handling_depth_unit,omitempty"`

	// ChannelDepth ChannelDepth Depth of the approach channel
	//
	// Example: 23
	ChannelDepth *float64 `json:"channel_depth,omitempty"`

	// ChannelDepthUnit ChannelDepthUnit Unit for channel depth measurement
	//
	// Example: m
	ChannelDepthUnit *string `json:"channel_depth_unit,omitempty"`

	// Country Country Country information for the port
	Country *ContractsPortCountry `json:"country,omitempty"`

	// GarbageDisposal GarbageDisposal Whether garbage disposal services are available
	//
	// Example: true
	GarbageDisposal *bool `json:"garbage_disposal,omitempty"`

	// HarborSize HarborSize Harbor size classification (Large/Medium/Small/Very Small)
	//
	// Example: Large
	HarborSize *string `json:"harbor_size,omitempty"`

	// HarborType HarborType Type of harbor (CB=Coastal Breakwater, CN=Coastal Natural, etc.)
	//
	// Example: CN
	HarborType *string `json:"harbor_type,omitempty"`

	// HarborUse HarborUse Primary use of the harbor (FISH/MIL/CARGO/FERRY/UNK)
	//
	// Example: CARGO
	HarborUse *string `json:"harbor_use,omitempty"`

	// HasDrydock HasDrydock Whether the port has drydock facilities
	//
	// Example: true
	HasDrydock *bool `json:"has_drydock,omitempty"`

	// Latitude Latitude Geographic latitude in decimal degrees
	//
	// Example: 1.2644
	Latitude *float64 `json:"latitude,omitempty"`

	// Location Location GeoJSON point for geospatial queries
	Location *GeoJSON `json:"location,omitempty"`

	// Longitude Longitude Geographic longitude in decimal degrees
	//
	// Example: 103.8215
	Longitude *float64 `json:"longitude,omitempty"`

	// MaxVesselBeam MaxVesselBeam Maximum beam (width) of vessel that can be accommodated
	//
	// Example: 60
	MaxVesselBeam *float64 `json:"max_vessel_beam,omitempty"`

	// MaxVesselBeamUnit MaxVesselBeamUnit Unit for maximum vessel beam
	//
	// Example: m
	MaxVesselBeamUnit *string `json:"max_vessel_beam_unit,omitempty"`

	// MaxVesselDraft MaxVesselDraft Maximum draft of vessel that can be accommodated
	//
	// Example: 16
	MaxVesselDraft *float64 `json:"max_vessel_draft,omitempty"`

	// MaxVesselDraftUnit MaxVesselDraftUnit Unit for maximum vessel draft
	//
	// Example: m
	MaxVesselDraftUnit *string `json:"max_vessel_draft_unit,omitempty"`

	// MaxVesselLength MaxVesselLength Maximum length of vessel that can be accommodated
	//
	// Example: 400
	MaxVesselLength *float64 `json:"max_vessel_length,omitempty"`

	// MaxVesselLengthUnit MaxVesselLengthUnit Unit for maximum vessel length
	//
	// Example: m
	MaxVesselLengthUnit *string `json:"max_vessel_length_unit,omitempty"`

	// MedicalFacilities MedicalFacilities Whether medical facilities are available at the port
	//
	// Example: true
	MedicalFacilities *bool `json:"medical_facilities,omitempty"`

	// Name Name The port's official name
	//
	// Example: Singapore
	Name *string `json:"name,omitempty"`

	// NavigationArea NavigationArea NAVAREA designation for maritime safety communications
	//
	// Example: XI
	NavigationArea *string `json:"navigation_area,omitempty"`

	// PilotageAvailable PilotageAvailable Whether pilotage services are available
	//
	// Example: true
	PilotageAvailable *bool `json:"pilotage_available,omitempty"`

	// PilotageCompulsory PilotageCompulsory Whether pilotage is mandatory for vessel entry
	//
	// Example: true
	PilotageCompulsory *bool `json:"pilotage_compulsory,omitempty"`

	// PortSecurity PortSecurity Whether ISPS (International Ship and Port Facility Security) compliant
	//
	// Example: true
	PortSecurity *bool `json:"port_security,omitempty"`

	// RegionName RegionName Geographic region where the port is located
	//
	// Example: Southeast Asia
	RegionName *string `json:"region_name,omitempty"`

	// RepairCapability RepairCapability Level of ship repair capability (Major/Moderate/Limited/Emergency/None)
	//
	// Example: Major
	RepairCapability *string `json:"repair_capability,omitempty"`

	// Shelter Shelter Quality of shelter from weather (Excellent/Good/Fair/Poor/None)
	//
	// Example: Excellent
	Shelter *string `json:"shelter,omitempty"`

	// Size Size Size classification of the port
	//
	// Example: Large
	Size *string `json:"size,omitempty"`

	// SupplyDiesel SupplyDiesel Whether diesel supply is available
	//
	// Example: true
	SupplyDiesel *bool `json:"supply_diesel,omitempty"`

	// SupplyFuel SupplyFuel Whether fuel oil supply is available
	//
	// Example: true
	SupplyFuel *bool `json:"supply_fuel,omitempty"`

	// SupplyWater SupplyWater Whether fresh water supply is available
	//
	// Example: true
	SupplyWater *bool `json:"supply_water,omitempty"`

	// TrafficSeparationScheme TrafficSeparationScheme Whether a TSS (Traffic Separation Scheme) is in place
	//
	// Example: true
	TrafficSeparationScheme *bool `json:"traffic_separation_scheme,omitempty"`

	// TugsAvailable TugsAvailable Whether tug services are available
	//
	// Example: true
	TugsAvailable *bool `json:"tugs_available,omitempty"`

	// Type Type Port classification type
	//
	// Example: Seaport
	Type *string `json:"type,omitempty"`

	// UnloCode UnloCode UN Location Code (LOCODE) - unique port identifier
	//
	// Example: SGSIN
	UnloCode *string `json:"unlo_code,omitempty"`

	// VesselTrafficService VesselTrafficService Whether VTS (Vessel Traffic Service) is operational
	//
	// Example: true
	VesselTrafficService *bool `json:"vessel_traffic_service,omitempty"`
}

Port Complete port information including facilities, services, and characteristics

type PortEvent 

type PortEvent struct {
	// Event Event Type of port event - either "Arrival" or "Departure"
	//
	// Example: Arrival
	Event *string `json:"event,omitempty"`

	// Port Port Reference to the port where the event occurred
	Port *PortReference `json:"port,omitempty"`

	// Timestamp Timestamp UTC timestamp when the event occurred
	Timestamp *string `json:"timestamp,omitempty"`

	// Vessel Vessel Reference to the vessel involved in the port event
	Vessel *VesselReference `json:"vessel,omitempty"`
}

PortEvent Vessel port call event including arrivals and departures

type PortEventResponse 

type PortEventResponse struct {
	Meta *TypesResolutionMeta `json:"_meta,omitempty"`

	// PortEvent Vessel port call event including arrivals and departures
	PortEvent *PortEvent `json:"portEvent,omitempty"`
}

PortEventResponse Response containing a single port event

type PortEventsResponse 

type PortEventsResponse struct {
	Meta       *TypesResolutionMeta `json:"_meta,omitempty"`
	NextToken  *string              `json:"nextToken,omitempty"`
	PortEvents *[]PortEvent         `json:"portEvents,omitempty"`
}

PortEventsResponse defines model for PortEventsResponse.

type PortEventsService 

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

PortEventsService wraps port event API endpoints.

func (*PortEventsService) AllByPort 

func (s *PortEventsService) AllByPort(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams) *Iterator[PortEvent]

AllByPort returns an iterator over all port events for a specific port.

func (*PortEventsService) AllByPorts 

func (s *PortEventsService) AllByPorts(ctx context.Context, params *GetPorteventsPortsParams) *Iterator[PortEvent]

AllByPorts returns an iterator over all port events by port name search.

func (*PortEventsService) AllByVessel 

func (s *PortEventsService) AllByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdParams) *Iterator[PortEvent]

AllByVessel returns an iterator over all port events for a vessel.

func (*PortEventsService) AllByVessels 

func (s *PortEventsService) AllByVessels(ctx context.Context, params *GetPorteventsVesselsParams) *Iterator[PortEvent]

AllByVessels returns an iterator over all port events by vessel name search.

func (*PortEventsService) ByPort 

func (s *PortEventsService) ByPort(ctx context.Context, unlocode string, params *GetPorteventsPortUnlocodeParams) (*PortEventsResponse, error)

ByPort retrieves port events for a specific port by UNLOCODE.

func (*PortEventsService) ByPorts 

func (s *PortEventsService) ByPorts(ctx context.Context, params *GetPorteventsPortsParams) (*PortEventsResponse, error)

ByPorts retrieves port events by port name search.

func (*PortEventsService) ByVessel 

func (s *PortEventsService) ByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdParams) (*PortEventsResponse, error)

ByVessel retrieves port events for a specific vessel.

func (*PortEventsService) ByVessels 

func (s *PortEventsService) ByVessels(ctx context.Context, params *GetPorteventsVesselsParams) (*PortEventsResponse, error)

ByVessels retrieves port events by vessel name search.

func (*PortEventsService) LastByVessel 

func (s *PortEventsService) LastByVessel(ctx context.Context, id string, params *GetPorteventsVesselIdLastParams) (*PortEventResponse, error)

LastByVessel retrieves the last port event for a vessel.

func (*PortEventsService) List 

func (s *PortEventsService) List(ctx context.Context, params *GetPorteventsParams) (*PortEventsResponse, error)

List retrieves port events with optional time range and filtering by country, port, vessel, or event type.

func (*PortEventsService) ListAll 

func (s *PortEventsService) ListAll(ctx context.Context, params *GetPorteventsParams) *Iterator[PortEvent]

ListAll returns an iterator over all port events.

type PortInboundResponse 

type PortInboundResponse struct {
	NextToken  *string      `json:"nextToken,omitempty"`
	VesselETAs *[]VesselETA `json:"vesselETAs,omitempty"`
}

PortInboundResponse Response containing vessels heading to a port

type PortReference 

type PortReference struct {
	// Country Country Country where the port is located
	//
	// Example: Singapore
	Country *string `json:"country,omitempty"`

	// Name Name The port's official name
	//
	// Example: Singapore
	Name *string `json:"name,omitempty"`

	// UnloCode UnloCode UN Location Code (LOCODE) for the port
	//
	// Example: SGSIN
	UnloCode *string `json:"unlo_code,omitempty"`
}

PortReference Port identification details for port event reference

type PortResponse 

type PortResponse struct {
	// Port Complete port information including facilities, services, and characteristics
	Port *Port `json:"port,omitempty"`
}

PortResponse Response containing a single port

type PortsService 

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

PortsService wraps port-related API endpoints.

func (*PortsService) Get 

func (s *PortsService) Get(ctx context.Context, unlocode string) (*PortResponse, error)

Get retrieves a port by its UN/LOCODE.

func (*PortsService) Inbound 

func (s *PortsService) Inbound(ctx context.Context, unlocode string, params *GetPortUnlocodeInboundParams) (*PortInboundResponse, error)

Inbound retrieves vessels heading to a port within an ETA window.

The ETA window is optional. Leave FilterEtaFrom and FilterEtaTo nil and the service covers now to 72 hours ahead.

func (*PortsService) InboundAll 

func (s *PortsService) InboundAll(ctx context.Context, unlocode string, params *GetPortUnlocodeInboundParams) *Iterator[VesselETA]

InboundAll returns an iterator over all inbound vessels for a port across pages.

type PortsWithinLocationResponse 

type PortsWithinLocationResponse struct {
	NextToken *string `json:"nextToken,omitempty"`
	Ports     *[]Port `json:"ports,omitempty"`
}

PortsWithinLocationResponse Response containing ports within location data

type RadioBeacon 

type RadioBeacon struct {
	// AidType AidType Type of radio aid
	//
	// Example: RBn
	AidType *string `json:"aid_type,omitempty"`

	// Characteristic Characteristic Beacon transmission characteristic
	//
	// Example: A (.--)
	Characteristic *string `json:"characteristic,omitempty"`

	// DeleteFlag DeleteFlag Deletion status flag
	DeleteFlag *string `json:"delete_flag,omitempty"`

	// FeatureNumber FeatureNumber NGA feature number identifier
	//
	// Example: 456
	FeatureNumber *float64 `json:"feature_number,omitempty"`

	// Frequency Frequency Broadcast frequency
	//
	// Example: 286 kHz
	Frequency *string `json:"frequency,omitempty"`

	// GeopoliticalHeading GeopoliticalHeading Country or major geographic area
	//
	// Example: UNITED STATES
	GeopoliticalHeading *string `json:"geopolitical_heading,omitempty"`

	// Location Location GeoJSON point for geospatial queries
	Location *GeoJSON `json:"location,omitempty"`

	// Name Name Name of the radio beacon
	//
	// Example: Ambrose Light
	Name *string `json:"name,omitempty"`

	// NoticeNumber NoticeNumber Notice to Mariners number
	NoticeNumber *int `json:"notice_number,omitempty"`

	// NoticeWeek NoticeWeek Week of the notice
	NoticeWeek *string `json:"notice_week,omitempty"`

	// NoticeYear NoticeYear Year of the notice
	NoticeYear *string `json:"notice_year,omitempty"`

	// Position Position Human-readable position description
	//
	// Example: 40°27.1'N 73°49.5'W
	Position *string `json:"position,omitempty"`

	// PostNote PostNote Notes appearing after the main entry
	PostNote *string `json:"post_note,omitempty"`

	// PrecedingNote PrecedingNote Notes appearing before the main entry
	PrecedingNote *string `json:"preceding_note,omitempty"`

	// Range Range Signal range in nautical miles
	//
	// Example: 20
	Range *string `json:"range,omitempty"`

	// RegionHeading RegionHeading Regional geographic subdivision
	//
	// Example: EAST COAST
	RegionHeading *string `json:"region_heading,omitempty"`

	// RemoveFromList RemoveFromList Flag indicating if entry should be removed
	RemoveFromList *string `json:"remove_from_list,omitempty"`

	// SequenceText SequenceText Transmission sequence description
	SequenceText *string `json:"sequence_text,omitempty"`

	// StationRemark StationRemark Remarks specific to the station
	StationRemark *string `json:"station_remark,omitempty"`

	// VolumeNumber VolumeNumber NGA publication volume number
	//
	// Example: PUB 117
	VolumeNumber *string `json:"volume_number,omitempty"`
}

RadioBeacon Navigational radio beacon for maritime direction finding

type RadioBeaconsWithinLocationResponse 

type RadioBeaconsWithinLocationResponse struct {
	NextToken    *string        `json:"nextToken,omitempty"`
	RadioBeacons *[]RadioBeacon `json:"radioBeacons,omitempty"`
}

RadioBeaconsWithinLocationResponse Response containing radio beacons within location data

type RateLimitErrorDetail 

type RateLimitErrorDetail struct {
	// Code Code is a short string identifier for this error for programmatic handling
	//
	// Example: rate_limit_exceeded
	Code *ErrorCode `json:"code,omitempty"`

	// Message Message is a human-readable message providing more details about the error
	//
	// Example: API monthly quota exceeded
	Message *string `json:"message,omitempty"`

	// Type Type categorizes the error (always "rate_limit_error" for 429s)
	//
	// Example: rate_limit_error
	Type *ErrorType `json:"type,omitempty"`
}

RateLimitErrorDetail defines model for RateLimitErrorDetail.

type RateLimitErrorResponse 

type RateLimitErrorResponse struct {
	Error *RateLimitErrorDetail `json:"error,omitempty"`
}

RateLimitErrorResponse defines model for RateLimitErrorResponse.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type SearchService 

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

SearchService wraps search API endpoints.

func (*SearchService) AllDGPS 

func (s *SearchService) AllDGPS(ctx context.Context, params *GetSearchDgpsParams) *Iterator[DGPSStation]

AllDGPS returns an iterator over all DGPS station search results.

func (*SearchService) AllLightAids 

func (s *SearchService) AllLightAids(ctx context.Context, params *GetSearchLightaidsParams) *Iterator[LightAid]

AllLightAids returns an iterator over all light aid search results.

func (*SearchService) AllMODUs 

func (s *SearchService) AllMODUs(ctx context.Context, params *GetSearchModusParams) *Iterator[MODU]

AllMODUs returns an iterator over all MODU search results.

func (*SearchService) AllPorts 

func (s *SearchService) AllPorts(ctx context.Context, params *GetSearchPortsParams) *Iterator[Port]

AllPorts returns an iterator over all port search results.

func (*SearchService) AllRadioBeacons 

func (s *SearchService) AllRadioBeacons(ctx context.Context, params *GetSearchRadiobeaconsParams) *Iterator[RadioBeacon]

AllRadioBeacons returns an iterator over all radio beacon search results.

func (*SearchService) AllVessels 

func (s *SearchService) AllVessels(ctx context.Context, params *GetSearchVesselsParams) *Iterator[Vessel]

AllVessels returns an iterator over all vessel search results.

func (*SearchService) DGPS 

func (s *SearchService) DGPS(ctx context.Context, params *GetSearchDgpsParams) (*FindDGPSStationsResponse, error)

DGPS searches for DGPS stations by name.

func (*SearchService) LightAids 

func (s *SearchService) LightAids(ctx context.Context, params *GetSearchLightaidsParams) (*FindLightAidsResponse, error)

LightAids searches for light aids by name.

func (*SearchService) MODUs 

func (s *SearchService) MODUs(ctx context.Context, params *GetSearchModusParams) (*FindMODUsResponse, error)

MODUs searches for MODUs (Mobile Offshore Drilling Units) by name.

func (*SearchService) Ports 

func (s *SearchService) Ports(ctx context.Context, params *GetSearchPortsParams) (*FindPortsResponse, error)

Ports searches for ports by name, country, type, region, and other filters.

func (*SearchService) RadioBeacons 

func (s *SearchService) RadioBeacons(ctx context.Context, params *GetSearchRadiobeaconsParams) (*FindRadioBeaconsResponse, error)

RadioBeacons searches for radio beacons by name.

func (*SearchService) Vessels 

func (s *SearchService) Vessels(ctx context.Context, params *GetSearchVesselsParams) (*FindVesselsResponse, error)

Vessels searches for vessels by name, callsign, flag, type, and other filters.

type TypesResolutionMeta 

type TypesResolutionMeta struct {
	RequestedIdType *string `json:"requestedIdType,omitempty"`
	ResolvedId      *int    `json:"resolvedId,omitempty"`
	ResolvedIdType  *string `json:"resolvedIdType,omitempty"`

	// SuggestedIdType SuggestedIDType, when set, hints that the caller may get a result by
	// retrying with the opposite identifier type. Emitted only on a total miss
	// where the counterpart id was neither supplied nor derivable, and phrased
	// conditionally — it does not assert that the other id exists.
	SuggestedIdType *string `json:"suggestedIdType,omitempty"`
}

TypesResolutionMeta defines model for types.ResolutionMeta.

type Vessel 

type Vessel struct {
	// Breadth Breadth Maximum beam (width) of the vessel
	//
	// Example: 59
	Breadth *int `json:"breadth,omitempty"`

	// BreadthUnit BreadthUnit Unit of measurement for breadth (typically meters)
	//
	// Example: m
	BreadthUnit *string `json:"breadth_unit,omitempty"`

	// CallSign CallSign International radio call sign assigned to the vessel
	//
	// Example: H3RC
	CallSign *string `json:"call_sign,omitempty"`

	// Country Country Country of registration (flag state)
	//
	// Example: Panama
	Country *string `json:"country,omitempty"`

	// CountryCode CountryCode ISO 2-letter country code of flag state
	//
	// Example: PA
	CountryCode *string `json:"country_code,omitempty"`

	// DeadweightTonnage DeadweightTonnage Deadweight tonnage (DWT) - maximum cargo capacity in metric tons
	//
	// Example: 199629
	DeadweightTonnage *int `json:"deadweight_tonnage,omitempty"`

	// Draft Draft Maximum draft (depth below waterline) of the vessel
	//
	// Example: 16
	Draft *int `json:"draft,omitempty"`

	// DraftUnit DraftUnit Unit of measurement for draft (typically meters)
	//
	// Example: m
	DraftUnit *string `json:"draft_unit,omitempty"`

	// DraughtCalculatedAvg DraughtCalculatedAvg Arithmetic mean of reported draught in meters over the last 31 days of ETA messages (zero readings excluded).
	//
	// Example: 13.8
	DraughtCalculatedAvg *float64 `json:"draught_calculated_avg,omitempty"`

	// DraughtObservedMax DraughtObservedMax Peak reported draught in meters observed over the last 31 days of ETA messages. Distinct from SummerDraught (design value).
	//
	// Example: 16
	DraughtObservedMax *float64 `json:"draught_observed_max,omitempty"`

	// EngineModelName EngineModelName Model name of the main engine
	EngineModelName *string `json:"engine_model_name,omitempty"`

	// EngineType EngineType Type code for the main engine
	EngineType *int `json:"engine_type,omitempty"`

	// Eni ENI European Number of Identification for inland waterway vessels (8 digits)
	//
	// Example: 02320524
	Eni *string `json:"eni,omitempty"`

	// FormerNames FormerNames List of previous names the vessel has operated under
	FormerNames *[]ContractsVesselFormerName `json:"former_names,omitempty"`

	// GrossTonnage GrossTonnage Gross tonnage (GT) - measure of vessel's overall internal volume
	//
	// Example: 220940
	GrossTonnage *int `json:"gross_tonnage,omitempty"`

	// HomePort HomePort Port of registry for the vessel
	//
	// Example: Panama City
	HomePort *string `json:"home_port,omitempty"`

	// Imo IMO International Maritime Organization number - permanent 7-digit vessel identifier
	//
	// Example: 9321483
	Imo *int `json:"imo,omitempty"`

	// KilowattPower KilowattPower Main engine power in kilowatts
	//
	// Example: 58000
	KilowattPower *int `json:"kilowatt_power,omitempty"`

	// Length Length Overall length of the vessel
	//
	// Example: 400
	Length *int `json:"length,omitempty"`

	// LengthUnit LengthUnit Unit of measurement for length (typically meters)
	//
	// Example: m
	LengthUnit *string `json:"length_unit,omitempty"`

	// Mmsi MMSI Maritime Mobile Service Identity - 9-digit radio identifier
	//
	// Example: 477045900
	Mmsi *int `json:"mmsi,omitempty"`

	// Name Name The vessel's current registered name
	//
	// Example: EVER GIVEN
	Name *string `json:"name,omitempty"`

	// NameAis NameAIS The name as currently broadcast on AIS — may differ from the registered Name immediately after a rename until the next master update.
	//
	// Example: EVER GIVEN
	NameAis *string `json:"name_ais,omitempty"`

	// OperatingStatus OperatingStatus Current operational status (e.g., Active, Laid Up, Scrapped)
	//
	// Example: Active
	OperatingStatus *string `json:"operating_status,omitempty"`

	// SpeedCalculatedAvg SpeedCalculatedAvg Arithmetic mean of speed-over-ground in knots over the last 31 days of position reports, computed from this vessel's AIS history (stops excluded). Derived from our observations — distinct from design service speed.
	//
	// Example: 12.4
	SpeedCalculatedAvg *float64 `json:"speed_calculated_avg,omitempty"`

	// SpeedObservedMax SpeedObservedMax 99th-percentile peak speed-over-ground in knots over the last 31 days of position reports, capped at a sanity threshold to discard GPS glitches.
	//
	// Example: 22.1
	SpeedObservedMax *float64 `json:"speed_observed_max,omitempty"`

	// SummerDraught SummerDraught Maximum design draught (summer-load line). Static vessel attribute, distinct from DraughtObservedMax.
	//
	// Example: 16.5
	SummerDraught *float64 `json:"summer_draught,omitempty"`

	// Teu TEU Twenty-foot equivalent unit container capacity. Populated only for container ships.
	//
	// Example: 23992
	Teu *int `json:"teu,omitempty"`

	// VesselSubtype VesselSubtype Finer-grained classification beyond VesselType (e.g., inland motor cargo or tanker vessel).
	//
	// Example: Inland cargo
	VesselSubtype *string `json:"vessel_subtype,omitempty"`

	// VesselType VesselType Classification of vessel type (e.g., Container Ship, Bulk Carrier)
	//
	// Example: Container Ship
	VesselType *string `json:"vessel_type,omitempty"`

	// YearBuilt YearBuilt Year the vessel was constructed
	//
	// Example: 2018
	YearBuilt *int `json:"year_built,omitempty"`
}

Vessel Complete vessel static data including identification, dimensions, and capacities

type VesselClient 

type VesselClient struct {

	// Vessels provides access to vessel-related endpoints.
	Vessels *VesselsService

	// Ports provides access to port lookup endpoints.
	Ports *PortsService

	// PortEvents provides access to port event endpoints.
	PortEvents *PortEventsService

	// Emissions provides access to emissions endpoints.
	Emissions *EmissionsService

	// Search provides access to search endpoints.
	Search *SearchService

	// Location provides access to location-based endpoints.
	Location *LocationService
	// contains filtered or unexported fields
}

VesselClient is the high-level wrapper around the generated API client. It provides resource-oriented service accessors for interacting with the Vessel Tracking API.

func NewVesselClient 

func NewVesselClient(apiKey string, opts ...VesselClientOption) (*VesselClient, error)

NewVesselClient creates a new high-level Vessel API client. The apiKey is used as a Bearer token for authentication.

type VesselClientOption 

type VesselClientOption func(*clientConfig)

VesselClientOption configures a VesselClient.

func WithVesselBaseURL 

func WithVesselBaseURL(url string) VesselClientOption

WithVesselBaseURL sets the API base URL. Defaults to DefaultBaseURL.

func WithVesselHTTPClient 

func WithVesselHTTPClient(hc *http.Client) VesselClientOption

WithVesselHTTPClient sets the underlying HTTP client used for transport.

The client's Transport is used as the base round-tripper, with auth and retry layered on top. Its Timeout, Jar and CheckRedirect are adopted too. Note that Timeout covers the whole call including retries and the waits between them, not one attempt.

A supplied CheckRedirect runs after the built-in check that refuses redirects leaving the configured origin. That check cannot be turned off, because the API key is attached below this layer and would otherwise travel to whatever host the redirect names.

func WithVesselRetry 

func WithVesselRetry(maxRetries int) VesselClientOption

WithVesselRetry sets the maximum number of retries on 429 and 5xx responses. Defaults to 3.

func WithVesselUserAgent 

func WithVesselUserAgent(ua string) VesselClientOption

WithVesselUserAgent sets the User-Agent header value.

type VesselETA 

type VesselETA struct {
	// Destination Destination Reported destination port or area as entered by the vessel
	//
	// Example: SINGAPORE
	Destination *string `json:"destination,omitempty"`

	// DestinationPort DestinationPort Resolved UN/LOCODE of the destination port (empty if unresolved)
	//
	// Example: NLRTM
	DestinationPort *string `json:"destination_port,omitempty"`

	// Draught Draught Current draught (draft) of the vessel in meters
	//
	// Example: 14.5
	Draught *float64 `json:"draught,omitempty"`

	// Eta ETA Estimated time of arrival at destination as reported by the vessel
	Eta *string `json:"eta,omitempty"`

	// Imo IMO International Maritime Organization number - permanent vessel identifier
	//
	// Example: 9321483
	Imo *int `json:"imo,omitempty"`

	// Mmsi MMSI Maritime Mobile Service Identity - unique 9-digit vessel identifier
	//
	// Example: 477045900
	Mmsi *int `json:"mmsi,omitempty"`

	// Timestamp Timestamp UTC timestamp when this ETA information was received
	Timestamp *string `json:"timestamp,omitempty"`

	// VesselName VesselName The vessel's registered name as reported in AIS
	//
	// Example: EVER GIVEN
	VesselName *string `json:"vessel_name,omitempty"`
}

VesselETA Vessel Estimated Time of Arrival information from AIS static/voyage data

type VesselETAResponse 

type VesselETAResponse struct {
	Meta *TypesResolutionMeta `json:"_meta,omitempty"`

	// VesselEta Vessel Estimated Time of Arrival information from AIS static/voyage data
	VesselEta *VesselETA `json:"vesselEta,omitempty"`
}

VesselETAResponse Response containing vessel ETA data

type VesselEmission 

type VesselEmission struct {
	Co2EmissionsAtBerth        *float64 `json:"co2_emissions_at_berth,omitempty"`
	Co2EmissionsOnLadenVoyages *float64 `json:"co2_emissions_on_laden_voyages,omitempty"`

	// Co2EmissionsTotal CO2 emissions
	Co2EmissionsTotal *float64 `json:"co2_emissions_total,omitempty"`

	// Co2PerDistance kg CO₂ / n mile
	Co2PerDistance *float64 `json:"co2_per_distance,omitempty"`

	// Co2PerTransportWork g CO₂ / m tonnes · n miles
	Co2PerTransportWork *float64 `json:"co2_per_transport_work,omitempty"`
	CollectedAt         *string  `json:"collected_at,omitempty"`

	// DistanceThroughIce nautical miles
	DistanceThroughIce *float64 `json:"distance_through_ice,omitempty"`
	DocExpiryDate      *string  `json:"doc_expiry_date,omitempty"`

	// DocIssueDate DOC info
	DocIssueDate         *string  `json:"doc_issue_date,omitempty"`
	FlagCode             *string  `json:"flag_code,omitempty"`
	FlagName             *string  `json:"flag_name,omitempty"`
	FuelConsumptionHfo   *float64 `json:"fuel_consumption_hfo,omitempty"`
	FuelConsumptionLfo   *float64 `json:"fuel_consumption_lfo,omitempty"`
	FuelConsumptionLng   *float64 `json:"fuel_consumption_lng,omitempty"`
	FuelConsumptionMdo   *float64 `json:"fuel_consumption_mdo,omitempty"`
	FuelConsumptionMgo   *float64 `json:"fuel_consumption_mgo,omitempty"`
	FuelConsumptionOther *float64 `json:"fuel_consumption_other,omitempty"`

	// FuelConsumptionTotal Fuel consumption (tonnes)
	FuelConsumptionTotal *float64 `json:"fuel_consumption_total,omitempty"`

	// FuelPerDistance Efficiency metrics (pre-calculated)
	FuelPerDistance *float64 `json:"fuel_per_distance,omitempty"`

	// FuelPerTransportWork g / m tonnes · n miles
	FuelPerTransportWork *float64 `json:"fuel_per_transport_work,omitempty"`
	HomePort             *string  `json:"home_port,omitempty"`
	IceClass             *string  `json:"ice_class,omitempty"`

	// Imo Identifiers
	Imo *int `json:"imo,omitempty"`

	// MonitoringMethodA Monitoring method
	MonitoringMethodA  *string `json:"monitoring_method_a,omitempty"`
	MonitoringMethodB  *string `json:"monitoring_method_b,omitempty"`
	MonitoringMethodC  *string `json:"monitoring_method_c,omitempty"`
	MonitoringMethodD  *string `json:"monitoring_method_d,omitempty"`
	Name               *string `json:"name,omitempty"`
	PortCallsOutsideEu *int    `json:"port_calls_outside_eu,omitempty"`

	// PortCallsWithinEu EU specific
	PortCallsWithinEu *int `json:"port_calls_within_eu,omitempty"`

	// ReportingPeriod Reporting period
	ReportingPeriod *string `json:"reporting_period,omitempty"`

	// TechnicalEfficiency Technical efficiency
	TechnicalEfficiency      *string  `json:"technical_efficiency,omitempty"`
	TechnicalEfficiencyValue *float64 `json:"technical_efficiency_value,omitempty"`

	// TimeAtSeaThroughIce hours
	TimeAtSeaThroughIce *float64 `json:"time_at_sea_through_ice,omitempty"`

	// TotalTimeAtSea Distance and time
	TotalTimeAtSea *float64 `json:"total_time_at_sea,omitempty"`

	// UniqueKey Stable identifier for this emission record (IMO + reporting period)
	UniqueKey             *string `json:"unique_key,omitempty"`
	VerifierAccreditation *string `json:"verifier_accreditation,omitempty"`
	VerifierAddress       *string `json:"verifier_address,omitempty"`

	// VerifierName Verifier info
	VerifierName *string `json:"verifier_name,omitempty"`

	// VesselType Vessel identification
	VesselType *string `json:"vessel_type,omitempty"`
}

VesselEmission defines model for VesselEmission.

type VesselEmissionsResponse 

type VesselEmissionsResponse struct {
	Meta      *TypesResolutionMeta `json:"_meta,omitempty"`
	Emissions *[]VesselEmission    `json:"emissions,omitempty"`
	NextToken *string              `json:"nextToken,omitempty"`
}

VesselEmissionsResponse Response containing vessel emissions data

type VesselPosition 

type VesselPosition struct {
	// Cog COG Course Over Ground in degrees (0-359.9), null when unavailable
	//
	// Example: 231.5
	Cog *float64 `json:"cog,omitempty"`

	// Heading Heading True heading in degrees (0-359), null when unavailable
	//
	// Example: 230
	Heading *int `json:"heading,omitempty"`

	// Imo IMO International Maritime Organization number - permanent vessel identifier
	//
	// Example: 9321483
	Imo *int `json:"imo,omitempty"`

	// Latitude Latitude Geographic latitude in decimal degrees (-90 to 90)
	//
	// Example: 1.2644
	Latitude *float64 `json:"latitude,omitempty"`

	// Location Location GeoJSON point for geospatial queries
	Location *GeoJSON `json:"location,omitempty"`

	// Longitude Longitude Geographic longitude in decimal degrees (-180 to 180)
	//
	// Example: 103.8215
	Longitude *float64 `json:"longitude,omitempty"`

	// Mmsi MMSI Maritime Mobile Service Identity - unique 9-digit vessel identifier
	//
	// Example: 477045900
	Mmsi *int `json:"mmsi,omitempty"`

	// NavStatus NavStatus AIS navigational status (0=under way using engine, 1=at anchor, 2=not under command, 3=restricted manoeuvrability, 5=moored, 8=under way sailing, etc.), null when unavailable
	//
	// Example: 0
	NavStatus *int `json:"nav_status,omitempty"`

	// ProcessedTimestamp ProcessedTimestamp UTC timestamp when the position was processed by the system
	ProcessedTimestamp *string `json:"processed_timestamp,omitempty"`

	// Sog SOG Speed Over Ground in knots (0-102.2), null when unavailable
	//
	// Example: 14.1
	Sog *float64 `json:"sog,omitempty"`

	// SuspectedGlitch SuspectedGlitch indicates the position may be unreliable due to a GPS glitch or corrupted AIS transmission (implies impossible vessel speed)
	//
	// Example: false
	SuspectedGlitch *bool `json:"suspected_glitch,omitempty"`

	// Timestamp Timestamp UTC timestamp when the AIS message was transmitted by the vessel
	Timestamp *string `json:"timestamp,omitempty"`

	// VesselName VesselName The vessel's registered name as reported in AIS
	//
	// Example: EVER GIVEN
	VesselName *string `json:"vessel_name,omitempty"`
}

VesselPosition Real-time vessel position data derived from AIS messages

type VesselPositionResponse 

type VesselPositionResponse struct {
	Meta *TypesResolutionMeta `json:"_meta,omitempty"`

	// VesselPosition Real-time vessel position data derived from AIS messages
	VesselPosition *VesselPosition `json:"vesselPosition,omitempty"`
}

VesselPositionResponse Response containing a single vessel position

type VesselPositionsResponse 

type VesselPositionsResponse struct {
	NextToken       *string           `json:"nextToken,omitempty"`
	VesselPositions *[]VesselPosition `json:"vesselPositions,omitempty"`
}

VesselPositionsResponse Response containing vessel position data

type VesselReference 

type VesselReference struct {
	// Imo IMO International Maritime Organization number
	//
	// Example: 9321483
	Imo *int `json:"imo,omitempty"`

	// Mmsi MMSI Maritime Mobile Service Identity number
	//
	// Example: 477045900
	Mmsi *int `json:"mmsi,omitempty"`

	// Name Name The vessel's registered name
	//
	// Example: EVER GIVEN
	Name *string `json:"name,omitempty"`
}

VesselReference Vessel identification details for port event reference

type VesselResponse 

type VesselResponse struct {
	Meta *TypesResolutionMeta `json:"_meta,omitempty"`

	// Vessel Complete vessel static data including identification, dimensions, and capacities
	Vessel *Vessel `json:"vessel,omitempty"`
}

VesselResponse Response containing vessel data

type VesselSearchMeta 

type VesselSearchMeta struct {
	// MatchedOn MatchedOn maps the index of a vessel in the vessels array to the fields
	// that matched it, e.g. {"0":["eni"],"1":["imo"]}. Values are arrays because
	// one vessel can match on several fields at once (a vessel whose ENI and IMO
	// are the same digits). Field order within an entry is stable: eni, imo,
	// mmsi, callsign, name.
	MatchedOn *map[string][]string `json:"matchedOn,omitempty"`

	// Query Query echoes the q value the fields were matched against.
	//
	// Example: 4606770
	Query *string `json:"query,omitempty"`
}

VesselSearchMeta defines model for VesselSearchMeta.

type VesselsService 

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

VesselsService wraps vessel-related API endpoints.

func (*VesselsService) AllCasualties 

func (s *VesselsService) AllCasualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams) *Iterator[MarineCasualty]

AllCasualties returns an iterator over all casualties for a vessel.

func (*VesselsService) AllEmissions 

func (s *VesselsService) AllEmissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams) *Iterator[VesselEmission]

AllEmissions returns an iterator over all emissions for a vessel.

func (*VesselsService) AllPositions 

func (s *VesselsService) AllPositions(ctx context.Context, params *GetVesselsPositionsParams) *Iterator[VesselPosition]

AllPositions returns an iterator over all positions for multiple vessels.

func (*VesselsService) Casualties 

func (s *VesselsService) Casualties(ctx context.Context, id string, params *GetVesselIdCasualtiesParams) (*MarineCasualtiesResponse, error)

Casualties retrieves marine casualty records for a vessel.

func (*VesselsService) ETA 

func (s *VesselsService) ETA(ctx context.Context, id string, params *GetVesselIdEtaParams) (*VesselETAResponse, error)

ETA retrieves the estimated time of arrival for a vessel.

func (*VesselsService) Emissions 

func (s *VesselsService) Emissions(ctx context.Context, id string, params *GetVesselIdEmissionsParams) (*VesselEmissionsResponse, error)

Emissions retrieves emissions data for a vessel.

func (*VesselsService) Get 

func (s *VesselsService) Get(ctx context.Context, id string, params *GetVesselIdParams) (*VesselResponse, error)

Get retrieves vessel details by ID (IMO or MMSI).

func (*VesselsService) Position 

func (s *VesselsService) Position(ctx context.Context, id string, params *GetVesselIdPositionParams) (*VesselPositionResponse, error)

Position retrieves the latest position for a vessel.

func (*VesselsService) Positions 

func (s *VesselsService) Positions(ctx context.Context, params *GetVesselsPositionsParams) (*VesselPositionsResponse, error)

Positions retrieves positions for multiple vessels.

type VesselsWithinLocationResponse 

type VesselsWithinLocationResponse struct {
	NextToken *string           `json:"nextToken,omitempty"`
	Vessels   *[]VesselPosition `json:"vessels,omitempty"`
}

VesselsWithinLocationResponse Response containing vessel within location data

Source Files

View all Source files

Jump to

Keyboard shortcuts

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