{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.WorkMail.PutMailboxPermissions
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Sets permissions for a user, group, or resource. This replaces any
-- pre-existing permissions.
module Amazonka.WorkMail.PutMailboxPermissions
  ( -- * Creating a Request
    PutMailboxPermissions (..),
    newPutMailboxPermissions,

    -- * Request Lenses
    putMailboxPermissions_organizationId,
    putMailboxPermissions_entityId,
    putMailboxPermissions_granteeId,
    putMailboxPermissions_permissionValues,

    -- * Destructuring the Response
    PutMailboxPermissionsResponse (..),
    newPutMailboxPermissionsResponse,

    -- * Response Lenses
    putMailboxPermissionsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.WorkMail.Types

-- | /See:/ 'newPutMailboxPermissions' smart constructor.
data PutMailboxPermissions = PutMailboxPermissions'
  { -- | The identifier of the organization under which the user, group, or
    -- resource exists.
    PutMailboxPermissions -> Text
organizationId :: Prelude.Text,
    -- | The identifier of the user, group, or resource for which to update
    -- mailbox permissions.
    PutMailboxPermissions -> Text
entityId :: Prelude.Text,
    -- | The identifier of the user, group, or resource to which to grant the
    -- permissions.
    PutMailboxPermissions -> Text
granteeId :: Prelude.Text,
    -- | The permissions granted to the grantee. SEND_AS allows the grantee to
    -- send email as the owner of the mailbox (the grantee is not mentioned on
    -- these emails). SEND_ON_BEHALF allows the grantee to send email on behalf
    -- of the owner of the mailbox (the grantee is not mentioned as the
    -- physical sender of these emails). FULL_ACCESS allows the grantee full
    -- access to the mailbox, irrespective of other folder-level permissions
    -- set on the mailbox.
    PutMailboxPermissions -> [PermissionType]
permissionValues :: [PermissionType]
  }
  deriving (PutMailboxPermissions -> PutMailboxPermissions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutMailboxPermissions -> PutMailboxPermissions -> Bool
$c/= :: PutMailboxPermissions -> PutMailboxPermissions -> Bool
== :: PutMailboxPermissions -> PutMailboxPermissions -> Bool
$c== :: PutMailboxPermissions -> PutMailboxPermissions -> Bool
Prelude.Eq, ReadPrec [PutMailboxPermissions]
ReadPrec PutMailboxPermissions
Int -> ReadS PutMailboxPermissions
ReadS [PutMailboxPermissions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PutMailboxPermissions]
$creadListPrec :: ReadPrec [PutMailboxPermissions]
readPrec :: ReadPrec PutMailboxPermissions
$creadPrec :: ReadPrec PutMailboxPermissions
readList :: ReadS [PutMailboxPermissions]
$creadList :: ReadS [PutMailboxPermissions]
readsPrec :: Int -> ReadS PutMailboxPermissions
$creadsPrec :: Int -> ReadS PutMailboxPermissions
Prelude.Read, Int -> PutMailboxPermissions -> ShowS
[PutMailboxPermissions] -> ShowS
PutMailboxPermissions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutMailboxPermissions] -> ShowS
$cshowList :: [PutMailboxPermissions] -> ShowS
show :: PutMailboxPermissions -> String
$cshow :: PutMailboxPermissions -> String
showsPrec :: Int -> PutMailboxPermissions -> ShowS
$cshowsPrec :: Int -> PutMailboxPermissions -> ShowS
Prelude.Show, forall x. Rep PutMailboxPermissions x -> PutMailboxPermissions
forall x. PutMailboxPermissions -> Rep PutMailboxPermissions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PutMailboxPermissions x -> PutMailboxPermissions
$cfrom :: forall x. PutMailboxPermissions -> Rep PutMailboxPermissions x
Prelude.Generic)

-- |
-- Create a value of 'PutMailboxPermissions' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'organizationId', 'putMailboxPermissions_organizationId' - The identifier of the organization under which the user, group, or
-- resource exists.
--
-- 'entityId', 'putMailboxPermissions_entityId' - The identifier of the user, group, or resource for which to update
-- mailbox permissions.
--
-- 'granteeId', 'putMailboxPermissions_granteeId' - The identifier of the user, group, or resource to which to grant the
-- permissions.
--
-- 'permissionValues', 'putMailboxPermissions_permissionValues' - The permissions granted to the grantee. SEND_AS allows the grantee to
-- send email as the owner of the mailbox (the grantee is not mentioned on
-- these emails). SEND_ON_BEHALF allows the grantee to send email on behalf
-- of the owner of the mailbox (the grantee is not mentioned as the
-- physical sender of these emails). FULL_ACCESS allows the grantee full
-- access to the mailbox, irrespective of other folder-level permissions
-- set on the mailbox.
newPutMailboxPermissions ::
  -- | 'organizationId'
  Prelude.Text ->
  -- | 'entityId'
  Prelude.Text ->
  -- | 'granteeId'
  Prelude.Text ->
  PutMailboxPermissions
newPutMailboxPermissions :: Text -> Text -> Text -> PutMailboxPermissions
newPutMailboxPermissions
  Text
pOrganizationId_
  Text
pEntityId_
  Text
pGranteeId_ =
    PutMailboxPermissions'
      { $sel:organizationId:PutMailboxPermissions' :: Text
organizationId =
          Text
pOrganizationId_,
        $sel:entityId:PutMailboxPermissions' :: Text
entityId = Text
pEntityId_,
        $sel:granteeId:PutMailboxPermissions' :: Text
granteeId = Text
pGranteeId_,
        $sel:permissionValues:PutMailboxPermissions' :: [PermissionType]
permissionValues = forall a. Monoid a => a
Prelude.mempty
      }

-- | The identifier of the organization under which the user, group, or
-- resource exists.
putMailboxPermissions_organizationId :: Lens.Lens' PutMailboxPermissions Prelude.Text
putMailboxPermissions_organizationId :: Lens' PutMailboxPermissions Text
putMailboxPermissions_organizationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutMailboxPermissions' {Text
organizationId :: Text
$sel:organizationId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
organizationId} -> Text
organizationId) (\s :: PutMailboxPermissions
s@PutMailboxPermissions' {} Text
a -> PutMailboxPermissions
s {$sel:organizationId:PutMailboxPermissions' :: Text
organizationId = Text
a} :: PutMailboxPermissions)

