Categorygithub.com/buyco/go-cma-sdk/v2api
package
2.1.0
Repository: https://github.com/buyco/go-cma-sdk.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
22
Dependents
0
Files
12.2k SLOC

# README

Go API client for api

Managing and sending Shipment-, Transport- and Equipment-events and subscriptions for Track & Trace (T&T). API specification issued by DCSA.org. For explanation to specific values or objects please refer to the Information Model v3.3 Polling can be done on the GET /events endPoint. DCSA version 2.2.0

Overview

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

  • API version: 1.0.3
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://api-portal.cma-cgm.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

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

import api "github.com/buyco/go-cma-sdk/api"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), api.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), api.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), api.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://apis.cma-cgm.net/operation/trackandtrace/v1

ClassMethodHTTP requestDescription
EventsApiGetMoveOnCommercialCycleGet /events/{trackingReference}Find Commercial events from unique tracking greference.
EventsApiSearchMoveOnCommercialCycleGet /eventsFind Commercial events.

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: keyId
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: keyId and passed in as the auth context for each request.

oAuth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • tandtcommercial:read:be: read access for public enpoints
  • tandt:read:be: read access for private enpoints
  • tandtpublic:read:be: read access for public enpoints
  • tandtcommercial:read:fe: read access for front end public enpoints
  • tandtpublic:read:fe: read access for front end public enpoints
  • tandt:read:fe: read access for front end public enpoints

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAddress instantiates a new Address object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf instantiates a new AddressAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf1 instantiates a new AddressAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf1WithDefaults instantiates a new AddressAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOf2 instantiates a new AddressAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf2WithDefaults instantiates a new AddressAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOf3 instantiates a new AddressAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf3WithDefaults instantiates a new AddressAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOf4 instantiates a new AddressAllOf4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf4WithDefaults instantiates a new AddressAllOf4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOf5 instantiates a new AddressAllOf5 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf5WithDefaults instantiates a new AddressAllOf5 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOf6 instantiates a new AddressAllOf6 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf6WithDefaults instantiates a new AddressAllOf6 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOf7 instantiates a new AddressAllOf7 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAddressAllOf7WithDefaults instantiates a new AddressAllOf7 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressAllOfWithDefaults instantiates a new AddressAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAddressWithDefaults instantiates a new Address object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewBaseEquipmentEvent instantiates a new BaseEquipmentEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf instantiates a new BaseEquipmentEventAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf1 instantiates a new BaseEquipmentEventAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf1WithDefaults instantiates a new BaseEquipmentEventAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventAllOf2 instantiates a new BaseEquipmentEventAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf2WithDefaults instantiates a new BaseEquipmentEventAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventAllOf3 instantiates a new BaseEquipmentEventAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf3WithDefaults instantiates a new BaseEquipmentEventAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventAllOf4 instantiates a new BaseEquipmentEventAllOf4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf4WithDefaults instantiates a new BaseEquipmentEventAllOf4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventAllOf5 instantiates a new BaseEquipmentEventAllOf5 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf5WithDefaults instantiates a new BaseEquipmentEventAllOf5 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventAllOf6 instantiates a new BaseEquipmentEventAllOf6 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEquipmentEventAllOf6WithDefaults instantiates a new BaseEquipmentEventAllOf6 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventAllOfWithDefaults instantiates a new BaseEquipmentEventAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEquipmentEventWithDefaults instantiates a new BaseEquipmentEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEvent instantiates a new BaseEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventAllOf instantiates a new BaseEventAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventAllOf1 instantiates a new BaseEventAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventAllOf1WithDefaults instantiates a new BaseEventAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventAllOfWithDefaults instantiates a new BaseEventAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventBody instantiates a new BaseEventBody object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventBodyAllOf instantiates a new BaseEventBodyAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventBodyAllOf1 instantiates a new BaseEventBodyAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventBodyAllOf1WithDefaults instantiates a new BaseEventBodyAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventBodyAllOf2 instantiates a new BaseEventBodyAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventBodyAllOf2WithDefaults instantiates a new BaseEventBodyAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventBodyAllOf3 instantiates a new BaseEventBodyAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseEventBodyAllOf3WithDefaults instantiates a new BaseEventBodyAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventBodyAllOfWithDefaults instantiates a new BaseEventBodyAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventBodyWithDefaults instantiates a new BaseEventBody object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseEventWithDefaults instantiates a new BaseEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEvent instantiates a new BaseShipmentEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf instantiates a new BaseShipmentEventAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf1 instantiates a new BaseShipmentEventAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf1WithDefaults instantiates a new BaseShipmentEventAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventAllOf2 instantiates a new BaseShipmentEventAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf2WithDefaults instantiates a new BaseShipmentEventAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventAllOf3 instantiates a new BaseShipmentEventAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf3WithDefaults instantiates a new BaseShipmentEventAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventAllOf4 instantiates a new BaseShipmentEventAllOf4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf4WithDefaults instantiates a new BaseShipmentEventAllOf4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventAllOf5 instantiates a new BaseShipmentEventAllOf5 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf5WithDefaults instantiates a new BaseShipmentEventAllOf5 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventAllOf6 instantiates a new BaseShipmentEventAllOf6 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseShipmentEventAllOf6WithDefaults instantiates a new BaseShipmentEventAllOf6 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventAllOfWithDefaults instantiates a new BaseShipmentEventAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseShipmentEventWithDefaults instantiates a new BaseShipmentEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEvent instantiates a new BaseTransportEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf instantiates a new BaseTransportEventAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf1 instantiates a new BaseTransportEventAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf1WithDefaults instantiates a new BaseTransportEventAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEventAllOf2 instantiates a new BaseTransportEventAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf2WithDefaults instantiates a new BaseTransportEventAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEventAllOf3 instantiates a new BaseTransportEventAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf3WithDefaults instantiates a new BaseTransportEventAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEventAllOf4 instantiates a new BaseTransportEventAllOf4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf4WithDefaults instantiates a new BaseTransportEventAllOf4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEventAllOf5 instantiates a new BaseTransportEventAllOf5 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseTransportEventAllOf5WithDefaults instantiates a new BaseTransportEventAllOf5 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEventAllOfWithDefaults instantiates a new BaseTransportEventAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBaseTransportEventWithDefaults instantiates a new BaseTransportEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCarrierSpecificData instantiates a new CarrierSpecificData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCarrierSpecificDataWithDefaults instantiates a new CarrierSpecificData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewDocumentReferencesInner instantiates a new DocumentReferencesInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDocumentReferencesInnerWithDefaults instantiates a new DocumentReferencesInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDocumentTypeCodeFromValue returns a pointer to a valid DocumentTypeCode for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewEmptyIndicatorCodeFromValue returns a pointer to a valid EmptyIndicatorCode for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewEquipmentEvent instantiates a new EquipmentEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEquipmentEventTypeCodeFromValue returns a pointer to a valid EquipmentEventTypeCode for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewEquipmentEventWithDefaults instantiates a new EquipmentEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFacilityCodeListProviderFromValue returns a pointer to a valid FacilityCodeListProvider for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewFacilityTypeCodeTRNFromValue returns a pointer to a valid FacilityTypeCodeTRN for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewInlineResponseDefault instantiates a new InlineResponseDefault object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponseDefaultAllOf instantiates a new InlineResponseDefaultAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponseDefaultAllOf1 instantiates a new InlineResponseDefaultAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponseDefaultAllOf1WithDefaults instantiates a new InlineResponseDefaultAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponseDefaultAllOfWithDefaults instantiates a new InlineResponseDefaultAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponseDefaultWithDefaults instantiates a new InlineResponseDefault object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLocation instantiates a new Location object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLocationAllOf instantiates a new LocationAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLocationAllOf1 instantiates a new LocationAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLocationAllOf1WithDefaults instantiates a new LocationAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLocationAllOf2 instantiates a new LocationAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLocationAllOf2WithDefaults instantiates a new LocationAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLocationAllOf3 instantiates a new LocationAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLocationAllOf3WithDefaults instantiates a new LocationAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLocationAllOfWithDefaults instantiates a new LocationAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLocationWithDefaults instantiates a new Location object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModelError instantiates a new ModelError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModelErrorWithDefaults instantiates a new ModelError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModeOfTransportFromValue returns a pointer to a valid ModeOfTransport for the value passed as argument, or an error if the value passed is not allowed by the enum.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOperationsTransportEvent instantiates a new OperationsTransportEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOperationsTransportEventWithDefaults instantiates a new OperationsTransportEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewReference instantiates a new Reference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewReferenceAllOf instantiates a new ReferenceAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewReferenceAllOf1 instantiates a new ReferenceAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewReferenceAllOf1WithDefaults instantiates a new ReferenceAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewReferenceAllOfWithDefaults instantiates a new ReferenceAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewReferences instantiates a new References object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewReferencesWithDefaults instantiates a new References object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewReferenceTypeFromValue returns a pointer to a valid ReferenceType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewReferenceWithDefaults instantiates a new Reference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSeal instantiates a new Seal object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSealAllOf instantiates a new SealAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSealAllOf1 instantiates a new SealAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSealAllOf1WithDefaults instantiates a new SealAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSealAllOf2 instantiates a new SealAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSealAllOf2WithDefaults instantiates a new SealAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSealAllOfWithDefaults instantiates a new SealAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSeals instantiates a new Seals object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSealSourceFromValue returns a pointer to a valid SealSource for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewSealsWithDefaults instantiates a new Seals object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSealTypeFromValue returns a pointer to a valid SealType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewSealWithDefaults instantiates a new Seal object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewShipmentEvent instantiates a new ShipmentEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewShipmentEventTypeCodeFromValue returns a pointer to a valid ShipmentEventTypeCode for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewShipmentEventWithDefaults instantiates a new ShipmentEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSubErrorsInner instantiates a new SubErrorsInner object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSubErrorsInnerWithDefaults instantiates a new SubErrorsInner object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCall instantiates a new TransportCall object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf instantiates a new TransportCallAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf1 instantiates a new TransportCallAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf10 instantiates a new TransportCallAllOf10 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf10WithDefaults instantiates a new TransportCallAllOf10 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf11 instantiates a new TransportCallAllOf11 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf11WithDefaults instantiates a new TransportCallAllOf11 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf12 instantiates a new TransportCallAllOf12 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf12WithDefaults instantiates a new TransportCallAllOf12 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf13 instantiates a new TransportCallAllOf13 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf13WithDefaults instantiates a new TransportCallAllOf13 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf14 instantiates a new TransportCallAllOf14 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf14WithDefaults instantiates a new TransportCallAllOf14 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf1WithDefaults instantiates a new TransportCallAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf2 instantiates a new TransportCallAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf2WithDefaults instantiates a new TransportCallAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf3 instantiates a new TransportCallAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf3WithDefaults instantiates a new TransportCallAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf4 instantiates a new TransportCallAllOf4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf4WithDefaults instantiates a new TransportCallAllOf4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf5 instantiates a new TransportCallAllOf5 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf5WithDefaults instantiates a new TransportCallAllOf5 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf6 instantiates a new TransportCallAllOf6 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf6WithDefaults instantiates a new TransportCallAllOf6 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf7 instantiates a new TransportCallAllOf7 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf7WithDefaults instantiates a new TransportCallAllOf7 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf8 instantiates a new TransportCallAllOf8 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf8WithDefaults instantiates a new TransportCallAllOf8 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOf9 instantiates a new TransportCallAllOf9 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportCallAllOf9WithDefaults instantiates a new TransportCallAllOf9 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallAllOfWithDefaults instantiates a new TransportCallAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportCallWithDefaults instantiates a new TransportCall object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportEvent instantiates a new TransportEvent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportEventAllOf instantiates a new TransportEventAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransportEventAllOfWithDefaults instantiates a new TransportEventAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransportEventTypeCodeFromValue returns a pointer to a valid TransportEventTypeCode for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTransportEventWithDefaults instantiates a new TransportEvent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVessel instantiates a new Vessel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf instantiates a new VesselAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf1 instantiates a new VesselAllOf1 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf1WithDefaults instantiates a new VesselAllOf1 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVesselAllOf2 instantiates a new VesselAllOf2 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf2WithDefaults instantiates a new VesselAllOf2 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVesselAllOf3 instantiates a new VesselAllOf3 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf3WithDefaults instantiates a new VesselAllOf3 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVesselAllOf4 instantiates a new VesselAllOf4 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf4WithDefaults instantiates a new VesselAllOf4 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVesselAllOf5 instantiates a new VesselAllOf5 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVesselAllOf5WithDefaults instantiates a new VesselAllOf5 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVesselAllOfWithDefaults instantiates a new VesselAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVesselOperatorCarrierCodeListProviderFromValue returns a pointer to a valid VesselOperatorCarrierCodeListProvider for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewVesselWithDefaults instantiates a new Vessel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Constants

List of referenceType.
List of shipmentEventTypeCode.
List of transportEventTypeCode.
List of modeOfTransport.
List of facilityCodeListProvider.
List of sealType.
List of facilityTypeCodeTRN.
List of facilityTypeCodeTRN.
List of shipmentEventTypeCode.
List of facilityTypeCodeTRN.
List of shipmentEventTypeCode.
List of facilityTypeCodeTRN.
List of referenceType.
List of transportEventTypeCode.
List of facilityTypeCodeTRN.
List of equipmentEventTypeCode.
List of shipmentEventTypeCode.
List of equipmentEventTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of documentTypeCode.
List of emptyIndicatorCode.
List of referenceType.
List of referenceType.
List of equipmentEventTypeCode.
List of equipmentEventTypeCode.
List of shipmentEventTypeCode.
List of equipmentEventTypeCode.
List of facilityTypeCodeTRN.
List of shipmentEventTypeCode.
List of sealType.
List of emptyIndicatorCode.
List of equipmentEventTypeCode.
List of facilityTypeCodeTRN.
List of shipmentEventTypeCode.
List of shipmentEventTypeCode.
List of equipmentEventTypeCode.
List of referenceType.
List of facilityTypeCodeTRN.
List of modeOfTransport.
List of facilityTypeCodeTRN.
List of shipmentEventTypeCode.
List of shipmentEventTypeCode.
List of shipmentEventTypeCode.
List of shipmentEventTypeCode.
List of equipmentEventTypeCode.
List of equipmentEventTypeCode.
List of referenceType.
List of facilityCodeListProvider.
List of sealSource.
List of sealSource.
List of sealSource.
List of sealSource.
List of sealSource.
List of equipmentEventTypeCode.
List of equipmentEventTypeCode.
List of shipmentEventTypeCode.
List of shipmentEventTypeCode.
List of modeOfTransport.
List of modeOfTransport.
List of vesselOperatorCarrierCodeListProvider.
List of vesselOperatorCarrierCodeListProvider.
List of shipmentEventTypeCode.
List of sealType.

