enums

Documentation

Overview

Package enums has enums

Index

• type AuthProvider
  • func ToAuthProvider(r string) *AuthProvider
  • func (r AuthProvider) MarshalGQL(w io.Writer)
  • func (r AuthProvider) String() string
  • func (r *AuthProvider) UnmarshalGQL(v interface{}) error
  • func (AuthProvider) Values() (kinds []string)
• type DocumentType
  • func ToDocumentType(r string) *DocumentType
  • func (r DocumentType) MarshalGQL(w io.Writer)
  • func (r DocumentType) String() string
  • func (r *DocumentType) UnmarshalGQL(v interface{}) error
  • func (DocumentType) Values() (kinds []string)
• type InviteStatus
  • func ToInviteStatus(r string) *InviteStatus
  • func (r InviteStatus) MarshalGQL(w io.Writer)
  • func (r InviteStatus) String() string
  • func (r *InviteStatus) UnmarshalGQL(v interface{}) error
  • func (InviteStatus) Values() (kinds []string)
• type JoinPolicy
  • func ToGroupJoinPolicy(r string) *JoinPolicy
  • func (r JoinPolicy) MarshalGQL(w io.Writer)
  • func (r JoinPolicy) String() string
  • func (r *JoinPolicy) UnmarshalGQL(v interface{}) error
  • func (JoinPolicy) Values() (kinds []string)
• type Region
  • func ToRegion(p string) *Region
  • func (r Region) MarshalGQL(w io.Writer)
  • func (r Region) String() string
  • func (r *Region) UnmarshalGQL(v interface{}) error
  • func (Region) Values() (kinds []string)
• type Role
  • func ToRole(r string) *Role
  • func (r Role) MarshalGQL(w io.Writer)
  • func (r Role) String() string
  • func (r *Role) UnmarshalGQL(v interface{}) error
  • func (Role) Values() (kinds []string)
• type Tier
  • func ToTier(r string) *Tier
  • func (r Tier) MarshalGQL(w io.Writer)
  • func (r Tier) String() string
  • func (r *Tier) UnmarshalGQL(v interface{}) error
  • func (Tier) Values() (kinds []string)
• type UserStatus
  • func ToUserStatus(r string) *UserStatus
  • func (r UserStatus) MarshalGQL(w io.Writer)
  • func (r UserStatus) String() string
  • func (r *UserStatus) UnmarshalGQL(v interface{}) error
  • func (UserStatus) Values() (kinds []string)
• type Visibility
  • func ToGroupVisibility(r string) *Visibility
  • func (r Visibility) MarshalGQL(w io.Writer)
  • func (r Visibility) String() string
  • func (r *Visibility) UnmarshalGQL(v interface{}) error
  • func (Visibility) Values() (kinds []string)

Types

type AuthProvider

type AuthProvider string

var (
	// Credentials provider is when the user authenticates with a username and password
	AuthProviderCredentials AuthProvider = "CREDENTIALS"
	// Google oauth2 provider for authentication
	AuthProviderGoogle AuthProvider = "GOOGLE"
	// Github oauth2 provider for authentication
	AuthProviderGitHub AuthProvider = "GITHUB"
	// Webauthn passkey provider for authentication
	AuthProviderWebauthn AuthProvider = "WEBAUTHN"
	// AuthProviderInvalid is the default value for the AuthProvider enum
	AuthProviderInvalid AuthProvider = "INVALID"
)

func ToAuthProvider

func ToAuthProvider(r string) *AuthProvider

ToAuthProvider returns the AuthProvider based on string input

func (AuthProvider) MarshalGQL

func (r AuthProvider) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (AuthProvider) String

func (r AuthProvider) String() string

String returns the AuthProvider as a string

func (*AuthProvider) UnmarshalGQL

func (r *AuthProvider) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (AuthProvider) Values

func (AuthProvider) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the AuthProvider enum. Possible default values are "CREDENTIALS", "GOOGLE", "GITHUB", and "WEBAUTHN"

type DocumentType

type DocumentType string

var (
	// RootTemplate are templates provided by the system
	RootTemplate DocumentType = "ROOTTEMPLATE"
	// Document are templates from root templates, or scratch, owned by the organization
	Document DocumentType = "DOCUMENT"
	// DocumentTypeInvalid is the default value for the DocumentType enum
	DocumentTypeInvalid DocumentType = "INVALID"
)

func ToDocumentType

func ToDocumentType(r string) *DocumentType

ToDocumentType returns the user status enum based on string input

func (DocumentType) MarshalGQL

func (r DocumentType) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (DocumentType) String

func (r DocumentType) String() string

String returns the DocumentType as a string

func (*DocumentType) UnmarshalGQL

func (r *DocumentType) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (DocumentType) Values

func (DocumentType) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the DocumentType enum. Possible default values are "ROOTTEMPLATE", "DOCUMENT"

type InviteStatus

type InviteStatus string

var (
	InvitationSent     InviteStatus = "INVITATION_SENT"
	ApprovalRequired   InviteStatus = "APPROVAL_REQUIRED"
	InvitationAccepted InviteStatus = "INVITATION_ACCEPTED"
	InvitationExpired  InviteStatus = "INVITATION_EXPIRED"
	InviteInvalid      InviteStatus = "INVITE_INVALID"
)

func ToInviteStatus

func ToInviteStatus(r string) *InviteStatus

ToInviteStatus returns the invite status enum based on string input

func (InviteStatus) MarshalGQL

func (r InviteStatus) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (InviteStatus) String

func (r InviteStatus) String() string

String returns the invite status as a string