-- | The identifier of the user, group, or resource for which to update
-- mailbox permissions.
putMailboxPermissions_entityId :: Lens.Lens' PutMailboxPermissions Prelude.Text
putMailboxPermissions_entityId :: Lens' PutMailboxPermissions Text
putMailboxPermissions_entityId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutMailboxPermissions' {Text
entityId :: Text
$sel:entityId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
entityId} -> Text
entityId) (\s :: PutMailboxPermissions
s@PutMailboxPermissions' {} Text
a -> PutMailboxPermissions
s {$sel:entityId:PutMailboxPermissions' :: Text
entityId = Text
a} :: PutMailboxPermissions)

-- | The identifier of the user, group, or resource to which to grant the
-- permissions.
putMailboxPermissions_granteeId :: Lens.Lens' PutMailboxPermissions Prelude.Text
putMailboxPermissions_granteeId :: Lens' PutMailboxPermissions Text
putMailboxPermissions_granteeId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutMailboxPermissions' {Text
granteeId :: Text
$sel:granteeId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
granteeId} -> Text
granteeId) (\s :: PutMailboxPermissions
s@PutMailboxPermissions' {} Text
a -> PutMailboxPermissions
s {$sel:granteeId:PutMailboxPermissions' :: Text
granteeId = Text
a} :: PutMailboxPermissions)

