itemcategoryep

type AddItemCategoryPropertyEndpoint struct{}

type AddItemCategoryPropertyRequest struct {
	// Item category ID.
	ItemCategoryID string `path:"id" validate:"required"`
	// ID of the property to add to the category.
	PropertyID string `path:"property_id" validate:"required"`
}

type BulkUpsertItemCategoriesEndpoint struct{}

type BulkUpsertItemCategoriesRequest struct {
	// Item categories to create or update, matched by name within the account.
	ItemCategories []UpsertItemCategoryInput `json:"item_categories" validate:"required,min=1,max=1000,dive"`
}

type ChangeItemCategoryUnitGroupEndpoint struct{}

type ChangeItemCategoryUnitGroupRequest struct {
	// Item category ID.
	ItemCategoryID string `path:"id" validate:"required"`
	// ID of the unit group to associate with the category.
	//
	// Must have the same unit type as the category's current unit group; otherwise the request fails with a validation error.
	UnitGroupID string `path:"unit_group_id" validate:"required"`
}

type CreateItemCategoryEndpoint struct{}

type CreateItemCategoryRequest struct {
	// Display name of the item category.
	Name string `json:"name" validate:"required,max=255"`
	// What kind of items this category groups.
	//
	// - `material_category`: groups raw materials and components (items of type `material`).
	// - `product_category`: groups finished products and parts (items of type `product` or `part`).
	//
	// The type is fixed once the category is created.
	Type constants.ItemCategoryType `json:"type" validate:"required"`
	// ID of the unit group that determines the units of measure available to items in this category.
	//
	// Must be one of your account's unit groups or a platform-provided one. After creation the unit group can only be replaced by another unit group of the same unit type, through the Change Item Category Unit Group endpoint.
	UnitGroupID string `json:"unit_group_id" validate:"required"`
}

type DeleteItemCategoryEndpoint struct{}

type DeleteItemCategoryRequest struct {
	// Item category ID.
	ItemCategoryID string `path:"id" validate:"required"`
}

type ExportItemCategoriesEndpoint struct{}

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

type ItemCategorySvc interface {
	ListItemCategories(ctx context.Context, req *ListItemCategoriesRequest) (*apiresource.List[apiresource.ItemCategory], *apierror.APIError)
	ExportItemCategories(ctx context.Context, req *ExportItemCategoriesRequest) (*apiresource.Job, *apierror.APIError)
	GetItemCategory(ctx context.Context, req *RetrieveItemCategoryRequest) (*apiresource.ItemCategory, *apierror.APIError)
	CreateItemCategory(ctx context.Context, req *CreateItemCategoryRequest) (*apiresource.ItemCategory, *apierror.APIError)
	UpdateItemCategory(ctx context.Context, req *UpdateItemCategoryRequest) (*apiresource.ItemCategory, *apierror.APIError)
	DeleteItemCategory(ctx context.Context, req *DeleteItemCategoryRequest) (*apiresource.EmptyResource, *apierror.APIError)
	AddItemCategoryProperty(ctx context.Context, req *AddItemCategoryPropertyRequest) (*apiresource.EmptyResource, *apierror.APIError)
	RemoveItemCategoryProperty(ctx context.Context, req *RemoveItemCategoryPropertyRequest) (*apiresource.EmptyResource, *apierror.APIError)
	ChangeItemCategoryUnitGroup(ctx context.Context, req *ChangeItemCategoryUnitGroupRequest) (*apiresource.EmptyResource, *apierror.APIError)
	BulkUpsertItemCategories(ctx context.Context, req *BulkUpsertItemCategoriesRequest) (*apiresource.Job, *apierror.APIError)
}

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

type ListItemCategoriesEndpoint struct{}

type ListItemCategoriesRequest struct {
	apiresource.PaginationRequest
	// Filter by item category type.
	Type *constants.ItemCategoryType `query:"type"`
}

type RemoveItemCategoryPropertyEndpoint struct{}

type RemoveItemCategoryPropertyRequest struct {
	// Item category ID.
	ItemCategoryID string `path:"id" validate:"required"`
	// ID of the property to remove from the category.
	PropertyID string `path:"property_id" validate:"required"`
}

type RetrieveItemCategoryEndpoint struct{}

type RetrieveItemCategoryRequest struct {
	// Item category ID.
	ItemCategoryID string `path:"id" validate:"required"`
}

type UpdateItemCategoryEndpoint struct{}

type UpdateItemCategoryRequest struct {
	// Item category ID.
	ItemCategoryID string `path:"id" validate:"required"`
	// Display name of the item category.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Free-form notes about the item category.
	Notes field.Optional[string] `json:"notes,omitzero"`
}

type UpsertItemCategoryInput struct {
	// Display name of the item category, used to match existing categories.
	Name string `json:"name" validate:"required,max=255"`
	// Item category type code. Create-only.
	Type constants.ItemCategoryType `json:"type" validate:"required"`
	// Unit group to associate with this item category, referenced by `id` or `name`.
	UnitGroup apirequest.ObjectIdentifier `json:"unit_group" validate:"required"`
	// Optional list of property names to attach to this category. Properties are matched
	// by name (case-insensitive) within the account; names not found are created automatically.
	// Relations are additive — existing relations are not removed.
	PropertyNames []string `json:"property_names" default:"[]"`
	// Optional notes.
	Notes *string `json:"notes" default:"null" nullable:"true"`
}