app

type Action struct {
	Type TaskActionType `json:"type"`
	// Payload is the json payload that stores action specific settings or config.
	// This should be unmarshalled into a concrete type during usage
	Payload string `json:"payload"`
}

type ActionType string

type AssignedRun struct {
	RunLink
	Tasks []AssignedTask
}

type AssignedTask struct {
	// ID is the identifier of the containing checklist.
	ChecklistID string

	// Title is the name of the containing checklist.
	ChecklistTitle string

	ChecklistItem
}

type CategorizeChannelPayload struct {
	CategoryName string `json:"category_name" mapstructure:"category_name"`
}

type Category struct {
	ID        string         `json:"id"`
	Name      string         `json:"name"`
	TeamID    string         `json:"team_id"`
	UserID    string         `json:"user_id"`
	Collapsed bool           `json:"collapsed"`
	CreateAt  int64          `json:"create_at"`
	UpdateAt  int64          `json:"update_at"`
	DeleteAt  int64          `json:"delete_at"`
	Items     []CategoryItem `json:"items"`
}

type CategoryItem struct {
	ItemID string           `json:"item_id"`
	Type   CategoryItemType `json:"type"`
	Name   string           `json:"name"`
	Public bool             `json:"public"`
}

type CategoryItemType string

type CategoryService interface {
	// Create creates a new Category
	Create(category Category) (string, error)

	// Get retrieves category with categoryID for user for team
	Get(categoryID string) (Category, error)

	// GetCategories retrieves all categories for user for team
	GetCategories(teamID, userID string) ([]Category, error)

	// Update updates a category
	Update(category Category) error

	// Delete deletes a category
	Delete(categoryID string) error

	// AddFavorite favorites an item, which may be either run or playbook
	AddFavorite(item CategoryItem, teamID, userID string) error

	// DeleteFavorite unfavorites an item, which may be either run or playbook
	DeleteFavorite(item CategoryItem, teamID, userID string) error

	// IsItemFavorite returns whether item was favorited or not
	IsItemFavorite(item CategoryItem, teamID, userID string) (bool, error)

	AreItemsFavorites(items []CategoryItem, teamID, userID string) ([]bool, error)
}

type CategoryStore interface {
	// Get retrieves a Category. Returns ErrNotFound if not found.
	Get(id string) (Category, error)

	// Create creates a new Category
	Create(category Category) error

	// GetCategories retrieves all categories for user for team
	GetCategories(teamID, userID string) ([]Category, error)

	// Update updates a category
	Update(category Category) error

	// Delete deletes a category
	Delete(categoryID string) error

	// GetFavoriteCategory returns favorite category
	GetFavoriteCategory(teamID, userID string) (Category, error)

	// AddItemToFavoriteCategory adds an item to favorite category,
	// if favorite category does not exist it creates one
	AddItemToFavoriteCategory(item CategoryItem, teamID, userID string) error

	// AddItemToCategory adds an item to category
	AddItemToCategory(item CategoryItem, categoryID string) error

	// DeleteItemFromCategory adds an item to category
	DeleteItemFromCategory(item CategoryItem, categoryID string) error
}

type CategoryTelemetry interface {
	// FavoriteItem tracks run favoriting of an item. Item can be run or a playbook
	FavoriteItem(item CategoryItem, userID string)

	// UnfavoriteItem tracks run unfavoriting of an item. Item can be run or a playbook
	UnfavoriteItem(item CategoryItem, userID string)
}

type ChannelActionService interface {
	// Create creates a new action
	Create(action GenericChannelAction) (string, error)

	// Get returns the action identified by id
	Get(id string) (GenericChannelAction, error)

	// GetChannelActions returns all actions in channelID,
	// filtered with the options if different from its zero value
	GetChannelActions(channelID string, options GetChannelActionOptions) ([]GenericChannelAction, error)

	// Update updates an existing action identified by action.ID
	Update(action GenericChannelAction, userID string) error

	// UserHasJoinedChannel is called when userID has joined channelID. If actorID is not blank, userID
	// was invited by actorID.
	UserHasJoinedChannel(userID, channelID, actorID string)

	// CheckAndSendMessageOnJoin checks if userID has viewed channelID and sends
	// the registered welcome message action. Returns true if the message was sent.
	CheckAndSendMessageOnJoin(userID, channelID string) bool

	// MessageHasBeenPosted suggests playbooks to the user if triggered
	MessageHasBeenPosted(post *model.Post)
}

type ChannelActionStore interface {
	// Create creates a new action
	Create(action GenericChannelAction) (string, error)

	// Get returns the action identified by id
	Get(id string) (GenericChannelAction, error)

	// GetChannelActions returns all actions in channelID,
	// filtered with the options if different from its zero value
	GetChannelActions(channelID string, options GetChannelActionOptions) ([]GenericChannelAction, error)

	// Update updates an existing action identified by action.ID
	Update(action GenericChannelAction) error

	// HasViewedChannel returns true if userID has viewed channelID
	HasViewedChannel(userID, channelID string) bool

	// SetViewedChannel records that userID has viewed channelID. NOTE: does not check if there is already a
	// record of that userID/channelID (i.e., will create duplicate rows)
	SetViewedChannel(userID, channelID string) error

	// SetViewedChannel records that all users in userIDs have viewed channelID.
	SetMultipleViewedChannel(userIDs []string, channelID string) error
}

type ChannelActionTelemetry interface {
	// RunChannelAction tracks the execution of a channel action, performed by the specified user.
	RunChannelAction(action GenericChannelAction, userID string)

	// UpdateChannelAction tracks the update of a channel action, performed by the specified user.
	UpdateChannelAction(action GenericChannelAction, userID string)
}

type ChannelPlaybookMode int

type Checklist struct {
	// ID is the identifier of the checklist.
	ID string `json:"id" export:"-"`

	// Title is the name of the checklist.
	Title string `json:"title" export:"title"`

	// Items is an array of all the items in the checklist.
	Items []ChecklistItem `json:"items" export:"-"`
}

type ChecklistCommon interface {
	GetItems() []ChecklistItemCommon
}

type ChecklistItem struct {
	// ID is the identifier of the checklist item.
	ID string `json:"id" export:"-"`

	// Title is the content of the checklist item.
	Title string `json:"title" export:"title"`

	// State is the state of the checklist item: "closed" if it's checked, "skipped" if it has
	// been skipped, the empty string otherwise.
	State string `json:"state" export:"-"`

	// StateModified is the timestamp, in milliseconds since epoch, of the last time the item's
	// state was modified. 0 if it was never modified.
	StateModified int64 `json:"state_modified" export:"-"`

	// AssigneeID is the identifier of the user to whom this item is assigned.
	AssigneeID string `json:"assignee_id" export:"-"`

	// AssigneeModified is the timestamp, in milliseconds since epoch, of the last time the item's
	// assignee was modified. 0 if it was never modified.
	AssigneeModified int64 `json:"assignee_modified" export:"-"`

	// Command, if not empty, is the slash command that can be run as part of this item.
	Command string `json:"command" export:"command"`

	// CommandLastRun is the timestamp, in milliseconds since epoch, of the last time the item's
	// slash command was run. 0 if it was never run.
	CommandLastRun int64 `json:"command_last_run" export:"-"`

	// Description is a string with the markdown content of the long description of the item.
	Description string `json:"description" export:"description"`

	// LastSkipped is the timestamp, in milliseconds since epoch, of the last time the item
	// was skipped. 0 if it was never skipped.
	LastSkipped int64 `json:"delete_at" export:"-"`

	// DueDate is the timestamp, in milliseconds since epoch. indicates relative or absolute due date
	// of the checklist item. 0 if not set.
	// Playbook can have only relative timstamp, run can have only absolute timestamp.
	DueDate int64 `json:"due_date" export:"due_date"`

	// TaskActions is an array of all the task actions associated with this task.
	TaskActions []TaskAction `json:"task_actions" export:"-"`
}

