apps

type AWSLambda struct {
	Functions []AWSLambdaFunction `json:"functions,omitempty"`
}

type AWSLambdaFunction struct {
	// The lambda function with its Path the longest-matching prefix of the
	// call's Path will be invoked for a call.
	Path    string `json:"path"`
	Name    string `json:"name"`
	Handler string `json:"handler"`
	Runtime string `json:"runtime"`
}

type App struct {
	// Manifest contains the manifest data that the App was installed with. It
	// may differ from what is currently in the manifest store for the app's ID.
	Manifest

	// DeployType is the type of upstream that can be used to access the App.
	DeployType DeployType `json:"deploy_type,omitempty"`

	// Disabled is set to true if the app is disabled. Disabling an app does not
	// erase any of it's data.
	Disabled bool `json:"disabled,omitempty"`

	// Secret is used to issue JWT when sending requests to HTTP apps.
	Secret string `json:"secret,omitempty"`

	// WebhookSecret is used to validate an incoming webhook secret.
	WebhookSecret string `json:"webhook_secret,omitempty"`

	// App's Mattermost Bot User credentials. An Mattermost server Bot Account
	// is created (or updated) when a Mattermost App is installed on the
	// instance.
	BotUserID   string `json:"bot_user_id,omitempty"`
	BotUsername string `json:"bot_username,omitempty"`

	// MattermostOAuth2 contains App's Mattermost OAuth2 credentials. An
	// Mattermost server OAuth2 app is created (or updated) when a Mattermost
	// App is installed on the instance.
	MattermostOAuth2 *model.OAuthApp `json:"mattermost_oauth2,omitempty"`

	// RemoteOAuth2 contains App's remote OAuth2 credentials. Use
	// appclient.StoreOAuth2App to update.
	RemoteOAuth2 OAuth2App `json:"remote_oauth2,omitempty"`

	// In V1, GrantedPermissions are simply copied from RequestedPermissions
	// upon the sysadmin's consent, during installing the App.
	GrantedPermissions Permissions `json:"granted_permissions,omitempty"`

	// GrantedLocations contains the list of top locations that the application
	// is allowed to bind to.
	//
	// In V1, GrantedLocations are simply copied from RequestedLocations upon
	// the sysadmin's consent, during installing the App.
	GrantedLocations Locations `json:"granted_locations,omitempty"`
}

type AppID string

type AppVersion string

type Binding struct {
	// For internal use by Mattermost, Apps do not need to set.
	AppID AppID `json:"app_id,omitempty"`

	// Location allows the App to identify where in the UX the Call request
	// comes from. It is optional. For /command bindings, Location is
	// defaulted to Label.
	//
	// TODO: default to Label, Name.
	Location Location `json:"location,omitempty"`

	// Icon is the icon to display, should be either a fully-qualified URL, or a
	// path for an app's static asset.
	Icon string `json:"icon,omitempty"`

	// Label is the (usually short) primary text to display at the location.
	//  - post menu: the item text.
	//  - channel header: the dropdown text.
	//  - command: the name of the command.
	//  - in-post: the title.
	Label string `json:"label,omitempty"`

	// Hint is the secondary text to display
	//  - post menu: not used
	//  - channel header: tooltip
	//  - command: the "Hint" line
	Hint string `json:"hint,omitempty"`

	// Description is the (optional) extended help text, used in modals and
	// autocomplete.
	//  - in-post: is the text of the embed
	Description string `json:"description,omitempty"`

	// Submit is used to execute the action associated to this binding.
	Submit *Call `json:"submit,omitempty"`

	// Form is used to gather additional input from the user before submitting.
	// At a minimum, it contains the Submit call path or a Source call path. A
	// form may be embedded, or be a source reference meaning that a call to
	// the app will be made to obtain the form.
	Form *Form `json:"form,omitempty"`

	// Bindings specifies sub-location bindings.
	Bindings []Binding `json:"bindings,omitempty"`
}

