Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Error

Contents

Static and dynamic error types
Static errors and Servant
Static errors and Polysemy

Synopsis

data DynError = DynError {
- eCode :: Natural
- eLabel :: Text
- eMessage :: Text
}
dynError :: forall e. KnownError e => DynError
dynErrorToWai :: DynError -> Error
data StaticError = StaticError {
- seCode :: Nat
- seLabel :: Symbol
- seMessage :: Symbol
}
class KnownError (e :: StaticError)
type family MapError (e :: k) :: StaticError
errorToResponse :: forall e. KnownError (MapError e) => JSONResponse
errorToWai :: forall e. KnownError (MapError e) => Error
class APIError e where
- toResponse :: e -> JSONResponse
data CanThrow e
data CanThrowMany (es :: [k])
type family DeclaredErrorEffects api :: EffectRow where ...
addErrorResponseToSwagger :: Int -> Response -> OpenApi -> OpenApi
addStaticErrorToSwagger :: forall e. (Typeable e, KnownError e) => OpenApi -> OpenApi
class IsSwaggerError e where
- addToOpenApi :: OpenApi -> OpenApi
data ErrorResponse e
type family ErrorEffect (e :: k) :: Effect
type ErrorS e = Error (Tagged e ())
throwS :: forall e r a. Member (ErrorS e) r => Sem r a
noteS :: forall e r a. Member (ErrorS e) r => Maybe a -> Sem r a
mapErrorS :: forall e e' r a. Member (ErrorS e') r => Sem (ErrorS e ': r) a -> Sem r a
runErrorS :: forall e r a. Sem (ErrorS e : r) a -> Sem r (Maybe a)
mapToRuntimeError :: forall e e' r a. Member (Error e') r => e' -> Sem (ErrorS e ': r) a -> Sem r a
mapToDynamicError :: forall e r a. (Member (Error DynError) r, KnownError (MapError e)) => Sem (ErrorS e ': r) a -> Sem r a

Static and dynamic error types

data DynError Source #

Runtime representation of a statically-known error.

Constructors

DynError
Fields eCode :: Natural eLabel :: Text eMessage :: Text

Instances

Instances details

FromJSON DynError Source #
Instance details Defined in Wire.API.Error Methods parseJSON :: Value -> Parser DynError Source # parseJSONList :: Value -> Parser [DynError] Source #
ToJSON DynError Source #
Instance details Defined in Wire.API.Error Methods toJSON :: DynError -> Value Source # toEncoding :: DynError -> Encoding Source # toJSONList :: [DynError] -> Value Source # toEncodingList :: [DynError] -> Encoding Source #
APIError DynError Source #
Instance details Defined in Wire.API.Error Methods toResponse :: DynError -> JSONResponse Source #

dynError :: forall e. KnownError e => DynError Source #

dynErrorToWai :: DynError -> Error Source #

data StaticError Source #

A statically-known error. This is meant to be used as a kind.

Constructors

StaticError
Fields seCode :: Nat seLabel :: Symbol seMessage :: Symbol

class KnownError (e :: StaticError) Source #

Minimal complete definition

seSing

Instances

Instances details

(KnownNat c, KnownSymbol l, KnownSymbol msg) => KnownError ('StaticError c l msg) Source #
Instance details Defined in Wire.API.Error Methods seSing :: SStaticError ('StaticError c l msg)

type family MapError (e :: k) :: StaticError Source #

Instances

Instances details

type MapError 'AccessDenied Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'AccessDenied = 'StaticError 403 "access-denied" "Access denied."
type MapError 'AccountEphemeral Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'AccountEphemeral = 'StaticError 403 "ephemeral" "Account ephemeral"
type MapError 'AccountPending Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'AccountPending = 'StaticError 403 "pending-activation" "Account pending activation"
type MapError 'AccountSuspended Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'AccountSuspended = 'StaticError 403 "suspended" "Account suspended"
type MapError 'AllowlistError Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'AllowlistError = 'StaticError 403 "unauthorized" "Unauthorized e-mail address"
type MapError 'BadCredentials Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'BadCredentials = 'StaticError 403 "invalid-credentials" "Authentication failed"
type MapError 'BlacklistedEmail Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'BlacklistedEmail = 'StaticError 403 "blacklisted-email" "The given e-mail address has been blacklisted due to a permanent bounce or a complaint."
type MapError 'CannotJoinMultipleTeams Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'CannotJoinMultipleTeams = 'StaticError 403 "cannot-join-multiple-teams" "Cannot accept invitations from multiple teams"
type MapError 'ChangePasswordMustDiffer Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ChangePasswordMustDiffer = 'StaticError 409 "password-must-differ" "For password change, new and old password must be different."
type MapError 'ClientNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ClientNotFound = 'StaticError 404 "client-not-found" "Client not found"
type MapError 'CodeAuthenticationFailed Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'CodeAuthenticationFailed = 'StaticError 403 "code-authentication-failed" "Code authentication failed"
type MapError 'CodeAuthenticationRequired Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'CodeAuthenticationRequired = 'StaticError 403 "code-authentication-required" "Code authentication is required"
type MapError 'ConflictingInvitations Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ConflictingInvitations = 'StaticError 409 "conflicting-invitations" "Multiple conflicting invitations to different teams exists."
type MapError 'ConnectionLimitReached Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ConnectionLimitReached = 'StaticError 403 "connection-limit" "Too many sent/accepted connections"
type MapError 'CustomerExtensionBlockedDomain Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'CustomerExtensionBlockedDomain = 'StaticError 451 "domain-blocked-for-registration" "[Customer extension] the email domain example.com that you are attempting to register a user with has been blocked for creating wire users. Please contact your IT department."
type MapError 'DeleteCodePending Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'DeleteCodePending = 'StaticError 403 "pending-delete" "A verification code for account deletion is still pending"
type MapError 'HandleExists Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'HandleExists = 'StaticError 409 "handle-exists" "The given handle is already taken"
type MapError 'HandleManagedByScim Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'HandleManagedByScim = 'StaticError 403 "managed-by-scim" "Updating handle is not allowed, because it is managed by SCIM, or E2EId is enabled"
type MapError 'HandleNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'HandleNotFound = 'StaticError 404 "not-found" "Handle not found"
type MapError 'InsufficientTeamPermissions Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InsufficientTeamPermissions = 'StaticError 403 "insufficient-permissions" "Insufficient team permissions"
type MapError 'InvalidActivationCodeWrongCode Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidActivationCodeWrongCode = 'StaticError 404 "invalid-code" "Invalid activation code"
type MapError 'InvalidActivationCodeWrongUser Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidActivationCodeWrongUser = 'StaticError 404 "invalid-code" "User does not exist"
type MapError 'InvalidBot Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidBot = 'StaticError 403 "invalid-bot" "The targeted user is not a bot."
type MapError 'InvalidCode Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidCode = 'StaticError 403 "invalid-code" "Invalid verification code"
type MapError 'InvalidConversation Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidConversation = 'StaticError 403 "invalid-conversation" "The operation is not allowed in this conversation."
type MapError 'InvalidEmail Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidEmail = 'StaticError 400 "invalid-email" "Invalid e-mail address."
type MapError 'InvalidHandle Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidHandle = 'StaticError 400 "invalid-handle" "The given handle is invalid (less than 2 or more than 256 characters; chars not in \"a-z0-9_.-\"; or on the blocklist)"
type MapError 'InvalidInvitationCode Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidInvitationCode = 'StaticError 400 "invalid-invitation-code" "Invalid invitation code."
type MapError 'InvalidKeyPackageRef Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidKeyPackageRef = 'StaticError 409 "invalid-reference" "Key package's reference does not match its data"
type MapError 'InvalidPasswordResetCode Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidPasswordResetCode = 'StaticError 400 "invalid-code" "Invalid password reset code."
type MapError 'InvalidPasswordResetKey Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidPasswordResetKey = 'StaticError 400 "invalid-key" "Invalid email or mobile number for password reset."
type MapError 'InvalidPhone Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidPhone = 'StaticError 400 "invalid-phone" "Invalid mobile phone number"
type MapError 'InvalidProvider Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidProvider = 'StaticError 403 "invalid-provider" "The provider does not exist."
type MapError 'InvalidServiceKey Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidServiceKey = 'StaticError 400 "invalid-service-key" "Invalid service key."
type MapError 'InvalidTransition Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidTransition = 'StaticError 403 "bad-conn-update" "Invalid status transition"
type MapError 'InvalidUser Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'InvalidUser = 'StaticError 400 "invalid-user" "Invalid user"
type MapError 'KeyPackageDecodingError Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'KeyPackageDecodingError = 'StaticError 409 "decoding-error" "Key package could not be TLS-decoded"
type MapError 'LastIdentity Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'LastIdentity = 'StaticError 403 "last-identity" "The last user identity cannot be removed."
type MapError 'LocaleManagedByScim Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'LocaleManagedByScim = 'StaticError 403 "managed-by-scim" "Updating locale is not allowed, because it is managed by SCIM, or E2EId is enabled"
type MapError 'MLSDuplicatePublicKey Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MLSDuplicatePublicKey = 'StaticError 400 "mls-duplicate-public-key" "MLS public key for the given signature scheme already exists"
type MapError 'MLSIdentityMismatch Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MLSIdentityMismatch = 'StaticError 403 "mls-identity-mismatch" "Key package credential does not match qualified client ID"
type MapError 'MLSNotEnabled Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MLSNotEnabled = 'StaticError 400 "mls-not-enabled" "MLS is not configured on this backend. See docs.wire.com for instructions on how to enable it"
type MapError 'MLSProtocolError Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MLSProtocolError = 'StaticError 400 "mls-protocol-error" "MLS protocol error"
type MapError 'MalformedPrekeys Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MalformedPrekeys = 'StaticError 400 "bad-request" "Malformed prekeys uploaded"
type MapError 'MissingAuth Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MissingAuth = 'StaticError 403 "missing-auth" "Re-authentication via password required"
type MapError 'MissingIdentity Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MissingIdentity = 'StaticError 403 "missing-identity" "Using an invitation code requires registering the given email."
type MapError 'MissingLegalholdConsent Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MissingLegalholdConsent = 'StaticError 403 "missing-legalhold-consent" "Failed to connect to a user or to invite a user to a group because somebody is under legalhold and somebody else has not granted consent"
type MapError 'MissingLegalholdConsentOldClients Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'MissingLegalholdConsentOldClients = 'StaticError 403 "missing-legalhold-consent-old-clients" "Failed to connect to a user or to invite a user to a group because somebody is under legalhold and somebody else has old clients that do not support legalhold's UI requirements"
type MapError 'NameManagedByScim Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'NameManagedByScim = 'StaticError 403 "managed-by-scim" "Updating name is not allowed, because it is managed by SCIM, or E2EId is enabled"
type MapError 'NoEmail Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'NoEmail = 'StaticError 403 "no-email" "This operation requires the user to have a verified email address."
type MapError 'NoIdentity Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'NoIdentity = 'StaticError 403 "no-identity" "The user has no verified email"
type MapError 'NoPassword Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'NoPassword = 'StaticError 403 "no-password" "The user has no password."
type MapError 'NotConnected Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'NotConnected = 'StaticError 403 "not-connected" "Users are not connected"
type MapError 'NotificationNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'NotificationNotFound = 'StaticError 404 "not-found" "Notification not found."
type MapError 'OwnerDeletingSelf Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'OwnerDeletingSelf = 'StaticError 403 "no-self-delete-for-team-owner" "Team owners are not allowed to delete themselves; ask a fellow owner"
type MapError 'PasswordAuthenticationFailed Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PasswordAuthenticationFailed = 'StaticError 403 "password-authentication-failed" "Password authentication failed."
type MapError 'PasswordExists Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PasswordExists = 'StaticError 403 "password-exists" "The operation is not permitted because the user has a password set"
type MapError 'PasswordIsStale Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PasswordIsStale = 'StaticError 403 "password-is-stale" "The password is too old, please update your password."
type MapError 'PasswordResetInProgress Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PasswordResetInProgress = 'StaticError 409 "code-exists" "A password reset is already in progress."
type MapError 'PendingInvitationNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PendingInvitationNotFound = 'StaticError 404 "not-found" "No pending invitations exists."
type MapError 'PropertyKeyTooLarge Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PropertyKeyTooLarge = 'StaticError 403 "property-key-too-large" "The property key is too large."
type MapError 'PropertyValueTooLarge Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'PropertyValueTooLarge = 'StaticError 403 "property-value-too-large" "The property value is too large"
type MapError 'ProviderNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ProviderNotFound = 'StaticError 404 "not-found" "Provider not found."
type MapError 'ResetPasswordMustDiffer Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ResetPasswordMustDiffer = 'StaticError 409 "password-must-differ" "For password reset, new and old password must be different."
type MapError 'ServiceDisabled Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ServiceDisabled = 'StaticError 403 "service-disabled" "The desired service is currently disabled."
type MapError 'ServiceNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'ServiceNotFound = 'StaticError 404 "not-found" "Service not found."
type MapError 'TeamsNotFederating Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'TeamsNotFederating = 'StaticError 403 "team-not-federating" "The target user is owned by a federated backend, but is not in an allow-listed team"
type MapError 'TooManyClients Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'TooManyClients = 'StaticError 403 "too-many-clients" "Too many clients"
type MapError 'TooManyConversationMembers Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'TooManyConversationMembers = 'StaticError 403 "too-many-members" "Maximum number of members per conversation reached."
type MapError 'TooManyProperties Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'TooManyProperties = 'StaticError 403 "too-many-properties" "Too many properties"
type MapError 'TooManyTeamInvitations Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'TooManyTeamInvitations = 'StaticError 403 "too-many-team-invitations" "Too many team invitations for this team"
type MapError 'TooManyTeamMembers Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'TooManyTeamMembers = 'StaticError 403 "too-many-team-members" "Too many members in this team."
type MapError 'UnknownClient Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'UnknownClient = 'StaticError 403 "unknown-client" "Unknown Client"
type MapError 'UserAlreadyInATeam Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'UserAlreadyInATeam = 'StaticError 403 "user-already-in-a-team" "Switching teams is not allowed"
type MapError 'UserCreationRestricted Source #	docsreferenceuser/registration.md {#RefRestrictRegistration}.
Instance details Defined in Wire.API.Error.Brig type MapError 'UserCreationRestricted = 'StaticError 403 "user-creation-restricted" "This instance does not allow creation of personal users or teams."
type MapError 'UserKeyExists Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'UserKeyExists = 'StaticError 409 "key-exists" "The given e-mail address is in use."
type MapError 'UserNotFound Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'UserNotFound = 'StaticError 404 "not-found" "User not found"
type MapError 'VerificationCodeThrottled Source #
Instance details Defined in Wire.API.Error.Brig type MapError 'VerificationCodeThrottled = 'StaticError 429 "too-many-requests" "Too many request to generate a verification code."
type MapError 'ClientGone Source #
Instance details Defined in Wire.API.Error.Cannon type MapError 'ClientGone = 'StaticError 410 "general" "client gone"
type MapError 'PresenceNotRegistered Source #
Instance details Defined in Wire.API.Error.Cannon type MapError 'PresenceNotRegistered = 'StaticError 404 "not-found" "presence not registered"
type MapError 'AssetNotFound Source #
Instance details Defined in Wire.API.Error.Cargohold type MapError 'AssetNotFound = 'StaticError 404 "not-found" "Asset not found"
type MapError 'AssetTooLarge Source #
Instance details Defined in Wire.API.Error.Cargohold type MapError 'AssetTooLarge = 'StaticError 413 "client-error" "Asset too large"
type MapError 'InvalidLength Source #
Instance details Defined in Wire.API.Error.Cargohold type MapError 'InvalidLength = 'StaticError 400 "invalid-length" "Invalid content length"
type MapError 'NoMatchingAssetEndpoint Source #	Return `AssetNotFound` to hide there's a multi-ingress setup.
Instance details Defined in Wire.API.Error.Cargohold type MapError 'NoMatchingAssetEndpoint = MapError 'AssetNotFound
type MapError 'Unauthorised Source #
Instance details Defined in Wire.API.Error.Cargohold type MapError 'Unauthorised = 'StaticError 403 "unauthorised" "Unauthorised operation"
type MapError 'UnverifiedUser Source #
Instance details Defined in Wire.API.Error.Cargohold type MapError 'UnverifiedUser = 'StaticError 403 "unverified-user" "Unverified user"
type MapError 'UserNotFound Source #
Instance details Defined in Wire.API.Error.Cargohold type MapError 'UserNotFound = 'StaticError 403 "not-found" "User not found"
type MapError 'ReAuthFailed Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'ReAuthFailed = 'StaticError 403 "access-denied" "This operation requires reauthentication"
type MapError 'VerificationCodeAuthFailed Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'VerificationCodeAuthFailed = 'StaticError 403 "code-authentication-failed" "Code authentication failed"
type MapError 'VerificationCodeRequired Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'VerificationCodeRequired = 'StaticError 403 "code-authentication-required" "Verification code required"
type MapError 'AccessDenied Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'AccessDenied = 'StaticError 403 "access-denied" "You do not have permission to access this resource"
type MapError 'BroadcastLimitExceeded Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'BroadcastLimitExceeded = 'StaticError 400 "too-many-users-to-broadcast" "Too many users to fan out the broadcast event to"
type MapError 'BulkGetMemberLimitExceeded Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'BulkGetMemberLimitExceeded = 'StaticError 400 "too-many-uids" (AppendSymbol (AppendSymbol "Can only process " (Show_ HardTruncationLimit)) " user ids per request.")
type MapError 'CannotEnableLegalHoldServiceLargeTeam Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'CannotEnableLegalHoldServiceLargeTeam = 'StaticError 403 "too-large-team-for-legalhold" "Cannot enable legalhold on large teams (reason: for removing LH from team, we need to iterate over all members, which is only supported for teams with less than 2k members)"
type MapError 'CodeNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'CodeNotFound = 'StaticError 404 "no-conversation-code" "Conversation code not found"
type MapError 'ConvAccessDenied Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'ConvAccessDenied = 'StaticError 403 "access-denied" "Conversation access denied"
type MapError 'ConvInvalidProtocolTransition Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'ConvInvalidProtocolTransition = 'StaticError 403 "invalid-protocol-transition" "Protocol transition is invalid"
type MapError 'ConvMemberNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'ConvMemberNotFound = 'StaticError 404 "no-conversation-member" "Conversation member not found"
type MapError 'ConvNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'ConvNotFound = 'StaticError 404 "no-conversation" "Conversation not found"
type MapError 'CreateConversationCodeConflict Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'CreateConversationCodeConflict = 'StaticError 409 "create-conv-code-conflict" "Conversation code already exists with a different password setting than the requested one."
type MapError 'CustomBackendNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'CustomBackendNotFound = 'StaticError 404 "custom-backend-not-found" "Custom backend not found"
type MapError 'DeleteQueueFull Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'DeleteQueueFull = 'StaticError 503 "queue-full" "The delete queue is full; no further delete requests can be processed at the moment"
type MapError 'GuestLinksDisabled Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'GuestLinksDisabled = 'StaticError 409 "guest-links-disabled" "The guest link feature is disabled and all guest links have been revoked"
type MapError 'InvalidAction Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidAction = 'StaticError 400 "invalid-actions" "The specified actions are invalid"
type MapError 'InvalidConversationPassword Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidConversationPassword = 'StaticError 403 "invalid-conversation-password" "Invalid conversation password"
type MapError 'InvalidOperation Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidOperation = 'StaticError 403 "invalid-op" "Invalid operation"
type MapError 'InvalidPermissions Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidPermissions = 'StaticError 403 "invalid-permissions" "The specified permissions are invalid"
type MapError 'InvalidTarget Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidTarget = 'StaticError 403 "invalid-op" "Invalid target"
type MapError 'InvalidTargetAccess Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidTargetAccess = 'StaticError 403 "invalid-op" "Invalid target access"
type MapError 'InvalidTeamNotificationId Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidTeamNotificationId = 'StaticError 400 "invalid-notification-id" "Could not parse notification id (must be UUIDv1)."
type MapError 'InvalidTeamStatusUpdate Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'InvalidTeamStatusUpdate = 'StaticError 403 "invalid-team-status-update" "Cannot use this endpoint to update the team to the given status."
type MapError 'LegalHoldCouldNotBlockConnections Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldCouldNotBlockConnections = 'StaticError 500 "legalhold-internal" "legal hold service: could not block connections when resolving policy conflicts."
type MapError 'LegalHoldDisableUnimplemented Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldDisableUnimplemented = 'StaticError 403 "legalhold-disable-unimplemented" "legal hold cannot be disabled for whitelisted teams"
type MapError 'LegalHoldNotEnabled Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldNotEnabled = 'StaticError 403 "legalhold-not-enabled" "legal hold is not enabled for this team"
type MapError 'LegalHoldServiceBadResponse Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldServiceBadResponse = 'StaticError 400 "legalhold-status-bad" "legal hold service: invalid response"
type MapError 'LegalHoldServiceInvalidKey Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldServiceInvalidKey = 'StaticError 400 "legalhold-invalid-key" "legal hold service pubkey is invalid"
type MapError 'LegalHoldServiceNotRegistered Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldServiceNotRegistered = 'StaticError 400 "legalhold-not-registered" "legal hold service has not been registered for this team"
type MapError 'MLSClientMismatch Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSClientMismatch = 'StaticError 409 "mls-client-mismatch" "A proposal of type Add or Remove does not apply to the full list of clients for a user"
type MapError 'MLSClientSenderUserMismatch Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSClientSenderUserMismatch = 'StaticError 400 "mls-client-sender-user-mismatch" "User ID resolved from Client ID does not match message's sender user ID"
type MapError 'MLSCommitMissingReferences Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSCommitMissingReferences = 'StaticError 400 "mls-commit-missing-references" "The commit is not referencing all pending proposals"
type MapError 'MLSDuplicatePublicKey Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSDuplicatePublicKey = 'StaticError 400 "mls-duplicate-public-key" "MLS public key for the given signature scheme already exists"
type MapError 'MLSFederatedOne2OneNotSupported Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSFederatedOne2OneNotSupported = 'StaticError 400 "mls-federated-one2one-not-supported" "Federated One2One MLS conversations are only supported in API version >= 6"
type MapError 'MLSGroupConversationMismatch Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSGroupConversationMismatch = 'StaticError 400 "mls-group-conversation-mismatch" "Conversation ID resolved from Group ID does not match submitted Conversation ID"
type MapError 'MLSInvalidLeafNodeIndex Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSInvalidLeafNodeIndex = 'StaticError 400 "mls-invalid-leaf-node-index" "A referenced leaf node index points to a blank or non-existing node"
type MapError 'MLSLegalholdIncompatible Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSLegalholdIncompatible = 'StaticError 409 "mls-legal-hold-not-allowed" "A user who is under legal-hold may not participate in MLS conversations"
type MapError 'MLSMigrationCriteriaNotSatisfied Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSMigrationCriteriaNotSatisfied = 'StaticError 400 "mls-migration-criteria-not-satisfied" "The migration criteria for mixed to MLS protocol transition are not satisfied for this conversation"
type MapError 'MLSMissingGroupInfo Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSMissingGroupInfo = 'StaticError 404 "mls-missing-group-info" "The conversation has no group information"
type MapError 'MLSNonEmptyMemberList Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSNonEmptyMemberList = 'StaticError 400 "non-empty-member-list" "Attempting to add group members outside MLS"
type MapError 'MLSNotEnabled Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSNotEnabled = 'StaticError 400 "mls-not-enabled" "MLS is not configured on this backend. See docs.wire.com for instructions on how to enable it"
type MapError 'MLSProposalNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSProposalNotFound = 'StaticError 404 "mls-proposal-not-found" "A proposal referenced in a commit message could not be found"
type MapError 'MLSProtocolErrorTag Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSProtocolErrorTag = MapError 'MLSProtocolError
type MapError 'MLSSelfRemovalNotAllowed Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSSelfRemovalNotAllowed = 'StaticError 400 "mls-self-removal-not-allowed" "Self removal from group is not allowed"
type MapError 'MLSStaleMessage Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSStaleMessage = 'StaticError 409 "mls-stale-message" "The conversation epoch in a message is too old"
type MapError 'MLSSubConvClientNotInParent Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSSubConvClientNotInParent = 'StaticError 403 "mls-subconv-join-parent-missing" "MLS client cannot join the subconversation because it is not member of the parent conversation"
type MapError 'MLSSubConvUnsupportedConvType Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSSubConvUnsupportedConvType = 'StaticError 403 "mls-subconv-unsupported-convtype" "MLS subconversations are only supported for regular conversations"
type MapError 'MLSUnsupportedMessage Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSUnsupportedMessage = 'StaticError 422 "mls-unsupported-message" "Attempted to send a message with an unsupported combination of content type and wire format"
type MapError 'MLSUnsupportedProposal Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSUnsupportedProposal = 'StaticError 422 "mls-unsupported-proposal" "Unsupported proposal type"
type MapError 'MLSWelcomeMismatch Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSWelcomeMismatch = 'StaticError 400 "mls-welcome-mismatch" "The list of targets of a welcome message does not match the list of new clients in a group"
type MapError 'MissingLegalholdConsent Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MissingLegalholdConsent = 'StaticError 403 "missing-legalhold-consent" "Failed to connect to a user or to invite a user to a group because somebody is under legalhold and somebody else has not granted consent"
type MapError 'MissingLegalholdConsentOldClients Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MissingLegalholdConsentOldClients = 'StaticError 403 "missing-legalhold-consent-old-clients" "Failed to connect to a user or to invite a user to a group because somebody is under legalhold and somebody else has old clients that do not support legalhold's UI requirements"
type MapError 'NoAddToBinding Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NoAddToBinding = 'StaticError 403 "binding-team" "Cannot add users to binding teams, invite only"
type MapError 'NoBindingTeam Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NoBindingTeam = 'StaticError 403 "no-binding-team" "Operation allowed only on binding teams"
type MapError 'NoBindingTeamMembers Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NoBindingTeamMembers = 'StaticError 403 "non-binding-team-members" "Both users must be members of the same binding team"
type MapError 'NoLegalHoldDeviceAllocated Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NoLegalHoldDeviceAllocated = 'StaticError 404 "legalhold-no-device-allocated" "no legal hold device is registered for this user. POST /teams/:tid/legalhold/:uid/ to start the flow."
type MapError 'NoUserLegalHoldConsent Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NoUserLegalHoldConsent = 'StaticError 409 "legalhold-no-consent" "user has not given consent to using legal hold"
type MapError 'NonBindingTeam Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NonBindingTeam = 'StaticError 404 "non-binding-team" "Not a member of a binding team"
type MapError 'NotAOneMemberTeam Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NotAOneMemberTeam = 'StaticError 403 "not-one-member-team" "Can only delete teams with a single member"
type MapError 'NotATeamMember Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NotATeamMember = 'StaticError 403 "no-team-member" "Requesting user is not a team member"
type MapError 'NotConnected Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'NotConnected = 'StaticError 403 "not-connected" "Users are not connected"
type MapError 'TeamMemberNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TeamMemberNotFound = 'StaticError 404 "no-team-member" "Team member not found"
type MapError 'TeamNotFound Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TeamNotFound = 'StaticError 404 "no-team" "Team not found"
type MapError 'TeamSearchVisibilityNotEnabled Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TeamSearchVisibilityNotEnabled = 'StaticError 403 "team-search-visibility-not-enabled" "Custom search is not available for this team"
type MapError 'TooManyMembers Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TooManyMembers = 'StaticError 403 "too-many-members" "Maximum number of members per conversation reached"
type MapError 'TooManyTeamAdmins Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TooManyTeamAdmins = 'StaticError 403 "too-many-team-admins" "Maximum number of admins per team reached"
type MapError 'TooManyTeamMembers Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TooManyTeamMembers = 'StaticError 403 "too-many-team-members" "Maximum number of members per team reached"
type MapError 'TooManyTeamMembersOnTeamWithLegalhold Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'TooManyTeamMembersOnTeamWithLegalhold = 'StaticError 403 "too-many-members-for-legalhold" "cannot add more members to team when legalhold service is enabled."
type MapError 'UserBindingExists Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'UserBindingExists = 'StaticError 403 "binding-exists" "User already bound to a different team"
type MapError 'UserLegalHoldAlreadyEnabled Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'UserLegalHoldAlreadyEnabled = 'StaticError 409 "legalhold-already-enabled" "legal hold is already enabled for this user"
type MapError 'UserLegalHoldIllegalOperation Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'UserLegalHoldIllegalOperation = 'StaticError 500 "legalhold-illegal-op" "internal server error: inconsistent change of user's legalhold state"
type MapError 'UserLegalHoldNotPending Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'UserLegalHoldNotPending = 'StaticError 412 "legalhold-not-pending" "legal hold cannot be approved without being in a pending state"
type MapError 'AppLockInactivityTimeoutTooLow Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'AppLockInactivityTimeoutTooLow = 'StaticError 400 "inactivity-timeout-too-low" "Applock inactivity timeout must be at least 30 seconds"
type MapError 'DisableSsoNotImplemented Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'DisableSsoNotImplemented = 'StaticError 403 "not-implemented" "The SSO feature flag is disabled by default. It can only be enabled once for any team, never disabled.\n\nRationale: there are two services in the backend that need to keep their status in sync: galley (teams),\nand spar (SSO). Galley keeps track of team features. If galley creates an idp, the feature flag is\nchecked. For authentication, spar avoids this expensive check and assumes that the idp can only have\nbeen created if the SSO is enabled. This assumption does not hold any more if the switch is turned off\nagain, so we do not support this.\n\nIt is definitely feasible to change this. If you have a use case, please contact customer support, or\nopen an issue on https://github.com/wireapp/wire-server."
type MapError 'FeatureLocked Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'FeatureLocked = 'StaticError 409 "feature-locked" "Feature config cannot be updated (e.g. because it is configured to be locked, or because you need to upgrade your plan)"
type MapError 'LegalHoldFeatureFlagNotEnabled Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldFeatureFlagNotEnabled = 'StaticError 403 "legalhold-not-enabled" "Legal hold is not enabled for this wire instance"
type MapError 'LegalHoldWhitelistedOnly Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'LegalHoldWhitelistedOnly = 'StaticError 403 "legalhold-whitelisted-only" "Legal hold is enabled for teams via server config and cannot be changed here"
type MapError 'MLSE2EIDMissingCrlProxy Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSE2EIDMissingCrlProxy = 'StaticError 400 "mls-e2eid-missing-crl-proxy" "The field 'crlProxy' is missing in the request payload"
type MapError 'MLSProtocolMismatch Source #
Instance details Defined in Wire.API.Error.Galley type MapError 'MLSProtocolMismatch = 'StaticError 400 "mls-protocol-mismatch" "The default protocol needs to be part of the supported protocols"
type MapError 'AddTokenErrorApnsVoipNotSupported Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'AddTokenErrorApnsVoipNotSupported = 'StaticError 400 "apns-voip-not-supported" "Adding APNS_VOIP tokens is not supported"
type MapError 'AddTokenErrorInvalid Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'AddTokenErrorInvalid = 'StaticError 404 "invalid-token" "Invalid push token"
type MapError 'AddTokenErrorMetadataTooLong Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'AddTokenErrorMetadataTooLong = 'StaticError 413 "metadata-too-long" "Tried to add token to endpoint resulting in metadata length > 2048"
type MapError 'AddTokenErrorNoBudget Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'AddTokenErrorNoBudget = 'StaticError 413 "sns-thread-budget-reached" "Too many concurrent calls to SNS; is SNS down?"
type MapError 'AddTokenErrorNotFound Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'AddTokenErrorNotFound = 'StaticError 404 "app-not-found" "App does not exist"
type MapError 'AddTokenErrorTooLong Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'AddTokenErrorTooLong = 'StaticError 413 "token-too-long" "Push token length must be < 8192 for GCM or 400 for APNS"
type MapError 'NotificationNotFound Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'NotificationNotFound = 'StaticError 404 "not-found" "Some notifications not found"
type MapError 'TokenNotFound Source #
Instance details Defined in Wire.API.Error.Gundeck type MapError 'TokenNotFound = 'StaticError 404 "not-found" "Push token not found"
type MapError 'OAuthAuthorizationCodeNotFound Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthAuthorizationCodeNotFound = 'StaticError 404 "not-found" "OAuth authorization code not found"
type MapError 'OAuthClientNotFound Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthClientNotFound = 'StaticError 404 "not-found" "OAuth client not found"
type MapError 'OAuthFeatureDisabled Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthFeatureDisabled = 'StaticError 403 "forbidden" "OAuth is disabled"
type MapError 'OAuthInvalidClientCredentials Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthInvalidClientCredentials = 'StaticError 403 "forbidden" "Invalid client credentials"
type MapError 'OAuthInvalidGrant Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthInvalidGrant = 'StaticError 403 "invalid_grant" "Invalid grant"
type MapError 'OAuthInvalidGrantType Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthInvalidGrantType = 'StaticError 403 "forbidden" "Invalid grant type"
type MapError 'OAuthInvalidRefreshToken Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthInvalidRefreshToken = 'StaticError 403 "forbidden" "Invalid refresh token"
type MapError 'OAuthJwtError Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthJwtError = 'StaticError 500 "jwt-error" "Internal error while handling JWT token"
type MapError 'OAuthRedirectUrlMissMatch Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthRedirectUrlMissMatch = 'StaticError 400 "redirect-url-miss-match" "The redirect URL does not match the one registered with the client"
type MapError 'OAuthUnsupportedResponseType Source #
Instance details Defined in Wire.API.OAuth type MapError 'OAuthUnsupportedResponseType = 'StaticError 400 "unsupported-response-type" "Unsupported response type"
type MapError ('ActionDenied action :: GalleyError) Source #
Instance details Defined in Wire.API.Error.Galley type MapError ('ActionDenied action :: GalleyError) = 'StaticError 403 "action-denied" (AppendSymbol (AppendSymbol "Insufficient authorization (missing " (ActionName action)) ")")
type MapError ('MissingPermission mperm :: GalleyError) Source #
Instance details Defined in Wire.API.Error.Galley type MapError ('MissingPermission mperm :: GalleyError)

errorToResponse :: forall e. KnownError (MapError e) => JSONResponse Source #

errorToWai :: forall e. KnownError (MapError e) => Error Source #

class APIError e where Source #

Methods

toResponse :: e -> JSONResponse Source #

Instances

Instances details

APIError Error Source #
Instance details Defined in Wire.API.Error Methods toResponse :: Error -> JSONResponse Source #
APIError DynError Source #
Instance details Defined in Wire.API.Error Methods toResponse :: DynError -> JSONResponse Source #
APIError NonFederatingBackends Source #
Instance details Defined in Wire.API.Error.Galley Methods toResponse :: NonFederatingBackends -> JSONResponse Source #
APIError UnreachableBackends Source #
Instance details Defined in Wire.API.Error.Galley Methods toResponse :: UnreachableBackends -> JSONResponse Source #
APIError UnreachableBackendsLegacy Source #
Instance details Defined in Wire.API.Error.Galley Methods toResponse :: UnreachableBackendsLegacy -> JSONResponse Source #
KnownError (MapError e) => APIError (Tagged e ()) Source #
Instance details Defined in Wire.API.Error.Galley Methods toResponse :: Tagged e () -> JSONResponse Source #

Static errors and Servant

data CanThrow e Source #

Instances

Instances details

RoutesToPaths api => RoutesToPaths (CanThrow err :> api :: Type) Source #
Instance details Defined in Wire.API.Error Methods getRoutes :: Forest PathSegment Source #
HasClient m api => HasClient m (CanThrow e :> api) Source #
Instance details Defined in Wire.API.Error Associated Types type Client m (CanThrow e :> api) Source # Methods clientWithRoute :: Proxy m -> Proxy (CanThrow e :> api) -> Request -> Client m (CanThrow e :> api) Source # hoistClientMonad :: Proxy m -> Proxy (CanThrow e :> api) -> (forall x. mon x -> mon' x) -> Client mon (CanThrow e :> api) -> Client mon' (CanThrow e :> api) Source #
(HasOpenApi api, IsSwaggerError e) => HasOpenApi (CanThrow e :> api :: Type) Source #
Instance details Defined in Wire.API.Error Methods toOpenApi :: Proxy (CanThrow e :> api) -> OpenApi Source #
HasFeds rest => HasFeds (CanThrow e :> rest :: Type) Source #
Instance details Defined in Wire.API.MakesFederatedCall Methods getFedCalls :: Proxy (CanThrow e :> rest) -> State FedCallFrom [FedCallFrom] Source #
HasServer api ctx => HasServer (CanThrow e :> api :: Type) ctx Source #
Instance details Defined in Wire.API.Error Associated Types type ServerT (CanThrow e :> api) m Source # Methods route :: Proxy (CanThrow e :> api) -> Context ctx -> Delayed env (Server (CanThrow e :> api)) -> Router env Source # hoistServerWithContext :: Proxy (CanThrow e :> api) -> Proxy ctx -> (forall x. m x -> n x) -> ServerT (CanThrow e :> api) m -> ServerT (CanThrow e :> api) n Source #
type Client m (CanThrow e :> api) Source #
Instance details Defined in Wire.API.Error type Client m (CanThrow e :> api) = Client m api
type SpecialiseToVersion v (CanThrow e :> api) Source #
Instance details Defined in Wire.API.Error type SpecialiseToVersion v (CanThrow e :> api) = CanThrow e :> SpecialiseToVersion v api
type ServerT (CanThrow e :> api :: Type) m Source #
Instance details Defined in Wire.API.Error type ServerT (CanThrow e :> api :: Type) m = ServerT api m

data CanThrowMany (es :: [k]) Source #

Instances

Instances details

RoutesToPaths api => RoutesToPaths (CanThrowMany errs :> api :: Type) Source #
Instance details Defined in Wire.API.Error Methods getRoutes :: Forest PathSegment Source #
(HasOpenApi (CanThrowMany es :> api), IsSwaggerError e) => HasOpenApi (CanThrowMany (e ': es) :> api :: Type) Source #
Instance details Defined in Wire.API.Error Methods toOpenApi :: Proxy (CanThrowMany (e ': es) :> api) -> OpenApi Source #
HasOpenApi api => HasOpenApi (CanThrowMany ('[] :: [k]) :> api :: Type) Source #
Instance details Defined in Wire.API.Error Methods toOpenApi :: Proxy (CanThrowMany '[] :> api) -> OpenApi Source #
HasFeds rest => HasFeds (CanThrowMany es :> rest :: Type) Source #
Instance details Defined in Wire.API.MakesFederatedCall Methods getFedCalls :: Proxy (CanThrowMany es :> rest) -> State FedCallFrom [FedCallFrom] Source #
HasServer api ctx => HasServer (CanThrowMany es :> api :: Type) ctx Source #
Instance details Defined in Wire.API.Error Associated Types type ServerT (CanThrowMany es :> api) m Source # Methods route :: Proxy (CanThrowMany es :> api) -> Context ctx -> Delayed env (Server (CanThrowMany es :> api)) -> Router env Source # hoistServerWithContext :: Proxy (CanThrowMany es :> api) -> Proxy ctx -> (forall x. m x -> n x) -> ServerT (CanThrowMany es :> api) m -> ServerT (CanThrowMany es :> api) n Source #
type SpecialiseToVersion v (CanThrowMany es :> api) Source #
Instance details Defined in Wire.API.Error type SpecialiseToVersion v (CanThrowMany es :> api) = CanThrowMany es :> SpecialiseToVersion v api
type ServerT (CanThrowMany es :> api :: Type) m Source #
Instance details Defined in Wire.API.Error type ServerT (CanThrowMany es :> api :: Type) m = ServerT api m

type family DeclaredErrorEffects api :: EffectRow where ... Source #

Equations

DeclaredErrorEffects (CanThrow e :> api) = ErrorEffect e ': DeclaredErrorEffects api
DeclaredErrorEffects (CanThrowMany (e : es) :> api) = DeclaredErrorEffects (CanThrow e :> (CanThrowMany es :> api))
DeclaredErrorEffects (x :> api) = DeclaredErrorEffects api
DeclaredErrorEffects (Named n api) = DeclaredErrorEffects api
DeclaredErrorEffects api = '[]

addErrorResponseToSwagger :: Int -> Response -> OpenApi -> OpenApi Source #

addStaticErrorToSwagger :: forall e. (Typeable e, KnownError e) => OpenApi -> OpenApi Source #

class IsSwaggerError e where Source #

Methods

addToOpenApi :: OpenApi -> OpenApi Source #

Instances

Instances details

(Typeable (MapError e), KnownError (MapError e)) => IsSwaggerError (e :: BrigError) Source #
Instance details Defined in Wire.API.Error.Brig Methods addToOpenApi :: OpenApi -> OpenApi Source #
(Typeable (MapError e), KnownError (MapError e)) => IsSwaggerError (e :: CannonError) Source #
Instance details Defined in Wire.API.Error.Cannon Methods addToOpenApi :: OpenApi -> OpenApi Source #
(Typeable (MapError e), KnownError (MapError e)) => IsSwaggerError (e :: CargoholdError) Source #
Instance details Defined in Wire.API.Error.Cargohold Methods addToOpenApi :: OpenApi -> OpenApi Source #
(Typeable (MapError e), KnownError (MapError e)) => IsSwaggerError (e :: GalleyError) Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #
(Typeable (MapError e), KnownError (MapError e)) => IsSwaggerError (e :: GundeckError) Source #
Instance details Defined in Wire.API.Error.Gundeck Methods addToOpenApi :: OpenApi -> OpenApi Source #
(Typeable (MapError e), KnownError (MapError e)) => IsSwaggerError (e :: OAuthError) Source #
Instance details Defined in Wire.API.OAuth Methods addToOpenApi :: OpenApi -> OpenApi Source #
IsSwaggerError AuthenticationError Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #
IsSwaggerError MLSProposalFailure Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #
IsSwaggerError NonFederatingBackends Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #
IsSwaggerError TeamFeatureError Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #
IsSwaggerError UnreachableBackends Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #
IsSwaggerError UnreachableBackendsLegacy Source #
Instance details Defined in Wire.API.Error.Galley Methods addToOpenApi :: OpenApi -> OpenApi Source #

data ErrorResponse e Source #

Instances

Instances details

AsUnion CreateOAuthAuthorizationCodeResponses CreateOAuthCodeResponse Source #
Instance details Defined in Wire.API.Routes.Public.Brig.OAuth Methods toUnion :: CreateOAuthCodeResponse -> Union (ResponseTypes CreateOAuthAuthorizationCodeResponses) Source # fromUnion :: Union (ResponseTypes CreateOAuthAuthorizationCodeResponses) -> CreateOAuthCodeResponse Source #
AsUnion HeadInvitationsResponses HeadInvitationByEmailResult Source #
Instance details Defined in Wire.API.Team.Invitation Methods toUnion :: HeadInvitationByEmailResult -> Union (ResponseTypes HeadInvitationsResponses) Source # fromUnion :: Union (ResponseTypes HeadInvitationsResponses) -> HeadInvitationByEmailResult Source #
(ResponseBody (RespondWithStaticError (MapError e)) ~ LByteString, ResponseType (RespondWithStaticError (MapError e)) ~ DynError, IsResponse cs (RespondWithStaticError (MapError e))) => IsResponse (cs :: k2) (ErrorResponse e) Source #
Instance details Defined in Wire.API.Error Associated Types type ResponseStatus (ErrorResponse e) :: Nat Source # type ResponseBody (ErrorResponse e) Source # Methods responseRender :: AcceptHeader -> ResponseType (ErrorResponse e) -> Maybe (ResponseF (ResponseBody (ErrorResponse e))) Source # responseUnrender :: MediaType -> ResponseF (ResponseBody (ErrorResponse e)) -> UnrenderResult (ResponseType (ErrorResponse e)) Source #
AsUnion UpgradePersonalToTeamResponses (Either UpgradePersonalToTeamError CreateUserTeam) Source #
Instance details Defined in Wire.API.User Methods toUnion :: Either UpgradePersonalToTeamError CreateUserTeam -> Union (ResponseTypes UpgradePersonalToTeamResponses) Source # fromUnion :: Union (ResponseTypes UpgradePersonalToTeamResponses) -> Either UpgradePersonalToTeamError CreateUserTeam Source #
(KnownError (MapError e), Typeable (MapError e)) => IsSwaggerResponse (ErrorResponse e :: Type) Source #
Instance details Defined in Wire.API.Error Methods responseSwagger :: Declare Response Source #
AsUnion (MessageNotSentResponses a) (MessageNotSent a) Source #
Instance details Defined in Wire.API.Routes.Public.Galley.Messaging Methods toUnion :: MessageNotSent a -> Union (ResponseTypes (MessageNotSentResponses a)) Source # fromUnion :: Union (ResponseTypes (MessageNotSentResponses a)) -> MessageNotSent a Source #
KnownError (MapError e) => AsConstructor ('[] :: [Type]) (ErrorResponse e) Source #
Instance details Defined in Wire.API.Error Methods toConstructor :: ResponseType (ErrorResponse e) -> NP I '[] Source # fromConstructor :: NP I '[] -> ResponseType (ErrorResponse e) Source #
(ResponseType r ~ a, KnownError (MapError e)) => AsUnion '[ErrorResponse e, r] (Maybe a) Source #
Instance details Defined in Wire.API.Error Methods toUnion :: Maybe a -> Union (ResponseTypes '[ErrorResponse e, r]) Source # fromUnion :: Union (ResponseTypes '[ErrorResponse e, r]) -> Maybe a Source #
(ResponseType r1 ~ AssetLocation Absolute, ResponseType r2 ~ SourceIO ByteString, KnownError (MapError e)) => AsUnion '[ErrorResponse e, r1, r2] (Maybe LocalOrRemoteAsset) Source #
Instance details Defined in Wire.API.Asset Methods toUnion :: Maybe LocalOrRemoteAsset -> Union (ResponseTypes '[ErrorResponse e, r1, r2]) Source # fromUnion :: Union (ResponseTypes '[ErrorResponse e, r1, r2]) -> Maybe LocalOrRemoteAsset Source #
type ResponseBody (ErrorResponse e) Source #
Instance details Defined in Wire.API.Error type ResponseBody (ErrorResponse e) = LByteString
type ResponseStatus (ErrorResponse e) Source #
Instance details Defined in Wire.API.Error type ResponseStatus (ErrorResponse e)
type ResponseType (ErrorResponse e) Source #
Instance details Defined in Wire.API.Error type ResponseType (ErrorResponse e) = DynError

Static errors and Polysemy

type family ErrorEffect (e :: k) :: Effect Source #

Instances

Instances details

type ErrorEffect (e :: GalleyError) Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect (e :: GalleyError)
type ErrorEffect AuthenticationError Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect AuthenticationError = Error AuthenticationError :: (Type -> Type) -> Type -> Type
type ErrorEffect MLSProposalFailure Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect MLSProposalFailure = Error MLSProposalFailure :: (Type -> Type) -> Type -> Type
type ErrorEffect NonFederatingBackends Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect NonFederatingBackends = Error NonFederatingBackends :: (Type -> Type) -> Type -> Type
type ErrorEffect TeamFeatureError Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect TeamFeatureError = Error TeamFeatureError :: (Type -> Type) -> Type -> Type
type ErrorEffect UnreachableBackends Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect UnreachableBackends = Error UnreachableBackends :: (Type -> Type) -> Type -> Type
type ErrorEffect UnreachableBackendsLegacy Source #
Instance details Defined in Wire.API.Error.Galley type ErrorEffect UnreachableBackendsLegacy = Error UnreachableBackendsLegacy :: (Type -> Type) -> Type -> Type

type ErrorS e = Error (Tagged e ()) Source #

An effect for a static error type with no data.

throwS :: forall e r a. Member (ErrorS e) r => Sem r a Source #

noteS :: forall e r a. Member (ErrorS e) r => Maybe a -> Sem r a Source #

mapErrorS :: forall e e' r a. Member (ErrorS e') r => Sem (ErrorS e ': r) a -> Sem r a Source #

runErrorS :: forall e r a. Sem (ErrorS e : r) a -> Sem r (Maybe a) Source #

mapToRuntimeError :: forall e e' r a. Member (Error e') r => e' -> Sem (ErrorS e ': r) a -> Sem r a Source #

mapToDynamicError :: forall e r a. (Member (Error DynError) r, KnownError (MapError e)) => Sem (ErrorS e ': r) a -> Sem r a Source #