type ChecklistItemCommon interface {
	GetAssigneeID() string

	SetAssigneeModified(modified int64)
	SetState(state string)
	SetStateModified(modified int64)
	SetCommandLastRun(lastRun int64)
}

type DialogState struct {
	PostID       string `json:"post_id"`
	ClientID     string `json:"client_id"`
	PromptPostID string `json:"prompt_post_id"`
}

type DialogStateAddToTimeline struct {
	PostID string `json:"post_id"`
}

type DigestNotificationSettings struct {
	DisableDailyDigest  bool `json:"disable_daily_digest"`
	DisableWeeklyDigest bool `json:"disable_weekly_digest"`
}

type GenericChannelAction struct {
	GenericChannelActionWithoutPayload
	Payload interface{} `json:"payload"`
}

type GenericChannelActionWithoutPayload struct {
	ID          string      `json:"id"`
	ChannelID   string      `json:"channel_id"`
	Enabled     bool        `json:"enabled"`
	DeleteAt    int64       `json:"delete_at"`
	ActionType  ActionType  `json:"action_type"`
	TriggerType TriggerType `json:"trigger_type"`
}

type GenericTelemetry interface {
	Page(name TelemetryPage, properties map[string]interface{})
	Track(name TelemetryTrack, properties map[string]interface{})
}

type GetChannelActionOptions struct {
	ActionType  ActionType
	TriggerType TriggerType
}

type GetPlaybookRunsResults struct {
	TotalCount int           `json:"total_count"`
	PageCount  int           `json:"page_count"`
	PerPage    int           `json:"per_page"`
	HasMore    bool          `json:"has_more"`
	Items      []PlaybookRun `json:"items"`
}

type GetPlaybooksResults struct {
	TotalCount int        `json:"total_count"`
	PageCount  int        `json:"page_count"`
	HasMore    bool       `json:"has_more"`
	Items      []Playbook `json:"items"`
}

type JobOnceScheduler interface {
	Start() error
	SetCallback(callback func(string)) error
	ListScheduledJobs() ([]cluster.JobOnceMetadata, error)
	ScheduleOnce(key string, runAt time.Time) (*cluster.JobOnce, error)
	Cancel(key string)
}

type KeywordsByUsersTrigger struct {
	Payload KeywordsByUsersTriggerPayload
	// contains filtered or unexported fields
}

type KeywordsByUsersTriggerPayload struct {
	Keywords []string `json:"keywords" mapstructure:"keywords"`
	UserIDs  []string `json:"user_ids" mapstructure:"user_ids"`
}

type KeywordsThreadIgnorer interface {
	Ignore(postID, userID string)
	IsIgnored(postID, userID string) bool
}

type LicenseChecker interface {
	PlaybookAllowed(isPlaybookPublic bool) bool
	RetrospectiveAllowed() bool
	TimelineAllowed() bool
	StatsAllowed() bool
	ChecklistItemDueDateAllowed() bool
}

type MarkItemAsDoneAction struct {
	Payload MarkItemAsDoneActionPayload
	// contains filtered or unexported fields
}

type MarkItemAsDoneActionPayload struct {
	Enabled bool `json:"enabled"`
}

type Metadata struct {
	ChannelName        string   `json:"channel_name"`
	ChannelDisplayName string   `json:"channel_display_name"`
	TeamName           string   `json:"team_name"`
	NumParticipants    int64    `json:"num_participants"`
	TotalPosts         int64    `json:"total_posts"`
	Followers          []string `json:"followers"`
}

type OwnerInfo struct {
	UserID    string `json:"user_id"`
	Username  string `json:"username"`
	FirstName string `json:"first_name"`
	LastName  string `json:"last_name"`
	Nickname  string `json:"nickname"`
}

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

type Playbook struct {
	ID                                      string                 `json:"id" export:"-"`
	Title                                   string                 `json:"title" export:"title"`
	Description                             string                 `json:"description" export:"description"`
	Public                                  bool                   `json:"public" export:"-"`
	TeamID                                  string                 `json:"team_id" export:"-"`
	CreatePublicPlaybookRun                 bool                   `json:"create_public_playbook_run" export:"-"`
	CreateAt                                int64                  `json:"create_at" export:"-"`
	UpdateAt                                int64                  `json:"update_at" export:"-"`
	DeleteAt                                int64                  `json:"delete_at" export:"-"`
	NumStages                               int64                  `json:"num_stages" export:"-"`
	NumSteps                                int64                  `json:"num_steps" export:"-"`
	NumRuns                                 int64                  `json:"num_runs" export:"-"`
	NumActions                              int64                  `json:"num_actions" export:"-"`
	LastRunAt                               int64                  `json:"last_run_at" export:"-"`
	Checklists                              []Checklist            `json:"checklists" export:"-"`
	Members                                 []PlaybookMember       `json:"members" export:"-"`
	ReminderMessageTemplate                 string                 `json:"reminder_message_template" export:"reminder_message_template"`
	ReminderTimerDefaultSeconds             int64                  `json:"reminder_timer_default_seconds" export:"reminder_timer_default_seconds"`
	StatusUpdateEnabled                     bool                   `json:"status_update_enabled" export:"status_update_enabled"`
	InvitedUserIDs                          []string               `json:"invited_user_ids" export:"-"`
	InvitedGroupIDs                         []string               `json:"invited_group_ids" export:"-"`
	InviteUsersEnabled                      bool                   `json:"invite_users_enabled" export:"-"`
	DefaultOwnerID                          string                 `json:"default_owner_id" export:"-"`
	DefaultOwnerEnabled                     bool                   `json:"default_owner_enabled" export:"-"`
	BroadcastChannelIDs                     []string               `json:"broadcast_channel_ids" export:"-"`
	WebhookOnCreationURLs                   []string               `json:"webhook_on_creation_urls" export:"-"`
	WebhookOnCreationEnabled                bool                   `json:"webhook_on_creation_enabled" export:"-"`
	MessageOnJoin                           string                 `json:"message_on_join" export:"message_on_join"`
	MessageOnJoinEnabled                    bool                   `json:"message_on_join_enabled" export:"message_on_join_enabled"`
	RetrospectiveReminderIntervalSeconds    int64                  `json:"retrospective_reminder_interval_seconds" export:"retrospective_reminder_interval_seconds"`
	RetrospectiveTemplate                   string                 `json:"retrospective_template" export:"retrospective_template"`
	RetrospectiveEnabled                    bool                   `json:"retrospective_enabled" export:"retrospective_enabled"`
	WebhookOnStatusUpdateURLs               []string               `json:"webhook_on_status_update_urls" export:"-"`
	SignalAnyKeywords                       []string               `json:"signal_any_keywords" export:"signal_any_keywords"`
	SignalAnyKeywordsEnabled                bool                   `json:"signal_any_keywords_enabled" export:"signal_any_keywords_enabled"`
	CategorizeChannelEnabled                bool                   `json:"categorize_channel_enabled" export:"categorize_channel_enabled"`
	CategoryName                            string                 `json:"category_name" export:"category_name"`
	RunSummaryTemplateEnabled               bool                   `json:"run_summary_template_enabled" export:"run_summary_template_enabled"`
	RunSummaryTemplate                      string                 `json:"run_summary_template" export:"run_summary_template"`
	ChannelNameTemplate                     string                 `json:"channel_name_template" export:"channel_name_template"`
	DefaultPlaybookAdminRole                string                 `json:"default_playbook_admin_role" export:"-"`
	DefaultPlaybookMemberRole               string                 `json:"default_playbook_member_role" export:"-"`
	DefaultRunAdminRole                     string                 `json:"default_run_admin_role" export:"-"`
	DefaultRunMemberRole                    string                 `json:"default_run_member_role" export:"-"`
	Metrics                                 []PlaybookMetricConfig `json:"metrics" export:"metrics"`
	ActiveRuns                              int64                  `json:"active_runs" export:"-"`
	CreateChannelMemberOnNewParticipant     bool                   `json:"create_channel_member_on_new_participant" export:"create_channel_member_on_new_participant"`
	RemoveChannelMemberOnRemovedParticipant bool                   `json:"remove_channel_member_on_removed_participant" export:"create_channel_member_on_removed_participant"`

	// ChannelID is the identifier of the channel that would be -potentially- linked
	// to any new run of this playbook
	ChannelID string `json:"channel_id" export:"channel_id"`

	// ChannelMode is the playbook>run>channel flow used
	ChannelMode ChannelPlaybookMode `json:"channel_mode" export:"channel_mode"`

	// Deprecated: preserved for backwards compatibility with v1.27
	BroadcastEnabled             bool `json:"broadcast_enabled" export:"-"`
	WebhookOnStatusUpdateEnabled bool `json:"webhook_on_status_update_enabled" export:"-"`
}

