@mattermost/types 11.1.0-0 → 11.1.0-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/lib/access_control.d.ts +71 -0
  2. package/lib/admin.d.ts +147 -0
  3. package/lib/apps.d.ts +191 -0
  4. package/lib/audits.d.ts +9 -0
  5. package/lib/autocomplete.d.ts +12 -0
  6. package/lib/bots.d.ts +15 -0
  7. package/lib/channel_bookmarks.d.ts +51 -0
  8. package/lib/channel_categories.d.ts +30 -0
  9. package/lib/channels.d.ts +190 -0
  10. package/lib/client4.d.ts +42 -0
  11. package/lib/cloud.d.ts +187 -0
  12. package/lib/compliance.d.ts +13 -0
  13. package/lib/config.d.ts +1035 -0
  14. package/lib/content_flagging.d.ts +24 -0
  15. package/lib/data_retention.d.ts +30 -0
  16. package/lib/drafts.d.ts +14 -0
  17. package/lib/emojis.d.ts +44 -0
  18. package/lib/errors.d.ts +8 -0
  19. package/lib/files.d.ts +41 -0
  20. package/lib/general.d.ts +16 -0
  21. package/lib/groups.d.ts +169 -0
  22. package/lib/hosted_customer.d.ts +7 -0
  23. package/lib/integration_actions.d.ts +20 -0
  24. package/lib/integrations.d.ts +187 -0
  25. package/lib/jobs.d.ts +23 -0
  26. package/lib/limits.d.ts +10 -0
  27. package/lib/marketplace.d.ts +42 -0
  28. package/lib/message_attachments.d.ts +24 -0
  29. package/lib/mfa.d.ts +4 -0
  30. package/lib/plugins.d.ts +136 -0
  31. package/lib/posts.d.ts +182 -0
  32. package/lib/preferences.d.ts +9 -0
  33. package/lib/product_notices.d.ts +26 -0
  34. package/lib/products.d.ts +8 -0
  35. package/lib/properties.d.ts +60 -0
  36. package/lib/reactions.d.ts +6 -0
  37. package/lib/remote_clusters.d.ts +35 -0
  38. package/lib/reports.d.ts +65 -0
  39. package/lib/requests.d.ts +53 -0
  40. package/lib/roles.d.ts +12 -0
  41. package/lib/saml.d.ts +10 -0
  42. package/lib/schedule_post.d.ts +27 -0
  43. package/lib/schemes.d.ts +29 -0
  44. package/lib/search.d.ts +29 -0
  45. package/lib/sessions.d.ts +15 -0
  46. package/lib/setup.d.ts +4 -0
  47. package/lib/shared_channels.d.ts +26 -0
  48. package/lib/store.d.ts +97 -0
  49. package/lib/teams.d.ts +99 -0
  50. package/lib/terms_of_service.d.ts +6 -0
  51. package/lib/threads.d.ts +63 -0
  52. package/lib/typing.d.ts +5 -0
  53. package/lib/users.d.ts +140 -0
  54. package/package.json +1 -1
