scanningstationep

type BulkUpsertScanningStationsEndpoint struct{}

type BulkUpsertScanningStationsRequest struct {
	// Scanning stations to create or update, matched by name (case-insensitive) within
	// the account.
	ScanningStations []UpsertScanningStationInput `json:"scanning_stations" validate:"required,min=1,max=1000,dive"`
}

type ConnectProductionStepsEndpoint struct{}

type ConnectProductionStepsRequest struct {
	// Scanning station ID.
	ScanningStationID string `path:"id" validate:"required"`
	// Full or partial production step name to match.
	//
	// Matching is a case-insensitive substring match, so a broad value such as a single letter can capture far more steps than intended.
	Name string `json:"name" validate:"required"`
}

type CreateScanningStationEndpoint struct{}

type CreateScanningStationRequest struct {
	// Display name of the scanning station.
	//
	// Must be unique within your account; maximum 255 characters.
	Name string `json:"name" validate:"required,max=255"`
	// Free-form notes about the scanning station.
	Notes field.Optional[string] `json:"notes,omitzero"`
	// Scanning station type, determining which batch operation an operator performs when they scan here.
	//
	// - `init_batch`: starts a new batch at the beginning of a production flow.
	// - `merge_batch`: combines several scanned batches into one.
	// - `move_batch`: advances a batch through a production step connected to this station.
	// - `split_batch`: divides a batch into several batches.
	//
	// The type cannot be changed after creation.
	Type constants.ScanningStationType `json:"type" validate:"required"`
	// Whether operators must perform a material check at this station.
	//
	// - `none`: no additional operator check is required.
	// - `material_check`: a material check is expected before the operation.
	OperatorRequirement constants.OperatorRequirement `json:"operator_requirement" validate:"required"`
	// ID of the department this station belongs to.
	//
	// Must be a department in your account, and cannot be changed after creation.
	DepartmentID string `json:"department_id" validate:"required"`
	// Size of the labels printed at this station, given as width-by-height (for example, `1x1`).
	LabelSizeCode field.Optional[constants.LabelSizeCode] `json:"label_size,omitzero"`
	// Type of label printed at this station.
	//
	// - `tag`: a label attached to the physical product.
	// - `traveler`: a routing sheet that accompanies the batch through every production step.
	LabelTypeCode field.Optional[constants.LabelTypeCode] `json:"label_type,omitzero"`
}

type DeleteScanningStationEndpoint struct{}

type DeleteScanningStationRequest struct {
	// Scanning station ID.
	ScanningStationID string `path:"id" validate:"required"`
}

type ExportScanningStationsEndpoint struct{}

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

type ListScanningStationsEndpoint struct{}

type ListScanningStationsRequest struct {
	apiresource.PaginationRequest
}

type RetrieveScanningStationEndpoint struct{}

type RetrieveScanningStationRequest struct {
	// Scanning station ID.
	ScanningStationID string `path:"id" validate:"required"`
}

type ScanningStationSvc interface {
	ListScanningStations(ctx context.Context, req *ListScanningStationsRequest) (*apiresource.List[apiresource.ScanningStation], *apierror.APIError)
	ExportScanningStations(ctx context.Context, req *ExportScanningStationsRequest) (*apiresource.Job, *apierror.APIError)
	GetScanningStation(ctx context.Context, req *RetrieveScanningStationRequest) (*apiresource.ScanningStation, *apierror.APIError)
	CreateScanningStation(ctx context.Context, req *CreateScanningStationRequest) (*apiresource.ScanningStation, *apierror.APIError)
	BulkUpsertScanningStations(ctx context.Context, req *BulkUpsertScanningStationsRequest) (*apiresource.Job, *apierror.APIError)
	UpdateScanningStation(ctx context.Context, req *UpdateScanningStationRequest) (*apiresource.ScanningStation, *apierror.APIError)
	DeleteScanningStation(ctx context.Context, req *DeleteScanningStationRequest) (*apiresource.EmptyResource, *apierror.APIError)
	ConnectProductionSteps(ctx context.Context, req *ConnectProductionStepsRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

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

type UpdateScanningStationEndpoint struct{}

type UpdateScanningStationRequest struct {
	// Scanning station ID.
	ScanningStationID string `path:"id" validate:"required"`
	// Display name of the scanning station.
	//
	// Must be unique within your account; maximum 255 characters.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Free-form notes about the scanning station.
	//
	// Send `null` to clear.
	Notes field.Clearable[string] `json:"notes,omitzero"`
	// Size of the labels printed at this station, given as width-by-height (for example, `1x1`).
	//
	// Send `null` or an empty string to clear.
	LabelSizeCode field.Clearable[constants.LabelSizeCode] `json:"label_size,omitzero"`
	// Type of label printed at this station.
	//
	// - `tag`: a label attached to the physical product.
	// - `traveler`: a routing sheet that accompanies the batch through every production step.
	//
	// Send `null` or an empty string to clear.
	LabelTypeCode field.Clearable[constants.LabelTypeCode] `json:"label_type,omitzero"`
	// Whether operators must perform a material check at this station.
	//
	// - `none`: no additional operator check is required.
	// - `material_check`: a material check is expected before the operation.
	OperatorRequirement field.Optional[constants.OperatorRequirement] `json:"operator_requirement,omitzero"`
}

type UpsertScanningStationInput struct {
	// Display name of the scanning station. Rows are matched against existing stations
	// by name (case-insensitive): a match updates that station, no match creates a new
	// one.
	Name string `json:"name" validate:"required,max=255"`
	// Free-form notes about the scanning station. Preserved when omitted on update.
	Notes field.Optional[string] `json:"notes,omitzero"`
	// Scanning station type, determining which batch operation the station performs.
	//
	// - `init_batch`: initializes a new batch.
	// - `merge_batch`: merges multiple batches into one.
	// - `move_batch`: moves a batch to another location or step.
	// - `split_batch`: splits a batch into multiple batches.
	//
	// The type cannot be changed after creation — rows updating an existing station
	// must state that station's current type.
	Type constants.ScanningStationType `json:"type" validate:"required"`
	// Whether operators must perform a material check at this station.
	//
	// - `none`: no additional operator check is required.
	// - `material_check`: a material check is expected before the operation.
	OperatorRequirement constants.OperatorRequirement `json:"operator_requirement" validate:"required"`
	// Size of the labels printed at this station, given as width-by-height (for
	// example, `1x1`). Preserved when omitted on update; send `null` or an empty
	// string to clear.
	LabelSizeCode field.Clearable[constants.LabelSizeCode] `json:"label_size,omitzero"`
	// Type of label printed at this station. Preserved when omitted on update; send
	// `null` or an empty string to clear.
	//
	// - `tag`: a label attached to the physical product.
	// - `traveler`: a routing sheet that accompanies the batch through every production step.
	LabelTypeCode field.Clearable[constants.LabelTypeCode] `json:"label_type,omitzero"`
	// Department this station belongs to, referenced by `id` or `name`. Create-only: a row
	// updating an existing station must state that station's current department.
	Department apirequest.ObjectIdentifier `json:"department" validate:"required"`
}