propertyep

type BulkUpsertPropertiesEndpoint struct{}

type BulkUpsertPropertiesRequest struct {
	// Properties to create or update, matched by name (case-insensitive) within the account.
	Properties []UpsertPropertyInput `json:"properties" validate:"required,min=1,max=1000,dive"`
}

type CreateAttributeEndpoint struct{}

type CreateAttributeRequest struct {
	// The property to add this attribute to.
	PropertyID string `path:"property_id" validate:"required"`
	// The selectable value this attribute represents, such as `Red`.
	//
	// Must be unique across all attributes in the account, not just within the property. Leading and trailing whitespace is trimmed.
	Value string `json:"value" validate:"required"`
	// Swatch color used to display this attribute in the UI.
	//
	// When omitted, one of the nine named colors (everything except `default`) is assigned at random.
	ColorCode field.Optional[constants.Color] `json:"color,omitzero"`
	// Position of the new attribute relative to its siblings within the property, starting at `1`.
	//
	// Must be at most the property's current attribute count plus one; siblings at or after this position are shifted one position later. Defaults to the last position if not provided.
	SortOrder field.Optional[int32] `json:"sort_order,omitzero" validate:"omitempty,min=1"`
}

type CreatePropertyEndpoint struct{}

type CreatePropertyRequest struct {
	// Display name of the property, such as `Color` or `Size`.
	//
	// Must be unique within your account.
	Name string `json:"name" validate:"required,max=255"`
}

type DeleteAttributeEndpoint struct{}

type DeleteAttributeRequest struct {
	// The property the attribute belongs to.
	PropertyID string `path:"property_id" validate:"required"`
	// Attribute ID.
	AttributeID string `path:"id" validate:"required"`
}

type DeletePropertyEndpoint struct{}

type DeletePropertyRequest struct {
	// Property ID.
	PropertyID string `path:"id" validate:"required"`
}

type ExportPropertiesEndpoint struct{}

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

type ListAttributesEndpoint struct{}

type ListAttributesRequest struct {
	apiresource.PaginationRequest
	// The property whose attributes are listed.
	PropertyID string `path:"property_id" validate:"required"`
}

type ListPropertiesEndpoint struct{}

type ListPropertiesRequest struct {
	apiresource.PaginationRequest
}

type PropertySvc interface {
	ListProperties(ctx context.Context, req *ListPropertiesRequest) (*apiresource.List[apiresource.Property], *apierror.APIError)
	GetProperty(ctx context.Context, req *RetrievePropertyRequest) (*apiresource.Property, *apierror.APIError)
	CreateProperty(ctx context.Context, req *CreatePropertyRequest) (*apiresource.Property, *apierror.APIError)
	UpdateProperty(ctx context.Context, req *UpdatePropertyRequest) (*apiresource.Property, *apierror.APIError)
	DeleteProperty(ctx context.Context, req *DeletePropertyRequest) (*apiresource.EmptyResource, *apierror.APIError)
	BulkUpsertProperties(ctx context.Context, req *BulkUpsertPropertiesRequest) (*apiresource.Job, *apierror.APIError)
	ExportProperties(ctx context.Context, req *ExportPropertiesRequest) (*apiresource.Job, *apierror.APIError)
	ListAttributes(ctx context.Context, req *ListAttributesRequest) (*apiresource.List[apiresource.Attribute], *apierror.APIError)
	GetAttribute(ctx context.Context, req *RetrieveAttributeRequest) (*apiresource.Attribute, *apierror.APIError)
	CreateAttribute(ctx context.Context, req *CreateAttributeRequest) (*apiresource.Attribute, *apierror.APIError)
	UpdateAttribute(ctx context.Context, req *UpdateAttributeRequest) (*apiresource.Attribute, *apierror.APIError)
	DeleteAttribute(ctx context.Context, req *DeleteAttributeRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

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

type RetrieveAttributeEndpoint struct{}

type RetrieveAttributeRequest struct {
	// The property the attribute belongs to.
	PropertyID string `path:"property_id" validate:"required"`
	// Attribute ID.
	AttributeID string `path:"id" validate:"required"`
}

type RetrievePropertyEndpoint struct{}

type RetrievePropertyRequest struct {
	// Property ID.
	PropertyID string `path:"id" validate:"required"`
}

type UpdateAttributeEndpoint struct{}

type UpdateAttributeRequest struct {
	// The property the attribute belongs to.
	PropertyID string `path:"property_id" validate:"required"`
	// Attribute ID.
	AttributeID string `path:"id" validate:"required"`
	// The selectable value this attribute represents, such as `Red`.
	//
	// Must be non-blank and unique across all attributes in the account, not just within the property.
	Value field.Optional[string] `json:"value,omitzero"`
	// Swatch color used to display this attribute in the UI.
	ColorCode field.Optional[constants.Color] `json:"color,omitzero"`
	// New position of this attribute relative to its siblings within the property, starting at `1`.
	//
	// Must be at most the property's current attribute count; the attributes between the old and new positions shift to make room.
	SortOrder field.Optional[int32] `json:"sort_order,omitzero" validate:"omitempty,min=1"`
}

type UpdatePropertyEndpoint struct{}

type UpdatePropertyRequest struct {
	// Property ID.
	PropertyID string `path:"id" validate:"required"`
	// Display name of the property, such as `Color` or `Size`.
	//
	// Must be unique within your account.
	Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
}

type UpsertPropertyAttributeInput struct {
	// The selectable value this attribute represents, such as `Red`.
	//
	// Must be unique across all attributes in the account, not just within the property. Leading and trailing whitespace is trimmed.
	Value string `json:"value" validate:"required,max=255"`
	// Swatch color used to display this attribute in the UI.
	//
	// When omitted, one of the nine named colors is assigned. Ignored for a value the property already defines.
	ColorCode field.Optional[constants.Color] `json:"color,omitzero"`
}

type UpsertPropertyInput struct {
	// Display name of the property, used to match existing properties within the account.
	Name string `json:"name" validate:"required,max=255"`
	// The selectable values to define under this property, in the order they should be arranged.
	//
	// Additive — values the property already defines are left as they stand, and none are removed. New values are appended after the existing ones.
	Attributes []UpsertPropertyAttributeInput `json:"attributes" default:"[]" validate:"max=1000,dive"`
}