productionstepep

type BulkCreateConsumptionInput struct {
	// SKU of the consumed material.
	SKU string `json:"sku" validate:"required"`
	// Quantity consumed, in the item's base unit.
	Measure float64 `json:"measure" validate:"required,gt=0"`
	// Instructions for this consumption.
	Instructions field.Optional[string] `json:"instructions,omitzero"`
}

type BulkCreateProductionOutputInput struct {
	// SKU of the produced item.
	SKU string `json:"sku" validate:"required"`
	// Quantity produced, in the item's base unit.
	Measure float64 `json:"measure" validate:"required,gt=0"`
}

type BulkCreateProductionStepInput struct {
	// Display name of the production step.
	//
	// Used to match existing steps: if a step with this name already exists in the account, that step is updated in place instead of creating a new one.
	Name string `json:"name" validate:"required"`
	// Materials consumed by the step, matched by SKU.
	Consumptions []BulkCreateConsumptionInput `json:"consumptions"`
	// Items produced by the step, matched by SKU.
	Productions []BulkCreateProductionOutputInput `json:"productions" validate:"required,min=1"`
	// Labor rate in dollars per hour.
	LaborRate float64 `json:"labor_rate" validate:"required,gt=0"`
	// Labor time required per unit of output.
	//
	// Recorded as `labor_time_unit` per one base unit of the first item in `productions`.
	LaborTime float64 `json:"labor_time" validate:"required,gt=0"`
	// Unit that `labor_time` is expressed in.
	//
	// One of `hr`, `min`, `minute`, `sec`, `second`, or `day`; a row naming anything else is skipped. Labor time is read as hours when this is omitted.
	LaborTimeUnit field.Optional[string] `json:"labor_time_unit,omitzero"`
	// Overhead rate in dollars per hour.
	OverheadRate float64 `json:"overhead_rate" validate:"required,gt=0"`
	// Allowance correction factor applied to labor time in cost calculations.
	//
	// When omitted, no allowance adjustment is applied.
	Allowances field.Optional[float64] `json:"allowances,omitzero"`
	// Leveling correction factor applied to labor time in cost calculations.
	//
	// When omitted, no leveling adjustment is applied.
	LevelingFactor field.Optional[float64] `json:"leveling_factor,omitzero"`
	// Name of an existing scanning station to assign to the step.
	//
	// Resolved by exact name; rows referencing an unknown station are skipped.
	Station field.Optional[string] `json:"station,omitzero"`
}

type BulkCreateProductionStepsEndpoint struct{}

type BulkCreateProductionStepsRequest struct {
	// Production steps to create or update.
	Steps []BulkCreateProductionStepInput `json:"steps" validate:"required"`
}

type BulkUpsertProductionStepsEndpoint struct{}

type BulkUpsertProductionStepsRequest struct {
	// Production steps to create or update, matched by name (case-insensitive) within
	// the account.
	ProductionSteps []UpsertProductionStepInput `json:"production_steps" validate:"required,min=1,max=1000,dive"`
}

type CreateConsumptionInput struct {
	// Material the step consumes.
	ItemID string `json:"item_id" validate:"required"`
	// Quantity value as a decimal string.
	QuantityValue string `json:"quantity_value" validate:"required"`
	// Unit for `quantity_value`.
	QuantityUnitID string `json:"quantity_unit_id" validate:"required"`
	// Quantity expected to be lost as scrap or waste, as a decimal string.
	WasteQuantityValue string `json:"waste_quantity_value" validate:"required"`
	// Unit 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 CreateProductionInput struct {
	// Item the step produces.
	ItemID string `json:"item_id" validate:"required"`
	// Quantity value as a decimal string.
	QuantityValue string `json:"quantity_value" validate:"required"`
	// Unit for `quantity_value`.
	QuantityUnitID string `json:"quantity_unit_id" validate:"required"`
}

type CreateProductionStepEndpoint struct{}