type Call struct {
	// The path of the Call. For HTTP apps, the path is appended to the app's
	// RootURL. For AWS Lambda apps, it is mapped to the appropriate Lambda name
	// to invoke, and then passed in the call request.
	Path string `json:"path,omitempty"`

	// Expand specifies what extended data should be provided to the function in
	// each request's Context. It may be various auth tokens, configuration
	// data, or details of Mattermost entities such as the acting user, current
	// team and channel, etc.
	Expand *Expand `json:"expand,omitempty"`

	// Custom data that will be passed to the function in JSON, "as is".
	State interface{} `json:"state,omitempty"`
}

type CallRequest struct {
	// A copy of the Call struct that originated the request. Path and State are
	// of significance.
	Call

	// Values are all values entered by the user.
	Values map[string]interface{} `json:"values,omitempty"`

	// Context of execution, see the Context type for more information.
	Context Context `json:"context,omitempty"`

	// In case the request came from the command line, the raw text of the
	// command, as submitted by the user.
	RawCommand string `json:"raw_command,omitempty"`

	// In the case of a form refresh call, the field of the select value chosen.
	// In the case of a lookup call, the field that the user is using for autocomplete.
	SelectedField string `json:"selected_field,omitempty"`

	// In the case of a lookup call, the query the user has typed in for autocomplete.
	Query string `json:"query,omitempty"`
}

type CallResponse struct {
	Type CallResponseType `json:"type"`

	// Text is used for OK and Error response, and will show the text in the
	// proper output.
	Text string `json:"text,omitempty"`

	// Optional. Force refresh bindings for acting user
	RefreshBindings bool `json:"refresh_bindings,omitempty"`

	// Used in CallResponseTypeOK to return the displayble, and JSON results
	Data interface{} `json:"data,omitempty"`

	// Used in CallResponseTypeNavigate
	NavigateToURL      string `json:"navigate_to_url,omitempty"`
	UseExternalBrowser bool   `json:"use_external_browser,omitempty"`

	// Used in CallResponseTypeCall
	Call *Call `json:"call,omitempty"`

	// Used in CallResponseTypeForm
	Form *Form `json:"form,omitempty"`
}

type CallResponseType string

type Context struct {
	// Subject is a subject of notification, if the call originated from a
	// subscription.
	Subject Subject `json:"subject,omitempty"`

	// Data accepted from the user agent
	UserAgentContext

	// More data as requested by call.Expand
	ExpandedContext
}

type Deploy struct {
	// AWSLambda contains metadata for an app that can be deployed to AWS Lambda
	// and S3 services, and is accessed using the AWS APIs. The JSON name
	// `aws_lambda` must match the type.
	AWSLambda *AWSLambda `json:"aws_lambda,omitempty"`

	// HTTP contains metadata for an app that is already, deployed externally
	// and us accessed over HTTP. The JSON name `http` must match the type.
	HTTP *HTTP `json:"http,omitempty"`

	OpenFAAS *OpenFAAS `json:"open_faas,omitempty"`

	// Plugin contains metadata for an app that is implemented and is deployed
	// and accessed as a local Plugin. The JSON name `plugin` must match the
	// type.
	Plugin *Plugin `json:"plugin,omitempty"`
}

type DeployType string

type DeployTypes []DeployType

type Event struct {
	// Subscription subject. See type Subject godoc (linked) for details.
	Subject Subject `json:"subject"`

	// ChannelID and TeamID are the subscription scope, as applicable to the subject.
	ChannelID string `json:"channel_id,omitempty"`
	TeamID    string `json:"team_id,omitempty"`
}

