organizations

type AddMemberInput struct {
	OrganizationID string `json:"organization_id"`
	UserID         string `json:"user_id"`
	Role           Role   `json:"role"`
}

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

type Capability = Organization

type Config struct {
	// CacheTTL controls how long organizations and memberships are cached.
	// Defaults to 5 minutes. If non-positive, caching is disabled.
	CacheTTL time.Duration

	// DefaultInvitationTTL sets the duration an invitation remains valid.
	// Defaults to 7 days.
	DefaultInvitationTTL time.Duration
}

type CreateInvitationInput struct {
	OrganizationID string        `json:"organization_id"`
	Email          string        `json:"email"`
	Role           Role          `json:"role"`
	InviterUserID  string        `json:"inviter_user_id"`
	TTL            time.Duration `json:"ttl,omitempty"`
}

type CreateOrganizationInput struct {
	Name     string            `json:"name"`
	Slug     string            `json:"slug"`
	OwnerID  string            `json:"owner_id"`
	Metadata map[string]string `json:"metadata,omitempty"`
}

type CreateTeamInput struct {
	OrganizationID string `json:"organization_id"`
	Name           string `json:"name"`
	Slug           string `json:"slug"`
	Description    string `json:"description,omitempty"`
}

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

type Invitation struct {
	ID             string     `json:"id"`
	OrganizationID string     `json:"organization_id"`
	Email          string     `json:"email"`
	Role           Role       `json:"role"`
	InviterUserID  string     `json:"inviter_user_id"`
	TokenHash      string     `json:"token_hash"`
	ExpiresAt      time.Time  `json:"expires_at"`
	AcceptedAt     *time.Time `json:"accepted_at,omitempty"`
	CreatedAt      time.Time  `json:"created_at"`
}

type InvitationAcceptedPayload struct {
	OrganizationID string    `json:"organization_id"`
	InvitationID   string    `json:"invitation_id"`
	UserID         string    `json:"user_id"`
	AcceptedAt     time.Time `json:"accepted_at"`
}

type InvitationCreatedPayload struct {
	OrganizationID string    `json:"organization_id"`
	InvitationID   string    `json:"invitation_id"`
	Email          string    `json:"email"`
	Role           Role      `json:"role"`
	InviterUserID  string    `json:"inviter_user_id"`
	ExpiresAt      time.Time `json:"expires_at"`
}

type InvitationRevokedPayload struct {
	OrganizationID string `json:"organization_id"`
	InvitationID   string `json:"invitation_id"`
}

type MemberAddedPayload struct {
	OrganizationID string `json:"organization_id"`
	UserID         string `json:"user_id"`
	Role           Role   `json:"role"`
}

type MemberRemovedPayload struct {
	OrganizationID string `json:"organization_id"`
	UserID         string `json:"user_id"`
}

type MemberUpdatedPayload struct {
	OrganizationID string           `json:"organization_id"`
	UserID         string           `json:"user_id"`
	Role           Role             `json:"role"`
	Status         MembershipStatus `json:"status"`
}

type Membership struct {
	ID             string           `json:"id"`
	OrganizationID string           `json:"organization_id"`
	UserID         string           `json:"user_id"`
	Role           Role             `json:"role"`
	Status         MembershipStatus `json:"status"`
	CreatedAt      time.Time        `json:"created_at"`
	UpdatedAt      time.Time        `json:"updated_at"`
}

type MembershipStatus string

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

type Option func(*Config)