-- | The permissions granted to the grantee. SEND_AS allows the grantee to
-- send email as the owner of the mailbox (the grantee is not mentioned on
-- these emails). SEND_ON_BEHALF allows the grantee to send email on behalf
-- of the owner of the mailbox (the grantee is not mentioned as the
-- physical sender of these emails). FULL_ACCESS allows the grantee full
-- access to the mailbox, irrespective of other folder-level permissions
-- set on the mailbox.
putMailboxPermissions_permissionValues :: Lens.Lens' PutMailboxPermissions [PermissionType]
putMailboxPermissions_permissionValues :: Lens' PutMailboxPermissions [PermissionType]
putMailboxPermissions_permissionValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutMailboxPermissions' {[PermissionType]
permissionValues :: [PermissionType]
$sel:permissionValues:PutMailboxPermissions' :: PutMailboxPermissions -> [PermissionType]
permissionValues} -> [PermissionType]
permissionValues) (\s :: PutMailboxPermissions
s@PutMailboxPermissions' {} [PermissionType]
a -> PutMailboxPermissions
s {$sel:permissionValues:PutMailboxPermissions' :: [PermissionType]
permissionValues = [PermissionType]
a} :: PutMailboxPermissions) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest PutMailboxPermissions where
  type
    AWSResponse PutMailboxPermissions =
      PutMailboxPermissionsResponse
  request :: (Service -> Service)
-> PutMailboxPermissions -> Request PutMailboxPermissions
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy PutMailboxPermissions
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse PutMailboxPermissions)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> () -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveEmpty
      ( \Int
s ResponseHeaders
h ()
x ->
          Int -> PutMailboxPermissionsResponse
PutMailboxPermissionsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable PutMailboxPermissions where
  hashWithSalt :: Int -> PutMailboxPermissions -> Int
hashWithSalt Int
_salt PutMailboxPermissions' {[PermissionType]
Text
permissionValues :: [PermissionType]
granteeId :: Text
entityId :: Text
organizationId :: Text
$sel:permissionValues:PutMailboxPermissions' :: PutMailboxPermissions -> [PermissionType]
$sel:granteeId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
$sel:entityId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
$sel:organizationId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
organizationId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
entityId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
granteeId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [PermissionType]
permissionValues

instance Prelude.NFData PutMailboxPermissions where
  rnf :: PutMailboxPermissions -> ()
rnf PutMailboxPermissions' {[PermissionType]
Text
permissionValues :: [PermissionType]
granteeId :: Text
entityId :: Text
organizationId :: Text
$sel:permissionValues:PutMailboxPermissions' :: PutMailboxPermissions -> [PermissionType]
$sel:granteeId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
$sel:entityId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
$sel:organizationId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
organizationId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
entityId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
granteeId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [PermissionType]
permissionValues

instance Data.ToHeaders PutMailboxPermissions where
  toHeaders :: PutMailboxPermissions -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"WorkMailService.PutMailboxPermissions" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON PutMailboxPermissions where
  toJSON :: PutMailboxPermissions -> Value
toJSON PutMailboxPermissions' {[PermissionType]
Text
permissionValues :: [PermissionType]
granteeId :: Text
entityId :: Text
organizationId :: Text
$sel:permissionValues:PutMailboxPermissions' :: PutMailboxPermissions -> [PermissionType]
$sel:granteeId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
$sel:entityId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
$sel:organizationId:PutMailboxPermissions' :: PutMailboxPermissions -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"OrganizationId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
organizationId),
            forall a. a -> Maybe a
Prelude.Just (Key
"EntityId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
entityId),
            forall a. a -> Maybe a
Prelude.Just (Key
"GranteeId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
granteeId),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"PermissionValues" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [PermissionType]
permissionValues)
          ]
      )

instance Data.ToPath PutMailboxPermissions where
  toPath :: PutMailboxPermissions -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery PutMailboxPermissions where
  toQuery :: PutMailboxPermissions -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newPutMailboxPermissionsResponse' smart constructor.
