entity

Documentation

Index

• type APIKey
• type APIKeyInput
  • func (a APIKeyInput) GetAppID(defaultVal string) string
  • func (a APIKeyInput) GetCreatedAt(defaultVal time.Time) time.Time
  • func (a APIKeyInput) GetIsDisabled(defaultVal bool) bool
  • func (a APIKeyInput) GetKey(defaultVal string) string
• type App
• type Change
• type Empty
• type SSOUser
• type ShortLink
• type ShortLinkInput
  • func (s *ShortLinkInput) GetCustomAlias(defaultVal string) string
  • func (s *ShortLinkInput) GetLongLink(defaultVal string) string
• type Toggle
• type ToggleType
• type User

Types

type APIKey

type APIKey struct {
	AppID      string
	Key        string
	IsDisabled bool
	CreatedAt  time.Time
}

APIKey allows external systems to access cloud APIs enabled for the given third party app.

type APIKeyInput

type APIKeyInput struct {
	AppID      *string
	Key        *string
	IsDisabled *bool
	CreatedAt  *time.Time
}

APIKeyInput represents APIKey with all fields as optional, with some of which having default values

func (APIKeyInput) GetAppID

func (a APIKeyInput) GetAppID(defaultVal string) string

GetAppID fetches AppID for APIKeyInput with default value.

func (APIKeyInput) GetCreatedAt

func (a APIKeyInput) GetCreatedAt(defaultVal time.Time) time.Time

GetCreatedAt fetches createdAt for APIKeyInput with default value.

func (APIKeyInput) GetIsDisabled

func (a APIKeyInput) GetIsDisabled(defaultVal bool) bool

GetIsDisabled fetches isDisabled for APIKeyInput with default value.

func (APIKeyInput) GetKey

func (a APIKeyInput) GetKey(defaultVal string) string

GetKey fetches Key for APIKeyInput with default value.

type App

type App struct {
	ID        string
	Name      string
	CreatedAt time.Time
}

App represents an application owned by third party developer.

type Change

type Change struct {
	ID              string
	Title           string
	SummaryMarkdown *string
	ReleasedAt      time.Time
}

Change represents a single change in change log

type Empty

type Empty struct{}

Empty is a placeholder for an empty struct to reduce memory usage when initializing data structures, such as map with non empty key but empty value.

type SSOUser

type SSOUser struct {
	ID    string
	Email string
	Name  string
}

SSOUser represents an user of the identity provider.

type ShortLink

type ShortLink struct {
	Alias         string
	LongLink      string
	ExpireAt      *time.Time
	CreatedBy     *User
	CreatedAt     *time.Time
	UpdatedAt     *time.Time
	OpenGraphTags metatag.OpenGraph
	TwitterTags   metatag.Twitter
}

ShortLink represents a short link.

type ShortLinkInput

type ShortLinkInput struct {
	LongLink    *string
	CustomAlias *string
	ExpireAt    *time.Time
	CreatedAt   *time.Time
	UpdatedAt   *time.Time
}

ShortLinkInput represents possible ShortLink attributes for a short link.

func (*ShortLinkInput) GetCustomAlias

func (s *ShortLinkInput) GetCustomAlias(defaultVal string) string

GetCustomAlias fetches CustomAlias for ShortLinkInput with default value.

func (*ShortLinkInput) GetLongLink

func (s *ShortLinkInput) GetLongLink(defaultVal string) string

GetLongLink fetches LongLink for ShortLinkInput with default value.

type Toggle

type Toggle struct {
	ID        string
	IsEnabled bool
	Type      ToggleType
}

Toggle represents a controllable switch that can be turned on or off.

type ToggleType

type ToggleType string

const (
	ManualToggle     ToggleType = "manual"
	PermissionToggle ToggleType = "permission"
)

type User

type User struct {
	ID             string
	Name           string
	Email          string
	LastSignedInAt *time.Time
	CreatedAt      *time.Time
	UpdatedAt      *time.Time
}

User contains basic user information such as, user ID, name, and email.