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

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

-- |
-- Module      : Amazonka.AppFlow.Types.OAuthCredentials
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.AppFlow.Types.OAuthCredentials where

import Amazonka.AppFlow.Types.ConnectorOAuthRequest
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

-- | The OAuth credentials required for OAuth type authentication.
--
-- /See:/ 'newOAuthCredentials' smart constructor.
data OAuthCredentials = OAuthCredentials'
  { -- | The access token used to access protected SAPOData resources.
    OAuthCredentials -> Maybe (Sensitive Text)
accessToken :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The OAuth requirement needed to request security tokens from the
    -- connector endpoint.
    OAuthCredentials -> Maybe ConnectorOAuthRequest
oAuthRequest :: Prelude.Maybe ConnectorOAuthRequest,
    -- | The refresh token used to refresh expired access token.
    OAuthCredentials -> Maybe Text
refreshToken :: Prelude.Maybe Prelude.Text,
    -- | The identifier for the desired client.
    OAuthCredentials -> Text
clientId :: Prelude.Text,
    -- | The client secret used by the OAuth client to authenticate to the
    -- authorization server.
    OAuthCredentials -> Sensitive Text
clientSecret :: Data.Sensitive Prelude.Text
  }
  deriving (OAuthCredentials -> OAuthCredentials -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: OAuthCredentials -> OAuthCredentials -> Bool
$c/= :: OAuthCredentials -> OAuthCredentials -> Bool
== :: OAuthCredentials -> OAuthCredentials -> Bool
$c== :: OAuthCredentials -> OAuthCredentials -> Bool
Prelude.Eq, Int -> OAuthCredentials -> ShowS
[OAuthCredentials] -> ShowS
OAuthCredentials -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [OAuthCredentials] -> ShowS
$cshowList :: [OAuthCredentials] -> ShowS
show :: OAuthCredentials -> String
$cshow :: OAuthCredentials -> String
showsPrec :: Int -> OAuthCredentials -> ShowS
$cshowsPrec :: Int -> OAuthCredentials -> ShowS
Prelude.Show, forall x. Rep OAuthCredentials x -> OAuthCredentials
forall x. OAuthCredentials -> Rep OAuthCredentials x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep OAuthCredentials x -> OAuthCredentials
$cfrom :: forall x. OAuthCredentials -> Rep OAuthCredentials x
Prelude.Generic)

-- |
-- Create a value of 'OAuthCredentials' 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:
--
-- 'accessToken', 'oAuthCredentials_accessToken' - The access token used to access protected SAPOData resources.
--
-- 'oAuthRequest', 'oAuthCredentials_oAuthRequest' - The OAuth requirement needed to request security tokens from the
-- connector endpoint.
--
-- 'refreshToken', 'oAuthCredentials_refreshToken' - The refresh token used to refresh expired access token.
--
-- 'clientId', 'oAuthCredentials_clientId' - The identifier for the desired client.
--
-- 'clientSecret', 'oAuthCredentials_clientSecret' - The client secret used by the OAuth client to authenticate to the
-- authorization server.
newOAuthCredentials ::
  -- | 'clientId'
  Prelude.Text ->
  -- | 'clientSecret'
  Prelude.Text ->
  OAuthCredentials
newOAuthCredentials :: Text -> Text -> OAuthCredentials
newOAuthCredentials Text
pClientId_ Text
pClientSecret_ =
  OAuthCredentials'
    { $sel:accessToken:OAuthCredentials' :: Maybe (Sensitive Text)
accessToken = forall a. Maybe a
Prelude.Nothing,
      $sel:oAuthRequest:OAuthCredentials' :: Maybe ConnectorOAuthRequest
oAuthRequest = forall a. Maybe a
Prelude.Nothing,
      $sel:refreshToken:OAuthCredentials' :: Maybe Text
refreshToken = forall a. Maybe a
Prelude.Nothing,
      $sel:clientId:OAuthCredentials' :: Text
clientId = Text
pClientId_,
      $sel:clientSecret:OAuthCredentials' :: Sensitive Text
clientSecret = forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pClientSecret_
    }

