repositories

Documentation

Index

• type AssignmentOptions
• type AssignmentRepository
• type AssignmentResponse
• type AuditRepository
• type CancelShipmentRequest
• type CommodityRepository
• type CustomerRepository
• type DocumentQualityConfigRepository
• type EquipmentManufacturerRepository
• type EquipmentTypeRepository
• type FleetCodeRepository
• type GetCommodityByIDOptions
• type GetCustomerByIDOptions
• type GetDocumentQualityConfigOptions
• type GetEquipManufacturerByIDOptions
• type GetEquipmentTypeByIDOptions
• type GetFleetCodeByIDOptions
• type GetHazardousMaterialByIDOptions
• type GetLocationByIDOptions
• type GetLocationCategoryByIDOptions
• type GetMoveByIDOptions
• type GetOrgByIDOptions
• type GetPCMilerConfigurationOptions
• type GetServiceTypeByIDOptions
• type GetShipmentByIDOptions
• type GetShipmentTypeByIDOptions
• type GetTractorByIDOptions
• type GetTrailerByIDOptions
• type GetUserByIDOptions
• type GetWorkerByIDOptions
• type HazardousMaterialRepository
• type HazmatExpirationRepository
• type ListCustomerOptions
• type ListFleetCodeOptions
• type ListLocationOptions
• type ListShipmentOptions
• type ListTableConfigurationResult
• type ListTractorOptions
• type ListTrailerOptions
• type ListWorkerOptions
• type LocationCategoryRepository
• type LocationRepository
• type OrganizationRepository
• type PCMilerConfigurationRepository
• type PermissionCacheRepository
• type PermissionRepository
• type ServiceTypeRepository
• type SessionRepository
• type ShipmentMoveRepository
• type ShipmentOptions
• type ShipmentRepository
• type ShipmentTypeRepository
• type TableConfigurationFilters
• type TableConfigurationRepository
• type TractorRepository
• type TrailerRepository
• type UpdateStatusOptions
• type UpdateWorkerOptions
• type UsStateCacheRepository
• type UsStateRepository
• type UserRepository
• type WorkerRepository

Types

type AssignmentOptions

type AssignmentOptions struct {
	TractorID pulid.ID `json:"tractorId"`
	OrgID     pulid.ID `json:"orgId"`
	BuID      pulid.ID `json:"buId"`
}

type AssignmentRepository

type AssignmentRepository interface {
	SingleAssign(ctx context.Context, a *shipment.Assignment) (*shipment.Assignment, error)
}

type AssignmentResponse

type AssignmentResponse struct {
	PrimaryWorkerID   pulid.ID  `json:"primaryWorkerId"`
	SecondaryWorkerID *pulid.ID `json:"secondaryWorkerId"`
}

type AuditRepository

type AuditRepository interface {
	InsertAuditEntries(ctx context.Context, entries []*audit.Entry) error
}

type CancelShipmentRequest

type CancelShipmentRequest struct {
	ShipmentID   pulid.ID `json:"shipmentId"`
	OrgID        pulid.ID `json:"orgId"`
	BuID         pulid.ID `json:"buId"`
	CanceledByID pulid.ID `json:"canceledById"`
	CanceledAt   int64    `json:"canceledAt"`
	CancelReason string   `json:"cancelReason"`
}

type CommodityRepository

type CommodityRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*commodity.Commodity], error)
	GetByID(ctx context.Context, opts GetCommodityByIDOptions) (*commodity.Commodity, error)
	Create(ctx context.Context, c *commodity.Commodity) (*commodity.Commodity, error)
	Update(ctx context.Context, c *commodity.Commodity) (*commodity.Commodity, error)
}

type CustomerRepository

type CustomerRepository interface {
	List(ctx context.Context, opts *ListCustomerOptions) (*ports.ListResult[*customer.Customer], error)
	GetByID(ctx context.Context, opts GetCustomerByIDOptions) (*customer.Customer, error)
	Create(ctx context.Context, c *customer.Customer) (*customer.Customer, error)
	Update(ctx context.Context, c *customer.Customer) (*customer.Customer, error)
}

type DocumentQualityConfigRepository

type DocumentQualityConfigRepository interface {
	Get(ctx context.Context, opts *GetDocumentQualityConfigOptions) (*documentqualityconfig.DocumentQualityConfig, error)
	Update(ctx context.Context, dqc *documentqualityconfig.DocumentQualityConfig) (*documentqualityconfig.DocumentQualityConfig, error)
}

