machineep

type BulkUpsertMachinesEndpoint struct{}

type BulkUpsertMachinesRequest struct {
	// Machines to create or update, matched by name or serial number (case-insensitive)
	// within the account.
	Machines []UpsertMachineInput `json:"machines" validate:"required,min=1,max=1000,dive"`
}

type CreateMachineEndpoint struct{}

type CreateMachineRequest struct {
	// Display name of the machine.
	//
	// Must be unique within your account; maximum 255 characters.
	Name string `json:"name" validate:"required,max=255"`
	// Serial number of the machine.
	//
	// Maximum 255 characters.
	SerialNumber string `json:"serial_number" validate:"required,max=255"`
	// Free-form notes about the machine.
	Notes field.Optional[string] `json:"notes,omitzero"`
	// ID of the department this machine belongs to.
	//
	// Must reference a department in your account.
	DepartmentID string `json:"department_id" validate:"required"`
}

type DeleteMachineEndpoint struct{}

type DeleteMachineRequest struct {
	// ID of the machine to delete.
	MachineID string `path:"id" validate:"required"`
}

type ExportMachinesEndpoint struct{}

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

type ListMachinesEndpoint struct{}

type ListMachinesRequest struct {
	apiresource.PaginationRequest
}

type MachineSvc interface {
	ListMachines(ctx context.Context, req *ListMachinesRequest) (*apiresource.List[apiresource.Machine], *apierror.APIError)
	ExportMachines(ctx context.Context, req *ExportMachinesRequest) (*apiresource.Job, *apierror.APIError)
	GetMachine(ctx context.Context, req *RetrieveMachineRequest) (*apiresource.Machine, *apierror.APIError)
	CreateMachine(ctx context.Context, req *CreateMachineRequest) (*apiresource.Machine, *apierror.APIError)
	UpdateMachine(ctx context.Context, req *UpdateMachineRequest) (*apiresource.Machine, *apierror.APIError)
	BulkUpsertMachines(ctx context.Context, req *BulkUpsertMachinesRequest) (*apiresource.Job, *apierror.APIError)
	DeleteMachine(ctx context.Context, req *DeleteMachineRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type MachineSvcConfig struct {
	// CoreClient (required) is the core-service fulfillment gRPC client.
	CoreClient pb.CoreFulfillmentServiceClient
}

type RetrieveMachineEndpoint struct{}

type RetrieveMachineRequest struct {
	// ID of the machine to retrieve.
	MachineID string `path:"id" validate:"required"`
}

type UpdateMachineEndpoint struct{}

type UpdateMachineRequest struct {
	// ID of the machine to update.
	MachineID string `path:"id" validate:"required"`
	// Display name of the machine.
	//
	// Must be unique within your account; maximum 255 characters.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Serial number of the machine.
	//
	// Maximum 255 characters.
	SerialNumber field.Optional[string] `json:"serial_number,omitzero" validate:"omitempty,max=255"`
	// Free-form notes about the machine.
	Notes field.Optional[string] `json:"notes,omitzero"`
}

type UpsertMachineInput struct {
	// Display name of the machine. Rows match existing machines by name or serial number
	// (case-insensitive); a row whose name and serial match two different machines fails.
	Name string `json:"name" validate:"required,max=255"`
	// Serial number of the machine. Also used for matching — see `name`.
	SerialNumber string `json:"serial_number" validate:"required,max=255"`
	// Free-form notes about the machine. Preserved when omitted on update.
	Notes field.Optional[string] `json:"notes,omitzero"`
	// Department this machine belongs to, referenced by `id` or `name`. Create-only.
	Department apirequest.ObjectIdentifier `json:"department" validate:"required"`
}