type PlaybookFilterOptions struct {
	Sort               SortField
	Direction          SortDirection
	SearchTerm         string
	WithArchived       bool
	WithMembershipOnly bool //if true will return only playbooks you are a member of
	PlaybookIDs        []string

	// Pagination options.
	Page    int
	PerPage int
}

type PlaybookGetter interface {
	Get(id string) (Playbook, error)
}

type PlaybookInsight struct {
	// ID of the playbook
	// required: true
	PlaybookID string `json:"playbook_id"`

	// Run count of playbook
	// required: true
	NumRuns int `json:"num_runs"`

	// Title of playbook
	// required: true
	Title string `json:"title"`

	// Time the playbook was last run.
	// required: false
	LastRunAt int64 `json:"last_run_at"`
}

type PlaybookMember struct {
	UserID      string   `json:"user_id"`
	Roles       []string `json:"roles"`
	SchemeRoles []string `json:"scheme_roles"`
}

type PlaybookMetricConfig struct {
	ID          string   `json:"id" export:"-"`
	PlaybookID  string   `json:"playbook_id" export:"-"`
	Title       string   `json:"title" export:"title"`
	Description string   `json:"description" export:"description"`
	Type        string   `json:"type" export:"type"`
	Target      null.Int `json:"target" export:"target"`
}

type PlaybookRun struct {
	// ID is the unique identifier of the playbook run.
	ID string `json:"id"`

	// Name is the name of the playbook run's channel.
	Name string `json:"name"`

	// Summary is a short string, in Markdown, describing what the run is.
	Summary string `json:"summary"`

	// SummaryModifiedAt is date when the summary was modified
	SummaryModifiedAt int64 `json:"summary_modified_at"`

	// OwnerUserID is the user identifier of the playbook run's owner.
	OwnerUserID string `json:"owner_user_id"`

	// ReporterUserID is the user identifier of the playbook run's reporter; i.e., the user that created the run.
	ReporterUserID string `json:"reporter_user_id"`

	// TeamID is the identifier of the team the playbook run lives in.
	TeamID string `json:"team_id"`

	// ChannelID is the identifier of the playbook run's channel.
	ChannelID string `json:"channel_id"`

	// CreateAt is the timestamp, in milliseconds since epoch, of when the playbook run was created.
	CreateAt int64 `json:"create_at"`

	// EndAt is the timestamp, in milliseconds since epoch, of when the playbook run was ended.
	// If 0, the run is still ongoing.
	EndAt int64 `json:"end_at"`

	// Deprecated: preserved for backwards compatibility with v1.2.
	DeleteAt int64 `json:"delete_at"`

	// Deprecated: preserved for backwards compatibility with v1.2.
	ActiveStage int `json:"active_stage"`

	// Deprecated: preserved for backwards compatibility with v1.2.
	ActiveStageTitle string `json:"active_stage_title"`

	// PostID, if not empty, is the identifier of the post from which this playbook run was originally created.
	PostID string `json:"post_id"`

	// PlaybookID is the identifier of the playbook from which this run was created.
	PlaybookID string `json:"playbook_id"`

	// Checklists is an array of the checklists in the run.
	Checklists []Checklist `json:"checklists"`

	// StatusPosts is an array of all the status updates posted in the run.
	StatusPosts []StatusPost `json:"status_posts"`

	// CurrentStatus is the current status of the playbook run.
	// It can be StatusInProgress ("InProgress") or StatusFinished ("Finished")
	CurrentStatus string `json:"current_status"`

	// LastStatusUpdateAt is the timestamp, in milliseconds since epoch, of the time the last
	// status update was posted.
	LastStatusUpdateAt int64 `json:"last_status_update_at"`

	// ReminderPostID, if not empty, is the identifier of the reminder posted to the channel to
	// update the status.
	ReminderPostID string `json:"reminder_post_id"`

	// PreviousReminder, if not empty, is the time.Duration (nanoseconds) at which the next
	// scheduled status update will be posted.
	PreviousReminder time.Duration `json:"previous_reminder"`

	// ReminderMessageTemplate, if not empty, is the template shown when updating the status of the
	// playbook run for the first time.
	ReminderMessageTemplate string `json:"reminder_message_template"`

	// ReminderTimerDefaultSeconds is the expected default interval, in seconds,
	// between every status update
	ReminderTimerDefaultSeconds int64 `json:"reminder_timer_default_seconds"`

	//Defines if status update functionality is enabled
	StatusUpdateEnabled bool `json:"status_update_enabled"`

	// InvitedUserIDs, if not empty, is an array containing the identifiers of the users that were
	// automatically invited to the playbook run when it was created.
	InvitedUserIDs []string `json:"invited_user_ids"`

	// InvitedGroupIDs, if not empty, is an array containing the identifiers of the user groups that
	// were automatically invited to the playbook run when it was created.
	InvitedGroupIDs []string `json:"invited_group_ids"`

	// TimelineEvents is an array of the events saved to the timeline of the playbook run.
	TimelineEvents []TimelineEvent `json:"timeline_events"`

	// DefaultOwnerID, if not empty, is the identifier of the user that was automatically assigned
	// as owner of the playbook run when it was created.
	DefaultOwnerID string `json:"default_owner_id"`

	// BroadcastChannelIDs is an array of the identifiers of the channels where the playbook run
	// creation and status updates are announced.
	BroadcastChannelIDs []string `json:"broadcast_channel_ids"`

	// WebhookOnCreationURLs, if not empty, is the URL to which a POST request is made with the whole
	// playbook run as payload when the run is created.
	WebhookOnCreationURLs []string `json:"webhook_on_creation_urls"`

	// WebhookOnStatusUpdateURLs, if not empty, is the URL to which a POST request is made with the
	// whole playbook run as payload every time the status of the playbook run is updated.
	WebhookOnStatusUpdateURLs []string `json:"webhook_on_status_update_urls"`

	// StatusUpdateBroadcastChannelsEnabled is true if the channels broadcast action is enabled for
	// the run status update event, false otherwise.
	StatusUpdateBroadcastChannelsEnabled bool `json:"status_update_broadcast_channels_enabled"`

	// StatusUpdateBroadcastWebhooksEnabled is true if the webhooks broadcast action is enabled for
	// the run status update event, false otherwise.
	StatusUpdateBroadcastWebhooksEnabled bool `json:"status_update_broadcast_webhooks_enabled"`

	// Retrospective is a string containing the currently saved retrospective.
	// If RetrospectivePublishedAt is different than 0, this is the final published retrospective.
	Retrospective string `json:"retrospective"`

	// RetrospectivePublishedAt is the timestamp, in milliseconds since epoch, of the last time a
	// retrospective was published. If 0, the retrospective has not been published yet.
	RetrospectivePublishedAt int64 `json:"retrospective_published_at"`

	// RetrospectiveWasCanceled is true if the retrospective was cancelled, false otherwise.
	RetrospectiveWasCanceled bool `json:"retrospective_was_canceled"`

	// RetrospectiveReminderIntervalSeconds is the interval, in seconds, between subsequent reminders
	// to fill the retrospective.
	RetrospectiveReminderIntervalSeconds int64 `json:"retrospective_reminder_interval_seconds"`

	// Defines if retrospective functionality is enabled
	RetrospectiveEnabled bool `json:"retrospective_enabled"`

	// MessageOnJoin, if not empty, is the message shown to every user that joins the channel of
	// the playbook run.
	MessageOnJoin string `json:"message_on_join"`

	// ParticipantIDs is an array of the identifiers of all the participants in the playbook run.
	// A participant is any member of the playbook run channel that isn't a bot.
	ParticipantIDs []string `json:"participant_ids"`

	// CategoryName, if not empty, is the name of the category where the run channel will live.
	CategoryName string `json:"category_name"`

	// Playbook run metric values
	MetricsData []RunMetricData `json:"metrics_data"`

	// CreateChannelMemberOnNewParticipant is the Run action flag that defines if a new channel member will be added
	// to the run's channel when a new participant is added to the run (by themselve or by other members).
	CreateChannelMemberOnNewParticipant bool `json:"create_channel_member_on_new_participant" export:"create_channel_member_on_new_participant"`

	// RemoveChannelMemberOnRemovedParticipant is the Run action flag that defines if an existent channel member will be removed
	// from the run's channel when a new participant is added to the run (by themselve or by other members).
	RemoveChannelMemberOnRemovedParticipant bool `json:"remove_channel_member_on_removed_participant" export:"create_channel_member_on_removed_participant"`

	// Type determines a type of a run.
	// It can be RunTypePlaybook ("playbook") or RunTypeChannelChecklist ("channel")
	Type string `json:"type"`
}