data PutMailboxPermissionsResponse = PutMailboxPermissionsResponse'
  { -- | The response's http status code.
    PutMailboxPermissionsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (PutMailboxPermissionsResponse
-> PutMailboxPermissionsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutMailboxPermissionsResponse
-> PutMailboxPermissionsResponse -> Bool
$c/= :: PutMailboxPermissionsResponse
-> PutMailboxPermissionsResponse -> Bool
== :: PutMailboxPermissionsResponse
-> PutMailboxPermissionsResponse -> Bool
$c== :: PutMailboxPermissionsResponse
-> PutMailboxPermissionsResponse -> Bool
Prelude.Eq, ReadPrec [PutMailboxPermissionsResponse]
ReadPrec PutMailboxPermissionsResponse
Int -> ReadS PutMailboxPermissionsResponse
ReadS [PutMailboxPermissionsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PutMailboxPermissionsResponse]
$creadListPrec :: ReadPrec [PutMailboxPermissionsResponse]
readPrec :: ReadPrec PutMailboxPermissionsResponse
$creadPrec :: ReadPrec PutMailboxPermissionsResponse
readList :: ReadS [PutMailboxPermissionsResponse]
$creadList :: ReadS [PutMailboxPermissionsResponse]
readsPrec :: Int -> ReadS PutMailboxPermissionsResponse
$creadsPrec :: Int -> ReadS PutMailboxPermissionsResponse
Prelude.Read, Int -> PutMailboxPermissionsResponse -> ShowS
[PutMailboxPermissionsResponse] -> ShowS
PutMailboxPermissionsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutMailboxPermissionsResponse] -> ShowS
$cshowList :: [PutMailboxPermissionsResponse] -> ShowS
show :: PutMailboxPermissionsResponse -> String
$cshow :: PutMailboxPermissionsResponse -> String
showsPrec :: Int -> PutMailboxPermissionsResponse -> ShowS
$cshowsPrec :: Int -> PutMailboxPermissionsResponse -> ShowS
Prelude.Show, forall x.
Rep PutMailboxPermissionsResponse x
-> PutMailboxPermissionsResponse
forall x.
PutMailboxPermissionsResponse
-> Rep PutMailboxPermissionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep PutMailboxPermissionsResponse x
-> PutMailboxPermissionsResponse
$cfrom :: forall x.
PutMailboxPermissionsResponse
-> Rep PutMailboxPermissionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'PutMailboxPermissionsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'httpStatus', 'putMailboxPermissionsResponse_httpStatus' - The response's http status code.
newPutMailboxPermissionsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  PutMailboxPermissionsResponse
newPutMailboxPermissionsResponse :: Int -> PutMailboxPermissionsResponse
newPutMailboxPermissionsResponse Int
pHttpStatus_ =
  PutMailboxPermissionsResponse'
    { $sel:httpStatus:PutMailboxPermissionsResponse' :: Int
httpStatus =
        Int
pHttpStatus_
    }

-- | The response's http status code.
putMailboxPermissionsResponse_httpStatus :: Lens.Lens' PutMailboxPermissionsResponse Prelude.Int
putMailboxPermissionsResponse_httpStatus :: Lens' PutMailboxPermissionsResponse Int
putMailboxPermissionsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutMailboxPermissionsResponse' {Int
httpStatus :: Int
$sel:httpStatus:PutMailboxPermissionsResponse' :: PutMailboxPermissionsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: PutMailboxPermissionsResponse
s@PutMailboxPermissionsResponse' {} Int
a -> PutMailboxPermissionsResponse
s {$sel:httpStatus:PutMailboxPermissionsResponse' :: Int
httpStatus = Int
a} :: PutMailboxPermissionsResponse)

instance Prelude.NFData PutMailboxPermissionsResponse where
  rnf :: PutMailboxPermissionsResponse -> ()
rnf PutMailboxPermissionsResponse' {Int
httpStatus :: Int
$sel:httpStatus:PutMailboxPermissionsResponse' :: PutMailboxPermissionsResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus