organizations

Documentation

Index

• func Routes(plugin *OrganizationsPlugin) []models.Route
• type API
  • func BuildAPI(plugin *OrganizationsPlugin) *API
  • func (a *API) AcceptInvitation(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationInvitation, error)
  • func (a *API) AddMember(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationMember, error)
  • func (a *API) AddTeamMember(ctx context.Context, actor *models.Actor, organizationID string, teamID string, ...) (*types.OrganizationTeamMember, error)
  • func (a *API) CreateInvitation(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationInvitation, error)
  • func (a *API) CreateOrganization(ctx context.Context, actor *models.Actor, ...) (*types.Organization, error)
  • func (a *API) CreateTeam(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationTeam, error)
  • func (a *API) DeleteOrganization(ctx context.Context, actor *models.Actor, organizationID string) error
  • func (a *API) DeleteTeam(ctx context.Context, actor *models.Actor, organizationID string, teamID string) error
  • func (a *API) ExistsByID(ctx context.Context, organizationID string) (bool, error)
  • func (a *API) GetAllInvitations(ctx context.Context, actor *models.Actor, organizationID string) ([]types.OrganizationInvitation, error)
  • func (a *API) GetAllMembers(ctx context.Context, actor *models.Actor, organizationID string, page int, ...) ([]types.OrganizationMember, error)
  • func (a *API) GetAllOrganizationsByOwner(ctx context.Context, actor *models.Actor) ([]types.Organization, error)
  • func (a *API) GetAllTeamMembers(ctx context.Context, actor *models.Actor, organizationID string, teamID string, ...) ([]types.OrganizationTeamMember, error)
  • func (a *API) GetAllTeams(ctx context.Context, actor *models.Actor, organizationID string) ([]types.OrganizationTeam, error)
  • func (a *API) GetInvitation(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationInvitation, error)
  • func (a *API) GetMember(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationMember, error)
  • func (a *API) GetOrganizationByID(ctx context.Context, actor *models.Actor, organizationID string) (*types.Organization, error)
  • func (a *API) GetTeam(ctx context.Context, actor *models.Actor, organizationID string, teamID string) (*types.OrganizationTeam, error)
  • func (a *API) GetTeamMember(ctx context.Context, actor *models.Actor, organizationID string, teamID string, ...) (*types.OrganizationTeamMember, error)
  • func (a *API) RejectInvitation(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationInvitation, error)
  • func (a *API) RemoveMember(ctx context.Context, actor *models.Actor, organizationID string, ...) error
  • func (a *API) RemoveTeamMember(ctx context.Context, actor *models.Actor, organizationID string, teamID string, ...) error
  • func (a *API) RevokeInvitation(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationInvitation, error)
  • func (a *API) UpdateMember(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.OrganizationMember, error)
  • func (a *API) UpdateOrganization(ctx context.Context, actor *models.Actor, organizationID string, ...) (*types.Organization, error)
  • func (a *API) UpdateTeam(ctx context.Context, actor *models.Actor, organizationID string, teamID string, ...) (*types.OrganizationTeam, error)
• type OrganizationLookupService
• type OrganizationsPlugin
  • func New(config types.OrganizationsPluginConfig) *OrganizationsPlugin
  • func (p *OrganizationsPlugin) Close() error
  • func (p *OrganizationsPlugin) Config() any
  • func (p *OrganizationsPlugin) DependsOn() []string
  • func (p *OrganizationsPlugin) Init(ctx *models.PluginContext) error
  • func (p *OrganizationsPlugin) Metadata() models.PluginMetadata
  • func (p *OrganizationsPlugin) Migrations(provider string) []migrations.Migration
  • func (p *OrganizationsPlugin) Routes() []models.Route

Functions

func Routes

func Routes(plugin *OrganizationsPlugin) []models.Route

Types

type API

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

func BuildAPI

func BuildAPI(plugin *OrganizationsPlugin) *API

func (*API) AcceptInvitation

func (a *API) AcceptInvitation(ctx context.Context, actor *models.Actor, organizationID string, invitationID string) (*types.OrganizationInvitation, error)

func (*API) AddMember

func (a *API) AddMember(ctx context.Context, actor *models.Actor, organizationID string, request types.AddOrganizationMemberRequest) (*types.OrganizationMember, error)

func (*API) AddTeamMember

func (a *API) AddTeamMember(ctx context.Context, actor *models.Actor, organizationID string, teamID string, request types.AddOrganizationTeamMemberRequest) (*types.OrganizationTeamMember, error)

func (*API) CreateInvitation

func (a *API) CreateInvitation(ctx context.Context, actor *models.Actor, organizationID string, request types.CreateOrganizationInvitationRequest) (*types.OrganizationInvitation, error)

func (*API) CreateOrganization

func (a *API) CreateOrganization(ctx context.Context, actor *models.Actor, request types.CreateOrganizationRequest) (*types.Organization, error)