# Variables

All allowed values of DocumentTypeCode enum.
All allowed values of EmptyIndicatorCode enum.
All allowed values of EquipmentEventTypeCode enum.
All allowed values of FacilityCodeListProvider enum.
All allowed values of FacilityTypeCodeTRN enum.
All allowed values of ModeOfTransport enum.
All allowed values of ReferenceType enum.
All allowed values of SealSource enum.
All allowed values of SealType enum.
All allowed values of ShipmentEventTypeCode enum.
All allowed values of TransportEventTypeCode enum.
All allowed values of VesselOperatorCarrierCodeListProvider enum.
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

Address An object for storing address related information.
AddressAllOf struct for AddressAllOf.
AddressAllOf1 struct for AddressAllOf1.
AddressAllOf2 struct for AddressAllOf2.
AddressAllOf3 struct for AddressAllOf3.
AddressAllOf4 struct for AddressAllOf4.
AddressAllOf5 struct for AddressAllOf5.
AddressAllOf6 struct for AddressAllOf6.
AddressAllOf7 struct for AddressAllOf7.
APIClient manages communication with the Logistic Tracking service API - DCSA OpenAPI specification for Track & Trace v2.2.0 API v1.0.3 In most cases there should be only one, shared, APIClient.
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
BaseEquipmentEvent The equipment event entity is a specialization of the event entity to support specification of data that only applies to an equipment event.
BaseEquipmentEventAllOf struct for BaseEquipmentEventAllOf.
BaseEquipmentEventAllOf1 struct for BaseEquipmentEventAllOf1.
BaseEquipmentEventAllOf2 struct for BaseEquipmentEventAllOf2.
BaseEquipmentEventAllOf3 struct for BaseEquipmentEventAllOf3.
BaseEquipmentEventAllOf4 struct for BaseEquipmentEventAllOf4.
BaseEquipmentEventAllOf5 struct for BaseEquipmentEventAllOf5.
BaseEquipmentEventAllOf6 struct for BaseEquipmentEventAllOf6.
BaseEvent struct for BaseEvent.
BaseEventAllOf struct for BaseEventAllOf.
BaseEventAllOf1 struct for BaseEventAllOf1.
BaseEventBody The Event entity is described as a generalization of all the specific event categories.
BaseEventBodyAllOf struct for BaseEventBodyAllOf.
BaseEventBodyAllOf1 struct for BaseEventBodyAllOf1.
BaseEventBodyAllOf2 struct for BaseEventBodyAllOf2.
BaseEventBodyAllOf3 struct for BaseEventBodyAllOf3.
BaseShipmentEvent The shipment event entity is a specialization of the event entity to support specification of data that only applies to a shipment event.
BaseShipmentEventAllOf struct for BaseShipmentEventAllOf.
BaseShipmentEventAllOf1 struct for BaseShipmentEventAllOf1.
BaseShipmentEventAllOf2 struct for BaseShipmentEventAllOf2.
BaseShipmentEventAllOf3 struct for BaseShipmentEventAllOf3.
BaseShipmentEventAllOf4 struct for BaseShipmentEventAllOf4.
BaseShipmentEventAllOf5 struct for BaseShipmentEventAllOf5.
BaseShipmentEventAllOf6 struct for BaseShipmentEventAllOf6.
BaseTransportEvent The transport event entity is a specialization of the event entity to support specification of data that only applies to a transport event.
BaseTransportEventAllOf struct for BaseTransportEventAllOf.
BaseTransportEventAllOf1 struct for BaseTransportEventAllOf1.
BaseTransportEventAllOf2 struct for BaseTransportEventAllOf2.
BaseTransportEventAllOf3 struct for BaseTransportEventAllOf3.
BaseTransportEventAllOf4 struct for BaseTransportEventAllOf4.
BaseTransportEventAllOf5 struct for BaseTransportEventAllOf5.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CarrierSpecificData struct for CarrierSpecificData.
Configuration stores the configuration of the API client.
DocumentReferencesInner struct for DocumentReferencesInner.
EquipmentEvent struct for EquipmentEvent.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
InlineResponseDefault struct for InlineResponseDefault.
InlineResponseDefaultAllOf struct for InlineResponseDefaultAllOf.
InlineResponseDefaultAllOf1 struct for InlineResponseDefaultAllOf1.
Location generally used to capture location-related data, also for locations without UN Location Codes.
LocationAllOf struct for LocationAllOf.
LocationAllOf1 struct for LocationAllOf1.
LocationAllOf2 struct for LocationAllOf2.
LocationAllOf3 struct for LocationAllOf3.
ModelError struct for ModelError.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OperationsTransportEvent struct for OperationsTransportEvent.
Reference references provided by the shipper or freight forwarder at the time of booking or at the time of providing shipping instruction.
ReferenceAllOf struct for ReferenceAllOf.
ReferenceAllOf1 struct for ReferenceAllOf1.
References struct for References.
Seal addresses the seal-related information associated with the shipment equipment.
SealAllOf struct for SealAllOf.
SealAllOf1 struct for SealAllOf1.
SealAllOf2 struct for SealAllOf2.
Seals struct for Seals.
SearchMoveOnCommercialCycle200ResponseInner struct for SearchMoveOnCommercialCycle200ResponseInner.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ShipmentEvent struct for ShipmentEvent.
SubErrorsInner struct for SubErrorsInner.
TransportCall struct for TransportCall.
TransportCallAllOf struct for TransportCallAllOf.
TransportCallAllOf1 struct for TransportCallAllOf1.
TransportCallAllOf10 struct for TransportCallAllOf10.
TransportCallAllOf11 struct for TransportCallAllOf11.
TransportCallAllOf12 struct for TransportCallAllOf12.
TransportCallAllOf13 struct for TransportCallAllOf13.
TransportCallAllOf14 struct for TransportCallAllOf14.
TransportCallAllOf2 struct for TransportCallAllOf2.
TransportCallAllOf3 struct for TransportCallAllOf3.
TransportCallAllOf4 struct for TransportCallAllOf4.
TransportCallAllOf5 struct for TransportCallAllOf5.
TransportCallAllOf6 struct for TransportCallAllOf6.
TransportCallAllOf7 struct for TransportCallAllOf7.
TransportCallAllOf8 struct for TransportCallAllOf8.
TransportCallAllOf9 struct for TransportCallAllOf9.
TransportEvent struct for TransportEvent.
TransportEventAllOf struct for TransportEventAllOf.
Vessel describes a floating, sea going structure (mother vessels and feeder vessels) with either an internal or external mode of propulsion designed for the transport of cargo and/or passengers.
VesselAllOf struct for VesselAllOf.
VesselAllOf1 struct for VesselAllOf1.
VesselAllOf2 struct for VesselAllOf2.
VesselAllOf3 struct for VesselAllOf3.
VesselAllOf4 struct for VesselAllOf4.
VesselAllOf5 struct for VesselAllOf5.

# Interfaces

No description provided by the author

# Type aliases

DocumentTypeCode The code to identify the type of information documentID points to.
EmptyIndicatorCode Code to denote whether the equipment is empty or laden.
EquipmentEventTypeCode Unique identifier for equipmentEventTypeCode.
EventsApiService EventsApi service.
FacilityCodeListProvider The provider used for identifying the facility Code.
FacilityTypeCodeTRN A specialized version of the facilityCode to be used in TransportCalls.
ModeOfTransport The mode of transport as defined by DCSA.
ReferenceType The reference type codes defined by DCSA.
SealSource The source of the seal, namely who has affixed the seal.
SealType The type of seal.
ServerConfigurations stores multiple ServerConfiguration items.
ShipmentEventTypeCode The status of the document in the process.
TransportEventTypeCode Identifier for type of Transport event - ARRI (Arrived) - DEPA (Departed) More details can be found on <a href=\"https://github.com/dcsaorg/DCSA-Information-Model/blob/master/datamodel/referencedata.d/transporteventtypecodes.csv\">GitHub</a>.
VesselOperatorCarrierCodeListProvider Identifies the code list provider used for the operator and partner carriercodes.