@@ -0,0 +1,1035 @@
1
+ import type { ContentFlaggingEvent, NotificationTarget } from './content_flagging';
2
+ export type ClientConfig = {
3
+ AboutLink: string;
4
+ AllowBannerDismissal: string;
5
+ AllowCustomThemes: string;
6
+ AllowSyncedDrafts: string;
7
+ AllowedThemes: string;
8
+ AndroidAppDownloadLink: string;
9
+ AndroidLatestVersion: string;
10
+ AndroidMinVersion: string;
11
+ AppDownloadLink: string;
12
+ AppsPluginEnabled: string;
13
+ AsymmetricSigningPublicKey: string;
14
+ AvailableLocales: string;
15
+ BannerColor: string;
16
+ BannerText: string;
17
+ BannerTextColor: string;
18
+ BuildDate: string;
19
+ BuildEnterpriseReady: string;
20
+ BuildHash: string;
21
+ BuildHashEnterprise: string;
22
+ BuildNumber: string;
23
+ CollapsedThreads: CollapsedThreads;
24
+ CustomBrandText: string;
25
+ CustomDescriptionText: string;
26
+ CustomTermsOfServiceId: string;
27
+ CustomTermsOfServiceReAcceptancePeriod: string;
28
+ CustomUrlSchemes: string;
29
+ CWSURL: string;
30
+ CWSMock: string;
31
+ DataRetentionEnableFileDeletion: string;
32
+ DataRetentionEnableMessageDeletion: string;
33
+ DataRetentionFileRetentionHours: string;
34
+ DataRetentionMessageRetentionHours: string;
35
+ DefaultClientLocale: string;
36
+ DefaultTheme: string;
37
+ DiagnosticId: string;
38
+ DiagnosticsEnabled: string;
39
+ DisableRefetchingOnBrowserFocus: string;
40
+ DisableWakeUpReconnectHandler: string;
41
+ EmailLoginButtonBorderColor: string;
42
+ EmailLoginButtonColor: string;
43
+ EmailLoginButtonTextColor: string;
44
+ EmailNotificationContentsType: string;
45
+ EnableAskCommunityLink: string;
46
+ EnableBanner: string;
47
+ EnableBotAccountCreation: string;
48
+ EnableChannelViewedMessages: string;
49
+ EnableClientMetrics: string;
50
+ EnableClientPerformanceDebugging: string;
51
+ EnableCluster: string;
52
+ EnableCommands: string;
53
+ EnableCompliance: string;
54
+ EnableConfirmNotificationsToChannel: string;
55
+ EnableCustomBrand: string;
56
+ EnableCustomEmoji: string;
57
+ EnableCustomGroups: string;
58
+ EnableCustomUserStatuses: string;
59
+ EnableExperimentalLocales: string;
60
+ EnableUserStatuses: string;
61
+ EnableLastActiveTime: string;
62
+ EnableTimedDND: string;
63
+ EnableCrossTeamSearch: 'true' | 'false';
64
+ EnableCustomTermsOfService: string;
65
+ EnableDeveloper: string;
66
+ EnableDiagnostics: string;
67
+ EnableDesktopLandingPage: 'true' | 'false';
68
+ EnableEmailBatching: string;
69
+ EnableEmailInvitations: string;
70
+ EnableEmojiPicker: string;
71
+ EnableFileAttachments: string;
72
+ EnableFile: string;
73
+ EnableGifPicker: string;
74
+ EnableGuestAccounts: string;
75
+ EnableIncomingWebhooks: string;
76
+ EnableJoinLeaveMessageByDefault: string;
77
+ EnableLatex: string;
78
+ EnableInlineLatex: string;
79
+ EnableLdap: string;
80
+ EnableLinkPreviews: string;
81
+ EnableMarketplace: string;
82
+ EnableMetrics: string;
83
+ EnableMobileFileDownload: string;
84
+ EnableMobileFileUpload: string;
85
+ EnableMultifactorAuthentication: string;
86
+ EnableOAuthServiceProvider: string;
87
+ EnableOutgoingOAuthConnections: string;
88
+ EnableOpenServer: string;
89
+ EnableOutgoingWebhooks: string;
90
+ EnablePostIconOverride: string;
91
+ EnablePostUsernameOverride: string;
92
+ EnablePreviewModeBanner: string;
93
+ EnablePublicLink: string;
94
+ EnableReliableWebSockets: string;
95
+ EnableSaml: string;
96
+ EnableSignInWithEmail: string;
97
+ EnableSignInWithUsername: string;
98
+ EnableSignUpWithEmail: string;
99
+ EnableSignUpWithGitLab: string;
100
+ EnableSignUpWithGoogle: string;
101
+ EnableSignUpWithOffice365: string;
102
+ EnableSignUpWithOpenId: string;
103
+ EnableSVGs: string;
104
+ EnableTesting: string;
105
+ EnableThemeSelection: string;
106
+ EnableTutorial: string;
107
+ EnableOnboardingFlow: string;
108
+ EnableUserAccessTokens: string;
109
+ EnableUserCreation: string;
110
+ EnableUserDeactivation: string;
111
+ EnableUserTypingMessages: string;
112
+ EnforceMultifactorAuthentication: string;
113
+ ExperimentalChannelCategorySorting: string;
114
+ ExperimentalEnableAuthenticationTransfer: string;
115
+ ExperimentalEnableAutomaticReplies: string;
116
+ ExperimentalEnableDefaultChannelLeaveJoinMessages: string;
117
+ ExperimentalEnablePostMetadata: string;
118
+ ExperimentalGroupUnreadChannels: string;
119
+ ExperimentalPrimaryTeam: string;
120
+ FileLevel: string;
121
+ FeatureFlagAppsEnabled: string;
122
+ FeatureFlagCallsEnabled: string;
123
+ FeatureFlagCustomProfileAttributes: string;
124
+ FeatureFlagAttributeBasedAccessControl: string;
125
+ FeatureFlagWebSocketEventScope: string;
126
+ FeatureFlagInteractiveDialogAppsForm: string;
127
+ FeatureFlagContentFlagging: string;
128
+ ForgotPasswordLink: string;
129
+ GiphySdkKey: string;
130
+ GoogleDeveloperKey: string;
131
+ GuestAccountsEnforceMultifactorAuthentication: string;
132
+ HasImageProxy: string;
133
+ HelpLink: string;
134
+ HideGuestTags: string;
135
+ IosAppDownloadLink: string;
136
+ IosLatestVersion: string;
137
+ IosMinVersion: string;
138
+ InstallationDate: string;
139
+ IsDefaultMarketplace: string;
140
+ LdapFirstNameAttributeSet: string;
141
+ LdapLastNameAttributeSet: string;
142
+ LdapLoginButtonBorderColor: string;
143
+ LdapLoginButtonColor: string;
144
+ LdapLoginButtonTextColor: string;
145
+ LdapLoginFieldName: string;
146
+ LdapNicknameAttributeSet: string;
147
+ LdapPositionAttributeSet: string;
148
+ LdapPictureAttributeSet: string;
149
+ LockTeammateNameDisplay: string;
150
+ ManagedResourcePaths: string;
151
+ MaxFileSize: string;
152
+ MaxPostSize: string;
153
+ MaxNotificationsPerChannel: string;
154
+ MinimumHashtagLength: string;
155
+ NoAccounts: string;
156
+ GitLabButtonText: string;
157
+ GitLabButtonColor: string;
158
+ OpenIdButtonText: string;
159
+ OpenIdButtonColor: string;
160
+ PasswordEnableForgotLink: string;
161
+ PasswordMinimumLength: string;
162
+ PasswordRequireLowercase: string;
163
+ PasswordRequireNumber: string;
164
+ PasswordRequireSymbol: string;
165
+ PasswordRequireUppercase: string;
166
+ PluginsEnabled: string;
167
+ PostEditTimeLimit: string;
168
+ PrivacyPolicyLink: string;
169
+ ReportAProblemLink: string;
170
+ ReportAProblemType: string;
171
+ ReportAProblemMail: string;
172
+ AllowDownloadLogs: string;
173
+ RequireEmailVerification: string;
174
+ RestrictDirectMessage: string;
175
+ RunJobs: string;
176
+ SamlFirstNameAttributeSet: string;
177
+ SamlLastNameAttributeSet: string;
178
+ SamlLoginButtonBorderColor: string;
179
+ SamlLoginButtonColor: string;
180
+ SamlLoginButtonText: string;
181
+ SamlLoginButtonTextColor: string;
182
+ SamlNicknameAttributeSet: string;
183
+ SamlPositionAttributeSet: string;
184
+ SchemaVersion: string;
185
+ SendEmailNotifications: string;
186
+ SendPushNotifications: string;
187
+ ShowEmailAddress: string;
188
+ SiteName: string;
189
+ SiteURL: string;
190
+ SQLDriverName: string;
191
+ SupportEmail: string;
192
+ TelemetryId: string;
193
+ TeammateNameDisplay: string;
194
+ TermsOfServiceLink: string;
195
+ TimeBetweenUserTypingUpdatesMilliseconds: string;
196
+ UpgradedFromTE: string;
197
+ Version: string;
198
+ WebsocketPort: string;
199
+ WebsocketSecurePort: string;
200
+ WebsocketURL: string;
201
+ ExperimentalSharedChannels: string;
202
+ DisableAppBar: string;
203
+ EnableComplianceExport: string;
204
+ PostPriority: string;
205
+ PostAcknowledgements: string;
206
+ AllowPersistentNotifications: string;
207
+ PersistentNotificationMaxRecipients: string;
208
+ PersistentNotificationIntervalMinutes: string;
209
+ AllowPersistentNotificationsForGuests: string;
210
+ DelayChannelAutocomplete: 'true' | 'false';
211
+ WranglerPermittedWranglerRoles: string;
212
+ WranglerAllowedEmailDomain: string;
213
+ WranglerMoveThreadMaxCount: string;
214
+ WranglerMoveThreadFromPrivateChannelEnable: string;
215
+ WranglerMoveThreadFromDirectMessageChannelEnable: string;
216
+ WranglerMoveThreadFromGroupMessageChannelEnable: string;
217
+ ServiceEnvironment: string;
218
+ UniqueEmojiReactionLimitPerPost: string;
219
+ UsersStatusAndProfileFetchingPollIntervalMilliseconds: string;
220
+ YoutubeReferrerPolicy: 'true' | 'false';
221
+ ScheduledPosts: string;
222
+ DeleteAccountLink: string;
223
+ ContentFlaggingEnabled: 'true' | 'false';
224
+ EnableAttributeBasedAccessControl: string;
225
+ EnableChannelScopeAccessControl: string;
226
+ EnableUserManagedAttributes: string;
227
+ };
228
+ export type License = {
229
+ id: string;
230
+ issued_at: number;
231
+ starts_at: number;
232
+ expires_at: string;
233
+ customer: LicenseCustomer;
234
+ features: LicenseFeatures;
235
+ sku_name: string;
236
+ short_sku_name: string;
237
+ };
238
+ export type LicenseCustomer = {
239
+ id: string;
240
+ name: string;
241
+ email: string;
242
+ company: string;
243
+ };
244
+ export type LicenseFeatures = {
245
+ users?: number;
246
+ ldap?: boolean;
247
+ ldap_groups?: boolean;
248
+ mfa?: boolean;
249
+ google_oauth?: boolean;
250
+ office365_oauth?: boolean;
251
+ compliance?: boolean;
252
+ cluster?: boolean;
253
+ metrics?: boolean;
254
+ mhpns?: boolean;
255
+ saml?: boolean;
256
+ elastic_search?: boolean;
257
+ announcement?: boolean;
258
+ theme_management?: boolean;
259
+ email_notification_contents?: boolean;
260
+ data_retention?: boolean;
261
+ message_export?: boolean;
262
+ custom_permissions_schemes?: boolean;
263
+ custom_terms_of_service?: boolean;
264
+ guest_accounts?: boolean;
265
+ guest_accounts_permissions?: boolean;
266
+ id_loaded?: boolean;
267
+ lock_teammate_name_display?: boolean;
268
+ cloud?: boolean;
269
+ future_features?: boolean;
270
+ };
271
+ export type ClientLicense = Record<string, string>;
272
+ export type RequestLicenseBody = {
273
+ users: number;
274
+ terms_accepted: boolean;
275
+ receive_emails_accepted: boolean;
276
+ contact_name: string;
277
+ contact_email: string;
278
+ company_name: string;
279
+ company_size: string;
280
+ company_country: string;
281
+ };
282
+ export type DataRetentionPolicy = {
283
+ message_deletion_enabled: boolean;
284
+ file_deletion_enabled: boolean;
285
+ message_retention_cutoff: number;
286
+ file_retention_cutoff: number;
287
+ boards_retention_cutoff: number;
288
+ boards_deletion_enabled: boolean;
289
+ };
290
+ export type ServiceSettings = {
291
+ SiteURL: string;
292
+ WebsocketURL: string;
293
+ LicenseFileLocation: string;
294
+ ListenAddress: string;
295
+ ConnectionSecurity: string;
296
+ TLSCertFile: string;
297
+ TLSKeyFile: string;
298
+ TLSMinVer: string;
299
+ TLSStrictTransport: boolean;
300
+ TLSStrictTransportMaxAge: number;
301
+ TLSOverwriteCiphers: string[];
302
+ UseLetsEncrypt: boolean;
303
+ LetsEncryptCertificateCacheFile: string;
304
+ Forward80To443: boolean;
305
+ TrustedProxyIPHeader: string[];
306
+ ReadTimeout: number;
307
+ WriteTimeout: number;
308
+ IdleTimeout: number;
309
+ MaximumLoginAttempts: number;
310
+ GoroutineHealthThreshold: number;
311
+ GoogleDeveloperKey: string;
312
+ EnableOAuthServiceProvider: boolean;
313
+ EnableIncomingWebhooks: boolean;
314
+ EnableOutgoingWebhooks: boolean;
315
+ EnableOutgoingOAuthConnections: boolean;
316
+ EnableCommands: boolean;
317
+ OutgoingIntegrationRequestsTimeout: number;
318
+ EnablePostUsernameOverride: boolean;
319
+ EnablePostIconOverride: boolean;
320
+ EnableLinkPreviews: boolean;
321
+ EnablePermalinkPreviews: boolean;
322
+ RestrictLinkPreviews: string;
323
+ EnableTesting: boolean;
324
+ EnableDeveloper: boolean;
325
+ DeveloperFlags: string;
326
+ EnableClientPerformanceDebugging: boolean;
327
+ EnableSecurityFixAlert: boolean;
328
+ EnableInsecureOutgoingConnections: boolean;
329
+ AllowedUntrustedInternalConnections: string;
330
+ EnableMultifactorAuthentication: boolean;
331
+ EnforceMultifactorAuthentication: boolean;
332
+ EnableUserAccessTokens: boolean;
333
+ AllowCorsFrom: string;
334
+ CorsExposedHeaders: string;
335
+ CorsAllowCredentials: boolean;
336
+ CorsDebug: boolean;
337
+ AllowCookiesForSubdomains: boolean;
338
+ ExtendSessionLengthWithActivity: boolean;
339
+ TerminateSessionsOnPasswordChange: boolean;
340
+ SessionLengthWebInDays: number;
341
+ SessionLengthWebInHours: number;
342
+ SessionLengthMobileInDays: number;
343
+ SessionLengthMobileInHours: number;
344
+ SessionLengthSSOInDays: number;
345
+ SessionLengthSSOInHours: number;
346
+ SessionCacheInMinutes: number;
347
+ SessionIdleTimeoutInMinutes: number;
348
+ WebsocketSecurePort: number;
349
+ WebsocketPort: number;
350
+ WebserverMode: string;
351
+ EnableCustomEmoji: boolean;
352
+ EnableEmojiPicker: boolean;
353
+ EnableGifPicker: boolean;
354
+ GiphySdkKey: string;
355
+ PostEditTimeLimit: number;
356
+ TimeBetweenUserTypingUpdatesMilliseconds: number;
357
+ EnableCrossTeamSearch: boolean;
358
+ EnablePostSearch: boolean;
359
+ EnableFileSearch: boolean;
360
+ MinimumHashtagLength: number;
361
+ EnableUserTypingMessages: boolean;
362
+ EnableChannelViewedMessages: boolean;
363
+ EnableUserStatuses: boolean;
364
+ ExperimentalEnableAuthenticationTransfer: boolean;
365
+ ClusterLogTimeoutMilliseconds: number;
366
+ EnableTutorial: boolean;
367
+ EnableOnboardingFlow: boolean;
368
+ ExperimentalEnableDefaultChannelLeaveJoinMessages: boolean;
369
+ ExperimentalGroupUnreadChannels: string;
370
+ EnableAPITeamDeletion: boolean;
371
+ EnableAPITriggerAdminNotifications: boolean;
372
+ EnableAPIUserDeletion: boolean;
373
+ ExperimentalEnableHardenedMode: boolean;
374
+ ExperimentalStrictCSRFEnforcement: boolean;
375
+ EnableEmailInvitations: boolean;
376
+ DisableBotsWhenOwnerIsDeactivated: boolean;
377
+ EnableBotAccountCreation: boolean;
378
+ EnableSVGs: boolean;
379
+ EnableLatex: boolean;
380
+ EnableInlineLatex: boolean;
381
+ EnableLocalMode: boolean;
382
+ LocalModeSocketLocation: string;
383
+ CollapsedThreads: CollapsedThreads;
384
+ ThreadAutoFollow: boolean;
385
+ PostPriority: boolean;
386
+ EnableAPIChannelDeletion: boolean;
387
+ EnableAWSMetering: boolean;
388
+ SplitKey: string;
389
+ FeatureFlagSyncIntervalSeconds: number;
390
+ DebugSplit: boolean;
391
+ ManagedResourcePaths: string;
392
+ EnableCustomGroups: boolean;
393
+ AllowSyncedDrafts: boolean;
394
+ AllowPersistentNotifications: boolean;
395
+ AllowPersistentNotificationsForGuests: boolean;
396
+ PersistentNotificationIntervalMinutes: number;
397
+ PersistentNotificationMaxCount: number;
398
+ PersistentNotificationMaxRecipients: number;
399
+ UniqueEmojiReactionLimitPerPost: number;
400
+ RefreshPostStatsRunTime: string;
401
+ MaximumPayloadSizeBytes: number;
402
+ EnableAPIPostDeletion: boolean;
403
+ EnableDesktopLandingPage: boolean;
404
+ MaximumURLLength: number;
405
+ ScheduledPosts: boolean;
406
+ EnableWebHubChannelIteration: boolean;
407
+ FrameAncestors: string;
408
+ DeleteAccountLink: string;
409
+ };
410
+ export type TeamSettings = {
411
+ SiteName: string;
412
+ MaxUsersPerTeam: number;
413
+ EnableCustomUserStatuses: boolean;
414
+ EnableUserCreation: boolean;
415
+ EnableOpenServer: boolean;
416
+ EnableUserDeactivation: boolean;
417
+ RestrictCreationToDomains: string;
418
+ EnableCustomBrand: boolean;
419
+ CustomBrandText: string;
420
+ CustomDescriptionText: string;
421
+ RestrictDirectMessage: string;
422
+ UserStatusAwayTimeout: number;
423
+ MaxChannelsPerTeam: number;
424
+ MaxNotificationsPerChannel: number;
425
+ EnableConfirmNotificationsToChannel: boolean;
426
+ TeammateNameDisplay: string;
427
+ ExperimentalEnableAutomaticReplies: boolean;
428
+ LockTeammateNameDisplay: boolean;
429
+ ExperimentalPrimaryTeam: string;
430
+ ExperimentalDefaultChannels: string[];
431
+ EnableLastActiveTime: boolean;
432
+ EnableJoinLeaveMessageByDefault: boolean;
433
+ };
434
+ export type ClientRequirements = {
435
+ AndroidLatestVersion: string;
436
+ AndroidMinVersion: string;
437
+ IosLatestVersion: string;
438
+ IosMinVersion: string;
439
+ };
440
+ export type SqlSettings = {
441
+ DriverName: string;
442
+ DataSource: string;
443
+ DataSourceReplicas: string[];
444
+ DataSourceSearchReplicas: string[];
445
+ MaxIdleConns: number;
446
+ ConnMaxLifetimeMilliseconds: number;
447
+ ConnMaxIdleTimeMilliseconds: number;
448
+ MaxOpenConns: number;
449
+ Trace: boolean;
450
+ AtRestEncryptKey: string;
451
+ QueryTimeout: number;
452
+ DisableDatabaseSearch: boolean;
453
+ MigrationsStatementTimeoutSeconds: number;
454
+ ReplicaLagSettings: ReplicaLagSetting[];
455
+ ReplicaMonitorIntervalSeconds: number;
456
+ };
457
+ export type LogSettings = {
458
+ EnableConsole: boolean;
459
+ ConsoleLevel: string;
460
+ ConsoleJson: boolean;
461
+ EnableColor: boolean;
462
+ EnableFile: boolean;
463
+ FileLevel: string;
464
+ FileJson: boolean;
465
+ FileLocation: string;
466
+ EnableWebhookDebugging: boolean;
467
+ EnableDiagnostics: boolean;
468
+ EnableSentry: boolean;
469
+ AdvancedLoggingJSON: Record<string, any>;
470
+ MaxFieldSize: number;
471
+ };
472
+ export type ExperimentalAuditSettings = {
473
+ FileEnabled: boolean;
474
+ FileName: string;
475
+ FileMaxSizeMB: number;
476
+ FileMaxAgeDays: number;
477
+ FileMaxBackups: number;
478
+ FileCompress: boolean;
479
+ FileMaxQueueSize: number;
480
+ AdvancedLoggingJSON: Record<string, any>;
481
+ Certificate: string;
482
+ };
483
+ export type PasswordSettings = {
484
+ MinimumLength: number;
485
+ Lowercase: boolean;
486
+ Number: boolean;
487
+ Uppercase: boolean;
488
+ Symbol: boolean;
489
+ EnableForgotLink: boolean;
490
+ };
491
+ export type WranglerSettings = {
492
+ PermittedWranglerRoles: string[];
493
+ AllowedEmailDomain: string[];
494
+ MoveThreadMaxCount: number;
495
+ MoveThreadToAnotherTeamEnable: boolean;
496
+ MoveThreadFromPrivateChannelEnable: boolean;
497
+ MoveThreadFromDirectMessageChannelEnable: boolean;
498
+ MoveThreadFromGroupMessageChannelEnable: boolean;
499
+ };
500
+ export type ConnectedWorkspacesSettings = {
501
+ EnableSharedChannels: boolean;
502
+ EnableRemoteClusterService: boolean;
503
+ DisableSharedChannelsStatusSync: boolean;
504
+ SyncUsersOnConnectionOpen: boolean;
505
+ GlobalUserSyncBatchSize: number;
506
+ MaxPostsPerSync: number;
507
+ MemberSyncBatchSize: number;
508
+ };
509
+ export type FileSettings = {
510
+ EnableFileAttachments: boolean;
511
+ EnableMobileUpload: boolean;
512
+ EnableMobileDownload: boolean;
513
+ MaxFileSize: number;
514
+ MaxImageResolution: number;
515
+ MaxImageDecoderConcurrency: number;
516
+ DriverName: string;
517
+ Directory: string;
518
+ EnablePublicLink: boolean;
519
+ ExtractContent: boolean;
520
+ ArchiveRecursion: boolean;
521
+ PublicLinkSalt: string;
522
+ InitialFont: string;
523
+ AmazonS3AccessKeyId: string;
524
+ AmazonS3SecretAccessKey: string;
525
+ AmazonS3Bucket: string;
526
+ AmazonS3PathPrefix: string;
527
+ AmazonS3Region: string;
528
+ AmazonS3Endpoint: string;
529
+ AmazonS3SSL: boolean;
530
+ AmazonS3SignV2: boolean;
531
+ AmazonS3SSE: boolean;
532
+ AmazonS3Trace: boolean;
533
+ AmazonS3RequestTimeoutMilliseconds: number;
534
+ AmazonS3UploadPartSizeBytes: number;
535
+ AmazonS3StorageClass: string;
536
+ DedicatedExportStore: boolean;
537
+ ExportDriverName: string;
538
+ ExportDirectory: string;
539
+ ExportAmazonS3AccessKeyId: string;
540
+ ExportAmazonS3SecretAccessKey: string;
541
+ ExportAmazonS3Bucket: string;
542
+ ExportAmazonS3PathPrefix: string;
543
+ ExportAmazonS3Region: string;
544
+ ExportAmazonS3Endpoint: string;
545
+ ExportAmazonS3SSL: boolean;
546
+ ExportAmazonS3SignV2: boolean;
547
+ ExportAmazonS3SSE: boolean;
548
+ ExportAmazonS3Trace: boolean;
549
+ ExportAmazonS3RequestTimeoutMilliseconds: number;
550
+ ExportAmazonS3PresignExpiresSeconds: number;
551
+ ExportAmazonS3UploadPartSizeBytes: number;
552
+ ExportAmazonS3StorageClass: string;
553
+ };
554
+ export type EmailSettings = {
555
+ EnableSignUpWithEmail: boolean;
556
+ EnableSignInWithEmail: boolean;
557
+ EnableSignInWithUsername: boolean;
558
+ SendEmailNotifications: boolean;
559
+ UseChannelInEmailNotifications: boolean;
560
+ RequireEmailVerification: boolean;
561
+ FeedbackName: string;
562
+ FeedbackEmail: string;
563
+ ReplyToAddress: string;
564
+ FeedbackOrganization: string;
565
+ EnableSMTPAuth: boolean;
566
+ SMTPUsername: string;
567
+ SMTPPassword: string;
568
+ SMTPServer: string;
569
+ SMTPPort: string;
570
+ SMTPServerTimeout: number;
571
+ ConnectionSecurity: string;
572
+ SendPushNotifications: boolean;
573
+ PushNotificationServer: string;
574
+ PushNotificationServerType: 'off' | 'mhpns' | 'mtpns' | 'custom';
575
+ PushNotificationServerLocation: 'us' | 'de';
576
+ PushNotificationContents: string;
577
+ PushNotificationBuffer: number;
578
+ EnableEmailBatching: boolean;
579
+ EmailBatchingBufferSize: number;
580
+ EmailBatchingInterval: number;
581
+ EnablePreviewModeBanner: boolean;
582
+ SkipServerCertificateVerification: boolean;
583
+ EmailNotificationContentsType: string;
584
+ LoginButtonColor: string;
585
+ LoginButtonBorderColor: string;
586
+ LoginButtonTextColor: string;
587
+ };
588
+ export type RateLimitSettings = {
589
+ Enable: boolean;
590
+ PerSec: number;
591
+ MaxBurst: number;
592
+ MemoryStoreSize: number;
593
+ VaryByRemoteAddr: boolean;
594
+ VaryByUser: boolean;
595
+ VaryByHeader: string;
596
+ };
597
+ export type PrivacySettings = {
598
+ ShowEmailAddress: boolean;
599
+ ShowFullName: boolean;
600
+ };
601
+ export type SupportSettings = {
602
+ TermsOfServiceLink: string;
603
+ PrivacyPolicyLink: string;
604
+ AboutLink: string;
605
+ HelpLink: string;
606
+ ReportAProblemLink: string;
607
+ ReportAProblemType: string;
608
+ ReportAProblemMail: string;
609
+ AllowDownloadLogs: boolean;
610
+ ForgotPasswordLink: string;
611
+ SupportEmail: string;
612
+ CustomTermsOfServiceEnabled: boolean;
613
+ CustomTermsOfServiceReAcceptancePeriod: number;
614
+ EnableAskCommunityLink: boolean;
615
+ };
616
+ export type AnnouncementSettings = {
617
+ EnableBanner: boolean;
618
+ BannerText: string;
619
+ BannerColor: string;
620
+ BannerTextColor: string;
621
+ AllowBannerDismissal: boolean;
622
+ AdminNoticesEnabled: boolean;
623
+ UserNoticesEnabled: boolean;
624
+ NoticesURL: string;
625
+ NoticesFetchFrequency: number;
626
+ NoticesSkipCache: boolean;
627
+ };
628
+ export type ThemeSettings = {
629
+ EnableThemeSelection: boolean;
630
+ DefaultTheme: string;
631
+ AllowCustomThemes: boolean;
632
+ AllowedThemes: string[];
633
+ };
634
+ export type SSOSettings = {
635
+ Enable: boolean;
636
+ Secret: string;
637
+ Id: string;
638
+ Scope: string;
639
+ AuthEndpoint: string;
640
+ TokenEndpoint: string;
641
+ UserAPIEndpoint: string;
642
+ DiscoveryEndpoint: string;
643
+ ButtonText: string;
644
+ ButtonColor: string;
645
+ };
646
+ export type Office365Settings = {
647
+ Enable: boolean;
648
+ Secret: string;
649
+ Id: string;
650
+ Scope: string;
651
+ AuthEndpoint: string;
652
+ TokenEndpoint: string;
653
+ UserAPIEndpoint: string;
654
+ DiscoveryEndpoint: string;
655
+ DirectoryId: string;
656
+ };
657
+ export type LdapSettings = {
658
+ Enable: boolean;
659
+ EnableSync: boolean;
660
+ LdapServer: string;
661
+ LdapPort: number;
662
+ ConnectionSecurity: string;
663
+ BaseDN: string;
664
+ BindUsername: string;
665
+ BindPassword: string;
666
+ UserFilter: string;
667
+ GroupFilter: string;
668
+ GuestFilter: string;
669
+ EnableAdminFilter: boolean;
670
+ AdminFilter: string;
671
+ GroupDisplayNameAttribute: string;
672
+ GroupIdAttribute: string;
673
+ FirstNameAttribute: string;
674
+ LastNameAttribute: string;
675
+ EmailAttribute: string;
676
+ UsernameAttribute: string;
677
+ NicknameAttribute: string;
678
+ IdAttribute: string;
679
+ PositionAttribute: string;
680
+ LoginIdAttribute: string;
681
+ PictureAttribute: string;
682
+ SyncIntervalMinutes: number;
683
+ ReAddRemovedMembers: boolean;
684
+ SkipCertificateVerification: boolean;
685
+ PublicCertificateFile: string;
686
+ PrivateKeyFile: string;
687
+ QueryTimeout: number;
688
+ MaxPageSize: number;
689
+ LoginFieldName: string;
690
+ LoginButtonColor: string;
691
+ LoginButtonBorderColor: string;
692
+ LoginButtonTextColor: string;
693
+ MaximumLoginAttempts: number;
694
+ };
695
+ export type ComplianceSettings = {
696
+ Enable: boolean;
697
+ Directory: string;
698
+ EnableDaily: boolean;
699
+ BatchSize: number;
700
+ };
701
+ export type LocalizationSettings = {
702
+ DefaultServerLocale: string;
703
+ DefaultClientLocale: string;
704
+ AvailableLocales: string;
705
+ EnableExperimentalLocales: boolean;
706
+ };
707
+ export type SamlSettings = {
708
+ Enable: boolean;
709
+ EnableSyncWithLdap: boolean;
710
+ EnableSyncWithLdapIncludeAuth: boolean;
711
+ IgnoreGuestsLdapSync: boolean;
712
+ Verify: boolean;
713
+ Encrypt: boolean;
714
+ SignRequest: boolean;
715
+ IdpURL: string;
716
+ IdpDescriptorURL: string;
717
+ IdpMetadataURL: string;
718
+ ServiceProviderIdentifier: string;
719
+ AssertionConsumerServiceURL: string;
720
+ SignatureAlgorithm: string;
721
+ CanonicalAlgorithm: string;
722
+ ScopingIDPProviderId: string;
723
+ ScopingIDPName: string;
724
+ IdpCertificateFile: string;
725
+ PublicCertificateFile: string;
726
+ PrivateKeyFile: string;
727
+ IdAttribute: string;
728
+ GuestAttribute: string;
729
+ EnableAdminAttribute: boolean;
730
+ AdminAttribute: string;
731
+ FirstNameAttribute: string;
732
+ LastNameAttribute: string;
733
+ EmailAttribute: string;
734
+ UsernameAttribute: string;
735
+ NicknameAttribute: string;
736
+ LocaleAttribute: string;
737
+ PositionAttribute: string;
738
+ LoginButtonText: string;
739
+ LoginButtonColor: string;
740
+ LoginButtonBorderColor: string;
741
+ LoginButtonTextColor: string;
742
+ };
743
+ export type NativeAppSettings = {
744
+ AppCustomURLSchemes: string[];
745
+ AppDownloadLink: string;
746
+ AndroidAppDownloadLink: string;
747
+ IosAppDownloadLink: string;
748
+ MobileExternalBrowser: boolean;
749
+ MobileEnableBiometrics: boolean;
750
+ MobilePreventScreenCapture: boolean;
751
+ MobileJailbreakProtection: boolean;
752
+ MobileEnableSecureFilePreview: boolean;
753
+ MobileAllowPdfLinkNavigation: boolean;
754
+ };
755
+ export type ClusterSettings = {
756
+ Enable: boolean;
757
+ ClusterName: string;
758
+ OverrideHostname: string;
759
+ NetworkInterface: string;
760
+ BindAddress: string;
761
+ AdvertiseAddress: string;
762
+ UseIPAddress: boolean;
763
+ EnableGossipCompression: boolean;
764
+ EnableGossipEncryption: boolean;
765
+ ReadOnlyConfig: boolean;
766
+ GossipPort: number;
767
+ };
768
+ export type MetricsSettings = {
769
+ Enable: boolean;
770
+ BlockProfileRate: number;
771
+ ListenAddress: string;
772
+ EnableClientMetrics: boolean;
773
+ EnableNotificationMetrics: boolean;
774
+ ClientSideUserIds: string[];
775
+ };
776
+ export type ExperimentalSettings = {
777
+ LinkMetadataTimeoutMilliseconds: number;
778
+ RestrictSystemAdmin: boolean;
779
+ EnableSharedChannels: boolean;
780
+ EnableRemoteClusterService: boolean;
781
+ DisableAppBar: boolean;
782
+ DisableRefetchingOnBrowserFocus: boolean;
783
+ DelayChannelAutocomplete: boolean;
784
+ DisableWakeUpReconnectHandler: boolean;
785
+ UsersStatusAndProfileFetchingPollIntervalMilliseconds: number;
786
+ YoutubeReferrerPolicy: boolean;
787
+ ExperimentalChannelCategorySorting: boolean;
788
+ };
789
+ export type AnalyticsSettings = {
790
+ MaxUsersForStatistics: number;
791
+ };
792
+ export type CacheSettings = {
793
+ CacheType: string;
794
+ RedisAddress: string;
795
+ RedisPassword: string;
796
+ RedisDB: number;
797
+ RedisCachePrefix: string;
798
+ DisableClientCache: boolean;
799
+ };
800
+ export type ElasticsearchSettings = {
801
+ ConnectionURL: string;
802
+ Backend: string;
803
+ Username: string;
804
+ Password: string;
805
+ EnableIndexing: boolean;
806
+ EnableSearching: boolean;
807
+ EnableAutocomplete: boolean;
808
+ Sniff: boolean;
809
+ PostIndexReplicas: number;
810
+ PostIndexShards: number;
811
+ ChannelIndexReplicas: number;
812
+ ChannelIndexShards: number;
813
+ UserIndexReplicas: number;
814
+ UserIndexShards: number;
815
+ AggregatePostsAfterDays: number;
816
+ PostsAggregatorJobStartTime: string;
817
+ IndexPrefix: string;
818
+ GlobalSearchPrefix: string;
819
+ LiveIndexingBatchSize: number;
820
+ BatchSize: number;
821
+ RequestTimeoutSeconds: number;
822
+ SkipTLSVerification: boolean;
823
+ CA: string;
824
+ ClientCert: string;
825
+ ClientKey: string;
826
+ Trace: string;
827
+ IgnoredPurgeIndexes: string;
828
+ };
829
+ export type DataRetentionSettings = {
830
+ EnableMessageDeletion: boolean;
831
+ EnableFileDeletion: boolean;
832
+ MessageRetentionDays: number;
833
+ MessageRetentionHours: number;
834
+ FileRetentionDays: number;
835
+ FileRetentionHours: number;
836
+ DeletionJobStartTime: string;
837
+ BatchSize: number;
838
+ EnableBoardsDeletion: boolean;
839
+ BoardsRetentionDays: number;
840
+ TimeBetweenBatchesMilliseconds: number;
841
+ RetentionIdsBatchSize: number;
842
+ PreservePinnedPosts: boolean;
843
+ };
844
+ export type MessageExportSettings = {
845
+ EnableExport: boolean;
846
+ DownloadExportResults: boolean;
847
+ ExportFormat: string;
848
+ DailyRunTime: string;
849
+ ExportFromTimestamp: number;
850
+ BatchSize: number;
851
+ ChannelBatchSize: number;
852
+ ChannelHistoryBatchSize: number;
853
+ GlobalRelaySettings: {
854
+ CustomerType: string;
855
+ SMTPUsername: string;
856
+ SMTPPassword: string;
857
+ EmailAddress: string;
858
+ SMTPServerTimeout: number;
859
+ CustomSMTPServerName: string;
860
+ CustomSMTPPort: string;
861
+ };
862
+ };
863
+ export type JobSettings = {
864
+ RunJobs: boolean;
865
+ RunScheduler: boolean;
866
+ CleanupJobsThresholdDays: number;
867
+ CleanupConfigThresholdDays: number;
868
+ };
869
+ export type PluginSettings = {
870
+ Enable: boolean;
871
+ EnableUploads: boolean;
872
+ AllowInsecureDownloadURL: boolean;
873
+ EnableHealthCheck: boolean;
874
+ Directory: string;
875
+ ClientDirectory: string;
876
+ Plugins: Record<string, any>;
877
+ PluginStates: Record<string, {
878
+ Enable: boolean;
879
+ }>;
880
+ EnableMarketplace: boolean;
881
+ EnableRemoteMarketplace: boolean;
882
+ AutomaticPrepackagedPlugins: boolean;
883
+ RequirePluginSignature: boolean;
884
+ MarketplaceURL: string;
885
+ SignaturePublicKeyFiles: string[];
886
+ ChimeraOAuthProxyURL: string;
887
+ };
888
+ export type DisplaySettings = {
889
+ CustomURLSchemes: string[];
890
+ MaxMarkdownNodes: number;
891
+ };
892
+ export type GuestAccountsSettings = {
893
+ Enable: boolean;
894
+ HideTags: boolean;
895
+ AllowEmailAccounts: boolean;
896
+ EnforceMultifactorAuthentication: boolean;
897
+ RestrictCreationToDomains: string;
898
+ };
899
+ export type ImageProxySettings = {
900
+ Enable: boolean;
901
+ ImageProxyType: string;
902
+ RemoteImageProxyURL: string;
903
+ RemoteImageProxyOptions: string;
904
+ };
905
+ export type CloudSettings = {
906
+ CWSURL: string;
907
+ CWSAPIURL: string;
908
+ CWSMock: boolean;
909
+ Disable: boolean;
910
+ PreviewModalBucketURL: string;
911
+ };
912
+ export type FeatureFlags = Record<string, string | boolean>;
913
+ export type ImportSettings = {
914
+ Directory: string;
915
+ RetentionDays: number;
916
+ };
917
+ export type ExportSettings = {
918
+ Directory: string;
919
+ RetentionDays: number;
920
+ };
921
+ export type AccessControlSettings = {
922
+ EnableAttributeBasedAccessControl: boolean;
923
+ EnableChannelScopeAccessControl: boolean;
924
+ EnableUserManagedAttributes: boolean;
925
+ };
926
+ export type ContentFlaggingNotificationSettings = {
927
+ EventTargetMapping: Record<ContentFlaggingEvent, NotificationTarget[]>;
928
+ };
929
+ export type TeamReviewerSetting = {
930
+ Enabled: boolean;
931
+ ReviewerIds: string[];
932
+ };
933
+ export type ContentFlaggingReviewerSetting = {
934
+ CommonReviewers: boolean;
935
+ CommonReviewerIds: string[];
936
+ TeamReviewersSetting: Record<string, TeamReviewerSetting>;
937
+ SystemAdminsAsReviewers: boolean;
938
+ TeamAdminsAsReviewers: boolean;
939
+ };
940
+ export type ContentFlaggingAdditionalSettings = {
941
+ Reasons: string[];
942
+ ReporterCommentRequired: boolean;
943
+ ReviewerCommentRequired: boolean;
944
+ HideFlaggedContent: boolean;
945
+ };
946
+ export type ContentFlaggingSettings = {
947
+ EnableContentFlagging: boolean;
948
+ NotificationSettings: ContentFlaggingNotificationSettings;
949
+ ReviewerSettings: ContentFlaggingReviewerSetting;
950
+ AdditionalSettings: ContentFlaggingAdditionalSettings;
951
+ };
952
+ export type AdminConfig = {
953
+ ServiceSettings: ServiceSettings;
954
+ TeamSettings: TeamSettings;
955
+ ClientRequirements: ClientRequirements;
956
+ SqlSettings: SqlSettings;
957
+ LogSettings: LogSettings;
958
+ ExperimentalAuditSettings: ExperimentalAuditSettings;
959
+ PasswordSettings: PasswordSettings;
960
+ FileSettings: FileSettings;
961
+ EmailSettings: EmailSettings;
962
+ RateLimitSettings: RateLimitSettings;
963
+ PrivacySettings: PrivacySettings;
964
+ SupportSettings: SupportSettings;
965
+ AnnouncementSettings: AnnouncementSettings;
966
+ ThemeSettings: ThemeSettings;
967
+ GitLabSettings: SSOSettings;
968
+ GoogleSettings: SSOSettings;
969
+ Office365Settings: Office365Settings;
970
+ OpenIdSettings: SSOSettings;
971
+ LdapSettings: LdapSettings;
972
+ ComplianceSettings: ComplianceSettings;
973
+ LocalizationSettings: LocalizationSettings;
974
+ SamlSettings: SamlSettings;
975
+ NativeAppSettings: NativeAppSettings;
976
+ ClusterSettings: ClusterSettings;
977
+ MetricsSettings: MetricsSettings;
978
+ ExperimentalSettings: ExperimentalSettings;
979
+ AnalyticsSettings: AnalyticsSettings;
980
+ CacheSettings: CacheSettings;
981
+ ElasticsearchSettings: ElasticsearchSettings;
982
+ DataRetentionSettings: DataRetentionSettings;
983
+ MessageExportSettings: MessageExportSettings;
984
+ JobSettings: JobSettings;
985
+ PluginSettings: PluginSettings;
986
+ DisplaySettings: DisplaySettings;
987
+ GuestAccountsSettings: GuestAccountsSettings;
988
+ ImageProxySettings: ImageProxySettings;
989
+ CloudSettings: CloudSettings;
990
+ FeatureFlags: FeatureFlags;
991
+ ImportSettings: ImportSettings;
992
+ ExportSettings: ExportSettings;
993
+ WranglerSettings: WranglerSettings;
994
+ ConnectedWorkspacesSettings: ConnectedWorkspacesSettings;
995
+ AccessControlSettings: AccessControlSettings;
996
+ ContentFlaggingSettings: ContentFlaggingSettings;
997
+ };
998
+ export type ReplicaLagSetting = {
999
+ DataSource: string;
1000
+ QueryAbsoluteLag: string;
1001
+ QueryTimeLag: string;
1002
+ };
1003
+ export type EnvironmentConfigSettings<T> = {
1004
+ [P in keyof T]: boolean;
1005
+ };
1006
+ export type EnvironmentConfig = {
1007
+ [P in keyof AdminConfig]: EnvironmentConfigSettings<AdminConfig[P]>;
1008
+ };
1009
+ export type WarnMetricStatus = {
1010
+ id: string;
1011
+ limit: number;
1012
+ acked: boolean;
1013
+ store_status: string;
1014
+ };
1015
+ export declare enum CollapsedThreads {
1016
+ DISABLED = "disabled",
1017
+ DEFAULT_ON = "default_on",
1018
+ DEFAULT_OFF = "default_off",
1019
+ ALWAYS_ON = "always_on"
1020
+ }
1021
+ export declare enum ServiceEnvironment {
1022
+ PRODUCTION = "production",
1023
+ TEST = "test",
1024
+ DEV = "dev"
1025
+ }
1026
+ export type AllowedIPRange = {
1027
+ cidr_block: string;
1028
+ description: string;
1029
+ enabled: boolean;
1030
+ owner_id: string;
1031
+ };
1032
+ export type AllowedIPRanges = AllowedIPRange[];
1033
+ export type FetchIPResponse = {
1034
+ ip: string;
1035
+ };