type Expand struct {
	// App (default: none, required). Details about the installed record of the
	// App. Of relevance to the app may be the version, and the Bot account
	// details.
	App ExpandLevel `json:"app,omitempty"`

	// ActingUser (default: none, required). Set to "all" for the entire
	// (sanitized) model.User; to "summary" for BotDescription, DeleteAt, Email,
	// FirstName, Id, IsBot, LastName, Locale, Nickname, Roles, Timezone,
	// Username; to "id" for Id only.
	ActingUser ExpandLevel `json:"acting_user,omitempty"`

	// ActingUserAccessToken (default: none, required): Set to "all" to include
	// user-level access token in the request. Requires act_as_user permission
	// to have been granted to the app. "summary" and "id" fail to expand.
	ActingUserAccessToken ExpandLevel `json:"acting_user_access_token,omitempty"`

	// Locale (default: none, optional) expands the locale to use for this call. There is
	// no difference between the modes.
	Locale ExpandLevel `json:"locale,omitempty"`

	// Channel (default: none, optional): Set to "all" for model.Channel; to
	// "summary" for Id, DeleteAt, TeamId, Type, DisplayName, Name; to "id" for
	// Id only.
	Channel ExpandLevel `json:"channel,omitempty"`

	// ChannelMember (default: none, optional): expand model.ChannelMember if
	// ChannelID and ActingUserID (or UserID) are set. if both ActingUserID and
	// UserID are set, it expands UserID, as may be relevant in
	// UserJoinedChannel notifications. "all" and "summary" include the same
	// full model.ChannelMember struct.
	ChannelMember ExpandLevel `json:"channel_member,omitempty"`

	// Team (default: none, optional): "all" for model.Team; "summary"
	// for Id, DisplayName, Name, Description, Email, Type; "id" for Id only.
	Team ExpandLevel `json:"team,omitempty"`

	// TeamMember (default: none, optional): expand model.TeamMember if TeamID
	// and ActingUserID (or UserID) are set. if both ActingUserID and UserID are
	// set, it expands UserID, as may be relevant in UserJoinedTeam
	// notifications. "all" and "summary" include the same full model.TeamMember
	// struct.
	TeamMember ExpandLevel `json:"team_member,omitempty"`

	// Post, RootPost (default: none, optional): all for model.Post, summary for
	// Id, Type, UserId, ChannelId, RootId, Message.
	Post     ExpandLevel `json:"post,omitempty"`
	RootPost ExpandLevel `json:"root_post,omitempty"`

	// User (default: none, optional): all for model.User, summary for
	// BotDescription, DeleteAt, Email, FirstName, Id, IsBot, LastName, Locale,
	// Nickname, Roles, Timezone, Username.
	User ExpandLevel `json:"user,omitempty"`

	// OAuth2App (default: none, required) expands the remote (3rd party) OAuth2
	// app configuration data.
	OAuth2App ExpandLevel `json:"oauth2_app,omitempty"`

	// OAuth2User (default: none, required) expands the remote (3rd party)
	// OAuth2 user (custom object, previously stored with
	// appclient.StoreOAuthUser).
	OAuth2User ExpandLevel `json:"oauth2_user,omitempty"`
}

type ExpandLevel string

type ExpandedContext struct {
	// Top-level Mattermost site URL to use for REST API calls.
	MattermostSiteURL string `json:"mattermost_site_url"`

	// DeveloperMode is set if the apps plugin itself is running in Developer mode.
	DeveloperMode bool `json:"developer_mode,omitempty"`

	// App's path on the Mattermost instance (appendable to MattermostSiteURL).
	AppPath string `json:"app_path"`

	// BotUserID of the App.
	BotUserID string `json:"bot_user_id"`

	// BotAccessToken is always provided in expanded context.
	BotAccessToken string `json:"bot_access_token,omitempty"`
	App            *App   `json:"app,omitempty"`

	ActingUser            *model.User          `json:"acting_user,omitempty"`
	ActingUserAccessToken string               `json:"acting_user_access_token,omitempty"`
	Locale                string               `json:"locale,omitempty"`
	Channel               *model.Channel       `json:"channel,omitempty"`
	ChannelMember         *model.ChannelMember `json:"channel_member,omitempty"`
	Team                  *model.Team          `json:"team,omitempty"`
	TeamMember            *model.TeamMember    `json:"team_member,omitempty"`
	Post                  *model.Post          `json:"post,omitempty"`
	RootPost              *model.Post          `json:"root_post,omitempty"`

	// TODO replace User with mentions
	User *model.User `json:"user,omitempty"`

	OAuth2 OAuth2Context `json:"oauth2,omitempty"`
}

