cmd

Documentation

Index

• type ActivateBillingSubscription
• type ActivateTenant
• type AddMentionNotification
• type AddNewComment
• type AddNewNotification
• type AddNewPost
• type AddNewTag
• type AddSubscriber
• type AddVote
• type AssignTag
• type BlockUser
• type CancelBillingSubscription
• type ChangeUserEmail
• type ChangeUserRole
• type CreateTenant
• type DeleteBlob
• type DeleteComment
• type DeleteCurrentUser
• type DeleteTag
• type GenerateCheckoutLink
• type GetWebhookProps
• type HTTPRequest
• type LockExpiredTenants
• type LogDebug
• type LogError
• type LogInfo
• type LogWarn
• type MarkAllNotificationsAsRead
• type MarkNotificationAsRead
• type MarkPostAsDuplicate
• type NewEmailVerification
• type ParseOAuthRawProfile
• type PreviewWebhook
• type PurgeExpiredNotifications
• type RegenerateAPIKey
• type RegisterUser
• type RegisterUserProvider
• type RemoveSubscriber
• type RemoveVote
• type SaveCustomOAuthConfig
• type SaveVerificationKey
• type SendMail
• type SetAttachments
• type SetKeyAsVerified
• type SetPostResponse
• type SetSystemSettings
• type StoreBlob
• type StoreEvent
• type SupressEmail
• type TestWebhook
• type ToggleCommentReaction
• type TriggerWebhooks
• type UnassignTag
• type UnblockUser
• type UpdateComment
• type UpdateCurrentUser
• type UpdateCurrentUserSettings
• type UpdatePost
• type UpdateTag
• type UpdateTenantAdvancedSettings
• type UpdateTenantEmailAuthAllowedSettings
• type UpdateTenantPrivacySettings
• type UpdateTenantSettings
• type UploadImage
• type UploadImages
• type UserListCreateCompany
• type UserListHandleRoleChange
• type UserListUpdateCompany
• type UserListUpdateUser

Types

type ActivateBillingSubscription

type ActivateBillingSubscription struct {
	TenantID       int
	SubscriptionID string
	PlanID         string
}

type ActivateTenant

type ActivateTenant struct {
	TenantID int
}

type AddMentionNotification

type AddMentionNotification struct {
	UserID    int `db:"user_id"`
	CommentID int `db:"comment_id"`
	PostID    int `db:"post_id"`
}

type AddNewComment

type AddNewComment struct {
	Post    *entity.Post
	Content string

	Result *entity.Comment
}

type AddNewNotification

type AddNewNotification struct {
	User   *entity.User
	Title  string
	Link   string
	PostID int

	Result *entity.Notification
}

type AddNewPost

type AddNewPost struct {
	Title       string
	Description string

	Result *entity.Post
}

type AddNewTag

type AddNewTag struct {
	Name     string
	Color    string
	IsPublic bool

	Result *entity.Tag
}

type AddSubscriber

type AddSubscriber struct {
	Post *entity.Post
	User *entity.User
}

type AddVote

type AddVote struct {
	Post *entity.Post
	User *entity.User
}

type AssignTag

type AssignTag struct {
	Tag  *entity.Tag
	Post *entity.Post
}

type BlockUser

type BlockUser struct {
	UserID int
}

type CancelBillingSubscription

type CancelBillingSubscription struct {
	TenantID           int
	SubscriptionEndsAt time.Time
}

type ChangeUserEmail

type ChangeUserEmail struct {
	UserID int
	Email  string
}

type ChangeUserRole

type ChangeUserRole struct {
	UserID int
	Role   enum.Role
}

type CreateTenant

type CreateTenant struct {
	Name      string
	Subdomain string
	Status    enum.TenantStatus

	Result *entity.Tenant
}

type DeleteBlob

type DeleteBlob struct {
	Key string
}

type DeleteComment

type DeleteComment struct {
	CommentID int
}

type DeleteCurrentUser

type DeleteCurrentUser struct {
}

type DeleteTag

type DeleteTag struct {
	Tag *entity.Tag
}

type GenerateCheckoutLink

type GenerateCheckoutLink struct {
	PlanID      string
	Passthrough dto.PaddlePassthrough

	// Output
	URL string
}

type GetWebhookProps

type GetWebhookProps struct {
	Type enum.WebhookType

	Result webhook.Props
}

type HTTPRequest

type HTTPRequest struct {
	URL       string
	Body      io.Reader
	Method    string
	Headers   map[string]string
	BasicAuth *dto.BasicAuth

	//Output
	ResponseBody       []byte
	ResponseStatusCode int
	ResponseHeader     http.Header
}

type LockExpiredTenants

type LockExpiredTenants struct {
	//Output
	NumOfTenantsLocked int64
	TenantsLocked      []int
}

type LogDebug

type LogDebug struct {
	Message string
	Props   dto.Props
}

type LogError

type LogError struct {
	Err     error
	Message string
	Props   dto.Props
}

type LogInfo

type LogInfo struct {
	Message string
	Props   dto.Props
}

type LogWarn

type LogWarn struct {
	Message string
	Props   dto.Props
}

type MarkAllNotificationsAsRead

type MarkAllNotificationsAsRead struct{}

type MarkNotificationAsRead

type MarkNotificationAsRead struct {
	ID int
}

type MarkPostAsDuplicate

type MarkPostAsDuplicate struct {
	Post     *entity.Post
	Original *entity.Post
}

