unitgroupep

type BulkUpsertUnitGroupsEndpoint struct{}

type BulkUpsertUnitGroupsRequest struct {
	// Unit groups to create or update, matched by name within the account.
	UnitGroups []UpsertUnitGroupInput `json:"unit_groups" validate:"required,min=1,max=1000,dive"`
}

type CreateUnitGroupEndpoint struct{}

type CreateUnitGroupRequest struct {
	// Display name of the unit group.
	//
	// Must be unique within the account.
	Name string `json:"name" validate:"required,max=255"`
	// Free-form notes about the unit group.
	Notes field.Optional[string] `json:"notes,omitzero" default:"null"`
	// The dimension shared by every unit in this group, such as mass, volume, or currency.
	//
	// The base unit and all associated units must be of this dimension, and the dimension cannot be changed after the group is created.
	Type constants.UnitType `json:"type" validate:"required"`
	// ID of the unit to designate as the group's reference unit.
	//
	// Must be a unit of the group's `type`.
	BaseUnitID string `json:"base_unit_id" validate:"required"`
	// Units to associate with the group, each with its own discount and customer portal visibility.
	AssociatedUnits []CreateUnitGroupUnitParam `json:"associated_units,omitzero"`
}

type CreateUnitGroupUnitEndpoint struct{}

type CreateUnitGroupUnitParam struct {
	// ID of the unit to associate with the group.
	//
	// The unit's dimension must match the group's `type`.
	UnitID string `json:"unit_id" validate:"required"`
	// Share of the unit's price removed when an order is placed in this unit.
	//
	// Expressed as a decimal fraction rather than a whole number, so `0.1` is a 10% discount. Send `0` explicitly for no discount — omitting the field stores a discount of `1`, which removes the entire price.
	DiscountPercentage field.Optional[float64] `json:"discount_percentage,omitzero" default:"1"`
	// Flat amount subtracted from the unit's price when an order is placed in this unit.
	//
	// Subtracted before `discount_percentage` is applied.
	DiscountFixed field.Optional[float64] `json:"discount_fixed,omitzero" default:"0"`
	// Whether the unit is shown to customers in the customer portal.
	CustomerPortalVisibility field.Optional[constants.CustomerPortalVisibility] `json:"customer_portal_visibility,omitzero" default:"visible"`
}

type CreateUnitGroupUnitRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"unit_group_id" validate:"required"`
	// ID of the unit to associate with the group.
	//
	// The unit's dimension must match the group's `type`.
	UnitID string `json:"unit_id" validate:"required"`
	// Share of the unit's price removed when an order is placed in this unit.
	//
	// Expressed as a decimal fraction rather than a whole number, so `0.1` is a 10% discount. Send `0` explicitly for no discount — omitting the field stores a discount of `1`, which removes the entire price.
	DiscountPercentage field.Optional[float64] `json:"discount_percentage,omitzero" default:"1"`
	// Flat amount subtracted from the unit's price when an order is placed in this unit.
	//
	// Subtracted before `discount_percentage` is applied.
	DiscountFixed field.Optional[float64] `json:"discount_fixed,omitzero" default:"0"`
	// Whether the unit is shown to customers in the customer portal.
	CustomerPortalVisibility field.Optional[constants.CustomerPortalVisibility] `json:"customer_portal_visibility,omitzero" default:"visible"`
}

type DeleteUnitGroupEndpoint struct{}

type DeleteUnitGroupRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"id" validate:"required"`
}

type DeleteUnitGroupUnitEndpoint struct{}

type DeleteUnitGroupUnitRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"unit_group_id" validate:"required"`
	// ID of the unit's association with the group, not the ID of the unit itself.
	AssociatedUnitID string `path:"id" validate:"required"`
}

type ExportUnitGroupsEndpoint struct{}

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

type ListUnitGroupUnitsEndpoint struct{}

type ListUnitGroupUnitsRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"unit_group_id" validate:"required"`
}

type ListUnitGroupsEndpoint struct{}

type ListUnitGroupsRequest struct {
	apiresource.PaginationRequest
	// Filter by unit dimension.
	Type *constants.UnitType `query:"type"`
}

type RetrieveUnitGroupEndpoint struct{}

type RetrieveUnitGroupRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"id" validate:"required"`
}

type RetrieveUnitGroupUnitEndpoint struct{}

type RetrieveUnitGroupUnitRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"unit_group_id" validate:"required"`
	// ID of the unit's association with the group, not the ID of the unit itself.
	UnitGroupUnitID string `path:"id" validate:"required"`
}