func (*API) CreateTeam

func (a *API) CreateTeam(ctx context.Context, actor *models.Actor, organizationID string, request types.CreateOrganizationTeamRequest) (*types.OrganizationTeam, error)

func (*API) DeleteOrganization

func (a *API) DeleteOrganization(ctx context.Context, actor *models.Actor, organizationID string) error

func (*API) DeleteTeam

func (a *API) DeleteTeam(ctx context.Context, actor *models.Actor, organizationID string, teamID string) error

func (*API) ExistsByID

func (a *API) ExistsByID(ctx context.Context, organizationID string) (bool, error)

func (*API) GetAllInvitations

func (a *API) GetAllInvitations(ctx context.Context, actor *models.Actor, organizationID string) ([]types.OrganizationInvitation, error)

func (*API) GetAllMembers

func (a *API) GetAllMembers(ctx context.Context, actor *models.Actor, organizationID string, page int, limit int) ([]types.OrganizationMember, error)

func (*API) GetAllOrganizationsByOwner

func (a *API) GetAllOrganizationsByOwner(ctx context.Context, actor *models.Actor) ([]types.Organization, error)

func (*API) GetAllTeamMembers

func (a *API) GetAllTeamMembers(ctx context.Context, actor *models.Actor, organizationID string, teamID string, page int, limit int) ([]types.OrganizationTeamMember, error)

func (*API) GetAllTeams

func (a *API) GetAllTeams(ctx context.Context, actor *models.Actor, organizationID string) ([]types.OrganizationTeam, error)

func (*API) GetInvitation

func (a *API) GetInvitation(ctx context.Context, actor *models.Actor, organizationID string, invitationID string) (*types.OrganizationInvitation, error)

func (*API) GetMember

func (a *API) GetMember(ctx context.Context, actor *models.Actor, organizationID string, memberID string) (*types.OrganizationMember, error)

func (*API) GetOrganizationByID

func (a *API) GetOrganizationByID(ctx context.Context, actor *models.Actor, organizationID string) (*types.Organization, error)

func (*API) GetTeam

func (a *API) GetTeam(ctx context.Context, actor *models.Actor, organizationID string, teamID string) (*types.OrganizationTeam, error)

func (*API) GetTeamMember

func (a *API) GetTeamMember(ctx context.Context, actor *models.Actor, organizationID string, teamID string, memberID string) (*types.OrganizationTeamMember, error)

func (*API) RejectInvitation

func (a *API) RejectInvitation(ctx context.Context, actor *models.Actor, organizationID string, invitationID string) (*types.OrganizationInvitation, error)

func (*API) RemoveMember

func (a *API) RemoveMember(ctx context.Context, actor *models.Actor, organizationID string, memberID string) error

func (*API) RemoveTeamMember

func (a *API) RemoveTeamMember(ctx context.Context, actor *models.Actor, organizationID string, teamID string, memberID string) error

func (*API) RevokeInvitation

func (a *API) RevokeInvitation(ctx context.Context, actor *models.Actor, organizationID string, invitationID string) (*types.OrganizationInvitation, error)

func (*API) UpdateMember

func (a *API) UpdateMember(ctx context.Context, actor *models.Actor, organizationID string, memberID string, request types.UpdateOrganizationMemberRequest) (*types.OrganizationMember, error)

func (*API) UpdateOrganization

func (a *API) UpdateOrganization(ctx context.Context, actor *models.Actor, organizationID string, request types.UpdateOrganizationRequest) (*types.Organization, error)

func (*API) UpdateTeam

func (a *API) UpdateTeam(ctx context.Context, actor *models.Actor, organizationID string, teamID string, request types.UpdateOrganizationTeamRequest) (*types.OrganizationTeam, error)

type OrganizationLookupService

type OrganizationLookupService interface {
	ExistsByID(ctx context.Context, organizationID string) (bool, error)
}

type OrganizationsPlugin

type OrganizationsPlugin struct {
	Api *API
	// contains filtered or unexported fields
}

func New

func New(config types.OrganizationsPluginConfig) *OrganizationsPlugin

func (*OrganizationsPlugin) Close

func (p *OrganizationsPlugin) Close() error

func (*OrganizationsPlugin) Config

func (p *OrganizationsPlugin) Config() any

func (*OrganizationsPlugin) DependsOn

func (p *OrganizationsPlugin) DependsOn() []string

func (*OrganizationsPlugin) Init

func (p *OrganizationsPlugin) Init(ctx *models.PluginContext) error

func (*OrganizationsPlugin) Metadata

func (p *OrganizationsPlugin) Metadata() models.PluginMetadata

func (*OrganizationsPlugin) Migrations

func (p *OrganizationsPlugin) Migrations(provider string) []migrations.Migration

func (*OrganizationsPlugin) Routes

func (p *OrganizationsPlugin) Routes() []models.Route