type Field struct {
	// Name is the name of the JSON field to use.
	Name string `json:"name"`

	Type       FieldType `json:"type"`
	IsRequired bool      `json:"is_required,omitempty"`
	ReadOnly   bool      `json:"readonly,omitempty"`

	// Present (default) value of the field
	Value interface{} `json:"value,omitempty"`

	// Field description. Used in modal and autocomplete.
	Description string `json:"description,omitempty"`

	// Label is used in Autocomplete as the --flag name. It is ignored for
	// positional fields (with AutocompletePosition != 0).
	//
	// TODO: Label should default to Name.
	Label string `json:"label,omitempty"`

	// AutocompleteHint is used in Autocomplete as the hint line.
	AutocompleteHint string `json:"hint,omitempty"`

	// AutocompletePosition means that this is a positional argument, does not
	// have a --flag. If >0, indicates what position this field is in. If =-1,
	// indicates that this field is the last argument.
	AutocompletePosition int `json:"position,omitempty"`

	// ModalLabel is used in the modal dialog context, has no format
	// limitations. It defaults to Label.
	ModalLabel string `json:"modal_label,omitempty"`

	// SelectIsMulti designates whether a select field is a multiselect
	SelectIsMulti bool `json:"multiselect,omitempty"`

	// SelectRefresh means that a change in the value of this select triggers
	// reloading the form. Values of the fields with inputs that are not
	// included in the refreshed form are lost. Not yet implemented for /command
	// autocomplete.
	SelectRefresh bool `json:"refresh,omitempty"`

	// SelectStaticOptions is the list of options to display in a static select
	// field.
	SelectStaticOptions []SelectOption `json:"options,omitempty"`

	// SelectDynamicLookup is the call that will return the options to populate
	// the select.
	//
	// TODO document the Lookup format.
	SelectDynamicLookup *Call `json:"lookup,omitempty"`

	// Text props
	TextSubtype   TextFieldSubtype `json:"subtype,omitempty"`
	TextMinLength int              `json:"min_length,omitempty"`
	TextMaxLength int              `json:"max_length,omitempty"`
}

type FieldType string

type Form struct {
	// Source is the call to make when the form's definition is required (i.e.
	// it has no fields, or needs to be refreshed from the app). A simple call
	// can be specified as a path (string).
	Source *Call `json:"source,omitempty"`

	// Title, Header, and Footer are used for Modals only.
	Title  string `json:"title,omitempty"`
	Header string `json:"header,omitempty"`
	Footer string `json:"footer,omitempty"`

	// A fully-qualified URL, or a path to the form icon.
	// TODO do we default to the App icon?
	Icon string `json:"icon,omitempty"`

	// Submit is the call to make when the user clicks a submit button (or enter
	// for a command). A simple call can be specified as a path (string). It
	// will contain no expand/state.
	Submit *Call `json:"submit,omitempty"`

	// SubmitButtons refers to a field name that must be a FieldTypeStaticSelect
	// or FieldTypeDynamicSelect.
	//
	// In Modal view, the field will be rendered as a list of buttons at the
	// bottom. Clicking one of them submits the Call, providing the button
	// reference as the corresponding Field's value. Leaving this property
	// blank, displays the default "OK".
	//
	// In Autocomplete, it is ignored.
	SubmitButtons string `json:"submit_buttons,omitempty"`

	// Fields is the list of fields in the form.
	Fields []Field `json:"fields,omitempty"`
}

type HTTP struct {
	// All call and static paths are relative to the RootURL.
	RootURL string `json:"root_url,omitempty"`

	// UseJWT instructs the proxy to authenticate outgoing requests with a JWT.
	UseJWT bool `json:"use_jwt,omitempty"`
}

type HTTPCallRequest struct {
	Path       string            `json:"path"`
	HTTPMethod string            `json:"httpMethod"`
	Headers    map[string]string `json:"headers"`
	RawQuery   string            `json:"rawQuery,omitempty"`
	Body       string            `json:"body"`
}

type HTTPCallResponse struct {
	StatusCode      int               `json:"statusCode"`
	Headers         map[string]string `json:"headers"`
	IsBase64Encoded bool              `json:"isBase64Encoded"`
	Body            string            `json:"body"`
}

type JWTClaims struct {
	jwt.StandardClaims
	ActingUserID string `json:"acting_user_id,omitempty"`
}

