roadie

type Address struct {
	// Name is the name of the location if applicable. This helpful for the driver if the location is a business. Max length 200 characters
	Name string
	// StoreNumber is the store identifier, if the address is a retail location. Max length 20 characters
	StoreNumber string
	// Street1 is the first line of the address. Max length 200 characters (required)
	Street1 string
	// Street2 is the first line of the address. Max length 200 characters
	Street2 string
	// City is the city. Max length 200 characters (required)
	City string
	// State is the two letter state code (required)
	State string
	// Zip is the postal code. Max length 10 characters (required)
	Zip string
	// Latitude us tge exact pickup/delivery latitude
	Latitude float32
	// Longitude is the exact pickup/delivery longitude
	Longitude float32
}

type CancelShipmentRequest struct {
	// CancellationCode is the cancellation code matching the reason for the cancellation
	CancellationCode string
	// CancellationComment is an additional comment explaining the cancellation reason
	CancellationComment string
}

type Client struct {

	// Estimates is the service used to create estimates
	Estimates *EstimateService
	// Shipments is the service used to interact with shipments
	Shipments *ShipmentsService
	// contains filtered or unexported fields
}

type Contact struct {
	// Name is the name of the contact. Max length 200 characters (required)
	Name string
	// Phone is the phone number of the contact. Max length 10 characters (required)
	Phone string
}

type CreateEstimateRequest struct {
	// Items is an array of one or more item (required)
	Items []Item
	// PickupLocation is a location object (required)
	PickupLocation Location
	// DeliveryLocation is a location object (required)
	DeliveryLocation Location
	// PickupAfter is the time when the shipment is ready for pickup
	PickupAfter time.Time
	// DeliverBetween is the window within which the shipment must be complete
	DeliverBetween TimeWindow
}

type CreateEstimateResponse struct {
	// Price is the estimated price
	Price float32
	// Size is the size category
	Size string
	// Estimated distance is the estimated distance between pickup and delivery
	EstimatedDistance float32
	// Errors contains any errors returned from the API
	Errors ErrorResponse
}

type CreateShipmentRequest struct {
	// ReferenceId is the user supplied ID for the shipment. Max length 100 characters (required)
	ReferenceId string
	// IdempotencyKey is a unique value generated by the user which the Roadie system will use to recognize subsequent retries of the same request.
	// Duplicate requests with the same idempotency_key value will yield a 409 conflict response after the first successful 200 response.
	// Can only be supplied when creating a shipment.
	IdempotencyKey string
	// AlternateId1 is the user-supplied alternate identifier 1
	AlternateId1 string
	// AlternateId2 is the user-supplied alternate identifier 2
	AlternateId2 string
	// Description is a general description for the shipment, often containing important information for the driver. This field is globally visible to all users on the platform.
	// Max length 600 characters
	Description string
	// Items is an array of one or more item (required)
	Items []Item
	// PickupLocation is a complete location object (required)
	PickupLocation Location
	// DeliveryLocation is a complete location object (required)
	DeliveryLocation Location
	// PickupAfter is the time when the shipment is ready for pickup (required)
	PickupAfter time.Time
	// DeliverBetween is the window within which the shipment must be completed
	DeliverBetween TimeWindow
	// Options is any delivery options for the shipment
	Options DeliveryOptions
}

type CreateShipmentResponse struct {
	// Id is the id of the shipment, generated by roadie
	Id int64
	// ReferenceId is the user supplied ID for the shipment. Max length 100 characters (required)
	ReferenceId string
	// State is the state of the shipment
	State string
	// AlternateId1 is the user-supplied alternate identifier 1
	AlternateId1 string
	// AlternateId2 is the user-supplied alternate identifier 2
	AlternateId2 string
	// Description is a general description for the shipment, often containing important information for the driver. This field is globally visible to all users on the platform.
	// Max length 600 characters
	Description string
	// Items is an array of one or more item (required)
	Items []Item
	// PickupLocation is a complete location object (required)
	PickupLocation Location
	// DeliveryLocation is a complete location object (required)
	DeliveryLocation Location
	// PickupAfter is the time when the shipment is ready for pickup (required)
	PickupAfter time.Time
	// DeliverBetween is the window within which the shipment must be completed
	DeliverBetween TimeWindow
	// Options is any delivery options for the shipment
	Options DeliveryOptions
	// TrackingNumber is the tracking number associated with the shipment
	TrackingNumber string
	// Price is the price of the shipment
	Price float32
	// EstimatedDistance is the estimated distance of the shipment
	EstimatedDistance float32
	// Events is an array of shipment events associated with the shipment
	Events []ShipmentEvent
	// CreatedAt is the timestamp the shipment was created
	CreatedAt time.Time
	// UpdatedAt is the timestamp of the shipment's most recent update
	UpdatedAt time.Time
	// Errors contains any errors returned from the API
	Errors ErrorResponse
}