type Organization interface {

	// CreateOrganization atomically creates a new Organization and adds the owner as the initial active member with RoleOwner.
	CreateOrganization(ctx context.Context, in CreateOrganizationInput) (*OrganizationRecord, error)

	// GetOrganization retrieves an organization by its unique ID.
	GetOrganization(ctx context.Context, orgID string) (*OrganizationRecord, error)

	// GetOrganizationBySlug retrieves an organization by its unique URL slug.
	GetOrganizationBySlug(ctx context.Context, slug string) (*OrganizationRecord, error)

	// UpdateOrganization modifies an existing organization's name or metadata.
	UpdateOrganization(ctx context.Context, orgID string, in UpdateOrganizationInput) (*OrganizationRecord, error)

	// DeleteOrganization deletes an organization, cascading to members, teams, and invitations.
	DeleteOrganization(ctx context.Context, orgID string) error

	// ListUserOrganizations retrieves all organizations where the specified user is an active member.
	ListUserOrganizations(ctx context.Context, userID string) ([]*OrganizationRecord, error)

	// TransferOwnership assigns the organization's ownership to another existing member.
	TransferOwnership(ctx context.Context, orgID, newOwnerUserID string) error

	// AddMember associates a Core User with the organization with a specific role.
	AddMember(ctx context.Context, in AddMemberInput) (*Membership, error)

	// GetMember retrieves a membership record for a user in an organization.
	GetMember(ctx context.Context, orgID, userID string) (*Membership, error)

	// UpdateMemberRole updates the role assigned to a member.
	UpdateMemberRole(ctx context.Context, orgID, userID string, role Role) (*Membership, error)

	// UpdateMemberStatus updates the membership status (e.g. active, suspended).
	UpdateMemberStatus(ctx context.Context, orgID, userID string, status MembershipStatus) (*Membership, error)

	// RemoveMember removes a user from an organization. Cannot remove the owner.
	RemoveMember(ctx context.Context, orgID, userID string) error

	// ListMembers retrieves all members of an organization.
	ListMembers(ctx context.Context, orgID string) ([]*Membership, error)

	// CreateTeam creates a new team within an organization.
	CreateTeam(ctx context.Context, in CreateTeamInput) (*Team, error)

	// GetTeam retrieves a team by ID within the target organization.
	GetTeam(ctx context.Context, orgID, teamID string) (*Team, error)

	// UpdateTeam updates team details within an organization.
	UpdateTeam(ctx context.Context, orgID, teamID string, in UpdateTeamInput) (*Team, error)

	// DeleteTeam removes a team and its member associations.
	DeleteTeam(ctx context.Context, orgID, teamID string) error

	// ListTeams retrieves all teams belonging to an organization.
	ListTeams(ctx context.Context, orgID string) ([]*Team, error)

	// AddTeamMember enrolls an organization member into a team.
	AddTeamMember(ctx context.Context, orgID, teamID, userID string) error

	// RemoveTeamMember removes a user from a team.
	RemoveTeamMember(ctx context.Context, orgID, teamID, userID string) error

	// ListTeamMembers retrieves all user IDs belonging to a team.
	ListTeamMembers(ctx context.Context, orgID, teamID string) ([]string, error)

	// CreateInvitation creates an invitation for an email address and returns the invitation and plaintext redemption token.
	CreateInvitation(ctx context.Context, in CreateInvitationInput) (*Invitation, string, error)

	// GetInvitation retrieves an invitation by ID within an organization.
	GetInvitation(ctx context.Context, orgID, invitationID string) (*Invitation, error)

	// ListInvitations lists all pending invitations for an organization.
	ListInvitations(ctx context.Context, orgID string) ([]*Invitation, error)

	// AcceptInvitation redeems an invitation token for a user, adding them as a member.
	AcceptInvitation(ctx context.Context, rawToken, userID string) (*Membership, error)

	// RevokeInvitation revokes an invitation before it is accepted.
	RevokeInvitation(ctx context.Context, orgID, invitationID string) error

	// Authorize checks whether the context's authenticated Core Principal has active membership with at least minRole in orgID.
	Authorize(ctx context.Context, orgID string, minRole Role) (*Membership, error)
}

type OrganizationCreatedPayload struct {
	OrganizationID string    `json:"organization_id"`
	Slug           string    `json:"slug"`
	OwnerID        string    `json:"owner_id"`
	CreatedAt      time.Time `json:"created_at"`
}

type OrganizationDeletedPayload struct {
	OrganizationID string    `json:"organization_id"`
	DeletedAt      time.Time `json:"deleted_at"`
}

type OrganizationRecord struct {
	ID        string            `json:"id"`
	Name      string            `json:"name"`
	Slug      string            `json:"slug"`
	OwnerID   string            `json:"owner_id"`
	Metadata  map[string]string `json:"metadata,omitempty"`
	CreatedAt time.Time         `json:"created_at"`
	UpdatedAt time.Time         `json:"updated_at"`
}

type OrganizationUpdatedPayload struct {
	OrganizationID string    `json:"organization_id"`
	UpdatedAt      time.Time `json:"updated_at"`
}

type Organizations = Organization

type OwnershipTransferredPayload struct {
	OrganizationID string `json:"organization_id"`
	OldOwnerID     string `json:"old_owner_id"`
	NewOwnerID     string `json:"new_owner_id"`
}

type Role string

type ScopedPrincipal struct {
	Principal      auth.Principal
	OrganizationID string
	Membership     *Membership
}

type Team struct {
	ID             string    `json:"id"`
	OrganizationID string    `json:"organization_id"`
	Name           string    `json:"name"`
	Slug           string    `json:"slug"`
	Description    string    `json:"description,omitempty"`
	CreatedAt      time.Time `json:"created_at"`
	UpdatedAt      time.Time `json:"updated_at"`
}

type TeamCreatedPayload struct {
	OrganizationID string `json:"organization_id"`
	TeamID         string `json:"team_id"`
	Slug           string `json:"slug"`
}

type TeamDeletedPayload struct {
	OrganizationID string `json:"organization_id"`
	TeamID         string `json:"team_id"`
}

type TeamMemberPayload struct {
	OrganizationID string `json:"organization_id"`
	TeamID         string `json:"team_id"`
	UserID         string `json:"user_id"`
}

type TeamMembership struct {
	ID        string    `json:"id"`
	TeamID    string    `json:"team_id"`
	UserID    string    `json:"user_id"`
	CreatedAt time.Time `json:"created_at"`
}

type TeamUpdatedPayload struct {
	OrganizationID string `json:"organization_id"`
	TeamID         string `json:"team_id"`
}

type UpdateOrganizationInput struct {
	Name     *string           `json:"name,omitempty"`
	Metadata map[string]string `json:"metadata,omitempty"`
}

type UpdateTeamInput struct {
	Name        *string `json:"name,omitempty"`
	Description *string `json:"description,omitempty"`
}