type Kubeless struct {
	Functions []KubelessFunction `json:"functions,omitempty"`
}

type KubelessFunction struct {
	// Path is used to match/map incoming Call requests.
	Path string `json:"path"`

	// Handler refers to the actual language function being invoked.
	// TODO examples py, go
	Handler string `json:"handler"`

	// File is the file ath (relative, in the bundle) to the function (source?)
	// file. Checksum is the expected checksum of the file.
	File string `json:"file"`

	// DepsFile is the path to the file with runtime-specific dependency list,
	// e.g. go.mod.
	DepsFile string `json:"deps_file"`

	// Kubeless runtime to use.
	Runtime string `json:"runtime"`

	// Timeout for the function to complete its execution, in seconds.
	Timeout int `json:"timeout"`

	// Port is the local ipv4 port that the function listens to, default 8080.
	Port int32 `json:"port"`
}

type ListedApp struct {
	Manifest  Manifest                 `json:"manifest"`
	Installed bool                     `json:"installed"`
	Enabled   bool                     `json:"enabled"`
	IconURL   string                   `json:"icon_url,omitempty"`
	Labels    []model.MarketplaceLabel `json:"labels,omitempty"`
}

type Location string

type Locations []Location

type Manifest struct {
	// Set to the version of the Apps plugin that stores it, e.g. "v0.8.0"
	SchemaVersion string `json:",omitempty"`

	// The AppID is a globally unique identifier that represents your app. IDs
	// must be at least 3 characters, at most 32 characters and must contain
	// only alphanumeric characters, dashes, underscores and periods.
	AppID AppID `json:"app_id,omitempty"`

	// Version of the app, formatted as v00.00.000
	Version AppVersion `json:"version,omitempty"`

	// HomepageURL is required.
	HomepageURL string `json:"homepage_url,omitempty"`

	// DisplayName and Description provide optional information about the App.
	DisplayName string `json:"display_name,omitempty"`
	Description string `json:"description,omitempty"`

	// Icon is a relative path in the static assets folder of an png image,
	// which is used to represent the App.
	Icon string `json:"icon,omitempty"`

	// Bindings must be implemented by the Apps to add any UX elements to the
	// Mattermost UI. The default values for its fields are,
	//  "path":"/bindings",
	Bindings *Call `json:"bindings,omitempty"`

	// OnInstall gets invoked when a sysadmin installs the App with a `/apps
	// install` command. It may return another call to the app, or a form to
	// display. It is not called unless explicitly provided in the manifest.
	OnInstall *Call `json:"on_install,omitempty"`

	// OnVersionChanged gets invoked when the Mattermost-recommended version of
	// the app no longer matches the previously installed one, and the app needs
	// to be upgraded/downgraded. It is not called unless explicitly provided in
	// the manifest.
	OnVersionChanged *Call `json:"on_version_changed,omitempty"`

	// OnUninstall gets invoked when a sysadmin uses the `/apps uninstall`
	// command, before the app is actually removed. It is not called unless
	// explicitly provided in the manifest.
	OnUninstall *Call `json:"on_uninstall,omitempty"`

	// OnEnable gets invoked when a sysadmin uses the `/apps enable`
	// command, after the app is enabled. It is not called unless
	// explicitly provided in the manifest.
	OnEnable *Call `json:"on_enable,omitempty"`

	// OnDisable gets invoked when a sysadmin uses the `/apps disable`
	// command, before the app is actually disabled. It is not called unless
	// explicitly provided in the manifest.
	OnDisable *Call `json:"on_disable,omitempty"`

	// GetOAuth2ConnectURL is called when the App's "connect to 3rd party" link
	// is clicked, to be redirected to the OAuth flow. It must return Data set
	// to the remote OAuth2 redirect URL. A "state" string is created by the
	// proxy, and is passed to the app as a value. The state is  a 1-time secret
	// that is included in the connect URL, and will be used to validate OAuth2
	// complete callback.
	GetOAuth2ConnectURL *Call `json:"get_oauth2_connect_url,omitempty"`

	// OnOAuth2Complete gets called upon successful completion of the remote
	// (3rd party) OAuth2 flow, and after the "state" has already been
	// validated. It gets passed the URL query as Values. The App should obtain
	// the OAuth2 user token, and store it persistently for future use using
	// appclient.StoreOAuth2User.
	OnOAuth2Complete *Call `json:"on_oauth2_complete,omitempty"`

	// OnRemoteWebhook gets invoked when an HTTP webhook is received from a
	// remote system, and is optionally authenticated by Mattermost. The request
	// is passed to the call serialized as HTTPCallRequest (JSON).
	OnRemoteWebhook *Call `json:"on_remote_webhook,omitempty"`

	// Requested Access
	RequestedPermissions Permissions `json:"requested_permissions,omitempty"`

	// RemoteWebhookAuthType specifies how incoming webhook messages from remote
	// systems should be authenticated by Mattermost.
	RemoteWebhookAuthType RemoteWebhookAuthType `json:"remote_webhook_auth_type,omitempty"`

	// RequestedLocations is the list of top-level locations that the
	// application intends to bind to, e.g. `{"/post_menu", "/channel_header",
	// "/command/apptrigger"}“.
	RequestedLocations Locations `json:"requested_locations,omitempty"`

	// Deployment information
	Deploy
}

