Documentation

type FeatureAPIGetPut cfg = FeatureAPIGet cfg :<|> FeatureAPIPut cfg Source #

type FeatureAPI = FeatureAPIGet SSOConfig :<|> (FeatureAPIGetPut LegalholdConfig :<|> (FeatureAPIGetPut SearchVisibilityAvailableConfig :<|> (SearchVisibilityGet :<|> (SearchVisibilitySet :<|> (FeatureAPIGet ValidateSAMLEmailsConfig :<|> (FeatureAPIGet DigitalSignaturesConfig :<|> (FeatureAPIGetPut AppLockConfig :<|> (FeatureAPIGetPut FileSharingConfig :<|> (FeatureAPIGet ClassifiedDomainsConfig :<|> (FeatureAPIGetPut ConferenceCallingConfig :<|> (FeatureAPIGetPut SelfDeletingMessagesConfig :<|> (FeatureAPIGetPut GuestLinksConfig :<|> (FeatureAPIGetPut SndFactorPasswordChallengeConfig :<|> ((From 'V5 ::> FeatureAPIGetPut MLSConfig) :<|> (FeatureAPIGetPut ExposeInvitationURLsToTeamAdminConfig :<|> (FeatureAPIGetPut SearchVisibilityInboundConfig :<|> (FeatureAPIGetPut OutlookCalIntegrationConfig :<|> ((From 'V5 ::> FeatureAPIGet MlsE2EIdConfig) :<|> ((From 'V5 ::> (Until 'V6 ::> Named "put-MlsE2EIdConfig@v5" (ZUser :> FeatureStatusBasePutPublic MlsE2EIdConfig))) :<|> ((From 'V6 ::> FeatureAPIPut MlsE2EIdConfig) :<|> ((From 'V5 ::> FeatureAPIGetPut MlsMigrationConfig) :<|> ((From 'V5 ::> FeatureAPIGetPut EnforceFileDownloadLocationConfig) :<|> ((From 'V5 ::> FeatureAPIGet LimitedEventFanoutConfig) :<|> (AllTeamFeaturesUserGet :<|> (AllTeamFeaturesTeamGet :<|> (DeprecatedFeatureAPI :<|> AllDeprecatedFeatureConfigAPI DeprecatedFeatureConfigs)))))))))))))))))))))))))) Source #

type DeprecationNotice1 = "This endpoint is potentially used by the old Android client. It is not used by iOS, team management, or webapp as of June 2022" Source #

type DeprecationNotice2 = "The usage of this endpoint was removed in iOS in version 3.101. It is not used by team management, or webapp, and is potentially used by the old Android client as of June 2022" Source #

type DeprecatedFeatureConfigs = [LegalholdConfig, SSOConfig, SearchVisibilityAvailableConfig, ValidateSAMLEmailsConfig, DigitalSignaturesConfig, AppLockConfig, FileSharingConfig, ClassifiedDomainsConfig, ConferenceCallingConfig, SelfDeletingMessagesConfig, GuestLinksConfig, SndFactorPasswordChallengeConfig, MLSConfig] Source #

type family AllDeprecatedFeatureConfigAPI cfgs where ... Source #

type DeprecatedFeatureAPI = FeatureStatusDeprecatedGet DeprecationNotice1 SearchVisibilityAvailableConfig :<|> (FeatureStatusDeprecatedPut DeprecationNotice1 SearchVisibilityAvailableConfig :<|> (FeatureStatusDeprecatedGet DeprecationNotice1 ValidateSAMLEmailsConfig :<|> FeatureStatusDeprecatedGet DeprecationNotice2 DigitalSignaturesConfig)) Source #

type FeatureAPIGet cfg = Named '("get", cfg) (Description (FeatureAPIDesc cfg) :> (ZUser :> FeatureStatusBaseGet cfg)) Source #

type FeatureAPIPut cfg = Named '("put", cfg) (Description (FeatureAPIDesc cfg) :> (ZUser :> FeatureStatusBasePutPublic cfg)) Source #

type FeatureStatusDeprecatedGet d f = Named '("get-deprecated", f) (ZUser :> FeatureStatusBaseDeprecatedGet d f) Source #

type FeatureStatusDeprecatedPut d f = Named '("put-deprecated", f) (ZUser :> FeatureStatusBaseDeprecatedPut d f) Source #

