mattermost_dart (EXPERIMENTAL)

There is also a work-in-progress Postman API reference.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 4.0.0
  • Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  mattermost_dart: 4.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  mattermost_dart:
    git:
      url: https://github.com/tuyen-vuduc/mattermost-dart-openapi.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  mattermost_dart:
    path: /path/to/mattermost_dart

Getting Started

Please follow the installation procedure and then run the following:

import 'package:mattermost_dart/mattermost_dart.dart';


final api = MattermostDart().getAuthenticationApi();
final InlineObject26 inlineObject26 = ; // InlineObject26 | 

try {
    api.migrateAuthToLdap(inlineObject26);
} catch on DioError (e) {
    print("Exception when calling AuthenticationApi->migrateAuthToLdap: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://your-mattermost-url.com/api/v4

Class Method HTTP request Description
AuthenticationApi migrateAuthToLdap POST /users/migrate_auth/ldap Migrate user accounts authentication type to LDAP.
AuthenticationApi migrateAuthToSaml POST /users/migrate_auth/saml Migrate user accounts authentication type to SAML.
BleveApi purgeBleveIndexes POST /bleve/purge_indexes Purge all Bleve indexes
BotsApi assignBot POST /bots/{bot_user_id}/assign/{user_id} Assign a bot to a user
BotsApi convertBotToUser POST /bots/{bot_user_id}/convert_to_user Convert a bot into a user
BotsApi convertUserToBot POST /users/{user_id}/convert_to_bot Convert a user into a bot
BotsApi createBot POST /bots Create a bot
BotsApi deleteBotIconImage DELETE /bots/{bot_user_id}/icon Delete bot's LHS icon image
BotsApi disableBot POST /bots/{bot_user_id}/disable Disable a bot
BotsApi enableBot POST /bots/{bot_user_id}/enable Enable a bot
BotsApi getBot GET /bots/{bot_user_id} Get a bot
BotsApi getBotIconImage GET /bots/{bot_user_id}/icon Get bot's LHS icon
BotsApi getBots GET /bots Get bots
BotsApi patchBot PUT /bots/{bot_user_id} Patch a bot
BotsApi setBotIconImage POST /bots/{bot_user_id}/icon Set bot's LHS icon image
BrandApi deleteBrandImage DELETE /brand/image Delete current brand image
BrandApi getBrandImage GET /brand/image Get brand image
BrandApi uploadBrandImage POST /brand/image Upload brand image
ChannelsApi addChannelMember POST /channels/{channel_id}/members Add user to channel
ChannelsApi autocompleteChannelsForTeam GET /teams/{team_id}/channels/autocomplete Autocomplete channels
ChannelsApi autocompleteChannelsForTeamForSearch GET /teams/{team_id}/channels/search_autocomplete Autocomplete channels for search
ChannelsApi channelMembersMinusGroupMembers GET /channels/{channel_id}/members_minus_group_members Channel members minus group members.
ChannelsApi createChannel POST /channels Create a channel
ChannelsApi createDirectChannel POST /channels/direct Create a direct message channel
ChannelsApi createGroupChannel POST /channels/group Create a group message channel
ChannelsApi createSidebarCategoryForTeamForUser POST /users/{user_id}/teams/{team_id}/channels/categories Create user's sidebar category
ChannelsApi deleteChannel DELETE /channels/{channel_id} Delete a channel
ChannelsApi getAllChannels GET /channels Get a list of all channels
ChannelsApi getChannel GET /channels/{channel_id} Get a channel
ChannelsApi getChannelByName GET /teams/{team_id}/channels/name/{channel_name} Get a channel by name
ChannelsApi getChannelByNameForTeamName GET /teams/name/{team_name}/channels/name/{channel_name} Get a channel by name and team name
ChannelsApi getChannelMember GET /channels/{channel_id}/members/{user_id} Get channel member
ChannelsApi getChannelMemberCountsByGroup GET /channels/{channel_id}/member_counts_by_group Channel members counts for each group that has atleast one member in the channel
ChannelsApi getChannelMembers GET /channels/{channel_id}/members Get channel members
ChannelsApi getChannelMembersByIds POST /channels/{channel_id}/members/ids Get channel members by ids
ChannelsApi getChannelMembersForUser GET /users/{user_id}/teams/{team_id}/channels/members Get channel memberships and roles for a user
ChannelsApi getChannelMembersTimezones GET /channels/{channel_id}/timezones Get timezones in a channel
ChannelsApi getChannelModerations GET /channels/{channel_id}/moderations Get information about channel's moderation.
ChannelsApi getChannelStats GET /channels/{channel_id}/stats Get channel statistics
ChannelsApi getChannelUnread GET /users/{user_id}/channels/{channel_id}/unread Get unread messages
ChannelsApi getChannelsForTeamForUser GET /users/{user_id}/teams/{team_id}/channels Get channels for user
ChannelsApi getChannelsForUser GET /users/{user_id}/channels Get all channels from all teams
ChannelsApi getDeletedChannelsForTeam GET /teams/{team_id}/channels/deleted Get deleted channels
ChannelsApi getPinnedPosts GET /channels/{channel_id}/pinned Get a channel's pinned posts
ChannelsApi getPrivateChannelsForTeam GET /teams/{team_id}/channels/private Get private channels
ChannelsApi getPublicChannelsByIdsForTeam POST /teams/{team_id}/channels/ids Get a list of channels by ids
ChannelsApi getPublicChannelsForTeam GET /teams/{team_id}/channels Get public channels
ChannelsApi getSidebarCategoriesForTeamForUser GET /users/{user_id}/teams/{team_id}/channels/categories Get user's sidebar categories
ChannelsApi getSidebarCategoryForTeamForUser GET /users/{user_id}/teams/{team_id}/channels/categories/{category_id} Get sidebar category
ChannelsApi getSidebarCategoryOrderForTeamForUser GET /users/{user_id}/teams/{team_id}/channels/categories/order Get user's sidebar category order
ChannelsApi moveChannel POST /channels/{channel_id}/move Move a channel
ChannelsApi patchChannel PUT /channels/{channel_id}/patch Patch a channel
ChannelsApi patchChannelModerations PUT /channels/{channel_id}/moderations/patch Update a channel's moderation settings.
ChannelsApi removeSidebarCategoryForTeamForUser DELETE /users/{user_id}/teams/{team_id}/channels/categories/{category_id} Delete sidebar category
ChannelsApi removeUserFromChannel DELETE /channels/{channel_id}/members/{user_id} Remove user from channel
ChannelsApi restoreChannel POST /channels/{channel_id}/restore Restore a channel
ChannelsApi searchAllChannels POST /channels/search Search all private and open type channels across all teams
ChannelsApi searchArchivedChannels POST /teams/{team_id}/channels/search_archived Search archived channels
ChannelsApi searchChannels POST /teams/{team_id}/channels/search Search channels
ChannelsApi searchGroupChannels POST /channels/group/search Search Group Channels
ChannelsApi updateChannel PUT /channels/{channel_id} Update a channel
ChannelsApi updateChannelMemberSchemeRoles PUT /channels/{channel_id}/members/{user_id}/schemeRoles Update the scheme-derived roles of a channel member.
ChannelsApi updateChannelNotifyProps PUT /channels/{channel_id}/members/{user_id}/notify_props Update channel notifications
ChannelsApi updateChannelPrivacy PUT /channels/{channel_id}/privacy Update channel's privacy
ChannelsApi updateChannelRoles PUT /channels/{channel_id}/members/{user_id}/roles Update channel roles
ChannelsApi updateChannelScheme PUT /channels/{channel_id}/scheme Set a channel's scheme
ChannelsApi updateSidebarCategoriesForTeamForUser PUT /users/{user_id}/teams/{team_id}/channels/categories Update user's sidebar categories
ChannelsApi updateSidebarCategoryForTeamForUser PUT /users/{user_id}/teams/{team_id}/channels/categories/{category_id} Update sidebar category
ChannelsApi updateSidebarCategoryOrderForTeamForUser PUT /users/{user_id}/teams/{team_id}/channels/categories/order Update user's sidebar category order
ChannelsApi viewChannel POST /channels/members/{user_id}/view View channel
CloudApi confirmCustomerPayment POST /cloud/payment/confirm Completes the payment setup intent
CloudApi createCustomerPayment POST /cloud/payment Create a customer setup payment intent
CloudApi getCloudCustomer GET /cloud/customer Get cloud customer
CloudApi getCloudProducts GET /cloud/products Get cloud products
CloudApi getInvoiceForSubscriptionAsPdf GET /cloud/subscription/invoices/{invoice_id}/pdf Get cloud invoice PDF
CloudApi getInvoicesForSubscription GET /cloud/subscription/invoices Get cloud subscription invoices
CloudApi getSubscription GET /cloud/subscription Get cloud subscription
CloudApi getSubscriptionStats GET /cloud/subscription/stats GET endpoint for cloud subscription stats
CloudApi postEndpointForCwsWebhooks POST /cloud/webhook POST endpoint for CWS Webhooks
CloudApi sendAdminUpgradeRequestEmail POST /cloud/subscription/limitreached/invite POST endpoint for triggering sending emails to admin with request to upgrade workspace
CloudApi sendAdminUpgradeRequestEmailOnJoin POST /cloud/subscription/limitreached/join POST endpoint for triggering sending emails to admin with request to upgrade workspace
CloudApi updateCloudCustomer PUT /cloud/customer Update cloud customer
CloudApi updateCloudCustomerAddress PUT /cloud/customer/address Update cloud customer address
ClusterApi getClusterStatus GET /cluster/status Get cluster status
CommandsApi createCommand POST /commands Create a command
CommandsApi deleteCommand DELETE /commands/{command_id} Delete a command
CommandsApi executeCommand POST /commands/execute Execute a command
CommandsApi getCommandById GET /commands/{command_id} Get a command
CommandsApi listAutocompleteCommands GET /teams/{team_id}/commands/autocomplete List autocomplete commands
CommandsApi listCommandAutocompleteSuggestions GET /teams/{team_id}/commands/autocomplete_suggestions List commands' autocomplete data
CommandsApi listCommands GET /commands List commands for a team
CommandsApi moveCommand PUT /commands/{command_id}/move Move a command
CommandsApi regenCommandToken PUT /commands/{command_id}/regen_token Generate a new token
CommandsApi updateCommand PUT /commands/{command_id} Update a command
ComplianceApi createComplianceReport POST /compliance/reports Create report
ComplianceApi downloadComplianceReport GET /compliance/reports/{report_id}/download Download a report
ComplianceApi getComplianceReport GET /compliance/reports/{report_id} Get a report
ComplianceApi getComplianceReports GET /compliance/reports Get reports
DataRetentionApi addChannelsToRetentionPolicy POST /data_retention/policies/{policy_id}/channels Add channels to a granular data retention policy
DataRetentionApi addTeamsToRetentionPolicy POST /data_retention/policies/{policy_id}/teams Add teams to a granular data retention policy
DataRetentionApi createDataRetentionPolicy POST /data_retention/policies Create a new granular data retention policy
DataRetentionApi deleteDataRetentionPolicy DELETE /data_retention/policies/{policy_id} Delete a granular data retention policy
DataRetentionApi getChannelPoliciesForUser GET /users/{user_id}/data_retention/channel_policies Get the policies which are applied to a user's channels
DataRetentionApi getChannelsForRetentionPolicy GET /data_retention/policies/{policy_id}/channels Get the channels for a granular data retention policy
DataRetentionApi getDataRetentionPolicies GET /data_retention/policies Get the granular data retention policies
DataRetentionApi getDataRetentionPoliciesCount GET /data_retention/policies_count Get the number of granular data retention policies
DataRetentionApi getDataRetentionPolicy GET /data_retention/policy Get the global data retention policy
DataRetentionApi getDataRetentionPolicyByID GET /data_retention/policies/{policy_id} Get a granular data retention policy
DataRetentionApi getTeamPoliciesForUser GET /users/{user_id}/data_retention/team_policies Get the policies which are applied to a user's teams
DataRetentionApi getTeamsForRetentionPolicy GET /data_retention/policies/{policy_id}/teams Get the teams for a granular data retention policy
DataRetentionApi patchDataRetentionPolicy PATCH /data_retention/policies/{policy_id} Patch a granular data retention policy
DataRetentionApi removeChannelsFromRetentionPolicy DELETE /data_retention/policies/{policy_id}/channels Delete channels from a granular data retention policy
DataRetentionApi removeTeamsFromRetentionPolicy DELETE /data_retention/policies/{policy_id}/teams Delete teams from a granular data retention policy
DataRetentionApi searchChannelsForRetentionPolicy POST /data_retention/policies/{policy_id}/channels/search Search for the channels in a granular data retention policy
DataRetentionApi searchTeamsForRetentionPolicy POST /data_retention/policies/{policy_id}/teams/search Search for the teams in a granular data retention policy
ElasticsearchApi purgeElasticsearchIndexes POST /elasticsearch/purge_indexes Purge all Elasticsearch indexes
ElasticsearchApi testElasticsearch POST /elasticsearch/test Test Elasticsearch configuration
EmojiApi autocompleteEmoji GET /emoji/autocomplete Autocomplete custom emoji
EmojiApi createEmoji POST /emoji Create a custom emoji
EmojiApi deleteEmoji DELETE /emoji/{emoji_id} Delete a custom emoji
EmojiApi getEmoji GET /emoji/{emoji_id} Get a custom emoji
EmojiApi getEmojiByName GET /emoji/name/{emoji_name} Get a custom emoji by name
EmojiApi getEmojiImage GET /emoji/{emoji_id}/image Get custom emoji image
EmojiApi getEmojiList GET /emoji Get a list of custom emoji
EmojiApi searchEmoji POST /emoji/search Search custom emoji
ExportsApi deleteExport DELETE /exports/{export_name} Delete an export file
ExportsApi downloadExport GET /exports/{export_name} Download an export file
ExportsApi listExports GET /exports List export files
FilesApi getFile GET /files/{file_id} Get a file
FilesApi getFileInfo GET /files/{file_id}/info Get metadata for a file
FilesApi getFileLink GET /files/{file_id}/link Get a public file link
FilesApi getFilePreview GET /files/{file_id}/preview Get a file's preview
FilesApi getFilePublic GET /files/{file_id}/public Get a public file
FilesApi getFileThumbnail GET /files/{file_id}/thumbnail Get a file's thumbnail
FilesApi searchFiles POST /teams/{team_id}/files/search Search files in a team
FilesApi uploadFile POST /files Upload a file
GroupsApi getGroup GET /groups/{group_id} Get a group
GroupsApi getGroupStats GET /groups/{group_id}/stats Get group stats
GroupsApi getGroupSyncableForChannelId GET /groups/{group_id}/channels/{channel_id} Get GroupSyncable from channel ID
GroupsApi getGroupSyncableForTeamId GET /groups/{group_id}/teams/{team_id} Get GroupSyncable from Team ID
GroupsApi getGroupSyncablesChannels GET /groups/{group_id}/channels Get group channels
GroupsApi getGroupSyncablesTeams GET /groups/{group_id}/teams Get group teams
GroupsApi getGroupUsers GET /groups/{group_id}/members Get group users
GroupsApi getGroups GET /groups Get groups
GroupsApi getGroupsAssociatedToChannelsByTeam GET /teams/{team_id}/groups_by_channels Get team groups by channels
GroupsApi getGroupsByChannel GET /channels/{channel_id}/groups Get channel groups
GroupsApi getGroupsByTeam GET /teams/{team_id}/groups Get team groups
GroupsApi getGroupsByUserId GET /users/{user_id}/groups Get groups for a userId
GroupsApi linkGroupSyncableForChannel POST /groups/{group_id}/channels/{channel_id}/link Link a channel to a group
GroupsApi linkGroupSyncableForTeam POST /groups/{group_id}/teams/{team_id}/link Link a team to a group
GroupsApi patchGroup PUT /groups/{group_id}/patch Patch a group
GroupsApi patchGroupSyncableForChannel PUT /groups/{group_id}/channels/{channel_id}/patch Patch a GroupSyncable associated to Channel
GroupsApi patchGroupSyncableForTeam PUT /groups/{group_id}/teams/{team_id}/patch Patch a GroupSyncable associated to Team
GroupsApi unlinkGroupSyncableForChannel DELETE /groups/{group_id}/channels/{channel_id}/link Delete a link from a channel to a group
GroupsApi unlinkGroupSyncableForTeam DELETE /groups/{group_id}/teams/{team_id}/link Delete a link from a team to a group
GroupsApi unlinkLdapGroup DELETE /ldap/groups/{remote_id}/link Delete a link for LDAP group
ImportsApi listImports GET /imports List import files
IntegrationActionsApi openInteractiveDialog POST /actions/dialogs/open Open a dialog
IntegrationActionsApi submitInteractiveDialog POST /actions/dialogs/submit Submit a dialog
JobsApi cancelJob POST /jobs/{job_id}/cancel Cancel a job.
JobsApi createJob POST /jobs Create a new job.
JobsApi downloadJob GET /jobs/{job_id}/download Download the results of a job.
JobsApi getJob GET /jobs/{job_id} Get a job.
JobsApi getJobs GET /jobs Get the jobs.
JobsApi getJobsByType GET /jobs/type/{type} Get the jobs of the given type.
LDAPApi deleteLdapPrivateCertificate DELETE /ldap/certificate/private Remove private key
LDAPApi deleteLdapPublicCertificate DELETE /ldap/certificate/public Remove public certificate
LDAPApi migrateAuthToLdap POST /users/migrate_auth/ldap Migrate user accounts authentication type to LDAP.
LDAPApi migrateIdLdap POST /ldap/migrateid Migrate Id LDAP
LDAPApi syncLdap POST /ldap/sync Sync with LDAP
LDAPApi testLdap POST /ldap/test Test LDAP configuration
LDAPApi uploadLdapPrivateCertificate POST /ldap/certificate/private Upload private key
LDAPApi uploadLdapPublicCertificate POST /ldap/certificate/public Upload public certificate
LdapApi getLdapGroups GET /ldap/groups Returns a list of LDAP groups
LdapApi linkLdapGroup POST /ldap/groups/{remote_id}/link Link a LDAP group
MigrateApi migrateAuthToLdap POST /users/migrate_auth/ldap Migrate user accounts authentication type to LDAP.
MigrateApi migrateAuthToSaml POST /users/migrate_auth/saml Migrate user accounts authentication type to SAML.
OAuthApi createOAuthApp POST /oauth/apps Register OAuth app
OAuthApi deleteOAuthApp DELETE /oauth/apps/{app_id} Delete an OAuth app
OAuthApi getAuthorizedOAuthAppsForUser GET /users/{user_id}/oauth/apps/authorized Get authorized OAuth apps
OAuthApi getOAuthApp GET /oauth/apps/{app_id} Get an OAuth app
OAuthApi getOAuthAppInfo GET /oauth/apps/{app_id}/info Get info on an OAuth app
OAuthApi getOAuthApps GET /oauth/apps Get OAuth apps
OAuthApi regenerateOAuthAppSecret POST /oauth/apps/{app_id}/regen_secret Regenerate OAuth app secret
OAuthApi updateOAuthApp PUT /oauth/apps/{app_id} Update an OAuth app
OpenGraphApi openGraph POST /opengraph Get open graph metadata for url
PermissionsApi getAncillaryPermissions GET /permissions/ancillary Return all system console subsection ancillary permissions
PluginsApi disablePlugin POST /plugins/{plugin_id}/disable Disable plugin
PluginsApi enablePlugin POST /plugins/{plugin_id}/enable Enable plugin
PluginsApi getMarketplacePlugins GET /plugins/marketplace Gets all the marketplace plugins
PluginsApi getMarketplaceVisitedByAdmin GET /plugins/marketplace/first_admin_visit Get if the Plugin Marketplace has been visited by at least an admin.
PluginsApi getPluginStatuses GET /plugins/statuses Get plugins status
PluginsApi getPlugins GET /plugins Get plugins
PluginsApi getWebappPlugins GET /plugins/webapp Get webapp plugins
PluginsApi installMarketplacePlugin POST /plugins/marketplace Installs a marketplace plugin
PluginsApi installPluginFromUrl POST /plugins/install_from_url Install plugin from url
PluginsApi removePlugin DELETE /plugins/{plugin_id} Remove plugin
PluginsApi uploadPlugin POST /plugins Upload plugin
PostsApi createPost POST /posts Create a post
PostsApi createPostEphemeral POST /posts/ephemeral Create a ephemeral post
PostsApi deletePost DELETE /posts/{post_id} Delete a post
PostsApi doPostAction POST /posts/{post_id}/actions/{action_id} Perform a post action
PostsApi getFileInfosForPost GET /posts/{post_id}/files/info Get file info for post
PostsApi getFlaggedPostsForUser GET /users/{user_id}/posts/flagged Get a list of flagged posts
PostsApi getPost GET /posts/{post_id} Get a post
PostsApi getPostThread GET /posts/{post_id}/thread Get a thread
PostsApi getPostsAroundLastUnread GET /users/{user_id}/channels/{channel_id}/posts/unread Get posts around oldest unread
PostsApi getPostsByIds POST /posts/ids Get posts by a list of ids
PostsApi getPostsForChannel GET /channels/{channel_id}/posts Get posts for a channel
PostsApi patchPost PUT /posts/{post_id}/patch Patch a post
PostsApi pinPost POST /posts/{post_id}/pin Pin a post to the channel
PostsApi searchPosts POST /teams/{team_id}/posts/search Search for team posts
PostsApi setPostUnread POST /users/{user_id}/posts/{post_id}/set_unread Mark as unread from a post.
PostsApi unpinPost POST /posts/{post_id}/unpin Unpin a post to the channel
PostsApi updatePost PUT /posts/{post_id} Update a post
PreferencesApi deletePreferences POST /users/{user_id}/preferences/delete Delete user's preferences
PreferencesApi getPreferences GET /users/{user_id}/preferences Get the user's preferences
PreferencesApi getPreferencesByCategory GET /users/{user_id}/preferences/{category} List a user's preferences by category
PreferencesApi getPreferencesByCategoryByName GET /users/{user_id}/preferences/{category}/name/{preference_name} Get a specific user preference
PreferencesApi updatePreferences PUT /users/{user_id}/preferences Save the user's preferences
ReactionsApi deleteReaction DELETE /users/{user_id}/posts/{post_id}/reactions/{emoji_name} Remove a reaction from a post
ReactionsApi getBulkReactions POST /posts/ids/reactions Bulk get the reaction for posts
ReactionsApi getReactions GET /posts/{post_id}/reactions Get a list of reactions to a post
ReactionsApi saveReaction POST /reactions Create a reaction
RolesApi getRole GET /roles/{role_id} Get a role
RolesApi getRoleByName GET /roles/name/{role_name} Get a role
RolesApi getRolesByNames POST /roles/names Get a list of roles by name
RolesApi patchRole PUT /roles/{role_id}/patch Patch a role
RolesApi rolesGet GET /roles Get a list of all the roles
RootApi acknowledgeNotification POST /notifications/ack Acknowledge receiving of a notification
SAMLApi deleteSamlIdpCertificate DELETE /saml/certificate/idp Remove IDP certificate
SAMLApi deleteSamlPrivateCertificate DELETE /saml/certificate/private Remove private key
SAMLApi deleteSamlPublicCertificate DELETE /saml/certificate/public Remove public certificate
SAMLApi getSamlCertificateStatus GET /saml/certificate/status Get certificate status
SAMLApi getSamlMetadata GET /saml/metadata Get metadata
SAMLApi getSamlMetadataFromIdp POST /saml/metadatafromidp Get metadata from Identity Provider
SAMLApi migrateAuthToSaml POST /users/migrate_auth/saml Migrate user accounts authentication type to SAML.
SAMLApi resetSamlAuthDataToEmail POST /saml/reset_auth_data Reset AuthData to Email
SAMLApi uploadSamlIdpCertificate POST /saml/certificate/idp Upload IDP certificate
SAMLApi uploadSamlPrivateCertificate POST /saml/certificate/private Upload private key
SAMLApi uploadSamlPublicCertificate POST /saml/certificate/public Upload public certificate
SchemesApi createScheme POST /schemes Create a scheme
SchemesApi deleteScheme DELETE /schemes/{scheme_id} Delete a scheme
SchemesApi getChannelsForScheme GET /schemes/{scheme_id}/channels Get a page of channels which use this scheme.
SchemesApi getScheme GET /schemes/{scheme_id} Get a scheme
SchemesApi getSchemes GET /schemes Get the schemes.
SchemesApi getTeamsForScheme GET /schemes/{scheme_id}/teams Get a page of teams which use this scheme.
SchemesApi patchScheme PUT /schemes/{scheme_id}/patch Patch a scheme
SearchApi searchFiles POST /teams/{team_id}/files/search Search files in a team
SharedChannelsApi getAllSharedChannels GET /sharedchannels/{team_id} Get all shared channels for team.
SharedChannelsApi getRemoteClusterInfo GET /sharedchannels/remote_info/{remote_id} Get remote cluster info by ID for user.
StatusApi getUserStatus GET /users/{user_id}/status Get user status
StatusApi getUsersStatusesByIds POST /users/status/ids Get user statuses by id
StatusApi postUserRecentCustomStatusDelete POST /users/{user_id}/status/custom/recent/delete Delete user's recent custom status
StatusApi removeRecentCustomStatus DELETE /users/{user_id}/status/custom/recent Delete user's recent custom status
StatusApi unsetUserCustomStatus DELETE /users/{user_id}/status/custom Unsets user custom status
StatusApi updateUserCustomStatus PUT /users/{user_id}/status/custom Update user custom status
StatusApi updateUserStatus PUT /users/{user_id}/status Update user status
SystemApi checkIntegrity POST /integrity Perform a database integrity check
SystemApi clearServerBusy DELETE /server_busy Clears the server busy (high load) flag
SystemApi databaseRecycle POST /database/recycle Recycle database connections
SystemApi generateSupportPacket GET /system/support_packet Download a zip file which contains helpful and useful information for troubleshooting your mattermost instance.
SystemApi getAnalyticsOld GET /analytics/old Get analytics
SystemApi getAudits GET /audits Get audits
SystemApi getClientConfig GET /config/client Get client configuration
SystemApi getClientLicense GET /license/client Get client license
SystemApi getConfig GET /config Get configuration
SystemApi getEnvironmentConfig GET /config/environment Get configuration made through environment variables
SystemApi getImageByUrl GET /image Get an image by url
SystemApi getLogs GET /logs Get logs
SystemApi getNotices GET /system/notices/{teamId} Get notices for logged in user in specified team
SystemApi getPing GET /system/ping Check system health
SystemApi getRedirectLocation GET /redirect_location Get redirect location
SystemApi getServerBusyExpires GET /server_busy Get server busy expiry time.
SystemApi getSupportedTimezone GET /system/timezones Retrieve a list of supported timezones
SystemApi getWarnMetricsStatus GET /warn_metrics/status Get the warn metrics status (enabled or disabled)
SystemApi invalidateCaches POST /caches/invalidate Invalidate all the caches
SystemApi markNoticesViewed PUT /system/notices/view Update notices as 'viewed'
SystemApi patchConfig PUT /config/patch Patch configuration
SystemApi postLog POST /logs Add log message
SystemApi reloadConfig POST /config/reload Reload configuration
SystemApi removeLicenseFile DELETE /license Remove license file
SystemApi requestLicenseRenewalLink GET /license/renewal Request the license renewal link
SystemApi requestTrialLicense POST /trial-license Request and install a trial license for your server
SystemApi restartServer POST /restart Restart the system after an upgrade from Team Edition to Enterprise Edition
SystemApi sendTrialLicenseWarnMetricAck POST /warn_metrics/trial-license-ack/{warn_metric_id} Request trial license and acknowledge a warning of a metric status
SystemApi sendWarnMetricAck POST /warn_metrics/ack/{warn_metric_id} Acknowledge a warning of a metric status
SystemApi setServerBusy POST /server_busy Set the server busy (high load) flag
SystemApi testEmail POST /email/test Send a test email
SystemApi testS3Connection POST /file/s3_test Test AWS S3 connection
SystemApi testSiteURL POST /site_url/test Checks the validity of a Site URL
SystemApi trialLicensePrevGet GET /trial-license/prev Get last trial license used
SystemApi updateConfig PUT /config Update configuration
SystemApi updateMarketplaceVisitedByAdmin POST /plugins/marketplace/first_admin_visit Stores that the Plugin Marketplace has been visited by at least an admin.
SystemApi upgradeToEnterprise POST /upgrade_to_enterprise Executes an inplace upgrade from Team Edition to Enterprise Edition
SystemApi upgradeToEnterpriseStatus GET /upgrade_to_enterprise/status Get the current status for the inplace upgrade from Team Edition to Enterprise Edition
SystemApi uploadLicenseFile POST /license Upload license file
TeamsApi addTeamMember POST /teams/{team_id}/members Add user to team
TeamsApi addTeamMemberFromInvite POST /teams/members/invite Add user to team from invite
TeamsApi addTeamMembers POST /teams/{team_id}/members/batch Add multiple users to team
TeamsApi createTeam POST /teams Create a team
TeamsApi getAllTeams GET /teams Get teams
TeamsApi getTeam GET /teams/{team_id} Get a team
TeamsApi getTeamByName GET /teams/name/{name} Get a team by name
TeamsApi getTeamIcon GET /teams/{team_id}/image Get the team icon
TeamsApi getTeamInviteInfo GET /teams/invite/{invite_id} Get invite info for a team
TeamsApi getTeamMember GET /teams/{team_id}/members/{user_id} Get a team member
TeamsApi getTeamMembers GET /teams/{team_id}/members Get team members
TeamsApi getTeamMembersByIds POST /teams/{team_id}/members/ids Get team members by ids
TeamsApi getTeamMembersForUser GET /users/{user_id}/teams/members Get team members for a user
TeamsApi getTeamStats GET /teams/{team_id}/stats Get a team stats
TeamsApi getTeamUnread GET /users/{user_id}/teams/{team_id}/unread Get unreads for a team
TeamsApi getTeamsForUser GET /users/{user_id}/teams Get a user's teams
TeamsApi getTeamsUnreadForUser GET /users/{user_id}/teams/unread Get team unreads for a user
TeamsApi importTeam POST /teams/{team_id}/import Import a Team from other application
TeamsApi invalidateEmailInvites DELETE /teams/invites/email Invalidate active email invitations
TeamsApi inviteGuestsToTeam POST /teams/{team_id}/invite-guests/email Invite guests to the team by email
TeamsApi inviteUsersToTeam POST /teams/{team_id}/invite/email Invite users to the team by email
TeamsApi patchTeam PUT /teams/{team_id}/patch Patch a team
TeamsApi regenerateTeamInviteId POST /teams/{team_id}/regenerate_invite_id Regenerate the Invite ID from a Team
TeamsApi removeTeamIcon DELETE /teams/{team_id}/image Remove the team icon
TeamsApi removeTeamMember DELETE /teams/{team_id}/members/{user_id} Remove user from team
TeamsApi restoreTeam POST /teams/{team_id}/restore Restore a team
TeamsApi searchFiles POST /teams/{team_id}/files/search Search files in a team
TeamsApi searchTeams POST /teams/search Search teams
TeamsApi setTeamIcon POST /teams/{team_id}/image Sets the team icon
TeamsApi softDeleteTeam DELETE /teams/{team_id} Delete a team
TeamsApi teamExists GET /teams/name/{name}/exists Check if team exists
TeamsApi teamMembersMinusGroupMembers GET /teams/{team_id}/members_minus_group_members Team members minus group members.
TeamsApi updateTeam PUT /teams/{team_id} Update a team
TeamsApi updateTeamMemberRoles PUT /teams/{team_id}/members/{user_id}/roles Update a team member roles
TeamsApi updateTeamMemberSchemeRoles PUT /teams/{team_id}/members/{user_id}/schemeRoles Update the scheme-derived roles of a team member.
TeamsApi updateTeamPrivacy PUT /teams/{team_id}/privacy Update teams's privacy
TeamsApi updateTeamScheme PUT /teams/{team_id}/scheme Set a team's scheme
TermsOfServiceApi createTermsOfService POST /terms_of_service Creates a new terms of service
TermsOfServiceApi getTermsOfService GET /terms_of_service Get latest terms of service
TermsOfServiceApi getUserTermsOfService GET /users/{user_id}/terms_of_service Fetches user's latest terms of service action if the latest action was for acceptance.
TermsOfServiceApi registerTermsOfServiceAction POST /users/{user_id}/terms_of_service Records user action when they accept or decline custom terms of service
ThreadsApi getThreadMentionCountsByChannel GET /users/{user_id}/teams/{team_id}/threads/mention_counts Get all unread mention counts from followed threads, per-channel
ThreadsApi getUserThread GET /users/{user_id}/teams/{team_id}/threads/{thread_id} Get a thread followed by the user
ThreadsApi getUserThreads GET /users/{user_id}/teams/{team_id}/threads Get all threads that user is following
ThreadsApi startFollowingThread PUT /users/{user_id}/teams/{team_id}/threads/{thread_id}/following Start following a thread
ThreadsApi stopFollowingThread DELETE /users/{user_id}/teams/{team_id}/threads/{thread_id}/following Stop following a thread
ThreadsApi updateThreadReadForUser PUT /users/{user_id}/teams/{team_id}/threads/{thread_id}/read/{timestamp} Mark a thread that user is following read state to the timestamp
ThreadsApi updateThreadsReadForUser PUT /users/{user_id}/teams/{team_id}/threads/read Mark all threads that user is following as read
UploadsApi createUpload POST /uploads Create an upload
UploadsApi getUpload GET /uploads/{upload_id} Get an upload session
UploadsApi uploadData POST /uploads/{upload_id} Perform a file upload
UsersApi attachDeviceId PUT /users/sessions/device Attach mobile device
UsersApi autocompleteUsers GET /users/autocomplete Autocomplete users
UsersApi checkUserMfa POST /users/mfa Check MFA
UsersApi convertBotToUser POST /bots/{bot_user_id}/convert_to_user Convert a bot into a user
UsersApi convertUserToBot POST /users/{user_id}/convert_to_bot Convert a user into a bot
UsersApi createUser POST /users Create a user
UsersApi createUserAccessToken POST /users/{user_id}/tokens Create a user access token
UsersApi deleteUser DELETE /users/{user_id} Deactivate a user account.
UsersApi demoteUserToGuest POST /users/{user_id}/demote Demote a user to a guest
UsersApi disableUserAccessToken POST /users/tokens/disable Disable personal access token
UsersApi enableUserAccessToken POST /users/tokens/enable Enable personal access token
UsersApi generateMfaSecret POST /users/{user_id}/mfa/generate Generate MFA secret
UsersApi getChannelMembersWithTeamDataForUser GET /users/{user_id}/channel_members Get all channel members from all teams for a user
UsersApi getDefaultProfileImage GET /users/{user_id}/image/default Return user's default (generated) profile image
UsersApi getKnownUsers GET /users/known Get user IDs of known users
UsersApi getProfileImage GET /users/{user_id}/image Get user's profile image
UsersApi getSessions GET /users/{user_id}/sessions Get user's sessions
UsersApi getTotalUsersStats GET /users/stats Get total count of users in the system
UsersApi getTotalUsersStatsFiltered GET /users/stats/filtered Get total count of users in the system matching the specified filters
UsersApi getUploadsForUser GET /users/{user_id}/uploads Get uploads for a user
UsersApi getUser GET /users/{user_id} Get a user
UsersApi getUserAccessToken GET /users/tokens/{token_id} Get a user access token
UsersApi getUserAccessTokens GET /users/tokens Get user access tokens
UsersApi getUserAccessTokensForUser GET /users/{user_id}/tokens Get user access tokens
UsersApi getUserAudits GET /users/{user_id}/audits Get user's audits
UsersApi getUserByEmail GET /users/email/{email} Get a user by email
UsersApi getUserByUsername GET /users/username/{username} Get a user by username
UsersApi getUserTermsOfService GET /users/{user_id}/terms_of_service Fetches user's latest terms of service action if the latest action was for acceptance.
UsersApi getUsers GET /users Get users
UsersApi getUsersByGroupChannelIds POST /users/group_channels Get users by group channels ids
UsersApi getUsersByIds POST /users/ids Get users by ids
UsersApi getUsersByUsernames POST /users/usernames Get users by usernames
UsersApi login POST /users/login Login to Mattermost server
UsersApi loginByCwsToken POST /users/login/cws Auto-Login to Mattermost server using CWS token
UsersApi logout POST /users/logout Logout from the Mattermost server
UsersApi migrateAuthToLdap POST /users/migrate_auth/ldap Migrate user accounts authentication type to LDAP.
UsersApi migrateAuthToSaml POST /users/migrate_auth/saml Migrate user accounts authentication type to SAML.
UsersApi patchUser PUT /users/{user_id}/patch Patch a user
UsersApi permanentDeleteAllUsers DELETE /users Permanent delete all users
UsersApi promoteGuestToUser POST /users/{user_id}/promote Promote a guest to user
UsersApi publishUserTyping POST /users/{user_id}/typing Publish a user typing websocket event.
UsersApi registerTermsOfServiceAction POST /users/{user_id}/terms_of_service Records user action when they accept or decline custom terms of service
UsersApi resetPassword POST /users/password/reset Reset password
UsersApi revokeAllSessions POST /users/{user_id}/sessions/revoke/all Revoke all active sessions for a user
UsersApi revokeSession POST /users/{user_id}/sessions/revoke Revoke a user session
UsersApi revokeSessionsFromAllUsers POST /users/sessions/revoke/all Revoke all sessions from all users.
UsersApi revokeUserAccessToken POST /users/tokens/revoke Revoke a user access token
UsersApi searchUserAccessTokens POST /users/tokens/search Search tokens
UsersApi searchUsers POST /users/search Search users
UsersApi sendPasswordResetEmail POST /users/password/reset/send Send password reset email
UsersApi sendVerificationEmail POST /users/email/verify/send Send verification email
UsersApi setDefaultProfileImage DELETE /users/{user_id}/image Delete user's profile image
UsersApi setProfileImage POST /users/{user_id}/image Set user's profile image
UsersApi switchAccountType POST /users/login/switch Switch login method
UsersApi updateUser PUT /users/{user_id} Update a user
UsersApi updateUserActive PUT /users/{user_id}/active Update user active status
UsersApi updateUserAuth PUT /users/{user_id}/auth Update a user's authentication method
UsersApi updateUserMfa PUT /users/{user_id}/mfa Update a user's MFA
UsersApi updateUserPassword PUT /users/{user_id}/password Update a user's password
UsersApi updateUserRoles PUT /users/{user_id}/roles Update a user's roles
UsersApi verifyUserEmail POST /users/email/verify Verify user email
UsersApi verifyUserEmailWithoutToken POST /users/{user_id}/email/verify/member Verify user email by ID
WebhooksApi createIncomingWebhook POST /hooks/incoming Create an incoming webhook
WebhooksApi createOutgoingWebhook POST /hooks/outgoing Create an outgoing webhook
WebhooksApi deleteIncomingWebhook DELETE /hooks/incoming/{hook_id} Delete an incoming webhook
WebhooksApi deleteOutgoingWebhook DELETE /hooks/outgoing/{hook_id} Delete an outgoing webhook
WebhooksApi getIncomingWebhook GET /hooks/incoming/{hook_id} Get an incoming webhook
WebhooksApi getIncomingWebhooks GET /hooks/incoming List incoming webhooks
WebhooksApi getOutgoingWebhook GET /hooks/outgoing/{hook_id} Get an outgoing webhook
WebhooksApi getOutgoingWebhooks GET /hooks/outgoing List outgoing webhooks
WebhooksApi regenOutgoingHookToken POST /hooks/outgoing/{hook_id}/regen_token Regenerate the token for the outgoing webhook.
WebhooksApi updateIncomingWebhook PUT /hooks/incoming/{hook_id} Update an incoming webhook
WebhooksApi updateOutgoingWebhook PUT /hooks/outgoing/{hook_id} Update an outgoing webhook

Documentation For Models

Documentation For Authorization

bearerAuth

  • Type: HTTP basic authentication

Author

feedback@mattermost.com

Libraries

mattermost_dart