type EquipmentManufacturerRepository

type EquipmentManufacturerRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*equipmentmanufacturer.EquipmentManufacturer], error)
	GetByID(ctx context.Context, opts GetEquipManufacturerByIDOptions) (*equipmentmanufacturer.EquipmentManufacturer, error)
	Create(ctx context.Context, em *equipmentmanufacturer.EquipmentManufacturer) (*equipmentmanufacturer.EquipmentManufacturer, error)
	Update(ctx context.Context, em *equipmentmanufacturer.EquipmentManufacturer) (*equipmentmanufacturer.EquipmentManufacturer, error)
}

type EquipmentTypeRepository

type EquipmentTypeRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*equipmenttype.EquipmentType], error)
	GetByID(ctx context.Context, opts GetEquipmentTypeByIDOptions) (*equipmenttype.EquipmentType, error)
	Create(ctx context.Context, et *equipmenttype.EquipmentType) (*equipmenttype.EquipmentType, error)
	Update(ctx context.Context, et *equipmenttype.EquipmentType) (*equipmenttype.EquipmentType, error)
}

type FleetCodeRepository

type FleetCodeRepository interface {
	List(ctx context.Context, opts *ListFleetCodeOptions) (*ports.ListResult[*fleetcode.FleetCode], error)
	GetByID(ctx context.Context, opts GetFleetCodeByIDOptions) (*fleetcode.FleetCode, error)
	Create(ctx context.Context, fc *fleetcode.FleetCode) (*fleetcode.FleetCode, error)
	Update(ctx context.Context, fc *fleetcode.FleetCode) (*fleetcode.FleetCode, error)
}

type GetCommodityByIDOptions

type GetCommodityByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetCustomerByIDOptions

type GetCustomerByIDOptions struct {
	ID           pulid.ID
	OrgID        pulid.ID
	BuID         pulid.ID
	UserID       pulid.ID
	IncludeState bool `query:"includeState"`
}

type GetDocumentQualityConfigOptions

type GetDocumentQualityConfigOptions struct {
	OrgID pulid.ID
	BuID  pulid.ID
	// UserID is the ID of the user making the request
	UserID pulid.ID
}

type GetEquipManufacturerByIDOptions

type GetEquipManufacturerByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetEquipmentTypeByIDOptions

type GetEquipmentTypeByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetFleetCodeByIDOptions

type GetFleetCodeByIDOptions struct {
	ID                    pulid.ID
	OrgID                 pulid.ID
	BuID                  pulid.ID
	UserID                pulid.ID
	IncludeManagerDetails bool `query:"includeManagerDetails"`
}

type GetHazardousMaterialByIDOptions

type GetHazardousMaterialByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetLocationByIDOptions

type GetLocationByIDOptions struct {
	ID              pulid.ID
	OrgID           pulid.ID
	BuID            pulid.ID
	UserID          pulid.ID
	IncludeCategory bool `query:"includeCategory"`
	IncludeState    bool `query:"includeState"`
}

type GetLocationCategoryByIDOptions

type GetLocationCategoryByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetMoveByIDOptions

type GetMoveByIDOptions struct {
	// ID of the move
	MoveID pulid.ID

	// ID of the organization
	OrgID pulid.ID

	// ID of the business unit
	BuID pulid.ID
}

type GetOrgByIDOptions

type GetOrgByIDOptions struct {
	// ID of the organization
	OrgID pulid.ID

	// ID of the business unit
	BuID pulid.ID

	// IncludeState includes the state in the response
	IncludeState bool

	// IncludeBu includes the business unit in the response
	IncludeBu bool
}

type GetPCMilerConfigurationOptions

type GetPCMilerConfigurationOptions struct {
	OrgID pulid.ID
	BuID  pulid.ID
}

type GetServiceTypeByIDOptions

type GetServiceTypeByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetShipmentByIDOptions

type GetShipmentByIDOptions struct {
	ID              pulid.ID
	OrgID           pulid.ID
	BuID            pulid.ID
	UserID          pulid.ID
	ShipmentOptions ShipmentOptions
}

type GetShipmentTypeByIDOptions

type GetShipmentTypeByIDOptions struct {
	ID     pulid.ID
	OrgID  pulid.ID
	BuID   pulid.ID
	UserID pulid.ID
}