type FeatureStatusBaseGet featureConfig = Summary (AppendSymbol "Get config for " (FeatureSymbol featureConfig)) :> (CanThrow OperationDenied :> (CanThrow 'NotATeamMember :> (CanThrow 'TeamNotFound :> ("teams" :> (Capture "tid" TeamId :> ("features" :> (FeatureSymbol featureConfig :> Get '[JSON] (LockableFeature featureConfig)))))))) Source #

type FeatureStatusBasePutPublic featureConfig = Summary (AppendSymbol "Put config for " (FeatureSymbol featureConfig)) :> (CanThrow OperationDenied :> (CanThrow 'NotATeamMember :> (CanThrow 'TeamNotFound :> (CanThrow TeamFeatureError :> (CanThrowMany (FeatureErrors featureConfig) :> ("teams" :> (Capture "tid" TeamId :> ("features" :> (FeatureSymbol featureConfig :> (ReqBody '[JSON] (Feature featureConfig) :> Put '[JSON] (LockableFeature featureConfig))))))))))) Source #

type FeatureStatusBaseDeprecatedGet desc featureConfig = Summary (AppendSymbol "[deprecated] Get config for " (FeatureSymbol featureConfig)) :> (Until 'V2 :> (Description ((("Deprecated. Please use `GET /teams/:tid/features/" `AppendSymbol` FeatureSymbol featureConfig) `AppendSymbol` "` instead.\n") `AppendSymbol` desc) :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (CanThrow 'TeamNotFound :> ("teams" :> (Capture "tid" TeamId :> ("features" :> (DeprecatedFeatureName featureConfig :> Get '[JSON] (LockableFeature featureConfig)))))))))) Source #

type FeatureStatusBaseDeprecatedPut desc featureConfig = Summary (AppendSymbol "[deprecated] Get config for " (FeatureSymbol featureConfig)) :> (Until 'V2 :> (Description ((("Deprecated. Please use `PUT /teams/:tid/features/" `AppendSymbol` FeatureSymbol featureConfig) `AppendSymbol` "` instead.\n") `AppendSymbol` desc) :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (CanThrow 'TeamNotFound :> (CanThrow TeamFeatureError :> ("teams" :> (Capture "tid" TeamId :> ("features" :> (DeprecatedFeatureName featureConfig :> (ReqBody '[JSON] (Feature featureConfig) :> Put '[JSON] (LockableFeature featureConfig)))))))))))) Source #

type FeatureConfigDeprecatedGet desc featureConfig = Named '("get-config", featureConfig) (Summary (AppendSymbol "[deprecated] Get feature config for feature " (FeatureSymbol featureConfig)) :> (Until 'V2 :> (Description ("Deprecated. Please use `GET /feature-configs` instead.\n" `AppendSymbol` desc) :> (ZUser :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (CanThrow 'TeamNotFound :> ("feature-configs" :> (FeatureSymbol featureConfig :> Get '[JSON] (LockableFeature featureConfig)))))))))) Source #

type AllTeamFeaturesUserGet = Named "get-all-feature-configs-for-user" (Summary "Gets feature configs for a user" :> (Description "Gets feature configs for a user. If the user is a member of a team and has the required permissions, this will return the team's feature configs.If the user is not a member of a team, this will return the personal feature configs (the server defaults)." :> (DescriptionOAuthScope 'ReadFeatureConfigs :> (ZUser :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (CanThrow 'TeamNotFound :> ("feature-configs" :> Get '[JSON] AllTeamFeatures)))))))) Source #

type AllTeamFeaturesTeamGet = Named "get-all-feature-configs-for-team" (Summary "Gets feature configs for a team" :> (Description "Gets feature configs for a team. User must be a member of the team and have permission to view team features." :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (CanThrow 'TeamNotFound :> (ZLocalUser :> ("teams" :> (Capture "tid" TeamId :> ("features" :> Get '[JSON] AllTeamFeatures))))))))) Source #

type SearchVisibilityGet = Named "get-search-visibility" (Summary "Shows the value for search visibility" :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (ZLocalUser :> ("teams" :> (Capture "tid" TeamId :> ("search-visibility" :> Get '[JSON] TeamSearchVisibilityView))))))) Source #

type SearchVisibilitySet = Named "set-search-visibility" (Summary "Sets the search visibility for the whole team" :> (CanThrow 'NotATeamMember :> (CanThrow OperationDenied :> (CanThrow 'TeamSearchVisibilityNotEnabled :> (CanThrow 'TeamNotFound :> (CanThrow TeamFeatureError :> (ZLocalUser :> ("teams" :> (Capture "tid" TeamId :> ("search-visibility" :> (ReqBody '[JSON] TeamSearchVisibilityView :> MultiVerb 'PUT '[JSON] '[RespondEmpty 204 "Search visibility set"] ()))))))))))) Source #