type CreateProductionStepRequest struct {
	// Display name of the step.
	//
	// Must be unique within the account.
	Name string `json:"name" validate:"required,max=255"`
	// Free-form notes about the step.
	Notes field.Optional[string] `json:"notes,omitzero"`
	// Leveling correction factor applied to labor time in cost calculations, as a decimal string.
	//
	// Effective labor time per unit is `labor_time × (1 + leveling_factor) × (1 + allowances)`, so `0` applies no leveling correction.
	LevelingFactor string `json:"leveling_factor" validate:"required"`
	// Allowance correction factor applied to labor time in cost calculations, as a decimal string.
	//
	// Effective labor time per unit is `labor_time × (1 + leveling_factor) × (1 + allowances)`, so `0` applies no allowance.
	Allowances string `json:"allowances" validate:"required"`
	// Scanning station where batches at this step are scanned.
	ScanningStationID field.Optional[string] `json:"scanning_station_id,omitzero" validate:"omitempty"`
	// Department responsible for this step.
	DepartmentID field.Optional[string] `json:"department_id,omitzero" validate:"omitempty"`
	// Cost of labor for this step, expressed as a rate of currency per unit of time (e.g. `$` per `hr`).
	//
	// The numerator unit must be a currency and the denominator must not be.
	LaborRate CreateRateInput `json:"labor_rate" validate:"required"`
	// Labor duration for this step, expressed as a rate (e.g. time per unit of output).
	LaborTime CreateRateInput `json:"labor_time" validate:"required"`
	// Overhead cost for this step, expressed as a rate of currency per unit of time (e.g. `$` per `hr`).
	//
	// The numerator unit must be a currency and the denominator must not be.
	OverheadRate CreateRateInput `json:"overhead_rate" validate:"required"`
	// The item and quantity this step produces.
	Production CreateProductionInput `json:"production" validate:"required"`
	// Materials consumed by the step.
	Consumptions []CreateConsumptionInput `json:"consumptions,omitzero"`
}

type CreateRateInput struct {
	// Value as a decimal string.
	Value string `json:"value" validate:"required"`
	// Unit of the rate's numerator.
	NumeratorUnitID string `json:"numerator_unit_id" validate:"required"`
	// Unit of the rate's denominator.
	DenominatorUnitID string `json:"denominator_unit_id" validate:"required"`
}

type DeleteProductionStepEndpoint struct{}

type DeleteProductionStepRequest struct {
	// Production step ID.
	ProductionStepID string `path:"id" validate:"required"`
}

type ExportProductionStepsEndpoint struct{}

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

type ListProductionStepsEndpoint struct{}

type ListProductionStepsRequest struct {
	apiresource.PaginationRequest
	// Only return steps that produce or consume any of these items.
	ItemIDs []string `query:"item_ids"`
	// Only return steps with any of these machines assigned.
	MachineIDs []string `query:"machine_ids"`
	// Only return steps assigned to any of these scanning stations.
	ScanningStationIDs []string `query:"scanning_station_ids"`
	// Only return steps that are directly fed by any of these upstream steps.
	InputStepIDs []string `query:"input_step_ids"`
	// Only return steps that feed directly into any of these downstream steps.
	OutputStepIDs []string `query:"output_step_ids"`
	// Only return steps created on or after this timestamp (inclusive).
	StartDate *time.Time `query:"starts_at"`
	// Only return steps created on or before this timestamp (inclusive).
	EndDate *time.Time `query:"ends_at"`
}

