models

type Address struct {
	Country     *CountryCode `json:"country,omitempty"`
	PostalCode  *string      `json:"postalCode,omitempty"`
	State       *string      `json:"state,omitempty"`
	City        *string      `json:"city,omitempty"`
	Line1       *string      `json:"line1,omitempty"`
	Line2       *string      `json:"line2,omitempty"`
	PhoneNumber *string      `json:"phoneNumber,omitempty"`
}

type Annotated interface {
	// contains filtered or unexported methods
}

type AnnotatedModel struct {
	Metadata map[string]string `json:"metadata,omitempty"`
}

type CadenceList[T Cadenced] []T

type Cadenced interface {
	// contains filtered or unexported methods
}

type CadencedModel struct {
	ActiveFrom time.Time `json:"activeFrom"`
	// ActiveTo CANNOT be BEFORE ActiveFrom (it can be the same, which would mean the entity is never active)
	ActiveTo *time.Time `json:"activeTo"`
}

type CadencedResourceRepo[T Cadenced] interface {
	SetEndOfCadence(ctx context.Context, id NamespacedID, at *time.Time) (*T, error)
}

type CountryCode string

type Equaler[T any] interface {
	// Equal returns true in case all attributes of T are strictly equal.
	Equal(T) bool
}

type GenericConflictError struct {
	Inner error
}

type GenericForbiddenError struct {
	Inner error
}

type GenericNotImplementedError struct {
	// contains filtered or unexported fields
}

type GenericUserError struct {
	Inner error
}

type GenericValidationError struct {
	// contains filtered or unexported fields
}

type ManagedModel struct {
	CreatedAt time.Time `json:"createdAt"`
	// After creation the entity is considered updated.
	UpdatedAt time.Time `json:"updatedAt"`
	// Time of soft delete. If not null, the entity is considered deleted.
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type ManagedResource struct {
	NamespacedModel `json:",inline"`
	ManagedModel    `json:",inline"`

	// ID is the unique identifier for Resource.
	ID          string  `json:"id"`
	Description *string `json:"description,omitempty"`
	Name        string  `json:"name"`
}

type ManagedResourceInput struct {
	ID          string
	Namespace   string
	CreatedAt   time.Time
	UpdatedAt   time.Time
	DeletedAt   *time.Time
	Name        string
	Description *string
}

type ManagedUniqueResource struct {
	NamespacedModel
	ManagedModel

	// ID is the unique identifier for Resource.
	ID string `json:"id"`

	// Key is the unique key for Resource.
	Key string `json:"key"`
}

type Metadata map[string]string

type NamespaceNotFoundError struct {
	Namespace string
}

type NamespacedID struct {
	Namespace string `json:"namespace"`
	ID        string `json:"id"`
}

type NamespacedModel struct {
	Namespace string `json:"-" yaml:"-"`
}

type Problem interface {
	Respond(w http.ResponseWriter)
	Error() string
	ProblemType() ProblemType
	ProblemTitle() string
	ProblemStatus() int
}

type ProblemType string

type StatusProblem struct {
	Err error `json:"-"` // low-level runtime error

	// Type is a URI reference that identifies the problem type.
	Type ProblemType `json:"type"`
	// Title is a short, human-readable summary of the problem type.
	Title string `json:"title"`
	// Status is the HTTP status code generated by the origin server for this occurrence of the problem.
	Status int `json:"status"`
	// Detail is a human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail,omitempty"`
	// Instance is a URI reference that identifies the specific occurrence of the problem.
	Instance string `json:"instance,omitempty"`

	// Extension fields are allowed by spec, see https://datatracker.ietf.org/doc/html/rfc7807#section-3.2
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type Validator interface {
	// Validate returns an error if the instance of the Validator is invalid.
	Validate() error
}

type VersionedModel struct {
	// Key is the unique identifier of the entity across its versions.
	// Might be generated by the system or provided by the user.
	Key string `json:"key,omitempty"`
	// Version is the integer sequential version of the entity, starting from 1.
	Version int `json:"version,omitempty"`
}