type OAuth2App struct {
	RemoteRootURL string `json:"remote_root_url,omitempty"`
	ClientID      string `json:"client_id,omitempty"`
	ClientSecret  string `json:"client_secret,omitempty"`

	// Data allows apps to store custom data in their OAuth configuration. A
	// frequent use case is storing app-level service account credentials.
	Data interface{} `json:"data,omitempty"`
}

type OAuth2Context struct {
	// Expanded with "oauth2_app". Config must be previously stored with
	// appclient.StoreOAuth2App
	OAuth2App
	ConnectURL  string `json:"connect_url,omitempty"`
	CompleteURL string `json:"complete_url,omitempty"`

	User interface{} `json:"user,omitempty"`
}

type OpenFAAS struct {
	Functions []OpenFAASFunction `json:"functions,omitempty"`
}

type OpenFAASFunction struct {
	// Path is used to match/map incoming Call requests.
	Path string `json:"path"`

	// Name is the "short" name of the fuinction, it is combined with the app's
	// ID+Version when deployed, see upopenfaas.FunctionName.
	Name string `json:"name"`
}

type Permission string

type Permissions []Permission

type Plugin struct {
	// PluginID is the ID of the plugin, which manages the app, if there is one.
	PluginID string `json:"plugin_id,omitempty"`
}

type RemoteWebhookAuthType string

type SelectOption struct {
	// Label is the display name/label for the option's value.
	Label string `json:"label,omitempty"`

	Value    string `json:"value"`
	IconData string `json:"icon_data,omitempty"`
}

type Subject string

type Subscription struct {
	Event

	// Call is the (one-way) call to make upon the event.
	Call Call `json:"call"`
}

type TextFieldSubtype string

type UserAgentContext struct {

	// ChannelID is not send down to Apps.
	ChannelID string `json:"channel_id,omitempty"`
	// TeamID is not send down to Apps.
	TeamID string `json:"team_id,omitempty"`
	// PostID is not send down to Apps.
	PostID string `json:"post_id,omitempty"`
	// RootPostID is not send down to Apps.
	RootPostID string `json:"root_post_id,omitempty"`
	// UserID indicates the subject of the call, used only for notifications on
	// subjects like user_created and user_joined_channel.
	UserID string `json:"user_id,omitempty"`

	// AppID is used for handling CallRequest internally.
	AppID AppID `json:"app_id"`

	// Fully qualified original Location of the user action (if applicable),
	// e.g. "/command/helloworld/send" or "/channel_header/send".
	Location Location `json:"location,omitempty"`

	// UserAgent used to perform the call. It can be either "webapp" or "mobile".
	// Non user interactions like notifications will have this field empty.
	UserAgent string `json:"user_agent,omitempty"`

	// TrackAsSubmit indicates that the call was caused by a user "submit"
	// action from a binding or a form.
	TrackAsSubmit bool `json:"track_as_submit,omitempty"`
}