models

type ConsentEngineOperation string

type ConsentErrorCode string

type ConsentField struct {
	FieldName   string    `json:"fieldName"`
	SchemaID    string    `json:"schemaId"`
	DisplayName *string   `json:"displayName,omitempty"`
	Description *string   `json:"description,omitempty"`
	Owner       OwnerType `json:"owner"`
}

type ConsentPortalAction string

type ConsentPortalActionRequest struct {
	ConsentID string              `json:"consentId"`
	OwnerID   string              `json:"ownerId"` // Subject of the caller; must match the consent's owner
	Action    ConsentPortalAction `json:"action"`  // "approve", "reject" or "revoke"
	UpdatedBy string              `json:"updatedBy"`
}

type ConsentRecord struct {
	// ConsentID is the unique identifier for the consent record
	ConsentID uuid.UUID `gorm:"column:consent_id;type:uuid;primaryKey;default:gen_random_uuid()" json:"consent_id"`
	// OwnerID is the single canonical identifier (UID) for the data owner.
	// The whole system relies on this UID to identify a user; a token claim
	// (configurable) is matched against it during portal authorization.
	// Part of conditional unique constraint for active consents (pending/approved)
	OwnerID string `` /* 222-byte string literal not displayed */
	// AppID is the unique identifier for the consumer application
	// Part of conditional unique constraint for active consents (pending/approved)
	AppID string `` /* 216-byte string literal not displayed */
	// AppName is the name of the consumer application
	AppName *string `gorm:"column:app_name;type:varchar(255);" json:"app_name,omitempty"`
	// Status is the status of the consent record: pending, approved, rejected, expired, revoked
	// Filters the conditional unique constraint (via its WHERE clause) but is
	// deliberately NOT part of the index key, so a single (owner_id, app_id) can
	// have at most one active (pending OR approved) consent.
	Status string `gorm:"column:status;type:varchar(50);not null;index:idx_consent_records_status" json:"status"`
	// Type is the type of consent mechanism "realtime" or "offline"
	Type string `gorm:"column:type;type:varchar(50);not null" json:"type"`
	// CreatedAt is the timestamp when the consent record was created
	// Used to determine the most recent active consent
	CreatedAt time.Time `` /* 144-byte string literal not displayed */
	// UpdatedAt is the timestamp when the consent record was last updated
	UpdatedAt time.Time `gorm:"column:updated_at;type:timestamp with time zone;not null;default:CURRENT_TIMESTAMP" json:"updated_at"`
	// PendingExpiresAt is the timestamp when a pending consent expires (timeout waiting for approval/denial)
	// Set when status is pending, cleared when status changes to approved/rejected
	PendingExpiresAt *time.Time `` /* 143-byte string literal not displayed */
	// GrantExpiresAt is the timestamp when an approved consent grant expires
	// Calculated by adding GrantDuration to the current time when consent is approved
	// Only set when status is approved
	GrantExpiresAt *time.Time `` /* 137-byte string literal not displayed */
	// GrantDuration is the duration to add to current time when approving consent (e.g., "P30D", "1h")
	// Used to calculate GrantExpiresAt: GrantExpiresAt = current_time + GrantDuration
	GrantDuration string `gorm:"column:grant_duration;type:varchar(50);not null" json:"grant_duration"`
	// Fields is the list of data fields that require consent (stored as array of field names)
	Fields []ConsentField `gorm:"column:fields;type:jsonb;serializer:json;not null" json:"fields"`
	// SessionID is the session identifier for tracking the consent flow
	SessionID *string `gorm:"column:session_id;type:varchar(255);" json:"session_id,omitempty"`
	// ConsentPortalURL is the URL to redirect to for consent portal
	ConsentPortalURL string `gorm:"column:consent_portal_url;type:text;not null" json:"consent_portal_url"`
	// UpdatedBy identifies who last updated the consent (audit field)
	UpdatedBy *string `gorm:"column:updated_by;type:varchar(255)" json:"updated_by,omitempty"`
}

type ConsentRequirement struct {
	Owner   OwnerType      `json:"owner"`
	OwnerID string         `json:"ownerId"`
	Fields  []ConsentField `json:"fields"`
}

type ConsentResponseInternalView struct {
	ConsentID        string          `json:"consentId"`
	Status           string          `json:"status"`
	ConsentPortalURL *string         `json:"consentPortalUrl,omitempty"` // Only present when status is pending
	Fields           *[]ConsentField `json:"fields,omitempty"`           // Included for internal use if needed
}

type ConsentResponsePortalView struct {
	ConsentID        string         `json:"consentId"`
	AppID            string         `json:"appId"`
	AppName          *string        `json:"appName"`
	OwnerID          string         `json:"ownerId"`
	Status           ConsentStatus  `json:"status"`
	Type             ConsentType    `json:"type"`
	GrantDuration    string         `json:"grantDuration"`
	CreatedAt        time.Time      `json:"createdAt"`
	UpdatedAt        time.Time      `json:"updatedAt"`
	PendingExpiresAt *time.Time     `json:"pendingExpiresAt,omitempty"` // Only set while pending
	GrantExpiresAt   *time.Time     `json:"grantExpiresAt,omitempty"`   // Only set once approved
	Fields           []ConsentField `json:"fields"`                     // Rich field information with display names and descriptions
}

type ConsentStatus string

type ConsentSummaryView struct {
	ConsentID        string        `json:"consentId"`
	AppID            string        `json:"appId"`
	AppName          *string       `json:"appName"`
	Status           ConsentStatus `json:"status"`
	CreatedAt        time.Time     `json:"createdAt"`
	PendingExpiresAt *time.Time    `json:"pendingExpiresAt,omitempty"` // Only set while pending
	GrantExpiresAt   *time.Time    `json:"grantExpiresAt,omitempty"`   // Only set once approved
}

type ConsentType string

type CreateConsentRequest struct {
	AppID              string             `json:"appId"`
	AppName            *string            `json:"appName,omitempty"`
	ConsentRequirement ConsentRequirement `json:"consentRequirement"`
	GrantDuration      *string            `json:"grantDuration,omitempty"`
	ConsentType        *ConsentType       `json:"consentType,omitempty"`
}

type GrantDuration string

type ListConsentsResponse struct {
	Consents []ConsentSummaryView `json:"consents"`
	Total    int64                `json:"total"`
	Limit    int                  `json:"limit"`
	Offset   int                  `json:"offset"`
}

type OwnerType string

type UpdateByMessage string