-- | The access token used to access protected SAPOData resources.
oAuthCredentials_accessToken :: Lens.Lens' OAuthCredentials (Prelude.Maybe Prelude.Text)
oAuthCredentials_accessToken :: Lens' OAuthCredentials (Maybe Text)
oAuthCredentials_accessToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OAuthCredentials' {Maybe (Sensitive Text)
accessToken :: Maybe (Sensitive Text)
$sel:accessToken:OAuthCredentials' :: OAuthCredentials -> Maybe (Sensitive Text)
accessToken} -> Maybe (Sensitive Text)
accessToken) (\s :: OAuthCredentials
s@OAuthCredentials' {} Maybe (Sensitive Text)
a -> OAuthCredentials
s {$sel:accessToken:OAuthCredentials' :: Maybe (Sensitive Text)
accessToken = Maybe (Sensitive Text)
a} :: OAuthCredentials) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | The OAuth requirement needed to request security tokens from the
-- connector endpoint.
oAuthCredentials_oAuthRequest :: Lens.Lens' OAuthCredentials (Prelude.Maybe ConnectorOAuthRequest)
oAuthCredentials_oAuthRequest :: Lens' OAuthCredentials (Maybe ConnectorOAuthRequest)
oAuthCredentials_oAuthRequest = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OAuthCredentials' {Maybe ConnectorOAuthRequest
oAuthRequest :: Maybe ConnectorOAuthRequest
$sel:oAuthRequest:OAuthCredentials' :: OAuthCredentials -> Maybe ConnectorOAuthRequest
oAuthRequest} -> Maybe ConnectorOAuthRequest
oAuthRequest) (\s :: OAuthCredentials
s@OAuthCredentials' {} Maybe ConnectorOAuthRequest
a -> OAuthCredentials
s {$sel:oAuthRequest:OAuthCredentials' :: Maybe ConnectorOAuthRequest
oAuthRequest = Maybe ConnectorOAuthRequest
a} :: OAuthCredentials)

-- | The refresh token used to refresh expired access token.
oAuthCredentials_refreshToken :: Lens.Lens' OAuthCredentials (Prelude.Maybe Prelude.Text)
oAuthCredentials_refreshToken :: Lens' OAuthCredentials (Maybe Text)
oAuthCredentials_refreshToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OAuthCredentials' {Maybe Text
refreshToken :: Maybe Text
$sel:refreshToken:OAuthCredentials' :: OAuthCredentials -> Maybe Text
refreshToken} -> Maybe Text
refreshToken) (\s :: OAuthCredentials
s@OAuthCredentials' {} Maybe Text
a -> OAuthCredentials
s {$sel:refreshToken:OAuthCredentials' :: Maybe Text
refreshToken = Maybe Text
a} :: OAuthCredentials)

-- | The identifier for the desired client.
oAuthCredentials_clientId :: Lens.Lens' OAuthCredentials Prelude.Text
oAuthCredentials_clientId :: Lens' OAuthCredentials Text
oAuthCredentials_clientId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OAuthCredentials' {Text
clientId :: Text
$sel:clientId:OAuthCredentials' :: OAuthCredentials -> Text
clientId} -> Text
clientId) (\s :: OAuthCredentials
s@OAuthCredentials' {} Text
a -> OAuthCredentials
s {$sel:clientId:OAuthCredentials' :: Text
clientId = Text
a} :: OAuthCredentials)

-- | The client secret used by the OAuth client to authenticate to the
-- authorization server.
oAuthCredentials_clientSecret :: Lens.Lens' OAuthCredentials Prelude.Text
oAuthCredentials_clientSecret :: Lens' OAuthCredentials Text
oAuthCredentials_clientSecret = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OAuthCredentials' {Sensitive Text
clientSecret :: Sensitive Text
$sel:clientSecret:OAuthCredentials' :: OAuthCredentials -> Sensitive Text
clientSecret} -> Sensitive Text
clientSecret) (\s :: OAuthCredentials
s@OAuthCredentials' {} Sensitive Text
a -> OAuthCredentials
s {$sel:clientSecret:OAuthCredentials' :: Sensitive Text
clientSecret = Sensitive Text
a} :: OAuthCredentials) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

