Documentation
¶
Index ¶
- type AcceptOrganizationInvitationRequest
- type AddOrganizationMemberRequest
- type AddOrganizationTeamMemberRequest
- type CreateOrganizationInvitationRequest
- type CreateOrganizationRequest
- type CreateOrganizationTeamRequest
- type DeleteOrganizationMemberResponse
- type DeleteOrganizationResponse
- type DeleteOrganizationTeamMemberResponse
- type DeleteOrganizationTeamResponse
- type Organization
- type OrganizationDatabaseHooksConfig
- type OrganizationInvitation
- type OrganizationInvitationDatabaseHooksConfig
- type OrganizationInvitationStatus
- type OrganizationMember
- type OrganizationMemberDatabaseHooksConfig
- type OrganizationTeam
- type OrganizationTeamDatabaseHooksConfig
- type OrganizationTeamMember
- type OrganizationTeamMemberDatabaseHooksConfig
- type OrganizationsDatabaseHooksConfig
- type OrganizationsPluginConfig
- type SendOrganizationInvitationEmailParams
- type UpdateOrganizationMemberRequest
- type UpdateOrganizationRequest
- type UpdateOrganizationTeamRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AcceptOrganizationInvitationRequest ¶
type AcceptOrganizationInvitationRequest struct {
RedirectURL *string `json:"redirect_url,omitempty"`
}
func (*AcceptOrganizationInvitationRequest) Validate ¶ added in v1.5.0
func (r *AcceptOrganizationInvitationRequest) Validate() error
type AddOrganizationMemberRequest ¶
type AddOrganizationMemberRequest struct {
UserID string `json:"user_id"`
Role string `json:"role"`
}
func (*AddOrganizationMemberRequest) Validate ¶ added in v1.5.0
func (r *AddOrganizationMemberRequest) Validate() error
type AddOrganizationTeamMemberRequest ¶
type AddOrganizationTeamMemberRequest struct {
MemberID string `json:"member_id"`
}
func (*AddOrganizationTeamMemberRequest) Validate ¶ added in v1.5.0
func (r *AddOrganizationTeamMemberRequest) Validate() error
type CreateOrganizationInvitationRequest ¶
type CreateOrganizationInvitationRequest struct {
Email string `json:"email"`
Role string `json:"role"`
RedirectURL string `json:"redirect_url,omitempty"`
}
func (*CreateOrganizationInvitationRequest) Validate ¶ added in v1.5.0
func (r *CreateOrganizationInvitationRequest) Validate() error
type CreateOrganizationRequest ¶
type CreateOrganizationRequest struct {
Name string `json:"name"`
Role string `json:"role"`
Slug *string `json:"slug,omitempty"`
Logo *string `json:"logo,omitempty"`
Metadata json.RawMessage `json:"metadata,omitempty"`
}
func (*CreateOrganizationRequest) Validate ¶ added in v1.5.0
func (r *CreateOrganizationRequest) Validate() error
type CreateOrganizationTeamRequest ¶
type CreateOrganizationTeamRequest struct {
Name string `json:"name"`
Slug *string `json:"slug,omitempty"`
Description *string `json:"description,omitempty"`
Metadata json.RawMessage `json:"metadata,omitempty"`
}
func (*CreateOrganizationTeamRequest) Validate ¶ added in v1.5.0
func (r *CreateOrganizationTeamRequest) Validate() error
type DeleteOrganizationMemberResponse ¶
type DeleteOrganizationMemberResponse struct {
Message string `json:"message"`
}
type DeleteOrganizationResponse ¶
type DeleteOrganizationResponse struct {
Message string `json:"message"`
}
type DeleteOrganizationTeamMemberResponse ¶
type DeleteOrganizationTeamMemberResponse struct {
Message string `json:"message"`
}
type DeleteOrganizationTeamResponse ¶
type DeleteOrganizationTeamResponse struct {
Message string `json:"message"`
}
type Organization ¶
type Organization struct {
bun.BaseModel `bun:"table:organizations"`
ID string `json:"id" bun:"column:id,pk"`
OwnerID string `json:"owner_id" bun:"column:owner_id"`
Name string `json:"name" bun:"column:name"`
Slug string `json:"slug" bun:"column:slug"`
Logo *string `json:"logo" bun:"column:logo"`
Metadata json.RawMessage `json:"metadata" bun:"column:metadata"`
CreatedAt time.Time `json:"created_at" bun:"column:created_at,default:current_timestamp"`
UpdatedAt time.Time `json:"updated_at" bun:"column:updated_at,default:current_timestamp"`
}
type OrganizationDatabaseHooksConfig ¶
type OrganizationDatabaseHooksConfig struct {
BeforeCreate func(organization *Organization) error
AfterCreate func(organization Organization) error
BeforeUpdate func(organization *Organization) error
AfterUpdate func(organization Organization) error
BeforeDelete func(organization *Organization) error
AfterDelete func(organization Organization) error
}
type OrganizationInvitation ¶
type OrganizationInvitation struct {
bun.BaseModel `bun:"table:organization_invitations"`
ID string `json:"id" bun:"column:id,pk"`
Email string `json:"email" bun:"column:email"`
InviterID string `json:"inviter_id" bun:"column:inviter_id"`
OrganizationID string `json:"organization_id" bun:"column:organization_id"`
Role string `json:"role" bun:"column:role"`
Status OrganizationInvitationStatus `json:"status" bun:"column:status"`
ExpiresAt time.Time `json:"expires_at" bun:"column:expires_at"`
CreatedAt time.Time `json:"created_at" bun:"column:created_at,default:current_timestamp"`
}
type OrganizationInvitationDatabaseHooksConfig ¶
type OrganizationInvitationDatabaseHooksConfig struct {
BeforeCreate func(invitation *OrganizationInvitation) error
AfterCreate func(invitation OrganizationInvitation) error
BeforeUpdate func(invitation *OrganizationInvitation) error
AfterUpdate func(invitation OrganizationInvitation) error
BeforeDelete func(invitation *OrganizationInvitation) error
AfterDelete func(invitation OrganizationInvitation) error
}
type OrganizationInvitationStatus ¶
type OrganizationInvitationStatus string
const ( OrganizationInvitationStatusPending OrganizationInvitationStatus = "pending" OrganizationInvitationStatusAccepted OrganizationInvitationStatus = "accepted" OrganizationInvitationStatusRejected OrganizationInvitationStatus = "rejected" OrganizationInvitationStatusRevoked OrganizationInvitationStatus = "revoked" OrganizationInvitationStatusExpired OrganizationInvitationStatus = "expired" )
type OrganizationMember ¶
type OrganizationMember struct {
bun.BaseModel `bun:"table:organization_members"`
ID string `json:"id" bun:"column:id,pk"`
OrganizationID string `json:"organization_id" bun:"column:organization_id"`
UserID string `json:"user_id" bun:"column:user_id"`
Role string `json:"role" bun:"column:role"`
CreatedAt time.Time `json:"created_at" bun:"column:created_at,default:current_timestamp"`
UpdatedAt time.Time `json:"updated_at" bun:"column:updated_at,default:current_timestamp"`
}
type OrganizationMemberDatabaseHooksConfig ¶
type OrganizationMemberDatabaseHooksConfig struct {
BeforeCreate func(member *OrganizationMember) error
AfterCreate func(member OrganizationMember) error
BeforeUpdate func(member *OrganizationMember) error
AfterUpdate func(member OrganizationMember) error
BeforeDelete func(member *OrganizationMember) error
AfterDelete func(member OrganizationMember) error
}
type OrganizationTeam ¶
type OrganizationTeam struct {
bun.BaseModel `bun:"table:organization_teams"`
ID string `json:"id" bun:"column:id,pk"`
OrganizationID string `json:"organization_id" bun:"column:organization_id"`
Name string `json:"name" bun:"column:name"`
Slug string `json:"slug" bun:"column:slug"`
Description *string `json:"description" bun:"column:description"`
Metadata json.RawMessage `json:"metadata" bun:"column:metadata"`
CreatedAt time.Time `json:"created_at" bun:"column:created_at,default:current_timestamp"`
UpdatedAt time.Time `json:"updated_at" bun:"column:updated_at,default:current_timestamp"`
}
type OrganizationTeamDatabaseHooksConfig ¶
type OrganizationTeamDatabaseHooksConfig struct {
BeforeCreate func(team *OrganizationTeam) error
AfterCreate func(team OrganizationTeam) error
BeforeUpdate func(team *OrganizationTeam) error
AfterUpdate func(team OrganizationTeam) error
BeforeDelete func(team *OrganizationTeam) error
AfterDelete func(team OrganizationTeam) error
}
type OrganizationTeamMember ¶
type OrganizationTeamMember struct {
bun.BaseModel `bun:"table:organization_team_members"`
ID string `json:"id" bun:"column:id,pk"`
TeamID string `json:"team_id" bun:"column:team_id"`
MemberID string `json:"member_id" bun:"column:member_id"`
CreatedAt time.Time `json:"created_at" bun:"column:created_at,default:current_timestamp"`
}
type OrganizationTeamMemberDatabaseHooksConfig ¶
type OrganizationTeamMemberDatabaseHooksConfig struct {
BeforeCreate func(member *OrganizationTeamMember) error
AfterCreate func(member OrganizationTeamMember) error
BeforeDelete func(member *OrganizationTeamMember) error
AfterDelete func(member OrganizationTeamMember) error
}
type OrganizationsDatabaseHooksConfig ¶
type OrganizationsDatabaseHooksConfig struct {
Organizations *OrganizationDatabaseHooksConfig
Members *OrganizationMemberDatabaseHooksConfig
Invitations *OrganizationInvitationDatabaseHooksConfig
Teams *OrganizationTeamDatabaseHooksConfig
TeamMembers *OrganizationTeamMemberDatabaseHooksConfig
}
type OrganizationsPluginConfig ¶
type OrganizationsPluginConfig struct {
Enabled bool `json:"enabled" toml:"enabled"`
OrganizationsLimit *int `json:"organizations_limit" toml:"organizations_limit"`
MembersLimit *int `json:"members_limit" toml:"members_limit"`
InvitationsLimit *int `json:"invitations_limit" toml:"invitations_limit"`
InvitationExpiresIn time.Duration `json:"invitation_expires_in" toml:"invitation_expires_in"`
RequireEmailVerifiedOnInvitation bool `json:"require_email_verified_on_invitation" toml:"require_email_verified_on_invitation"`
DatabaseHooks *OrganizationsDatabaseHooksConfig `json:"-" toml:"-"`
SendOrganizationInvitationEmail func(params SendOrganizationInvitationEmailParams, reqCtx *models.RequestContext) error `json:"-" toml:"-"`
}
func (*OrganizationsPluginConfig) ApplyDefaults ¶
func (config *OrganizationsPluginConfig) ApplyDefaults()
type SendOrganizationInvitationEmailParams ¶ added in v1.5.0
type SendOrganizationInvitationEmailParams struct {
Organization *Organization
Invitation *OrganizationInvitation
Inviter *models.User
AcceptURL string
}
type UpdateOrganizationMemberRequest ¶
type UpdateOrganizationMemberRequest struct {
Role string `json:"role"`
}
func (*UpdateOrganizationMemberRequest) Validate ¶ added in v1.5.0
func (r *UpdateOrganizationMemberRequest) Validate() error
type UpdateOrganizationRequest ¶
type UpdateOrganizationRequest struct {
Name string `json:"name"`
Slug *string `json:"slug,omitempty"`
Logo *string `json:"logo,omitempty"`
Metadata json.RawMessage `json:"metadata,omitempty"`
}
func (*UpdateOrganizationRequest) Validate ¶ added in v1.5.0
func (r *UpdateOrganizationRequest) Validate() error
type UpdateOrganizationTeamRequest ¶
type UpdateOrganizationTeamRequest struct {
Name string `json:"name"`
Slug *string `json:"slug,omitempty"`
Description *string `json:"description,omitempty"`
Metadata json.RawMessage `json:"metadata,omitempty"`
}
func (*UpdateOrganizationTeamRequest) Validate ¶ added in v1.5.0
func (r *UpdateOrganizationTeamRequest) Validate() error
Click to show internal directories.
Click to hide internal directories.