type UnitGroupSvc interface {
	ListUnitGroups(ctx context.Context, req *ListUnitGroupsRequest) (*apiresource.List[apiresource.UnitGroup], *apierror.APIError)
	ExportUnitGroups(ctx context.Context, req *ExportUnitGroupsRequest) (*apiresource.Job, *apierror.APIError)
	GetUnitGroup(ctx context.Context, req *RetrieveUnitGroupRequest) (*apiresource.UnitGroup, *apierror.APIError)
	CreateUnitGroup(ctx context.Context, req *CreateUnitGroupRequest) (*apiresource.UnitGroup, *apierror.APIError)
	UpdateUnitGroup(ctx context.Context, req *UpdateUnitGroupRequest) (*apiresource.UnitGroup, *apierror.APIError)
	DeleteUnitGroup(ctx context.Context, req *DeleteUnitGroupRequest) (*apiresource.EmptyResource, *apierror.APIError)
	CreateUnitGroupUnit(ctx context.Context, req *CreateUnitGroupUnitRequest) (*apiresource.UnitGroupUnit, *apierror.APIError)
	UpdateUnitGroupUnit(ctx context.Context, req *UpdateUnitGroupUnitRequest) (*apiresource.UnitGroupUnit, *apierror.APIError)
	DeleteUnitGroupUnit(ctx context.Context, req *DeleteUnitGroupUnitRequest) (*apiresource.EmptyResource, *apierror.APIError)
	ListUnitGroupUnits(ctx context.Context, req *ListUnitGroupUnitsRequest) (*apiresource.List[apiresource.UnitGroupUnit], *apierror.APIError)
	GetUnitGroupUnit(ctx context.Context, req *RetrieveUnitGroupUnitRequest) (*apiresource.UnitGroupUnit, *apierror.APIError)
	BulkUpsertUnitGroups(ctx context.Context, req *BulkUpsertUnitGroupsRequest) (*apiresource.Job, *apierror.APIError)
}

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

type UpdateUnitGroupEndpoint struct{}

type UpdateUnitGroupRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"id" validate:"required"`
	// Display name of the unit group.
	//
	// Must be unique within the account.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
	// Free-form notes about the unit group.
	//
	// Set to `null` to clear.
	Notes field.Clearable[string] `json:"notes,omitzero"`
	// ID of the unit to designate as the group's reference unit.
	//
	// Must be a unit of the group's dimension, which cannot itself be changed.
	BaseUnitID field.Optional[string] `json:"base_unit_id,omitzero" validate:"omitempty"`
	// Units to add to the group.
	//
	// Only units that are not already in the group can be listed here; use the associated-unit update and delete endpoints to change or remove an existing association. Associations left out of the list are untouched.
	AssociatedUnits field.Optional[[]CreateUnitGroupUnitParam] `json:"associated_units,omitzero"`
}

type UpdateUnitGroupUnitEndpoint struct{}

type UpdateUnitGroupUnitRequest struct {
	// Unit group ID.
	UnitGroupID string `path:"unit_group_id" validate:"required"`
	// ID of the unit's association with the group, not the ID of the unit itself.
	AssociatedUnitID string `path:"id" validate:"required"`
	// ID of the unit this association refers to.
	//
	// Sending a different unit does not repoint the association; remove the association and add a new one instead. A unit sent here must still match the group's `type`.
	UnitID field.Optional[string] `json:"unit_id,omitzero" validate:"omitempty"`
	// Share of the unit's price removed when an order is placed in this unit.
	//
	// Expressed as a decimal fraction rather than a whole number, so `0.1` is a 10% discount and `0` is no discount.
	DiscountPercentage field.Optional[float64] `json:"discount_percentage,omitzero"`
	// Flat amount subtracted from the unit's price when an order is placed in this unit.
	//
	// Subtracted before `discount_percentage` is applied.
	DiscountFixed field.Optional[float64] `json:"discount_fixed,omitzero"`
	// Whether the unit is shown to customers in the customer portal.
	CustomerPortalVisibility field.Optional[constants.CustomerPortalVisibility] `json:"customer_portal_visibility,omitzero"`
}

type UpsertUnitGroupConversionInput struct {
	// Unit for this conversion, referenced by `id`, `name`, or `abbreviation`.
	Unit apirequest.UnitIdentifier `json:"unit" validate:"required"`
	// Discount percentage to apply for this unit conversion.
	DiscountPercentage *float64 `json:"discount_percentage,omitempty" default:"1" nullable:"false"`
}

type UpsertUnitGroupInput struct {
	// Display name of the unit group, matched case-insensitively against existing groups.
	// A row matching a system unit group fails — system groups cannot be modified.
	Name string `json:"name" validate:"required,max=255"`
	// Free-form notes about the unit group. Preserved when omitted on update.
	Notes *string `json:"notes,omitempty" default:"null" nullable:"false"`
	// Unit dimension type. Create-only — an existing group keeps its stored type.
	Type constants.UnitType `json:"type" validate:"required"`
	// Base unit for this group, referenced by `id`, `name`, or `abbreviation`.
	BaseUnit apirequest.UnitIdentifier `json:"base_unit" validate:"required"`
	// Units to associate with the group. Replaces the existing set on update; the base
	// unit is always kept.
	UnitConversions []UpsertUnitGroupConversionInput `json:"unit_conversions,omitempty"`
}