type PlaybookRunFilterOptions struct {
	// Gets all the headers with this TeamID.
	TeamID string `url:"team_id,omitempty"`

	// Pagination options.
	Page    int `url:"page,omitempty"`
	PerPage int `url:"per_page,omitempty"`

	// Sort sorts by this header field in json format (eg, "create_at", "end_at", "name", etc.);
	// defaults to "create_at".
	Sort SortField `url:"sort,omitempty"`

	// Direction orders by ascending or descending, defaulting to ascending.
	Direction SortDirection `url:"direction,omitempty"`

	// Statuses filters by all statuses in the list (inclusive)
	Statuses []string

	// OwnerID filters by owner's Mattermost user ID. Defaults to blank (no filter).
	OwnerID string `url:"owner_user_id,omitempty"`

	// ParticipantID filters playbook runs that have this member. Defaults to blank (no filter).
	ParticipantID string `url:"participant_id,omitempty"`

	// ParticipantOrFollowerID filters playbook runs that have this user as member or as follower. Defaults to blank (no filter).
	ParticipantOrFollowerID string `url:"participant_or_follower,omitempty"`

	// IncludeFavorites filters playbook runs that ParticipantOrFollowerID has marked as favorite.
	// There's no impact if ParticipantOrFollowerID is empty.
	IncludeFavorites bool `url:"include_favorites,omitempty"`

	// SearchTerm returns results of the search term and respecting the other header filter options.
	// The search term acts as a filter and respects the Sort and Direction fields (i.e., results are
	// not returned in relevance order).
	SearchTerm string `url:"search_term,omitempty"`

	// PlaybookID filters playbook runs that are derived from this playbook id.
	// Defaults to blank (no filter).
	PlaybookID string `url:"playbook_id,omitempty"`

	// ActiveGTE filters playbook runs that were active after (or equal) to the unix time given (in millis).
	// A value of 0 means the filter is ignored (which is the default).
	ActiveGTE int64 `url:"active_gte,omitempty"`

	// ActiveLT filters playbook runs that were active before the unix time given (in millis).
	// A value of 0 means the filter is ignored (which is the default).
	ActiveLT int64 `url:"active_lt,omitempty"`

	// StartedGTE filters playbook runs that were started after (or equal) to the unix time given (in millis).
	// A value of 0 means the filter is ignored (which is the default).
	StartedGTE int64 `url:"started_gte,omitempty"`

	// StartedLT filters playbook runs that were started before the unix time given (in millis).
	// A value of 0 means the filter is ignored (which is the default).
	StartedLT int64 `url:"started_lt,omitempty"`

	// ChannelID filters to playbook runs that are associated with the given channel ID
	ChannelID string `url:"channel_id,omitempty"`

	// Types filters by all run types in the list (inclusive)
	Types []string

	// Skip getting extra information (like timeline events and status posts). Used by GraphQL to limit the amount of data retrieved.
	SkipExtras bool
}

