@mattermost/types 9.3.0 → 9.4.0

package/lib/config.d.ts

@@ -1,4 +1,4 @@
-export declare type ClientConfig = {
+export type ClientConfig = {
     AboutLink: string;
     AllowBannerDismissal: string;
     AllowCustomThemes: string;
@@ -197,7 +197,7 @@ export declare type ClientConfig = {
     ServiceEnvironment: string;
     UniqueEmojiReactionLimitPerPost: string;
 };
-export declare type License = {
+export type License = {
     id: string;
     issued_at: number;
     starts_at: number;
@@ -207,13 +207,13 @@ export declare type License = {
     sku_name: string;
     short_sku_name: string;
 };
-export declare type LicenseCustomer = {
+export type LicenseCustomer = {
     id: string;
     name: string;
     email: string;
     company: string;
 };
-export declare type LicenseFeatures = {
+export type LicenseFeatures = {
     users?: number;
     ldap?: boolean;
     ldap_groups?: boolean;
@@ -240,8 +240,8 @@ export declare type LicenseFeatures = {
     cloud?: boolean;
     future_features?: boolean;
 };
-export declare type ClientLicense = Record<string, string>;
-export declare type RequestLicenseBody = {
+export type ClientLicense = Record<string, string>;
+export type RequestLicenseBody = {
     users: number;
     terms_accepted: boolean;
     receive_emails_accepted: boolean;
@@ -251,7 +251,7 @@ export declare type RequestLicenseBody = {
     company_size: string;
     company_country: string;
 };
-export declare type DataRetentionPolicy = {
+export type DataRetentionPolicy = {
     message_deletion_enabled: boolean;
     file_deletion_enabled: boolean;
     message_retention_cutoff: number;
@@ -259,7 +259,7 @@ export declare type DataRetentionPolicy = {
     boards_retention_cutoff: number;
     boards_deletion_enabled: boolean;
 };
-export declare type ServiceSettings = {
+export type ServiceSettings = {
     SiteURL: string;
     WebsocketURL: string;
     LicenseFileLocation: string;
@@ -368,8 +368,9 @@ export declare type ServiceSettings = {
     PersistentNotificationMaxCount: number;
     PersistentNotificationMaxRecipients: number;
     UniqueEmojiReactionLimitPerPost: number;
+    RefreshPostStatsRunTime: string;
 };
-export declare type TeamSettings = {
+export type TeamSettings = {
     SiteName: string;
     MaxUsersPerTeam: number;
     EnableCustomUserStatuses: boolean;
@@ -394,13 +395,13 @@ export declare type TeamSettings = {
     EnableLastActiveTime: boolean;
     EnableJoinLeaveMessageByDefault: boolean;
 };
-export declare type ClientRequirements = {
+export type ClientRequirements = {
     AndroidLatestVersion: string;
     AndroidMinVersion: string;
     IosLatestVersion: string;
     IosMinVersion: string;
 };
-export declare type SqlSettings = {
+export type SqlSettings = {
     DriverName: string;
     DataSource: string;
     DataSourceReplicas: string[];
@@ -417,7 +418,7 @@ export declare type SqlSettings = {
     ReplicaLagSettings: ReplicaLagSetting[];
     ReplicaMonitorIntervalSeconds: number;
 };
-export declare type LogSettings = {
+export type LogSettings = {
     EnableConsole: boolean;
     ConsoleLevel: string;
     ConsoleJson: boolean;
@@ -433,7 +434,7 @@ export declare type LogSettings = {
     AdvancedLoggingConfig: string;
     AdvancedLoggingJSON: Record<string, any>;
 };
-export declare type ExperimentalAuditSettings = {
+export type ExperimentalAuditSettings = {
     FileEnabled: boolean;
     FileName: string;
     FileMaxSizeMB: number;
@@ -444,7 +445,7 @@ export declare type ExperimentalAuditSettings = {
     AdvancedLoggingConfig: string;
     AdvancedLoggingJSON: Record<string, any>;
 };
-export declare type NotificationLogSettings = {
+export type NotificationLogSettings = {
     EnableConsole: boolean;
     ConsoleLevel: string;
     ConsoleJson: boolean;
@@ -456,7 +457,7 @@ export declare type NotificationLogSettings = {
     AdvancedLoggingConfig: string;
     AdvancedLoggingJSON: Record<string, any>;
 };
-export declare type PasswordSettings = {
+export type PasswordSettings = {
     MinimumLength: number;
     Lowercase: boolean;
     Number: boolean;
@@ -464,7 +465,7 @@ export declare type PasswordSettings = {
     Symbol: boolean;
     EnableForgotLink: boolean;
 };
-export declare type FileSettings = {
+export type FileSettings = {
     EnableFileAttachments: boolean;
     EnableMobileUpload: boolean;
     EnableMobileDownload: boolean;
@@ -505,7 +506,7 @@ export declare type FileSettings = {
     ExportAmazonS3RequestTimeoutMilliseconds: number;
     ExportAmazonS3PresignExpiresSeconds: number;
 };
-export declare type EmailSettings = {
+export type EmailSettings = {
     EnableSignUpWithEmail: boolean;
     EnableSignInWithEmail: boolean;
     EnableSignInWithUsername: boolean;
@@ -539,7 +540,7 @@ export declare type EmailSettings = {
     LoginButtonBorderColor: string;
     LoginButtonTextColor: string;
 };
-export declare type RateLimitSettings = {
+export type RateLimitSettings = {
     Enable: boolean;
     PerSec: number;
     MaxBurst: number;
@@ -548,11 +549,11 @@ export declare type RateLimitSettings = {
     VaryByUser: boolean;
     VaryByHeader: string;
 };
-export declare type PrivacySettings = {
+export type PrivacySettings = {
     ShowEmailAddress: boolean;
     ShowFullName: boolean;
 };
-export declare type SupportSettings = {
+export type SupportSettings = {
     TermsOfServiceLink: string;
     PrivacyPolicyLink: string;
     AboutLink: string;
@@ -564,7 +565,7 @@ export declare type SupportSettings = {
     CustomTermsOfServiceReAcceptancePeriod: number;
     EnableAskCommunityLink: boolean;
 };
-export declare type AnnouncementSettings = {
+export type AnnouncementSettings = {
     EnableBanner: boolean;
     BannerText: string;
     BannerColor: string;
@@ -576,13 +577,13 @@ export declare type AnnouncementSettings = {
     NoticesFetchFrequency: number;
     NoticesSkipCache: boolean;
 };
-export declare type ThemeSettings = {
+export type ThemeSettings = {
     EnableThemeSelection: boolean;
     DefaultTheme: string;
     AllowCustomThemes: boolean;
     AllowedThemes: string[];
 };
-export declare type SSOSettings = {
+export type SSOSettings = {
     Enable: boolean;
     Secret: string;
     Id: string;
@@ -594,7 +595,7 @@ export declare type SSOSettings = {
     ButtonText: string;
     ButtonColor: string;
 };
-export declare type Office365Settings = {
+export type Office365Settings = {
     Enable: boolean;
     Secret: string;
     Id: string;
@@ -605,7 +606,7 @@ export declare type Office365Settings = {
     DiscoveryEndpoint: string;
     DirectoryId: string;
 };
-export declare type LdapSettings = {
+export type LdapSettings = {
     Enable: boolean;
     EnableSync: boolean;
     LdapServer: string;
@@ -642,18 +643,18 @@ export declare type LdapSettings = {
     LoginButtonTextColor: string;
     Trace: boolean;
 };
-export declare type ComplianceSettings = {
+export type ComplianceSettings = {
     Enable: boolean;
     Directory: string;
     EnableDaily: boolean;
     BatchSize: number;
 };
-export declare type LocalizationSettings = {
+export type LocalizationSettings = {
     DefaultServerLocale: string;
     DefaultClientLocale: string;
     AvailableLocales: string;
 };
-export declare type SamlSettings = {
+export type SamlSettings = {
     Enable: boolean;
     EnableSyncWithLdap: boolean;
     EnableSyncWithLdapIncludeAuth: boolean;
@@ -689,13 +690,13 @@ export declare type SamlSettings = {
     LoginButtonBorderColor: string;
     LoginButtonTextColor: string;
 };
-export declare type NativeAppSettings = {
+export type NativeAppSettings = {
     AppCustomURLSchemes: string[];
     AppDownloadLink: string;
     AndroidAppDownloadLink: string;
     IosAppDownloadLink: string;
 };
-export declare type ClusterSettings = {
+export type ClusterSettings = {
     Enable: boolean;
     ClusterName: string;
     OverrideHostname: string;
@@ -712,12 +713,12 @@ export declare type ClusterSettings = {
     MaxIdleConnsPerHost: number;
     IdleConnTimeoutMilliseconds: number;
 };
-export declare type MetricsSettings = {
+export type MetricsSettings = {
     Enable: boolean;
     BlockProfileRate: number;
     ListenAddress: string;
 };
-export declare type ExperimentalSettings = {
+export type ExperimentalSettings = {
     ClientSideCertEnable: boolean;
     ClientSideCertCheck: string;
     LinkMetadataTimeoutMilliseconds: number;
@@ -729,10 +730,10 @@ export declare type ExperimentalSettings = {
     DisableRefetchingOnBrowserFocus: boolean;
     DelayChannelAutocomplete: boolean;
 };
-export declare type AnalyticsSettings = {
+export type AnalyticsSettings = {
     MaxUsersForStatistics: number;
 };
-export declare type ElasticsearchSettings = {
+export type ElasticsearchSettings = {
     ConnectionURL: string;
     Username: string;
     Password: string;
@@ -759,14 +760,14 @@ export declare type ElasticsearchSettings = {
     Trace: string;
     IgnoredPurgeIndexes: string;
 };
-export declare type BleveSettings = {
+export type BleveSettings = {
     IndexDir: string;
     EnableIndexing: boolean;
     EnableSearching: boolean;
     EnableAutocomplete: boolean;
     BatchSize: number;
 };
-export declare type DataRetentionSettings = {
+export type DataRetentionSettings = {
     EnableMessageDeletion: boolean;
     EnableFileDeletion: boolean;
     MessageRetentionDays: number;
@@ -778,7 +779,7 @@ export declare type DataRetentionSettings = {
     TimeBetweenBatchesMilliseconds: number;
     RetentionIdsBatchSize: number;
 };
-export declare type MessageExportSettings = {
+export type MessageExportSettings = {
     EnableExport: boolean;
     DownloadExportResults: boolean;
     ExportFormat: string;
@@ -791,16 +792,18 @@ export declare type MessageExportSettings = {
         SMTPPassword: string;
         EmailAddress: string;
         SMTPServerTimeout: number;
+        CustomSMTPServerName: string;
+        CustomSMTPPort: string;
     };
 };
-export declare type JobSettings = {
+export type JobSettings = {
     RunJobs: boolean;
     RunScheduler: boolean;
     CleanupJobsThresholdDays: number;
     CleanupConfigThresholdDays: number;
 };
-export declare type ProductSettings = {};
-export declare type PluginSettings = {
+export type ProductSettings = {};
+export type PluginSettings = {
     Enable: boolean;
     EnableUploads: boolean;
     AllowInsecureDownloadURL: boolean;
@@ -819,38 +822,38 @@ export declare type PluginSettings = {
     SignaturePublicKeyFiles: string[];
     ChimeraOAuthProxyURL: string;
 };
-export declare type DisplaySettings = {
+export type DisplaySettings = {
     CustomURLSchemes: string[];
     MaxMarkdownNodes: number;
 };
-export declare type GuestAccountsSettings = {
+export type GuestAccountsSettings = {
     Enable: boolean;
     HideTags: boolean;
     AllowEmailAccounts: boolean;
     EnforceMultifactorAuthentication: boolean;
     RestrictCreationToDomains: string;
 };
-export declare type ImageProxySettings = {
+export type ImageProxySettings = {
     Enable: boolean;
     ImageProxyType: string;
     RemoteImageProxyURL: string;
     RemoteImageProxyOptions: string;
 };
-export declare type CloudSettings = {
+export type CloudSettings = {
     CWSURL: string;
     CWSAPIURL: string;
     CWSMock: boolean;
 };
-export declare type FeatureFlags = Record<string, string | boolean>;
-export declare type ImportSettings = {
+export type FeatureFlags = Record<string, string | boolean>;
+export type ImportSettings = {
     Directory: string;
     RetentionDays: number;
 };
-export declare type ExportSettings = {
+export type ExportSettings = {
     Directory: string;
     RetentionDays: number;
 };
-export declare type AdminConfig = {
+export type AdminConfig = {
     ServiceSettings: ServiceSettings;
     TeamSettings: TeamSettings;
     ClientRequirements: ClientRequirements;
@@ -894,18 +897,18 @@ export declare type AdminConfig = {
     ImportSettings: ImportSettings;
     ExportSettings: ExportSettings;
 };
-export declare type ReplicaLagSetting = {
+export type ReplicaLagSetting = {
     DataSource: string;
     QueryAbsoluteLag: string;
     QueryTimeLag: string;
 };
-export declare type EnvironmentConfigSettings<T> = {
+export type EnvironmentConfigSettings<T> = {
     [P in keyof T]: boolean;
 };
-export declare type EnvironmentConfig = {
+export type EnvironmentConfig = {
     [P in keyof AdminConfig]: EnvironmentConfigSettings<AdminConfig[P]>;
 };
-export declare type WarnMetricStatus = {
+export type WarnMetricStatus = {
     id: string;
     limit: number;
     acked: boolean;
@@ -922,3 +925,13 @@ export declare enum ServiceEnvironment {
     TEST = "test",
     DEV = "dev"
 }
+export type AllowedIPRange = {
+    cidr_block: string;
+    description: string;
+    enabled: boolean;
+    owner_id: string;
+};
+export type AllowedIPRanges = AllowedIPRange[];
+export type FetchIPResponse = {
+    ip: string;
+};

package/lib/data_retention.d.ts

@@ -1,30 +1,30 @@
-export declare type DataRetentionCustomPolicy = {
+export type DataRetentionCustomPolicy = {
     id: string;
     display_name: string;
     post_duration: number;
     team_count: number;
     channel_count: number;
 };
-export declare type CreateDataRetentionCustomPolicy = {
+export type CreateDataRetentionCustomPolicy = {
     display_name: string;
     post_duration: number;
     channel_ids: string[];
     team_ids: string[];
 };
-export declare type PatchDataRetentionCustomPolicy = {
+export type PatchDataRetentionCustomPolicy = {
     display_name: string;
     post_duration: number;
 };
-export declare type PatchDataRetentionCustomPolicyTeams = {
+export type PatchDataRetentionCustomPolicyTeams = {
     team_ids: string[];
 };
-export declare type PatchDataRetentionCustomPolicyChannels = {
+export type PatchDataRetentionCustomPolicyChannels = {
     channel_ids: string[];
 };
-export declare type DataRetentionCustomPolicies = {
+export type DataRetentionCustomPolicies = {
     [x: string]: DataRetentionCustomPolicy;
 };
-export declare type GetDataRetentionCustomPoliciesRequest = {
+export type GetDataRetentionCustomPoliciesRequest = {
     policies: DataRetentionCustomPolicy[];
     total_count: number;
 };

package/lib/drafts.d.ts

@@ -1,5 +1,5 @@
 import { PostMetadata, PostPriorityMetadata } from './posts';
-export declare type Draft = {
+export type Draft = {
     create_at: number;
     update_at: number;
     delete_at: number;

package/lib/emojis.d.ts

@@ -1,5 +1,5 @@
-export declare type EmojiCategory = 'recent' | 'searchResults' | 'smileys-emotion' | 'people-body' | 'animals-nature' | 'food-drink' | 'activities' | 'travel-places' | 'objects' | 'symbols' | 'flags' | 'custom';
-export declare type CustomEmoji = {
+export type EmojiCategory = 'recent' | 'searchResults' | 'smileys-emotion' | 'people-body' | 'animals-nature' | 'food-drink' | 'activities' | 'travel-places' | 'objects' | 'symbols' | 'flags' | 'custom';
+export type CustomEmoji = {
     id: string;
     name: string;
     category: 'custom';
@@ -8,7 +8,7 @@ export declare type CustomEmoji = {
     delete_at: number;
     creator_id: string;
 };
-export declare type SystemEmoji = {
+export type SystemEmoji = {
     name: string;
     category: EmojiCategory;
     image: string;
@@ -19,7 +19,7 @@ export declare type SystemEmoji = {
     skin_variations?: Record<string, SystemEmojiVariation>;
     unified: string;
 };
-export declare type SystemEmojiVariation = {
+export type SystemEmojiVariation = {
     unified: string;
     non_qualified: null;
     image: string;
@@ -31,14 +31,14 @@ export declare type SystemEmojiVariation = {
     has_img_twitter: boolean;
     has_img_facebook: boolean;
 };
-export declare type Emoji = SystemEmoji | CustomEmoji;
-export declare type EmojisState = {
+export type Emoji = SystemEmoji | CustomEmoji;
+export type EmojisState = {
     customEmoji: {
         [x: string]: CustomEmoji;
     };
     nonExistentEmoji: Set<string>;
 };
-export declare type RecentEmojiData = {
+export type RecentEmojiData = {
     name: string;
     usageCount: number;
 };

package/lib/errors.d.ts

@@ -1,4 +1,4 @@
-export declare type ServerError = {
+export type ServerError = {
     type?: string;
     server_error_id?: string;
     stack?: string;

package/lib/files.d.ts

@@ -1,4 +1,4 @@
-export declare type FileInfo = {
+export type FileInfo = {
     id: string;
     user_id: string;
     create_at: number;
@@ -17,7 +17,7 @@ export declare type FileInfo = {
     archived: boolean;
     link?: string;
 };
-export declare type FilesState = {
+export type FilesState = {
     files: Record<string, FileInfo>;
     filesFromSearch: Record<string, FileSearchResultItem>;
     fileIdsByPostId: Record<string, string[]>;
@@ -25,14 +25,14 @@ export declare type FilesState = {
         link: string;
     };
 };
-export declare type FileUploadResponse = {
+export type FileUploadResponse = {
     file_infos: FileInfo[];
     client_ids: string[];
 };
-export declare type FileSearchResultItem = FileInfo & {
+export type FileSearchResultItem = FileInfo & {
     channel_id: string;
 };
-export declare type FileSearchResults = {
+export type FileSearchResults = {
     order: Array<FileSearchResultItem['id']>;
     file_infos: Map<string, FileSearchResultItem>;
     next_file_info_id: string;

package/lib/general.d.ts

@@ -1,5 +1,5 @@
 import { ClientConfig, ClientLicense, WarnMetricStatus } from './config';
-export declare type GeneralState = {
+export type GeneralState = {
     config: Partial<ClientConfig>;
     dataRetentionPolicy: any;
     firstAdminVisitMarketplaceStatus: boolean;
@@ -8,7 +8,7 @@ export declare type GeneralState = {
     serverVersion: string;
     warnMetricsStatus: Record<string, WarnMetricStatus>;
 };
-export declare type SystemSetting = {
+export type SystemSetting = {
     name: string;
     value: string;
 };

package/lib/groups.d.ts

@@ -4,19 +4,19 @@ export declare enum SyncableType {
     Team = "team",
     Channel = "channel"
 }
-export declare type SyncablePatch = {
+export type SyncablePatch = {
     scheme_admin: boolean;
     auto_add: boolean;
 };
-export declare type GroupPatch = {
+export type GroupPatch = {
     allow_reference: boolean;
     name?: string;
 };
-export declare type CustomGroupPatch = {
+export type CustomGroupPatch = {
     name: string;
     display_name: string;
 };
-export declare type Group = {
+export type Group = {
     id: string;
     name: string;
     display_name: string;
@@ -38,7 +38,7 @@ export declare enum GroupSource {
     Ldap = "ldap",
     Custom = "custom"
 }
-export declare type GroupTeam = {
+export type GroupTeam = {
     team_id: string;
     team_display_name: string;
     team_type?: string;
@@ -49,7 +49,7 @@ export declare type GroupTeam = {
     delete_at?: number;
     update_at?: number;
 };
-export declare type GroupChannel = {
+export type GroupChannel = {
     channel_id: string;
     channel_display_name: string;
     channel_type?: string;
@@ -63,7 +63,7 @@ export declare type GroupChannel = {
     delete_at?: number;
     update_at?: number;
 };
-export declare type GroupSyncable = {
+export type GroupSyncable = {
     group_id: string;
     auto_add: boolean;
     scheme_admin: boolean;
@@ -72,51 +72,51 @@ export declare type GroupSyncable = {
     update_at: number;
     type: 'Team' | 'Channel';
 };
-export declare type GroupSyncablesState = {
+export type GroupSyncablesState = {
     teams: GroupTeam[];
     channels: GroupChannel[];
 };
-export declare type GroupsState = {
+export type GroupsState = {
     syncables: Record<string, GroupSyncablesState>;
     stats: RelationOneToOne<Group, GroupStats>;
     groups: Record<string, Group>;
     myGroups: string[];
 };
-export declare type GroupStats = {
+export type GroupStats = {
     group_id: string;
     total_member_count: number;
 };
-export declare type GroupSearchOpts = {
+export type GroupSearchOpts = {
     q: string;
     is_linked?: boolean;
     is_configured?: boolean;
 };
-export declare type MixedUnlinkedGroup = {
+export type MixedUnlinkedGroup = {
     mattermost_group_id?: string;
     name: string;
     primary_key: string;
     has_syncables?: boolean;
 };
-export declare type MixedUnlinkedGroupRedux = MixedUnlinkedGroup & {
+export type MixedUnlinkedGroupRedux = MixedUnlinkedGroup & {
     failed?: boolean;
 };
-export declare type UserWithGroup = UserProfile & {
+export type UserWithGroup = UserProfile & {
     groups: Group[];
     scheme_guest: boolean;
     scheme_user: boolean;
     scheme_admin: boolean;
 };
-export declare type GroupsWithCount = {
+export type GroupsWithCount = {
     groups: Group[];
     total_group_count: number;
     channelID?: string;
     teamID?: string;
 };
-export declare type UsersWithGroupsAndCount = {
+export type UsersWithGroupsAndCount = {
     users: UserWithGroup[];
     total_count: number;
 };
-export declare type GroupCreateWithUserIds = {
+export type GroupCreateWithUserIds = {
     name: string;
     allow_reference: boolean;
     display_name: string;
@@ -124,7 +124,7 @@ export declare type GroupCreateWithUserIds = {
     user_ids: string[];
     description?: string;
 };
-export declare type GetGroupsParams = {
+export type GetGroupsParams = {
     filter_allow_reference?: boolean;
     page?: number;
     per_page?: number;
@@ -133,20 +133,20 @@ export declare type GetGroupsParams = {
     filter_archived?: boolean;
     include_member_ids?: boolean;
 };
-export declare type GetGroupsForUserParams = GetGroupsParams & {
+export type GetGroupsForUserParams = GetGroupsParams & {
     filter_has_member: string;
 };
-export declare type GroupSearchParams = GetGroupsParams & {
+export type GroupSearchParams = GetGroupsParams & {
     q: string;
     filter_has_member?: string;
     include_timezones?: string;
     include_channel_member_count?: string;
 };
-export declare type GroupMembership = {
+export type GroupMembership = {
     user_id: string;
     roles: string;
 };
-export declare type GroupPermissions = {
+export type GroupPermissions = {
     can_delete: boolean;
     can_manage_members: boolean;
     can_restore: boolean;