instance Prelude.Hashable OAuthCredentials where
  hashWithSalt :: Int -> OAuthCredentials -> Int
hashWithSalt Int
_salt OAuthCredentials' {Maybe Text
Maybe (Sensitive Text)
Maybe ConnectorOAuthRequest
Text
Sensitive Text
clientSecret :: Sensitive Text
clientId :: Text
refreshToken :: Maybe Text
oAuthRequest :: Maybe ConnectorOAuthRequest
accessToken :: Maybe (Sensitive Text)
$sel:clientSecret:OAuthCredentials' :: OAuthCredentials -> Sensitive Text
$sel:clientId:OAuthCredentials' :: OAuthCredentials -> Text
$sel:refreshToken:OAuthCredentials' :: OAuthCredentials -> Maybe Text
$sel:oAuthRequest:OAuthCredentials' :: OAuthCredentials -> Maybe ConnectorOAuthRequest
$sel:accessToken:OAuthCredentials' :: OAuthCredentials -> Maybe (Sensitive Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
accessToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ConnectorOAuthRequest
oAuthRequest
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
refreshToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
clientId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
clientSecret

instance Prelude.NFData OAuthCredentials where
  rnf :: OAuthCredentials -> ()
rnf OAuthCredentials' {Maybe Text
Maybe (Sensitive Text)
Maybe ConnectorOAuthRequest
Text
Sensitive Text
clientSecret :: Sensitive Text
clientId :: Text
refreshToken :: Maybe Text
oAuthRequest :: Maybe ConnectorOAuthRequest
accessToken :: Maybe (Sensitive Text)
$sel:clientSecret:OAuthCredentials' :: OAuthCredentials -> Sensitive Text
$sel:clientId:OAuthCredentials' :: OAuthCredentials -> Text
$sel:refreshToken:OAuthCredentials' :: OAuthCredentials -> Maybe Text
$sel:oAuthRequest:OAuthCredentials' :: OAuthCredentials -> Maybe ConnectorOAuthRequest
$sel:accessToken:OAuthCredentials' :: OAuthCredentials -> Maybe (Sensitive Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
accessToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ConnectorOAuthRequest
oAuthRequest
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
refreshToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
clientId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
clientSecret

instance Data.ToJSON OAuthCredentials where
  toJSON :: OAuthCredentials -> Value
toJSON OAuthCredentials' {Maybe Text
Maybe (Sensitive Text)
Maybe ConnectorOAuthRequest
Text
Sensitive Text
clientSecret :: Sensitive Text
clientId :: Text
refreshToken :: Maybe Text
oAuthRequest :: Maybe ConnectorOAuthRequest
accessToken :: Maybe (Sensitive Text)
$sel:clientSecret:OAuthCredentials' :: OAuthCredentials -> Sensitive Text
$sel:clientId:OAuthCredentials' :: OAuthCredentials -> Text
$sel:refreshToken:OAuthCredentials' :: OAuthCredentials -> Maybe Text
$sel:oAuthRequest:OAuthCredentials' :: OAuthCredentials -> Maybe ConnectorOAuthRequest
$sel:accessToken:OAuthCredentials' :: OAuthCredentials -> Maybe (Sensitive Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"accessToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (Sensitive Text)
accessToken,
            (Key
"oAuthRequest" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ConnectorOAuthRequest
oAuthRequest,
            (Key
"refreshToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
refreshToken,
            forall a. a -> Maybe a
Prelude.Just (Key
"clientId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
clientId),
            forall a. a -> Maybe a
Prelude.Just (Key
"clientSecret" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
clientSecret)
          ]
      )