type PlaybookRunService interface {
	// GetPlaybookRuns returns filtered playbook runs and the total count before paging.
	GetPlaybookRuns(requesterInfo RequesterInfo, options PlaybookRunFilterOptions) (*GetPlaybookRunsResults, error)

	// CreatePlaybookRun creates a new playbook run. userID is the user who initiated the CreatePlaybookRun.
	CreatePlaybookRun(playbookRun *PlaybookRun, playbook *Playbook, userID string, public bool) (*PlaybookRun, error)

	// OpenCreatePlaybookRunDialog opens an interactive dialog to start a new playbook run.
	OpenCreatePlaybookRunDialog(teamID, ownerID, triggerID, postID, clientID string, playbooks []Playbook) error

	// OpenUpdateStatusDialog opens an interactive dialog so the user can update the playbook run's status.
	OpenUpdateStatusDialog(playbookRunID, userID, triggerID string) error

	// OpenAddToTimelineDialog opens an interactive dialog so the user can add a post to the playbook run timeline.
	OpenAddToTimelineDialog(requesterInfo RequesterInfo, postID, teamID, triggerID string) error

	// OpenAddChecklistItemDialog opens an interactive dialog so the user can add a post to the playbook run timeline.
	OpenAddChecklistItemDialog(triggerID, userID, playbookRunID string, checklist int) error

	// AddPostToTimeline adds an event based on a post to a playbook run's timeline.
	AddPostToTimeline(playbookRunID, userID string, post *model.Post, summary string) error

	// RemoveTimelineEvent removes the timeline event (sets the DeleteAt to the current time).
	RemoveTimelineEvent(playbookRunID, userID, eventID string) error

	// UpdateStatus updates a playbook run's status.
	UpdateStatus(playbookRunID, userID string, options StatusUpdateOptions) error

	// OpenFinishPlaybookRunDialog opens the dialog to confirm the run should be finished.
	OpenFinishPlaybookRunDialog(playbookRunID, userID, triggerID string) error

	// FinishPlaybookRun changes a run's state to Finished. If run is already in Finished state, the call is a noop.
	FinishPlaybookRun(playbookRunID, userID string) error

	// ToggleStatusUpdates  enables or disables status update for the run
	ToggleStatusUpdates(playbookRunID, userID string, enable bool) error

	// GetPlaybookRun gets a playbook run by ID. Returns error if it could not be found.
	GetPlaybookRun(playbookRunID string) (*PlaybookRun, error)

	// GetPlaybookRunMetadata gets ancillary metadata about a playbook run.
	GetPlaybookRunMetadata(playbookRunID string) (*Metadata, error)

	// GetPlaybookRunsForChannelByUser get the playbookRuns associated with this channel and user.
	GetPlaybookRunsForChannelByUser(channelID string, userID string) ([]PlaybookRun, error)

	// GetOwners returns all the owners of playbook runs selected
	GetOwners(requesterInfo RequesterInfo, options PlaybookRunFilterOptions) ([]OwnerInfo, error)

	// IsOwner returns true if the userID is the owner for playbookRunID.
	IsOwner(playbookRunID string, userID string) bool

	// ChangeOwner processes a request from userID to change the owner for playbookRunID
	// to ownerID. Changing to the same ownerID is a no-op.
	ChangeOwner(playbookRunID string, userID string, ownerID string) error

	// ModifyCheckedState modifies the state of the specified checklist item
	// Idempotent, will not perform any actions if the checklist item is already in the specified state
	ModifyCheckedState(playbookRunID, userID, newState string, checklistNumber int, itemNumber int) error

	// ToggleCheckedState checks or unchecks the specified checklist item
	ToggleCheckedState(playbookRunID, userID string, checklistNumber, itemNumber int) error

	// SetAssignee sets the assignee for the specified checklist item
	// Idempotent, will not perform any actions if the checklist item is already assigned to assigneeID
	SetAssignee(playbookRunID, userID, assigneeID string, checklistNumber, itemNumber int) error

	// SetCommandToChecklistItem sets command to checklist item
	SetCommandToChecklistItem(playbookRunID, userID string, checklistNumber, itemNumber int, newCommand string) error

	// SetDueDate sets absolute due date timestamp for the specified checklist item
	SetDueDate(playbookRunID, userID string, duedate int64, checklistNumber, itemNumber int) error

	// SetTaskActionsToChecklistItem sets Task Actions to checklist item
	SetTaskActionsToChecklistItem(playbookRunID, userID string, checklistNumber, itemNumber int, taskActions []TaskAction) error

	// RunChecklistItemSlashCommand executes the slash command associated with the specified checklist item.
	RunChecklistItemSlashCommand(playbookRunID, userID string, checklistNumber, itemNumber int) (string, error)

	// DuplicateChecklistItem duplicates the checklist item.
	DuplicateChecklistItem(playbookRunID, userID string, checklistNumber, itemNumber int) error

	// AddChecklistItem adds an item to the specified checklist
	AddChecklistItem(playbookRunID, userID string, checklistNumber int, checklistItem ChecklistItem) error

	// RemoveChecklistItem removes an item from the specified checklist
	RemoveChecklistItem(playbookRunID, userID string, checklistNumber int, itemNumber int) error

	// DuplicateChecklist duplicates a checklist
	DuplicateChecklist(playbookRunID, userID string, checklistNumber int) error

	// SkipChecklist skips a checklist
	SkipChecklist(playbookRunID, userID string, checklistNumber int) error

	// RestoreChecklist restores a skipped checklist
	RestoreChecklist(playbookRunID, userID string, checklistNumber int) error

	// SkipChecklistItem removes an item from the specified checklist
	SkipChecklistItem(playbookRunID, userID string, checklistNumber int, itemNumber int) error

	// RestoreChecklistItem restores a skipped item from the specified checklist
	RestoreChecklistItem(playbookRunID, userID string, checklistNumber int, itemNumber int) error

	// EditChecklistItem changes the title, command and description of a specified checklist item.
	EditChecklistItem(playbookRunID, userID string, checklistNumber int, itemNumber int, newTitle, newCommand, newDescription string) error

	// MoveChecklistItem moves a checklist item from one position to another.
	MoveChecklist(playbookRunID, userID string, sourceChecklistIdx, destChecklistIdx int) error

	// MoveChecklistItem moves a checklist item from one position to another.
	MoveChecklistItem(playbookRunID, userID string, sourceChecklistIdx, sourceItemIdx, destChecklistIdx, destItemIdx int) error

	// GetChecklistItemAutocomplete returns the list of checklist items for playbookRuns to be used in autocomplete
	GetChecklistItemAutocomplete(playbookRuns []PlaybookRun) ([]model.AutocompleteListItem, error)

	// GetChecklistAutocomplete returns the list of checklists for playbookRuns to be used in autocomplete
	GetChecklistAutocomplete(playbookRuns []PlaybookRun) ([]model.AutocompleteListItem, error)

	// GetRunsAutocomplete returns the list of runs to be used in autocomplete
	GetRunsAutocomplete(playbookRuns []PlaybookRun) ([]model.AutocompleteListItem, error)

	// AddChecklist prepends a new checklist to the specified run
	AddChecklist(playbookRunID, userID string, checklist Checklist) error

	// RemoveChecklist removes the specified checklist.
	RemoveChecklist(playbookRunID, userID string, checklistNumber int) error

	// RenameChecklist renames the specified checklist
	RenameChecklist(playbookRunID, userID string, checklistNumber int, newTitle string) error

	// NukeDB removes all playbook run related data.
	NukeDB() error

	// SetReminder sets a reminder. After time.Now().Add(fromNow) in the future,
	// the owner will be reminded to update the playbook run's status.
	SetReminder(playbookRunID string, fromNow time.Duration) error

	// RemoveReminder removes the pending reminder for playbookRunID (if any).
	RemoveReminder(playbookRunID string)

	// HandleReminder is the handler for all reminder events.
	HandleReminder(key string)

	// SetNewReminder sets a new reminder for playbookRunID, removes any pending reminder, removes the
	// reminder post in the playbookRun's channel, and resets the PreviousReminder and
	// LastStatusUpdateAt (so the countdown timer to "update due" shows the correct time)
	SetNewReminder(playbookRunID string, newReminder time.Duration) error

	// ResetReminder records an event for snoozing a reminder, then calls SetNewReminder to create
	// the next reminder
	ResetReminder(playbookRunID string, newReminder time.Duration) error

	// ChangeCreationDate changes the creation date of the specified playbook run.
	ChangeCreationDate(playbookRunID string, creationTimestamp time.Time) error

	// UpdateRetrospective updates the retrospective for the given playbook run.
	UpdateRetrospective(playbookRunID, userID string, retrospective RetrospectiveUpdate) error

	// PublishRetrospective publishes the retrospective.
	PublishRetrospective(playbookRunID, userID string, retrospective RetrospectiveUpdate) error

	// CancelRetrospective cancels the retrospective.
	CancelRetrospective(playbookRunID, userID string) error

	// EphemeralPostTodoDigestToUser gathers the list of assigned tasks, participating runs, and overdue updates,
	// and sends an ephemeral post to userID on channelID. Use force = true to post even if there are no items.
	EphemeralPostTodoDigestToUser(userID string, channelID string, force bool, includeRunsInProgress bool) error

	// DMTodoDigestToUser gathers the list of assigned tasks, participating runs, and overdue updates,
	// and DMs the message to userID. Use force = true to DM even if there are no items.
	DMTodoDigestToUser(userID string, force bool, includeRunsInProgress bool) error

	// GetRunsWithAssignedTasks returns the list of runs that have tasks assigned to userID
	GetRunsWithAssignedTasks(userID string) ([]AssignedRun, error)

	// GetParticipatingRuns returns the list of active runs with userID as participant
	GetParticipatingRuns(userID string) ([]RunLink, error)

	// GetOverdueUpdateRuns returns the list of userID's runs that have overdue updates
	GetOverdueUpdateRuns(userID string) ([]RunLink, error)

	// Follow method lets user follow a specific playbook run
	Follow(playbookRunID, userID string) error

	// UnFollow method lets user unfollow a specific playbook run
	Unfollow(playbookRunID, userID string) error

	// GetFollowers returns list of followers for a specific playbook run
	GetFollowers(playbookRunID string) ([]string, error)

	// RestorePlaybookRun reverts a run from the Finished state. If run was not in Finished state, the call is a noop.
	RestorePlaybookRun(playbookRunID, userID string) error

	// RequestUpdate posts a status update request message in the run's channel
	RequestUpdate(playbookRunID, requesterID string) error

	// RequestJoinChannel posts a channel-join request message in the run's channel
	RequestJoinChannel(playbookRunID, requesterID string) error

	// RemoveParticipants removes users from the run's participants
	RemoveParticipants(playbookRunID string, userIDs []string, requesterUserID string) error

	// AddParticipants adds users to the participants list
	AddParticipants(playbookRunID string, userIDs []string, requesterUserID string, forceAddToChannel bool) error

	// GetPlaybookRunIDsForUser returns run ids where user is a participant or is following
	GetPlaybookRunIDsForUser(userID string) ([]string, error)

	// GetRunMetadataByIDs returns playbook runs metadata by passed run IDs.
	// Notice that order of passed ids and returned runs might not coincide
	GetRunMetadataByIDs(runIDs []string) ([]RunMetadata, error)

	// GetTaskMetadataByIDs gets PlaybookRunIDs and TeamIDs from runs by taskIDs
	GetTaskMetadataByIDs(taskIDs []string) ([]TopicMetadata, error)

	// GetStatusMetadataByIDs gets PlaybookRunIDs and TeamIDs from runs by statusIDs
	GetStatusMetadataByIDs(statusIDs []string) ([]TopicMetadata, error)

	// GraphqlUpdate taking a setmap for graphql
	GraphqlUpdate(id string, setmap map[string]interface{}) error

	// MessageHasBeenPosted checks posted messages for triggers that may trigger task actions
	MessageHasBeenPosted(post *model.Post)
}

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