type ProductionStepSvc interface {
	ListProductionSteps(ctx context.Context, req *ListProductionStepsRequest) (*apiresource.List[apiresource.ProductionStep], *apierror.APIError)
	ExportProductionSteps(ctx context.Context, req *ExportProductionStepsRequest) (*apiresource.Job, *apierror.APIError)
	GetProductionStep(ctx context.Context, req *RetrieveProductionStepRequest) (*apiresource.ProductionStep, *apierror.APIError)
	CreateProductionStep(ctx context.Context, req *CreateProductionStepRequest) (*apiresource.ProductionStep, *apierror.APIError)
	UpdateProductionStep(ctx context.Context, req *UpdateProductionStepRequest) (*apiresource.ProductionStep, *apierror.APIError)
	DeleteProductionStep(ctx context.Context, req *DeleteProductionStepRequest) (*apiresource.EmptyResource, *apierror.APIError)
	GetProduction(ctx context.Context, req *RetrieveProductionRequest) (*apiresource.ProductionOutput, *apierror.APIError)
	UpdateProduction(ctx context.Context, req *UpdateProductionRequest) (*apiresource.ProductionOutput, *apierror.APIError)
	BulkCreateProductionSteps(ctx context.Context, req *BulkCreateProductionStepsRequest) (*apiresource.BulkCreateProductionStepsResponse, *apierror.APIError)
	BulkUpsertProductionSteps(ctx context.Context, req *BulkUpsertProductionStepsRequest) (*apiresource.Job, *apierror.APIError)
}

type ProductionStepSvcConfig struct {
	// CoreClient (required) is the core-service production-step gRPC client.
	CoreClient pb.CoreProductionStepServiceClient
}

type RetrieveProductionEndpoint struct{}

type RetrieveProductionRequest struct {
	// Production step ID.
	ProductionStepID string `path:"production_step_id" validate:"required"`
	// Production ID.
	ProductionID string `path:"id" validate:"required"`
}

type RetrieveProductionStepEndpoint struct{}

type RetrieveProductionStepRequest struct {
	// Production step ID.
	ProductionStepID string `path:"id" validate:"required"`
}

type UpdateProductionEndpoint struct{}

type UpdateProductionRequest struct {
	// Production step ID.
	ProductionStepID string `path:"production_step_id" validate:"required"`
	// Production ID.
	ProductionID string `path:"id" validate:"required"`
	// Item this step produces.
	//
	// Changing the item recomputes all of the step's connections in the production flow graph from the items it now produces and consumes, which discards connections that were made manually.
	ItemID field.Optional[string] `json:"item_id,omitzero" validate:"omitempty"`
	// Quantity value as a decimal string.
	//
	// Ignored unless `quantity_unit_id` is also provided.
	QuantityValue field.Optional[string] `json:"quantity_value,omitzero"`
	// Unit ID for `quantity_value`.
	//
	// Ignored unless `quantity_value` is also provided.
	QuantityUnitID field.Optional[string] `json:"quantity_unit_id,omitzero" validate:"omitempty"`
}

type UpdateProductionStepEndpoint struct{}

type UpdateProductionStepRequest struct {
	// Production step ID.
	ProductionStepID string `path:"id" validate:"required"`
	// New display name.
	//
	// Must be unique within the account.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Leveling correction factor applied to labor time in cost calculations, as a decimal string.
	LevelingFactor field.Optional[string] `json:"leveling_factor,omitzero"`
	// Allowance correction factor applied to labor time in cost calculations, as a decimal string.
	Allowances field.Optional[string] `json:"allowances,omitzero"`
	// Scanning station where batches at this step are scanned.
	ScanningStationID field.Optional[string] `json:"scanning_station_id,omitzero" validate:"omitempty"`
}