func (*InviteStatus) UnmarshalGQL

func (r *InviteStatus) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (InviteStatus) Values

func (InviteStatus) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the InviteStatus enum. Possible default values are "INVITATION_SENT", "APPROVAL_REQUIRED", "INVITATION_ACCEPTED", and "INVITATION_EXPIRED"

type JoinPolicy

type JoinPolicy string

var (
	// JoinPolicyOpen is when the group is open for anyone to join
	JoinPolicyOpen JoinPolicy = "OPEN"
	// JoinPolicyInviteOnly is when the group is only joinable by invite
	JoinPolicyInviteOnly JoinPolicy = "INVITE_ONLY"
	// JoinPolicyApplicationOnly is when the group is only joinable by application
	JoinPolicyApplicationOnly JoinPolicy = "APPLICATION_ONLY"
	// JoinPolicyInviteOrApplication is when the group is joinable by invite or application
	JoinPolicyInviteOrApplication JoinPolicy = "INVITE_OR_APPLICATION"
	// JoinPolicyInvalid is the default value for the JoinPolicy enum
	JoinPolicyInvalid JoinPolicy = "INVALID"
)

func ToGroupJoinPolicy

func ToGroupJoinPolicy(r string) *JoinPolicy

ToGroupJoinPolicy returns the user status enum based on string input

func (JoinPolicy) MarshalGQL

func (r JoinPolicy) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (JoinPolicy) String

func (r JoinPolicy) String() string

String returns the JoinPolicy as a string

func (*JoinPolicy) UnmarshalGQL

func (r *JoinPolicy) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (JoinPolicy) Values

func (JoinPolicy) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the JoinPolicy enum. Possible default values are "OPEN", "INVITE_ONLY", "APPLICATION_ONLY", and "INVITE_OR_APPLICATION".

type Region

type Region string

var (
	Amer          Region = "AMER"
	Emea          Region = "EMEA"
	Apac          Region = "APAC"
	InvalidRegion Region = "INVALID"
)

func ToRegion

func ToRegion(p string) *Region

ToRegion returns the database provider enum based on string input

func (Region) MarshalGQL

func (r Region) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (Region) String

func (r Region) String() string

String returns the Region as a string

func (*Region) UnmarshalGQL

func (r *Region) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (Region) Values

func (Region) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the Region enum. Possible default values are "AMER", "EMEA", and "APAC"

type Role

type Role string

var (
	RoleOwner   Role = "OWNER"
	RoleAdmin   Role = "ADMIN"
	RoleMember  Role = "MEMBER"
	RoleUser    Role = "USER"
	RoleInvalid Role = "INVALID"
)

func ToRole

func ToRole(r string) *Role

ToRole returns the Role based on string input

func (Role) MarshalGQL

func (r Role) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (Role) String

func (r Role) String() string

String returns the role as a string

func (*Role) UnmarshalGQL

func (r *Role) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (Role) Values

func (Role) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the Role enum. Possible default values are "ADMIN", "MEMBER", "OWNER"

type Tier

type Tier string

var (
	TierFree       Tier = "FREE"
	TierPro        Tier = "PRO"
	TierEnterprise Tier = "ENTERPRISE"
	TierInvalid    Tier = "INVALID"
)

func ToTier

func ToTier(r string) *Tier

ToTier returns the Tier based on string input

func (Tier) MarshalGQL

func (r Tier) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (Tier) String

func (r Tier) String() string

String returns the Tier as a string

func (*Tier) UnmarshalGQL

func (r *Tier) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (Tier) Values

func (Tier) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the Tier enum. Possible default values are "FREE", "PRO" and "ENTERPRISE".

type UserStatus

type UserStatus string

var (
	UserStatusActive      UserStatus = "ACTIVE"
	UserStatusInactive    UserStatus = "INACTIVE"
	UserStatusDeactivated UserStatus = "DEACTIVATED"
	UserStatusSuspended   UserStatus = "SUSPENDED"
	UserStatusOnboarding  UserStatus = "ONBOARDING"
	UserStatusInvalid     UserStatus = "INVALID"
)

func ToUserStatus

func ToUserStatus(r string) *UserStatus

ToUserStatus returns the user status enum based on string input

func (UserStatus) MarshalGQL

func (r UserStatus) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (UserStatus) String

func (r UserStatus) String() string

String returns the UserStatus as a string

func (*UserStatus) UnmarshalGQL

func (r *UserStatus) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (UserStatus) Values

func (UserStatus) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the UserStatus enum. Possible default values are "ACTIVE", "INACTIVE", "DEACTIVATED", and "SUSPENDED".

type Visibility

type Visibility string

var (
	VisibilityPublic  Visibility = "PUBLIC"
	VisibilityPrivate Visibility = "PRIVATE"
	VisibilityInvalid Visibility = "INVALID"
)

func ToGroupVisibility

func ToGroupVisibility(r string) *Visibility

ToGroupVisibility returns the user status enum based on string input

func (Visibility) MarshalGQL

func (r Visibility) MarshalGQL(w io.Writer)

MarshalGQL implement the Marshaler interface for gqlgen

func (Visibility) String

func (r Visibility) String() string

String returns the visibility as a string

func (*Visibility) UnmarshalGQL

func (r *Visibility) UnmarshalGQL(v interface{}) error

UnmarshalGQL implement the Unmarshaler interface for gqlgen

func (Visibility) Values

func (Visibility) Values() (kinds []string)

Values returns a slice of strings that represents all the possible values of the Visibility enum. Possible default values are "PUBLIC", and "PRIVATE".