mattermost-redux/lib/actions/admin.d.ts

Common code (API client, Redux stores, logic, utility functions) for building a Mattermost client

import type { LogFilter } from '@mattermost/types/admin';
import type { Channel, ChannelSearchOpts } from '@mattermost/types/channels';
import type { Compliance } from '@mattermost/types/compliance';
import type { AdminConfig, AllowedIPRange, LdapSettings } from '@mattermost/types/config';
import type { CreateDataRetentionCustomPolicy, DataRetentionCustomPolicies, GetDataRetentionCustomPoliciesRequest, PatchDataRetentionCustomPolicy } from '@mattermost/types/data_retention';
import type { GroupSearchOpts } from '@mattermost/types/groups';
import type { CompleteOnboardingRequest } from '@mattermost/types/setup';
import type { Team, TeamSearchOpts } from '@mattermost/types/teams';
import type { DeepPartial } from '@mattermost/types/utilities';
import type { ActionFuncAsync } from 'mattermost-redux/types/actions';
export declare function getLogs({ serverNames, logLevels, dateFrom, dateTo }: LogFilter): ActionFuncAsync<string[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getPlainLogs(page?: number, perPage?: number): ActionFuncAsync<string[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getAudits(page?: number, perPage?: number): ActionFuncAsync<import("@mattermost/types/audits").Audit[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getConfig(): ActionFuncAsync<AdminConfig, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function patchConfig(config: DeepPartial<AdminConfig>): ActionFuncAsync<AdminConfig, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function reloadConfig(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getEnvironmentConfig(): ActionFuncAsync<import("@mattermost/types/config").EnvironmentConfig, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testEmail(config?: AdminConfig): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testSiteURL(siteURL: string): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testS3Connection(config?: AdminConfig): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function invalidateCaches(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function recycleDatabase(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function createComplianceReport(job: Partial<Compliance>): ActionFuncAsync<Compliance, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getComplianceReport(reportId: string): ActionFuncAsync<Compliance, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getComplianceReports(page?: number, perPage?: number): ActionFuncAsync<Compliance[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadBrandImage(imageData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function deleteBrandImage(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getClusterStatus(): ActionFuncAsync<import("@mattermost/types/admin").ClusterInfo[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testLdap(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testLdapConnection(settings: LdapSettings): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testLdapFilters(settings: LdapSettings): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testLdapAttributes(settings: LdapSettings): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testLdapGroupAttributes(settings: LdapSettings): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function syncLdap(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getLdapGroups(page?: number, perPage?: number, opts?: GroupSearchOpts): ActionFuncAsync<{
    count: number;
    groups: import("@mattermost/types/groups").MixedUnlinkedGroup[];
}, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function linkLdapGroup(key: string): ActionFuncAsync;
export declare function unlinkLdapGroup(key: string): ActionFuncAsync;
export declare function getSamlCertificateStatus(): ActionFuncAsync<import("@mattermost/types/saml").SamlCertificateStatus, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadPublicSamlCertificate(fileData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadPrivateSamlCertificate(fileData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadPublicLdapCertificate(fileData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadPrivateLdapCertificate(fileData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadIdpSamlCertificate(fileData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadAuditCertificate(fileData: File): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removeAuditCertificate(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removePublicSamlCertificate(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removePrivateSamlCertificate(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removePublicLdapCertificate(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removePrivateLdapCertificate(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removeIdpSamlCertificate(): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function testElasticsearch(config?: AdminConfig): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function purgeElasticsearchIndexes(indexes?: string[]): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function uploadLicense(fileData: File): ActionFuncAsync<import("@mattermost/types/config").License, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removeLicense(): ActionFuncAsync<boolean>;
export declare function getPrevTrialLicense(): ActionFuncAsync;
export declare function getAnalytics(name: string, teamId?: string): ActionFuncAsync;
export declare function getStandardAnalytics(teamId?: string): ActionFuncAsync;
export declare function getAdvancedAnalytics(teamId?: string): ActionFuncAsync;
export declare function getPostsPerDayAnalytics(teamId?: string): ActionFuncAsync;
export declare function getBotPostsPerDayAnalytics(teamId?: string): ActionFuncAsync;
export declare function getUsersPerDayAnalytics(teamId?: string): ActionFuncAsync;
export declare function uploadPlugin(fileData: File, force?: boolean): ActionFuncAsync;
export declare function installPluginFromUrl(url: string, force?: boolean): ActionFuncAsync;
export declare function getPlugins(): ActionFuncAsync<import("@mattermost/types/plugins").PluginsResponse, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getPluginStatuses(): ActionFuncAsync<import("@mattermost/types/plugins").PluginStatus[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removePlugin(pluginId: string): ActionFuncAsync;
export declare function enablePlugin(pluginId: string): ActionFuncAsync;
export declare function disablePlugin(pluginId: string): ActionFuncAsync;
export declare function getSamlMetadataFromIdp(samlMetadataURL: string): ActionFuncAsync<import("@mattermost/types/saml").SamlMetadataResponse, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function setSamlIdpCertificateFromMetadata(certData: string): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getDataRetentionCustomPolicies(page?: number, perPage?: number): ActionFuncAsync<GetDataRetentionCustomPoliciesRequest>;
export declare function getDataRetentionCustomPolicy(id: string): ActionFuncAsync<DataRetentionCustomPolicies>;
export declare function deleteDataRetentionCustomPolicy(id: string): ActionFuncAsync<{
    id: string;
}>;
export declare function getDataRetentionCustomPolicyTeams(id: string, page?: number, perPage?: number): ActionFuncAsync<Team[]>;
export declare function getDataRetentionCustomPolicyChannels(id: string, page?: number, perPage?: number): ActionFuncAsync<{
    channels: Channel[];
    total_count: number;
}>;
export declare function searchDataRetentionCustomPolicyTeams(id: string, term: string, opts: TeamSearchOpts): ActionFuncAsync<DataRetentionCustomPolicies>;
export declare function searchDataRetentionCustomPolicyChannels(id: string, term: string, opts: ChannelSearchOpts): ActionFuncAsync<DataRetentionCustomPolicies>;
export declare function createDataRetentionCustomPolicy(policy: CreateDataRetentionCustomPolicy): ActionFuncAsync<DataRetentionCustomPolicies>;
export declare function updateDataRetentionCustomPolicy(id: string, policy: PatchDataRetentionCustomPolicy): ActionFuncAsync<DataRetentionCustomPolicies>;
export declare function addDataRetentionCustomPolicyTeams(id: string, teams: string[]): ActionFuncAsync<DataRetentionCustomPolicies, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removeDataRetentionCustomPolicyTeams(id: string, teams: string[]): ActionFuncAsync<{
    teams: string[];
}>;
export declare function addDataRetentionCustomPolicyChannels(id: string, channels: string[]): ActionFuncAsync<DataRetentionCustomPolicies, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function removeDataRetentionCustomPolicyChannels(id: string, channels: string[]): ActionFuncAsync<{
    channels: string[];
}>;
export declare function completeSetup(completeSetup: CompleteOnboardingRequest): ActionFuncAsync<import("@mattermost/types/client4").StatusOK, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getAppliedSchemaMigrations(): ActionFuncAsync<import("@mattermost/types/admin").SchemaMigration[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getIPFilters(): ActionFuncAsync<AllowedIPRange[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function getCurrentIP(): ActionFuncAsync<import("@mattermost/types/config").FetchIPResponse, import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;
export declare function applyIPFilters(ipFilters: AllowedIPRange[]): ActionFuncAsync<AllowedIPRange[], import("@mattermost/types/store").GlobalState, import("redux").AnyAction>;