type PlaybookRunStore interface {
	// GetPlaybookRuns returns filtered playbook runs and the total count before paging.
	GetPlaybookRuns(requesterInfo RequesterInfo, options PlaybookRunFilterOptions) (*GetPlaybookRunsResults, error)

	// CreatePlaybookRun creates a new playbook run. If playbook run has an ID, that ID will be used.
	CreatePlaybookRun(playbookRun *PlaybookRun) (*PlaybookRun, error)

	// UpdatePlaybookRun updates a playbook run.
	UpdatePlaybookRun(playbookRun *PlaybookRun) (*PlaybookRun, error)

	// GraphqlUpdate taking a setmap for graphql
	GraphqlUpdate(id string, setmap map[string]interface{}) error

	// UpdateStatus updates the status of a playbook run.
	UpdateStatus(statusPost *SQLStatusPost) error

	// FinishPlaybookRun finishes a run at endAt (in millis)
	FinishPlaybookRun(playbookRunID string, endAt int64) error

	// RestorePlaybookRun restores a run at restoreAt (in millis)
	RestorePlaybookRun(playbookRunID string, restoreAt int64) error

	// GetTimelineEvent returns the timeline event for playbookRunID by the timeline event ID.
	GetTimelineEvent(playbookRunID, eventID string) (*TimelineEvent, error)

	// CreateTimelineEvent inserts the timeline event into the DB and returns the new event ID
	CreateTimelineEvent(event *TimelineEvent) (*TimelineEvent, error)

	// UpdateTimelineEvent updates an existing timeline event
	UpdateTimelineEvent(event *TimelineEvent) error

	// GetPlaybookRun gets a playbook run by ID.
	GetPlaybookRun(playbookRunID string) (*PlaybookRun, error)

	// GetPlaybookRunIDsForChannel gets a playbook runs list associated with the given channel id.
	GetPlaybookRunIDsForChannel(channelID string) ([]string, error)

	// GetHistoricalPlaybookRunParticipantsCount returns the count of all participants of the
	// playbook run associated with the given channel id since the beginning of the
	// playbook run, excluding bots.
	GetHistoricalPlaybookRunParticipantsCount(channelID string) (int64, error)

	// GetOwners returns the owners of the playbook runs selected by options
	GetOwners(requesterInfo RequesterInfo, options PlaybookRunFilterOptions) ([]OwnerInfo, error)

	// NukeDB removes all playbook run related data.
	NukeDB() error

	// ChangeCreationDate changes the creation date of the specified playbook run.
	ChangeCreationDate(playbookRunID string, creationTimestamp time.Time) error

	// GetBroadcastChannelIDsToRootIDs takes a playbookRunID and returns the mapping of
	// broadcastChannelID->rootID (to keep track of the status updates thread in each of the
	// playbook's broadcast channels).
	GetBroadcastChannelIDsToRootIDs(playbookRunID string) (map[string]string, error)

	// SetBroadcastChannelIDsToRootID sets the broadcastChannelID->rootID mappings for playbookRunID
	SetBroadcastChannelIDsToRootID(playbookRunID string, channelIDsToRootIDs map[string]string) error

	// GetRunsWithAssignedTasks returns the list of runs that have tasks assigned to userID
	GetRunsWithAssignedTasks(userID string) ([]AssignedRun, error)

	// GetParticipatingRuns returns the list of active runs with userID as a participant
	GetParticipatingRuns(userID string) ([]RunLink, error)

	// GetOverdueUpdateRuns returns the list of runs that userID is participating in that have overdue updates
	GetOverdueUpdateRuns(userID string) ([]RunLink, error)

	// Follow method lets user follow a specific playbook run
	Follow(playbookRunID, userID string) error

	// UnFollow method lets user unfollow a specific playbook run
	Unfollow(playbookRunID, userID string) error

	// GetFollowers returns list of followers for a specific playbook run
	GetFollowers(playbookRunID string) ([]string, error)

	// GetRunsActiveTotal returns number of active runs
	GetRunsActiveTotal() (int64, error)

	// GetOverdueUpdateRunsTotal returns number of runs that have overdue status updates
	GetOverdueUpdateRunsTotal() (int64, error)

	// GetOverdueRetroRunsTotal returns the number of completed runs without retro and with reminder
	GetOverdueRetroRunsTotal() (int64, error)

	// GetFollowersActiveTotal returns total number of active followers, including duplicates
	// if a user is following more than one run, it will be counted multiple times
	GetFollowersActiveTotal() (int64, error)

	// GetParticipantsActiveTotal returns number of active participants
	// (i.e. members of the playbook run channel when the run is active)
	// if a user is member of more than one channel, it will be counted multiple times
	GetParticipantsActiveTotal() (int64, error)

	// AddParticipants adds particpants to the run
	AddParticipants(playbookRunID string, userIDs []string) error

	// RemoveParticipants removes participants from the run
	RemoveParticipants(playbookRunID string, userIDs []string) error

	// GetSchemeRolesForChannel scheme role ids for the channel
	GetSchemeRolesForChannel(channelID string) (string, string, string, error)

	// GetSchemeRolesForTeam scheme role ids for the team
	GetSchemeRolesForTeam(teamID string) (string, string, string, error)

	// GetPlaybookRunIDsForUser returns run ids where user is a participant or is following
	GetPlaybookRunIDsForUser(userID string) ([]string, error)

	// GetRunMetadataByIDs returns playbook runs metadata by passed run IDs.
	// Notice that order of passed ids and returned runs might not coincide
	GetRunMetadataByIDs(runIDs []string) ([]RunMetadata, error)

	// GetTaskAsTopicMetadataByIDs gets PlaybookRunIDs and TeamIDs from runs by taskIDs
	GetTaskAsTopicMetadataByIDs(taskIDs []string) ([]TopicMetadata, error)

	// GetStatusAsTopicMetadataByIDs gets PlaybookRunIDs and TeamIDs from runs by statusIDs
	GetStatusAsTopicMetadataByIDs(statusIDs []string) ([]TopicMetadata, error)

	// GetStatsPostsByIDs gets the status posts for playbook runs
	GetStatusPostsByIDs(playbookRunID []string) (map[string][]StatusPost, error)

	// GetTimelineEventsByIDs gets the timeline events for playbook runs.
	GetTimelineEventsByIDs(playbookRunID []string) ([]TimelineEvent, error)

	// GetMetricsByIDs gets the metrics for playbook runs.
	GetMetricsByIDs(playbookRunID []string) (map[string][]RunMetricData, error)
}

