locationep

type BulkUpsertLocationsEndpoint struct{}

type BulkUpsertLocationsRequest struct {
	// Locations to create or update, matched by name within the account.
	Locations []UpsertLocationInput `json:"locations" validate:"required,min=1,max=1000,dive"`
}

type CreateLocationEndpoint struct{}

type CreateLocationRequest struct {
	// Display name of the location.
	//
	// Maximum 255 characters.
	Name string `json:"name" validate:"required,max=255"`
	// This location's level in the storage hierarchy.
	//
	// The levels run from largest to smallest: `building`, `section`, `aisle`, `rack`, `shelf`, `bin`. They are descriptive labels rather than a rule — the parent you choose is not required to be the next level up.
	TypeCode constants.LocationTypeCode `json:"type" validate:"required"`
	// The location this one sits under in the storage hierarchy.
	//
	// Must be an existing location in your account. Omit to create a top-level location.
	ParentID field.Optional[string] `json:"parent_id,omitzero"`
	// Existing locations to attach beneath the new location.
	//
	// Each listed location is reparented onto the new location, detaching it from its current parent. Every ID must belong to your account.
	ChildIDs field.Optional[[]string] `json:"child_ids,omitzero"`
}

type DeleteLocationEndpoint struct{}

type DeleteLocationRequest struct {
	// Location ID.
	LocationID string `path:"id" validate:"required"`
}

type ExportLocationsEndpoint struct{}

type ExportLocationsRequest struct {
	// Free-text search term matched against location names.
	Query *string `json:"q"`
}

type ListLocationTypesEndpoint struct{}

type ListLocationTypesRequest struct {
	apiresource.PaginationRequest
}

type ListLocationsEndpoint struct{}

type ListLocationsRequest struct {
	apiresource.PaginationRequest
}

type LocationSvc interface {
	ListLocations(ctx context.Context, req *ListLocationsRequest) (*apiresource.List[apiresource.Location], *apierror.APIError)
	ExportLocations(ctx context.Context, req *ExportLocationsRequest) (*apiresource.Job, *apierror.APIError)
	GetLocation(ctx context.Context, req *RetrieveLocationRequest) (*apiresource.Location, *apierror.APIError)
	CreateLocation(ctx context.Context, req *CreateLocationRequest) (*apiresource.Location, *apierror.APIError)
	UpdateLocation(ctx context.Context, req *UpdateLocationRequest) (*apiresource.Location, *apierror.APIError)
	DeleteLocation(ctx context.Context, req *DeleteLocationRequest) (*apiresource.EmptyResource, *apierror.APIError)
	BulkUpsertLocations(ctx context.Context, req *BulkUpsertLocationsRequest) (*apiresource.Job, *apierror.APIError)
	ListLocationTypes(ctx context.Context, req *ListLocationTypesRequest) (*apiresource.List[apiresource.LocationType], *apierror.APIError)
	GetLocationType(ctx context.Context, req *RetrieveLocationTypeRequest) (*apiresource.LocationType, *apierror.APIError)
}

type LocationSvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}

type RetrieveLocationEndpoint struct{}

type RetrieveLocationRequest struct {
	// Location ID.
	LocationID string `path:"id" validate:"required"`
}

type RetrieveLocationTypeEndpoint struct{}

type RetrieveLocationTypeRequest struct {
	// Location type ID or code, such as `building` or `bin`.
	Identifier string `path:"id" validate:"required"`
}

type UpdateLocationEndpoint struct{}

type UpdateLocationRequest struct {
	// Location ID.
	LocationID string `path:"id" validate:"required"`
	// Display name of the location.
	//
	// Maximum 255 characters.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// This location's level in the storage hierarchy.
	//
	// The levels run from largest to smallest: `building`, `section`, `aisle`, `rack`, `shelf`, `bin`. They are descriptive labels rather than a rule — the parent is not required to be the next level up.
	TypeCode field.Optional[constants.LocationTypeCode] `json:"type,omitzero"`
	// The location this one sits under in the storage hierarchy.
	//
	// Must be an existing location in your account, and cannot be the location being updated. Send `null` to detach it from its parent and make it a top-level location.
	ParentID field.Clearable[string] `json:"parent_id,omitzero" validate:"omitempty"`
	// The locations that sit directly beneath this one.
	//
	// This replaces the full set of children: current children that are not listed are detached and become top-level locations, and listed locations are reparented onto this location. Send `null` to detach every child. Omit the field to leave the existing children untouched.
	ChildIDs field.Clearable[[]string] `json:"child_ids,omitzero"`
}

type UpsertLocationInput struct {
	// Display name of the location, used to match existing locations.
	Name string `json:"name" validate:"required,max=255"`
	// Location type code.
	TypeCode constants.LocationTypeCode `json:"type" validate:"required"`
	// Parent location, referenced by `id` or `name`, or by name for a location in the same
	// batch. Omitted, a new location is top-level and an existing one keeps its parent.
	Parent *apirequest.ObjectIdentifier `json:"parent,omitempty"`
	// Child locations to re-parent under this one, referenced by `id` or `name`, or by name
	// for a location in the same batch. Redundant with `parent` on each child.
	Children []apirequest.ObjectIdentifier `json:"children,omitempty"`
}