type UpsertProductionStepInput struct {
	// Display name of the step. Rows are matched against existing production steps by
	// name (case-insensitive): a match updates that step, no match creates a new one.
	Name string `json:"name" validate:"required,max=255"`
	// Free-form notes about the step. Preserved when omitted on update.
	Notes field.Optional[string] `json:"notes,omitzero"`
	// Leveling correction factor applied to labor time in cost calculations, as a
	// decimal string. Defaults to `0` on create; preserved when omitted on update.
	LevelingFactor field.Optional[string] `json:"leveling_factor,omitzero" format:"decimal"`
	// Allowance correction factor applied to labor time in cost calculations, as a
	// decimal string. Defaults to `0` on create; preserved when omitted on update.
	Allowances field.Optional[string] `json:"allowances,omitzero" format:"decimal"`
	// Scanning station this step reports at, referenced by `id` or `name`. Preserved when
	// omitted on update.
	ScanningStation field.Optional[apirequest.ObjectIdentifier] `json:"scanning_station,omitzero"`
	// Department this step belongs to, referenced by `id` or `name`. Create-only: a row
	// updating an existing step must omit it or state the step's current department.
	Department field.Optional[apirequest.ObjectIdentifier] `json:"department,omitzero"`
	// Cost of labor for this step, expressed as a rate of currency per unit of time
	// (e.g. `$` per `hr`). The numerator unit must be a currency and the denominator
	// must not be. On update a fresh rate is written.
	LaborRate UpsertRateInput `json:"labor_rate" validate:"required"`
	// Labor duration for this step, expressed as a rate (e.g. time per unit of
	// output). On update a fresh rate is written.
	LaborTime UpsertRateInput `json:"labor_time" validate:"required"`
	// Overhead cost for this step, expressed as a rate of currency per unit of time
	// (e.g. `$` per `hr`). The numerator unit must be a currency and the denominator
	// must not be. On update a fresh rate is written.
	OverheadRate UpsertRateInput `json:"overhead_rate" validate:"required"`
	// The item and quantity this step produces. Replaced on update.
	Production UpsertStepProductionInput `json:"production" validate:"required"`
	// Materials consumed by the step. Replaced wholesale on update. Flow DAG edges
	// are derived automatically from item flows: a step consuming an item is linked
	// under the steps producing it.
	Consumptions []UpsertStepConsumptionInput `json:"consumptions" validate:"dive"`
}

type UpsertRateInput struct {
	// Value as a decimal string.
	Value string `json:"value" validate:"required" format:"decimal"`
	// Numerator unit (for example, `$`), referenced by `id`, `name`, or `abbreviation`.
	NumeratorUnit apirequest.UnitIdentifier `json:"numerator_unit" validate:"required"`
	// Denominator unit (for example, `hr`), referenced by `id`, `name`, or `abbreviation`.
	DenominatorUnit apirequest.UnitIdentifier `json:"denominator_unit" validate:"required"`
}

type UpsertStepConsumptionInput struct {
	// Item consumed by the step, referenced by `id` or `sku`.
	Item apirequest.ItemIdentifier `json:"item" validate:"required"`
	// Quantity value as a decimal string.
	QuantityValue string `json:"quantity_value" validate:"required" format:"decimal"`
	// Unit for `quantity_value`, referenced by `id`, `name`, or `abbreviation`.
	QuantityUnit apirequest.UnitIdentifier `json:"quantity_unit" validate:"required"`
	// Quantity expected to be lost as scrap or waste, as a decimal string. Defaults to zero.
	WasteQuantityValue field.Optional[string] `json:"waste_quantity_value,omitzero" format:"decimal"`
	// Unit for `waste_quantity_value`, referenced by `id`, `name`, or `abbreviation`.
	// Defaults to `quantity_unit`.
	WasteQuantityUnit field.Optional[apirequest.UnitIdentifier] `json:"waste_quantity_unit,omitzero"`
	// Instructions for how this material is consumed.
	Instructions field.Optional[string] `json:"instructions,omitzero"`
}

type UpsertStepProductionInput struct {
	// Item produced by the step, referenced by `id` or `sku`.
	Item apirequest.ItemIdentifier `json:"item" validate:"required"`
	// Quantity value as a decimal string.
	QuantityValue string `json:"quantity_value" validate:"required" format:"decimal"`
	// Unit for `quantity_value`, referenced by `id`, `name`, or `abbreviation`.
	QuantityUnit apirequest.UnitIdentifier `json:"quantity_unit" validate:"required"`
}