type NewEmailVerification

type NewEmailVerification interface {
	GetEmail() string
	GetName() string
	GetUser() *entity.User
	GetKind() enum.EmailVerificationKind
}

NewEmailVerification is used to define an email verification process

type ParseOAuthRawProfile

type ParseOAuthRawProfile struct {
	Provider string
	Body     string

	Result *dto.OAuthUserProfile
}

type PreviewWebhook

type PreviewWebhook struct {
	Type    enum.WebhookType
	Url     string
	Content string

	Result *dto.WebhookPreviewResult
}

type PurgeExpiredNotifications

type PurgeExpiredNotifications struct {
	NumOfDeletedNotifications int
}

type RegenerateAPIKey

type RegenerateAPIKey struct {
	Result string
}

type RegisterUser

type RegisterUser struct {
	User *entity.User
}

type RegisterUserProvider

type RegisterUserProvider struct {
	UserID       int
	ProviderName string
	ProviderUID  string
}

type RemoveSubscriber

type RemoveSubscriber struct {
	Post *entity.Post
	User *entity.User
}

type RemoveVote

type RemoveVote struct {
	Post *entity.Post
	User *entity.User
}

type SaveCustomOAuthConfig

type SaveCustomOAuthConfig struct {
	ID                int
	Logo              *dto.ImageUpload
	Provider          string
	Status            int
	DisplayName       string
	ClientID          string
	ClientSecret      string
	AuthorizeURL      string
	TokenURL          string
	Scope             string
	ProfileURL        string
	IsTrusted         bool
	JSONUserIDPath    string
	JSONUserNamePath  string
	JSONUserEmailPath string
}

type SaveVerificationKey

type SaveVerificationKey struct {
	Key      string
	Duration time.Duration
	Request  NewEmailVerification
}

type SendMail

type SendMail struct {
	From         dto.Recipient
	To           []dto.Recipient
	TemplateName string
	Props        dto.Props
}

type SetAttachments

type SetAttachments struct {
	Post        *entity.Post
	Comment     *entity.Comment
	Attachments []*dto.ImageUpload
}

type SetKeyAsVerified

type SetKeyAsVerified struct {
	Key string
}

type SetPostResponse

type SetPostResponse struct {
	Post   *entity.Post
	Text   string
	Status enum.PostStatus
}

type SetSystemSettings

type SetSystemSettings struct {
	Key   string
	Value string
}

type StoreBlob

type StoreBlob struct {
	Key         string
	Content     []byte
	ContentType string
}

type StoreEvent

type StoreEvent struct {
	ClientIP  string
	EventName string
}

type SupressEmail

type SupressEmail struct {
	EmailAddresses []string

	//Output
	NumOfSupressedEmailAddresses int
}

type TestWebhook

type TestWebhook struct {
	ID int

	Result *dto.WebhookTriggerResult
}

type ToggleCommentReaction

type ToggleCommentReaction struct {
	Comment *entity.Comment
	Emoji   string
	User    *entity.User
	Result  bool
}

type TriggerWebhooks

type TriggerWebhooks struct {
	Type  enum.WebhookType
	Props webhook.Props
}

type UnassignTag

type UnassignTag struct {
	Tag  *entity.Tag
	Post *entity.Post
}

type UnblockUser

type UnblockUser struct {
	UserID int
}

type UpdateComment

type UpdateComment struct {
	CommentID int
	Content   string
}

type UpdateCurrentUser

type UpdateCurrentUser struct {
	Name       string
	AvatarType enum.AvatarType
	Avatar     *dto.ImageUpload
}

type UpdateCurrentUserSettings

type UpdateCurrentUserSettings struct {
	Settings map[string]string
}

type UpdatePost

type UpdatePost struct {
	Post        *entity.Post
	Title       string
	Description string

	Result *entity.Post
}

type UpdateTag

type UpdateTag struct {
	TagID    int
	Name     string
	Color    string
	IsPublic bool

	Result *entity.Tag
}

type UpdateTenantAdvancedSettings

type UpdateTenantAdvancedSettings struct {
	CustomCSS string
}

type UpdateTenantEmailAuthAllowedSettings

type UpdateTenantEmailAuthAllowedSettings struct {
	IsEmailAuthAllowed bool
}

type UpdateTenantPrivacySettings

type UpdateTenantPrivacySettings struct {
	IsPrivate     bool
	IsFeedEnabled bool
}

type UpdateTenantSettings

type UpdateTenantSettings struct {
	Logo           *dto.ImageUpload
	Title          string
	Invitation     string
	WelcomeMessage string
	CNAME          string
	Locale         string
}

type UploadImage

type UploadImage struct {
	Image  *dto.ImageUpload
	Folder string
}

type UploadImages

type UploadImages struct {
	Images []*dto.ImageUpload
	Folder string
}

type UserListCreateCompany

type UserListCreateCompany struct {
	Name          string
	TenantId      int
	SignedUpAt    string
	BillingStatus string
	Subdomain     string
	UserId        int
	UserEmail     string
	UserName      string
}

type UserListHandleRoleChange

type UserListHandleRoleChange struct {
	Id   int
	Role enum.Role
}

type UserListUpdateCompany

type UserListUpdateCompany struct {
	TenantId      int
	Name          string
	BillingStatus enum.BillingStatus
}

type UserListUpdateUser

type UserListUpdateUser struct {
	Id       int
	TenantId int
	Email    string
	Name     string
}