type GetTractorByIDOptions

type GetTractorByIDOptions struct {
	ID                      pulid.ID
	OrgID                   pulid.ID
	BuID                    pulid.ID
	UserID                  pulid.ID
	IncludeWorkerDetails    bool `query:"includeWorkerDetails"`
	IncludeEquipmentDetails bool `query:"includeEquipmentDetails"`
	IncludeFleetDetails     bool `query:"includeFleetDetails"`
}

type GetTrailerByIDOptions

type GetTrailerByIDOptions struct {
	ID                      pulid.ID
	OrgID                   pulid.ID
	BuID                    pulid.ID
	UserID                  pulid.ID
	IncludeEquipmentDetails bool `query:"includeEquipmentDetails"`
	IncludeFleetDetails     bool `query:"includeFleetDetails"`
}

type GetUserByIDOptions

type GetUserByIDOptions struct {
	OrgID        pulid.ID
	BuID         pulid.ID
	UserID       pulid.ID
	IncludeRoles bool
	IncludeOrgs  bool
}

type GetWorkerByIDOptions

type GetWorkerByIDOptions struct {
	WorkerID       pulid.ID
	BuID           pulid.ID
	OrgID          pulid.ID
	UserID         pulid.ID
	IncludeProfile bool
	IncludePTO     bool
}

type HazardousMaterialRepository

type HazardousMaterialRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*hazardousmaterial.HazardousMaterial], error)
	GetByID(ctx context.Context, opts GetHazardousMaterialByIDOptions) (*hazardousmaterial.HazardousMaterial, error)
	Create(ctx context.Context, hm *hazardousmaterial.HazardousMaterial) (*hazardousmaterial.HazardousMaterial, error)
	Update(ctx context.Context, hm *hazardousmaterial.HazardousMaterial) (*hazardousmaterial.HazardousMaterial, error)
}

type HazmatExpirationRepository

type HazmatExpirationRepository interface {
	GetHazmatExpirationByStateID(ctx context.Context, stateID pulid.ID) (*compliance.HazmatExpiration, error)
}

type ListCustomerOptions

type ListCustomerOptions struct {
	Filter       *ports.LimitOffsetQueryOptions
	IncludeState bool `query:"includeState"`
}

type ListFleetCodeOptions

type ListFleetCodeOptions struct {
	Filter                *ports.LimitOffsetQueryOptions
	IncludeManagerDetails bool `query:"includeManagerDetails"`
}

type ListLocationOptions

type ListLocationOptions struct {
	Filter          *ports.LimitOffsetQueryOptions
	IncludeCategory bool `query:"includeCategory"`
	IncludeState    bool `query:"includeState"`
}

type ListShipmentOptions

type ListShipmentOptions struct {
	Filter          *ports.LimitOffsetQueryOptions
	ShipmentOptions ShipmentOptions
}

type ListTableConfigurationResult

type ListTableConfigurationResult struct {
	Configurations []*tableconfiguration.Configuration
	Total          int
}

type ListTractorOptions

type ListTractorOptions struct {
	Filter                  *ports.LimitOffsetQueryOptions
	IncludeWorkerDetails    bool `query:"includeWorkerDetails"`
	IncludeEquipmentDetails bool `query:"includeEquipmentDetails"`
	IncludeFleetDetails     bool `query:"includeFleetDetails"`
}

type ListTrailerOptions

type ListTrailerOptions struct {
	Filter                  *ports.LimitOffsetQueryOptions
	IncludeEquipmentDetails bool `query:"includeEquipmentDetails"`
	IncludeFleetDetails     bool `query:"includeFleetDetails"`
}

type ListWorkerOptions

type ListWorkerOptions struct {
	Filter         *ports.LimitOffsetQueryOptions
	IncludeProfile bool `query:"includeProfile"`
	IncludePTO     bool `query:"includePTO"`
}

type LocationCategoryRepository

type LocationCategoryRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*location.LocationCategory], error)
	GetByID(ctx context.Context, opts GetLocationCategoryByIDOptions) (*location.LocationCategory, error)
	Create(ctx context.Context, lc *location.LocationCategory) (*location.LocationCategory, error)
	Update(ctx context.Context, lc *location.LocationCategory) (*location.LocationCategory, error)
}

type LocationRepository