type DeliveryOptions struct {
	// SignatureRequired indicates whether driver must receive a signature from the recipient (required)
	SignatureRequired bool
	// NotificationsEnabled indicates whether the recipient should receive SMS updates for their delivery
	NotificationsEnables bool
	// Over21Required indicates if the driver must be over 21 to be eligible to deliver the item (typically for alcohol deliveries)
	Over21Required bool
	// ExtraCompensation is the additional compensation for the driver prior to assignment
	ExtraCompensation float32
	// TrailerRequired indicates if the driver must use a trailer to deliver the item(s)
	TrailerRequired bool
}

type Driver struct {
	// Name is the driver's name
	Name string
	// Phone is the driver's phone number
	Phone string
}

type ErrBadRequest struct{}

type ErrForbidden struct{}

type ErrGone struct{}

type ErrInternalServerError struct{}

type ErrMethodNotAllowed struct{}

type ErrNotAcceptable struct{}

type ErrNotFound struct{}

type ErrServiceUnavailable struct{}

type ErrTooManyRequests struct{}

type ErrUnauthorized struct{}

type Error struct {
	// Code is the roadie error code corresponding to the specific issue
	Code int
	// Parameter is the request parameter that is problematic
	Parameter string
	// Message is a message describing the issue
	Message string
}

type ErrorResponse struct {
	// Errors is an array of error objects
	Errors []Error
}

type EstimateService service

type GetShipmentResponse CreateShipmentResponse

type Item struct {
	// Length is the length in inches of the item
	Length float32
	// Width is the width in inches of the item
	Width float32
	// Height is the height in inches of the item
	Height float32
	// Weight is the weight in pounds of the item
	Weight float32
	// Quantity is the number of items included in the shipment
	Quantity int
	// Value is the monetary value of the item
	Value float32
	// Description is the description of the item. Max length 200 characters
	Description string
	// ReferenceId is the user supplied ID for the item. Max length 100 characters
	ReferenceId string
}

type LeaveTipRequest struct {
	// Amount is the amount of tip to leave
	Amount float32
}

type LeaveTipResponse struct {
	// Amount is the amount of tip to leave
	Amount float32
	// Errors contains any errors returned from the API
	Errors ErrorResponse
}

type Location struct {
	// Address is the address information (required)
	Address Address
	// Contact is the contact information (required for shipment)
	Contact Contact
	// Notes is any additional information the drivers needs regarding the location. Max length 500 characters
	Notes string
}

type RateDriverRequest struct {
	Value int
}

type RateDriverResponse struct {
	// Value is the value of the rating to give the driver
	Value int
	// Errors contains any errors returned from the API
	Errors ErrorResponse
}

type ShipmentEvent struct {
	// Name is the name of the event type
	Name string
	// OccurredAt is the time when the event occurred
	OccurredAt time.Time
	// Location is the location of the event
	Location Location
}

type ShipmentsService service

type TimeWindow struct {
	// Start is the start of the window in RFC 3339 format (required)
	Start time.Time
	// End is the end of the window in RFC 3339 format (required)
	End time.Time
}

type UpdateShipmentRequest struct {
	// ReferenceId is the reference id of the shipment to update
	ReferenceId string
	// AlternateId1 is the user-supplied alternate identifier 1
	AlternateId1 string
	// AlternateId2 is the user-supplied alternate identifier 2
	AlternateId2 string
	// Description is a general description for the shipment, often containing important information for the driver. This field is globally visible to all users on the platform.
	// Max length 600 characters
	Description string
	// Items is an array of one or more item (required)
	Items []Item
	// PickupLocation is a complete location object (required)
	PickupLocation Location
	// DeliveryLocation is a complete location object (required)
	DeliveryLocation Location
	// PickupAfter is the time when the shipment is ready for pickup (required)
	PickupAfter time.Time
	// DeliverBetween is the window within which the shipment must be completed
	DeliverBetween TimeWindow
	// Options is any delivery options for the shipment
	Options DeliveryOptions
	// TrackingNumber is the tracking number associated with the shipment
	Events []ShipmentEvent
}

type UpdateShipmentResponse CreateShipmentResponse