type PlaybookRunTelemetry interface {
	// CreatePlaybookRun tracks the creation of a new playbook run.
	CreatePlaybookRun(playbookRun *PlaybookRun, userID string, public bool)

	// FinishPlaybookRun tracks the end of a playbook run.
	FinishPlaybookRun(playbookRun *PlaybookRun, userID string)

	// RestorePlaybookRun tracks the restoration of a playbook run.
	RestorePlaybookRun(playbookRun *PlaybookRun, userID string)

	// RestartPlaybookRun tracks the restart of a playbook run.
	RestartPlaybookRun(playbookRun *PlaybookRun, userID string)

	// ChangeOwner tracks changes in owner.
	ChangeOwner(playbookRun *PlaybookRun, userID string)

	// UpdateStatus tracks when a playbook run's status has been updated
	UpdateStatus(playbookRun *PlaybookRun, userID string)

	// FrontendTelemetryForPlaybookRun tracks an event originating from the frontend
	FrontendTelemetryForPlaybookRun(playbookRun *PlaybookRun, userID, action string)

	// AddPostToTimeline tracks userID creating a timeline event from a post.
	AddPostToTimeline(playbookRun *PlaybookRun, userID string)

	// RemoveTimelineEvent tracks userID removing a timeline event.
	RemoveTimelineEvent(playbookRun *PlaybookRun, userID string)

	// ModifyCheckedState tracks the checking and unchecking of items.
	ModifyCheckedState(playbookRunID, userID string, task ChecklistItem, wasOwner bool)

	// SetAssignee tracks the changing of an assignee on an item.
	SetAssignee(playbookRunID, userID string, task ChecklistItem)

	// AddTask tracks the creation of a new checklist item.
	AddTask(playbookRunID, userID string, task ChecklistItem)

	// RemoveTask tracks the removal of a checklist item.
	RemoveTask(playbookRunID, userID string, task ChecklistItem)

	// SkipChecklist tracks the skipping of a checklist.
	SkipChecklist(playbookRunID, userID string, checklist Checklist)

	// RestoreChecklist tracks the restoring of a checklist.
	RestoreChecklist(playbookRunID, userID string, checklist Checklist)

	// SkipTask tracks the skipping of a checklist item.
	SkipTask(playbookRunID, userID string, task ChecklistItem)

	// RestoreTask tracks the restoring of a checklist item.
	RestoreTask(playbookRunID, userID string, task ChecklistItem)

	// RenameTask tracks the update of a checklist item.
	RenameTask(playbookRunID, userID string, task ChecklistItem)

	// MoveChecklist tracks the movement of a checklist
	MoveChecklist(playbookRunID, userID string, task Checklist)

	// MoveTask tracks the movement of a checklist item
	MoveTask(playbookRunID, userID string, task ChecklistItem)

	// RunTaskSlashCommand tracks the execution of a slash command attached to
	// a checklist item.
	RunTaskSlashCommand(playbookRunID, userID string, task ChecklistItem)

	// AddChecklsit tracks the creation of a new checklist.
	AddChecklist(playbookRunID, userID string, checklist Checklist)

	// RemoveChecklist tracks the removal of a checklist.
	RemoveChecklist(playbookRunID, userID string, checklist Checklist)

	// RenameChecklsit tracks the creation of a new checklist.
	RenameChecklist(playbookRunID, userID string, checklist Checklist)

	// UpdateRetrospective event
	UpdateRetrospective(playbookRun *PlaybookRun, userID string)

	// PublishRetrospective event
	PublishRetrospective(playbookRun *PlaybookRun, userID string)

	// Follow tracks userID following a playbook run.
	Follow(playbookRun *PlaybookRun, userID string)

	// Unfollow tracks userID following a playbook run.
	Unfollow(playbookRun *PlaybookRun, userID string)

	// RunAction tracks the run actions, i.e., status broadcast action
	RunAction(playbookRun *PlaybookRun, userID, triggerType, actionType string, numBroadcasts int)
}

type PlaybookRunWebhookEvent struct {
	// Type is the type of event emitted.
	Type timelineEventType `json:"type"`

	// At is the time when the event occurred.
	At int64 `json:"at"`

	// UserId is the user who triggered the event.
	UserID string `json:"user_id"`

	// Payload is optional, event-specific metadata.
	Payload interface{} `json:"payload"`
}

type PlaybookRunWebhookPayload struct {
	PlaybookRun

	// ChannelURL is the absolute URL of the playbook run channel.
	ChannelURL string `json:"channel_url"`

	// DetailsURL is the absolute URL of the playbook run overview page.
	DetailsURL string `json:"details_url"`

	// Event is metadata concerning the event that triggered this webhook.
	Event PlaybookRunWebhookEvent `json:"event"`
}

type PlaybookService interface {
	// Get retrieves a playbook. Returns ErrNotFound if not found.
	Get(id string) (Playbook, error)

	// Create creates a new playbook
	Create(playbook Playbook, userID string) (string, error)

	// Import imports a new playbook
	Import(playbook Playbook, userID string) (string, error)

	// GetPlaybooks retrieves all playbooks
	GetPlaybooks() ([]Playbook, error)

	// GetPlaybooksForTeam retrieves all playbooks on the specified team given the provided options
	GetPlaybooksForTeam(requesterInfo RequesterInfo, teamID string, opts PlaybookFilterOptions) (GetPlaybooksResults, error)

	// Update updates a playbook
	Update(playbook Playbook, userID string) error

	// Archive archives a playbook
	Archive(playbook Playbook, userID string) error

	// Restores an archived playbook
	Restore(playbook Playbook, userID string) error

	// AutoFollow method lets user auto-follow all runs of a specific playbook
	AutoFollow(playbookID, userID string) error

	// AutoUnfollow method lets user to not auto-follow the newly created playbook runs
	AutoUnfollow(playbookID, userID string) error

	// GetAutoFollows returns list of users who auto-follows a playbook
	GetAutoFollows(playbookID string) ([]string, error)

	// Duplicate duplicates a playbook
	Duplicate(playbook Playbook, userID string) (string, error)

	// Get top playbooks for teams
	GetTopPlaybooksForTeam(teamID, userID string, opts *model.InsightsOpts) (*PlaybooksInsightsList, error)

	// Get top playbooks for users
	GetTopPlaybooksForUser(teamID, userID string, opts *model.InsightsOpts) (*PlaybooksInsightsList, error)
}

type PlaybookStore interface {
	// Get retrieves a playbook
	Get(id string) (Playbook, error)

	// Create creates a new playbook
	Create(playbook Playbook) (string, error)

	// GetPlaybooks retrieves all playbooks
	GetPlaybooks() ([]Playbook, error)

	// GetPlaybooksForTeam retrieves all playbooks on the specified team
	GetPlaybooksForTeam(requesterInfo RequesterInfo, teamID string, opts PlaybookFilterOptions) (GetPlaybooksResults, error)

	// GetPlaybooksWithKeywords retrieves all playbooks with keywords enabled
	GetPlaybooksWithKeywords(opts PlaybookFilterOptions) ([]Playbook, error)

	// GetTimeLastUpdated retrieves time last playbook was updated at.
	// Passed argument determines whether to include playbooks with
	// SignalAnyKeywordsEnabled flag or not.
	GetTimeLastUpdated(onlyPlaybooksWithKeywordsEnabled bool) (int64, error)

	// GetPlaybookIDsForUser retrieves playbooks user can access
	GetPlaybookIDsForUser(userID, teamID string) ([]string, error)

	// Update updates a playbook
	Update(playbook Playbook) error

	// GraphqlUpdate taking a setmap for graphql
	GraphqlUpdate(id string, setmap map[string]interface{}) error

	// Archive archives a playbook
	Archive(id string) error

	// Restore restores a deleted playbook
	Restore(id string) error

	// AutoFollow method lets user auto-follow all runs of a specific playbook
	AutoFollow(playbookID, userID string) error

	// AutoUnfollow method lets user to not auto-follow the newly created playbook runs
	AutoUnfollow(playbookID, userID string) error

	// GetAutoFollows returns list of users who auto-follows a playbook
	GetAutoFollows(playbookID string) ([]string, error)

	// GetPlaybooksActiveTotal returns number of active playbooks
	GetPlaybooksActiveTotal() (int64, error)

	// GetMetric retrieves a metric by ID
	GetMetric(id string) (*PlaybookMetricConfig, error)

	// AddMetric adds a metric
	AddMetric(playbookID string, config PlaybookMetricConfig) error

	// UpdateMetric updates a metric
	UpdateMetric(id string, setmap map[string]interface{}) error

	// DeleteMetric deletes a metric
	DeleteMetric(id string) error

	// Get top playbooks for teams
	GetTopPlaybooksForTeam(teamID, userID string, opts *model.InsightsOpts) (*PlaybooksInsightsList, error)

	// Get top playbooks for users
	GetTopPlaybooksForUser(teamID, userID string, opts *model.InsightsOpts) (*PlaybooksInsightsList, error)

	// AddPlaybookMember adds a user as a member to a playbook
	AddPlaybookMember(id string, memberID string) error

	// RemovePlaybookMember removes a user from a playbook
	RemovePlaybookMember(id string, memberID string) error
}

