consumptionep

type ConsumptionSvc interface {
	GetConsumption(ctx context.Context, req *RetrieveConsumptionRequest) (*apiresource.Consumption, *apierror.APIError)
	CreateConsumption(ctx context.Context, req *CreateConsumptionRequest) (*apiresource.Consumption, *apierror.APIError)
	UpdateConsumption(ctx context.Context, req *UpdateConsumptionRequest) (*apiresource.Consumption, *apierror.APIError)
	DeleteConsumption(ctx context.Context, req *DeleteConsumptionRequest) (*apiresource.Consumption, *apierror.APIError)
}

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

type CreateConsumptionEndpoint struct{}

type CreateConsumptionRequest struct {
	// ID of the production step that consumes the material.
	ProductionStepID string `path:"production_step_id" validate:"required"`
	// ID of the item to consume.
	ItemID string `json:"item_id" validate:"required"`
	// Amount of the item consumed, as a decimal string.
	//
	// Stated against the step's own output rather than a single unit, so a step producing 100 pairs that consumes 5 kg of yarn takes `5`. Material requirements for an order scale it from there.
	QuantityValue string `json:"quantity_value" validate:"required"`
	// ID of the unit of measure for `quantity_value`.
	QuantityUnitID string `json:"quantity_unit_id" validate:"required"`
	// Amount of the item expected to be lost as waste, as a decimal string.
	//
	// Tracked separately from the consumed quantity, but added to it when material requirements are worked out, since the waste has to be bought as well.
	WasteQuantityValue string `json:"waste_quantity_value" validate:"required"`
	// ID of the unit of measure for `waste_quantity_value`.
	WasteQuantityUnitID string `json:"waste_quantity_unit_id" validate:"required"`
	// Instructions for how this material is consumed.
	Instructions field.Optional[string] `json:"instructions,omitzero"`
}

type DeleteConsumptionEndpoint struct{}

type DeleteConsumptionRequest struct {
	// Production step ID.
	ProductionStepID string `path:"production_step_id" validate:"required"`
	// Consumption ID.
	ConsumptionID string `path:"id" validate:"required"`
}

type RetrieveConsumptionEndpoint struct{}

type RetrieveConsumptionRequest struct {
	// Production step ID.
	ProductionStepID string `path:"production_step_id" validate:"required"`
	// Consumption ID.
	ConsumptionID string `path:"id" validate:"required"`
}

type UpdateConsumptionEndpoint struct{}

type UpdateConsumptionRequest struct {
	// Production step ID.
	ProductionStepID string `path:"production_step_id" validate:"required"`
	// Consumption ID.
	ConsumptionID string `path:"id" validate:"required"`
	// ID of the item to consume.
	//
	// Changing the item disconnects any production-flow link based on the previous item and re-links the flow using the new item.
	ItemID field.Optional[string] `json:"item_id,omitzero" validate:"omitempty"`
	// Amount of the item consumed, as a decimal string.
	//
	// The consumed quantity only changes when this and `quantity_unit_id` are sent together; sending either one alone leaves it untouched.
	QuantityValue field.Optional[string] `json:"quantity_value,omitzero"`
	// ID of the unit of measure for `quantity_value`.
	//
	// Send it together with `quantity_value`, even when the unit is not changing.
	QuantityUnitID field.Optional[string] `json:"quantity_unit_id,omitzero" validate:"omitempty"`
	// Amount of the item expected to be lost as waste, as a decimal string.
	//
	// The waste quantity only changes when this and `waste_quantity_unit_id` are sent together; sending either one alone leaves it untouched.
	WasteQuantityValue field.Optional[string] `json:"waste_quantity_value,omitzero"`
	// ID of the unit of measure for `waste_quantity_value`.
	//
	// Send it together with `waste_quantity_value`, even when the unit is not changing.
	WasteQuantityUnitID field.Optional[string] `json:"waste_quantity_unit_id,omitzero" validate:"omitempty"`
	// Instructions for how this material is consumed.
	Instructions field.Optional[string] `json:"instructions,omitzero"`
}