models

package module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Apr 3, 2024 License: GPL-3.0 Imports: 0 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Commodity

type Commodity struct {
	Id              string
	Description     string
	Weight          *Weight
	Dimensions      *Dimensions
	Volume          *Volume
	NFMC            *string
	HarmonizedCode  *string
	CountryOfOrigin *string
	DeclaredValue   *Currency
	IsHazardous     bool
	IsStackable     bool
	Metadata        Metadata
	MinTemperature  *Temperature
	MaxTemperature  *Temperature
	References      []Reference
}

Commodity represents a commodity model

type Contact

type Contact struct {
	Id    string  // The unique identifier for the contact.
	Name  string  // The name of the contact.
	Email string  // The email address of the contact.
	Phone string  // The phone number of the contact.
	Fax   *string // The fax number of the contact.
}

Contact represents a contact that can be used to reach a company, organization, or individual.

type Currency

type Currency struct {
	Code   string // The code of the currency
	Name   string // The name of the currency
	Symbol string // The symbol of the currency
}

CurrencyModel represents a currency model

type Dimensions

type Dimensions struct {
	Length float64 // The length dimension
	Width  float64 // The width dimension
	Height float64 // The height dimension
	Unit   string  // The unit of the dimensions
}

DimensionsModel represents a model for dimensions

type EquipmentType

type EquipmentType int
const (
	DryVan EquipmentType = iota
	Reefer
	Flatbed
	StepDeck
	DoubleDrop
	Lowboy
	PowerOnly
	Container
	Chassis
	Tanker
	Hopper
	Pneumatic
	Dump
	Livestock
	AutoCarrier
	Other
)

type FreightClass

type FreightClass int
const (
	Class50 FreightClass = iota + 50
	Class55
	Class60
	Class65
	Class70
	Class77_55
	Class85
	Class92_5
	Class100
	Class110
	Class125
	Class150
	Class175
	Class200
	Class250
	Class300
	Class400
	Class500
)

type HandlingUni

type HandlingUni struct {
	Id              string
	Description     string
	Weight          *Weight
	Dimensions      *Dimensions
	Volume          *Volume
	NFMC            *string
	HarmonizedCode  *string
	CountryOfOrigin *string
	DeclaredValue   *Currency
	IsHazardous     bool
	IsStackable     bool
	Metadata        Metadata
	MinTemperature  *Temperature
	MaxTemperature  *Temperature
	References      []Reference
	Commodities     []Commodity
}

HandlingUnitModel represents a handling unit model

type Metadata

type Metadata struct {
	OrderNumber         *string
	InvoiceNumber       *string
	PurchaseOrderNumber *string
	CustomerOrderNumber *string
	BillOfLading        *string
	LineItemNumber      *string
	ReferenceNumber     *string
	ContainerNumber     *string
	ShipmentNumber      *string
	SealNumber          *string
	BookingNumber       *string
	MasterBillOfLading  *string
	HouseBillOfLading   *string
	ProNumber           *string
	TrackingNumber      *string
	PackageNumber       *string
}

Metadata represents metadata information

type Reference

type Reference struct {
	Id          string  // Unique identifier for the reference for internal usage only.
	NameOrCode  string  // Name or code to relay to the consumer of what the reference may be for.
	Description *string // Description of the reference that tells more about the name or code that is implied.
	Value       string  // Any data that can be used by the end user to find information. JSON, XML, URLs, etc.
}

ReferenceModel represents a reference to a model that can be used to identify a company, organization, or individual.

type Temperature

type Temperature struct {
	Value float64 // The temperature value
	Unit  string  // The unit of the temperature
}

type TransportationMode

type TransportationMode int
const (
	Air TransportationMode = iota
	Ocean
	Rail
	LTL
	FTL
	VLTL
	Multimodal
	Intermodal
	Parcel
	Drayage
	RollOnRollOff
	LoadOnLoadOff
	BreakBulk
)

TransportationMode represents the mode of transportation used to move goods from one location to another. See: https://kb.freightcms.com/modes/

type Volume

type Volume struct {
	Value float64 // The volume value
	Unit  string  // The unit of the volume
}

type Weight

type Weight struct {
	Value float64 // The weight value
	Unit  string  // The unit of the weight. Possible values are: "kg", "lb"
}

WeightModel represents a model for weight

Jump to

Keyboard shortcuts

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