type LocationRepository interface {
	List(ctx context.Context, opts *ListLocationOptions) (*ports.ListResult[*location.Location], error)
	GetByID(ctx context.Context, opts GetLocationByIDOptions) (*location.Location, error)
	Create(ctx context.Context, l *location.Location) (*location.Location, error)
	Update(ctx context.Context, l *location.Location) (*location.Location, error)
}

type OrganizationRepository

type OrganizationRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*organization.Organization], error)
	GetByID(ctx context.Context, opts GetOrgByIDOptions) (*organization.Organization, error)
	Create(ctx context.Context, org *organization.Organization) (*organization.Organization, error)
	Update(ctx context.Context, org *organization.Organization) (*organization.Organization, error)
	SetLogo(ctx context.Context, org *organization.Organization) (*organization.Organization, error)
	ClearLogo(ctx context.Context, org *organization.Organization) (*organization.Organization, error)
	GetUserOrganizations(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*organization.Organization], error)
}

type PCMilerConfigurationRepository

type PCMilerConfigurationRepository interface {
	GetPCMilerConfiguration(ctx context.Context, opts GetPCMilerConfigurationOptions) (*pcmilerconfiguration.PCMilerConfiguration, error)
}

type PermissionCacheRepository

type PermissionCacheRepository interface {
	GetUserRoles(ctx context.Context, userID pulid.ID) ([]*string, error)
	SetUserRoles(ctx context.Context, userID pulid.ID, roles []*string) error
	GetUserPermissions(ctx context.Context, userID pulid.ID) ([]*permission.Permission, error)
	SetUserPermissions(ctx context.Context, userID pulid.ID, permissions []*permission.Permission) error
	InvalidateUserRoles(ctx context.Context, userID pulid.ID) error
	InvalidateUserPermissions(ctx context.Context, userID pulid.ID) error
	InvalidateAllUserData(ctx context.Context, userID pulid.ID) error
}

type PermissionRepository

type PermissionRepository interface {
	GetUserPermissions(ctx context.Context, userID pulid.ID) ([]*permission.Permission, error)
	GetUserRoles(ctx context.Context, userID pulid.ID) ([]*string, error)
	GetRolesAndPermissions(ctx context.Context, userID pulid.ID) (*permission.RolesAndPermissions, error)
}

type ServiceTypeRepository

type ServiceTypeRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*servicetype.ServiceType], error)
	GetByID(ctx context.Context, opts GetServiceTypeByIDOptions) (*servicetype.ServiceType, error)
	Create(ctx context.Context, st *servicetype.ServiceType) (*servicetype.ServiceType, error)
	Update(ctx context.Context, st *servicetype.ServiceType) (*servicetype.ServiceType, error)
}

type SessionRepository

type SessionRepository interface {
	Create(ctx context.Context, session *session.Session) error
	GetValidSession(ctx context.Context, sessionID pulid.ID, clientIP string) (*session.Session, error)
	GetUserActiveSessions(ctx context.Context, userID pulid.ID) ([]*session.Session, error)
	UpdateSessionActivity(ctx context.Context, sessionID pulid.ID, clientIP, userAgent string, eventType session.EventType, metadata map[string]any) error
	RevokeSession(ctx context.Context, sessionID pulid.ID, ip, userAgent, reason string) error
}

type ShipmentMoveRepository

type ShipmentMoveRepository interface {
	GetByID(ctx context.Context, opts GetMoveByIDOptions) (*shipment.ShipmentMove, error)
	UpdateStatus(ctx context.Context, opts UpdateStatusOptions) (*shipment.ShipmentMove, error)
}

type ShipmentOptions

type ShipmentOptions struct {
	ExpandShipmentDetails bool `query:"expandShipmentDetails"`
}

type ShipmentRepository

type ShipmentRepository interface {
	List(ctx context.Context, opts *ListShipmentOptions) (*ports.ListResult[*shipment.Shipment], error)
	GetByID(ctx context.Context, opts GetShipmentByIDOptions) (*shipment.Shipment, error)
	Create(ctx context.Context, t *shipment.Shipment) (*shipment.Shipment, error)
	Update(ctx context.Context, t *shipment.Shipment) (*shipment.Shipment, error)
	Cancel(ctx context.Context, req *CancelShipmentRequest) (*shipment.Shipment, error)
}

type ShipmentTypeRepository

type ShipmentTypeRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*shipmenttype.ShipmentType], error)
	GetByID(ctx context.Context, opts GetShipmentTypeByIDOptions) (*shipmenttype.ShipmentType, error)
	Create(ctx context.Context, st *shipmenttype.ShipmentType) (*shipmenttype.ShipmentType, error)
	Update(ctx context.Context, st *shipmenttype.ShipmentType) (*shipmenttype.ShipmentType, error)
}

type TableConfigurationFilters

type TableConfigurationFilters struct {
	Base            *ports.FilterQueryOptions
	TableIdentifier string
	CreatedBy       pulid.ID
	Visibility      *tableconfiguration.Visibility
	IsDefault       *bool
	Search          string
	UserID          pulid.ID
	// Include relationships
	IncludeShares  bool
	IncludeCreator bool
}

TableConfigurationFilters defines filters for querying configurations

type TableConfigurationRepository

type TableConfigurationRepository interface {
	GetByID(ctx context.Context, id pulid.ID, opts *TableConfigurationFilters) (*tableconfiguration.Configuration, error)
	List(ctx context.Context, filters *TableConfigurationFilters) (*ListTableConfigurationResult, error)
	Create(ctx context.Context, config *tableconfiguration.Configuration) error
	Update(ctx context.Context, config *tableconfiguration.Configuration) error
	Delete(ctx context.Context, id pulid.ID) error
	GetUserConfigurations(ctx context.Context, tableID string, opts *TableConfigurationFilters) ([]*tableconfiguration.Configuration, error)
	ShareConfiguration(ctx context.Context, share *tableconfiguration.ConfigurationShare) error
	RemoveShare(ctx context.Context, configID pulid.ID, sharedWithID pulid.ID) error
}

type TractorRepository

type TractorRepository interface {
	Assignment(ctx context.Context, opts AssignmentOptions) (*AssignmentResponse, error)
	List(ctx context.Context, opts *ListTractorOptions) (*ports.ListResult[*tractor.Tractor], error)
	GetByID(ctx context.Context, opts GetTractorByIDOptions) (*tractor.Tractor, error)
	Create(ctx context.Context, t *tractor.Tractor) (*tractor.Tractor, error)
	Update(ctx context.Context, t *tractor.Tractor) (*tractor.Tractor, error)
}

type TrailerRepository

type TrailerRepository interface {
	List(ctx context.Context, opts *ListTrailerOptions) (*ports.ListResult[*trailer.Trailer], error)
	GetByID(ctx context.Context, opts GetTrailerByIDOptions) (*trailer.Trailer, error)
	Create(ctx context.Context, t *trailer.Trailer) (*trailer.Trailer, error)
	Update(ctx context.Context, t *trailer.Trailer) (*trailer.Trailer, error)
}

type UpdateStatusOptions

type UpdateStatusOptions struct {
	// Fetch the move
	GetMoveOpts GetMoveByIDOptions

	// Status of the move
	Status shipment.MoveStatus
}

type UpdateWorkerOptions

type UpdateWorkerOptions struct {
	OrgID pulid.ID
	BuID  pulid.ID
}

type UsStateCacheRepository

type UsStateCacheRepository interface {
	Get(ctx context.Context) (*ports.ListResult[*usstate.UsState], error)
	Set(ctx context.Context, states []*usstate.UsState) error
	Invalidate(ctx context.Context) error
}

type UsStateRepository

type UsStateRepository interface {
	List(ctx context.Context) (*ports.ListResult[*usstate.UsState], error)
	GetByAbbreviation(ctx context.Context, abbreviation string) (*usstate.UsState, error)
}

type UserRepository

type UserRepository interface {
	List(ctx context.Context, opts *ports.LimitOffsetQueryOptions) (*ports.ListResult[*user.User], error)
	FindByEmail(ctx context.Context, email string) (*user.User, error)
	GetByID(ctx context.Context, opts GetUserByIDOptions) (*user.User, error)
}

type WorkerRepository

type WorkerRepository interface {
	List(ctx context.Context, opts *ListWorkerOptions) (*ports.ListResult[*worker.Worker], error)
	GetByID(ctx context.Context, opts GetWorkerByIDOptions) (*worker.Worker, error)
	Create(ctx context.Context, wrk *worker.Worker) (*worker.Worker, error)
	Update(ctx context.Context, wrk *worker.Worker) (*worker.Worker, error)
	GetWorkerPTO(ctx context.Context, ptoID, workerID, buID, orgID pulid.ID) (*worker.WorkerPTO, error)
}