type PlaybookTelemetry interface {
	// CreatePlaybook tracks the creation of a playbook.
	CreatePlaybook(playbook Playbook, userID string)

	// ImportPlaybook tracks the import of a playbook.
	ImportPlaybook(playbook Playbook, userID string)

	// UpdatePlaybook tracks the update of a playbook.
	UpdatePlaybook(playbook Playbook, userID string)

	// DeletePlaybook tracks the deletion of a playbook.
	DeletePlaybook(playbook Playbook, userID string)

	// RestorePlaybook tracks the restoration of a playbook.
	RestorePlaybook(playbook Playbook, userID string)

	// FrontendTelemetryForPlaybook tracks an event originating from the frontend
	FrontendTelemetryForPlaybook(playbook Playbook, userID, action string)

	// FrontendTelemetryForPlaybookTemplate tracks an event originating from the frontend
	FrontendTelemetryForPlaybookTemplate(templateName string, userID, action string)

	// AutoFollowPlaybook tracks the auto-follow of a playbook.
	AutoFollowPlaybook(playbook Playbook, userID string)

	// AutoUnfollowPlaybook tracks the auto-unfollow of a playbook.
	AutoUnfollowPlaybook(playbook Playbook, userID string)
}

type PlaybooksInsightsList struct {
	HasNext bool               `json:"has_next"`
	Items   []*PlaybookInsight `json:"items"`
}

type PromptRunPlaybookFromKeywordsPayload struct {
	Keywords   []string `json:"keywords" mapstructure:"keywords"`
	PlaybookID string   `json:"playbook_id" mapstructure:"playbook_id"`
}

type RequesterInfo struct {
	UserID  string
	TeamID  string
	IsAdmin bool
	IsGuest bool
}

type RetrospectiveUpdate struct {
	Text    string          `json:"retrospective"`
	Metrics []RunMetricData `json:"metrics"`
}

type RunAction struct {
	BroadcastChannelIDs       []string `json:"broadcast_channel_ids"`
	WebhookOnStatusUpdateURLs []string `json:"webhook_on_status_update_urls"`

	StatusUpdateBroadcastChannelsEnabled bool `json:"status_update_broadcast_channels_enabled"`
	StatusUpdateBroadcastWebhooksEnabled bool `json:"status_update_broadcast_webhooks_enabled"`

	CreateChannelMemberOnNewParticipant     bool `json:"create_channel_member_on_new_participant"`
	RemoveChannelMemberOnRemovedParticipant bool `json:"remove_channel_member_on_removed_participant"`
}

type RunLink struct {
	PlaybookRunID string
	Name          string
}

type RunMetadata struct {
	ID     string
	Name   string
	TeamID string
}

type RunMetricData struct {
	MetricConfigID string   `json:"metric_config_id"`
	Value          null.Int `json:"value"`
}

type RunWSOption func(options *RunWSOptions)

type RunWSOptions struct {
	AdditionalUserIDs []string
	PlaybookRun       *PlaybookRun
}

type SQLStatusPost struct {
	PlaybookRunID string
	PostID        string
	EndAt         int64
}

type SortDirection string

type SortField string

type StatusPost struct {
	// ID is the identifier of the post containing the status update.
	ID string `json:"id"`

	// CreateAt is the timestamp, in milliseconds since epoch, of the time this status update was
	// posted.
	CreateAt int64 `json:"create_at"`

	// DeleteAt is the timestamp, in milliseconds since epoch, of the time the post containing this
	// status update was deleted. 0 if it was never deleted.
	DeleteAt int64 `json:"delete_at"`
}

type StatusPostComplete struct {
	// ID is the identifier of the post containing the status update.
	ID string `json:"id"`

	// CreateAt is the timestamp, in milliseconds since epoch, of the time this status update was
	// posted.
	CreateAt int64 `json:"create_at"`

	// DeleteAt is the timestamp, in milliseconds since epoch, of the time the post containing this
	// status update was deleted. 0 if it was never deleted.
	DeleteAt int64 `json:"delete_at"`

	// Message is the content of the status update. It supports markdown.
	Message string `json:"message"`

	// AuthorUserName is the username of the user who sent the status update.
	AuthorUserName string `json:"author_user_name"`
}

type StatusUpdateOptions struct {
	Message   string        `json:"message"`
	Reminder  time.Duration `json:"reminder"`
	FinishRun bool          `json:"finish_run"`
}

type TaskAction struct {
	Trigger Trigger  `json:"trigger"`
	Actions []Action `json:"actions"`
}

type TaskActionType string

type TaskTriggerType string

type TelemetryPage int

type TelemetryTrack int

type TelemetryType string

type TimelineEvent struct {
	// ID is the identifier of this event.
	ID string `json:"id"`

	// PlaybookRunID is the identifier of the playbook run this event lives in.
	PlaybookRunID string `json:"playbook_run_id"`

	// CreateAt is the timestamp, in milliseconds since epoch, of the time this event was created.
	CreateAt int64 `json:"create_at"`

	// DeleteAt is the timestamp, in milliseconds since epoch, of the time this event was deleted.
	// 0 if it was never deleted.
	DeleteAt int64 `json:"delete_at"`

	// EventAt is the timestamp, in milliseconds since epoch, of the actual situation this event is
	// describing.
	EventAt int64 `json:"event_at"`

	// EventType is the type of this event. It can be "incident_created", "task_state_modified",
	// "status_updated", "owner_changed", "assignee_changed", "ran_slash_command",
	// "event_from_post", "user_joined_left", "published_retrospective", "canceled_retrospective" or "status_update_snoozed".
	EventType timelineEventType `json:"event_type"`

	// Summary is a short description of the event.
	Summary string `json:"summary"`

	// Details is the longer description of the event.
	Details string `json:"details"`

	// PostID, if not empty, is the identifier of the post announcing in the channel this event
	// happened. If the event is of type "event_from_post", this is the identifier of that post.
	PostID string `json:"post_id"`

	// SubjectUserID is the identifier of the user involved in the event. For example, if the event
	// is of type "owner_changed", this is the identifier of the new owner.
	SubjectUserID string `json:"subject_user_id"`

	// CreatorUserID is the identifier of the user that created the event.
	CreatorUserID string `json:"creator_user_id"`
}

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

type TopicMetadata struct {
	ID     string
	RunID  string
	TeamID string
}

type Trigger struct {
	Type TaskTriggerType `json:"type"`
	// Payload is the json payload that stores trigger specific settings or config.
	// This should be unmarshalled into a concrete type during usage
	Payload string `json:"payload"`
}

type TriggerType string

type UpdateOptions struct {
}

type UserInfo struct {
	ID                string
	LastDailyTodoDMAt int64
	DigestNotificationSettings
}

type UserInfoStore interface {
	// Get retrieves a UserInfo struct by the user's userID.
	Get(userID string) (UserInfo, error)

	// Upsert inserts (creates) or updates the UserInfo in info.
	Upsert(info UserInfo) error
}

type UserInfoTelemetry interface {
	// ChangeDigestSettings tracks when a user changes one of the digest settings
	ChangeDigestSettings(userID string, old DigestNotificationSettings, new DigestNotificationSettings)
}

type WelcomeMessagePayload struct {
	Message string `json:"message" mapstructure:"message"`
}