{-# LANGUAGE ExplicitForAll #-}
{-# LANGUAGE MultiWayIf #-}
-- CHANGE WITH CAUTION: This is a generated code file generated by https://github.com/Haskell-OpenAPI-Code-Generator/Haskell-OpenAPI-Client-Code-Generator.
{-# LANGUAGE OverloadedStrings #-}

-- | Contains the different functions to run the operation postIdentityVerificationSessionsSessionRedact
module StripeAPI.Operations.PostIdentityVerificationSessionsSessionRedact where

import qualified Control.Monad.Fail
import qualified Control.Monad.Trans.Reader
import qualified Data.Aeson
import qualified Data.Aeson as Data.Aeson.Encoding.Internal
import qualified Data.Aeson as Data.Aeson.Types
import qualified Data.Aeson as Data.Aeson.Types.FromJSON
import qualified Data.Aeson as Data.Aeson.Types.Internal
import qualified Data.Aeson as Data.Aeson.Types.ToJSON
import qualified Data.ByteString.Char8
import qualified Data.ByteString.Char8 as Data.ByteString.Internal
import qualified Data.Either
import qualified Data.Functor
import qualified Data.Scientific
import qualified Data.Text
import qualified Data.Text.Internal
import qualified Data.Time.Calendar as Data.Time.Calendar.Days
import qualified Data.Time.LocalTime as Data.Time.LocalTime.Internal.ZonedTime
import qualified Data.Vector
import qualified GHC.Base
import qualified GHC.Classes
import qualified GHC.Int
import qualified GHC.Show
import qualified GHC.Types
import qualified Network.HTTP.Client
import qualified Network.HTTP.Client as Network.HTTP.Client.Request
import qualified Network.HTTP.Client as Network.HTTP.Client.Types
import qualified Network.HTTP.Simple
import qualified Network.HTTP.Types
import qualified Network.HTTP.Types as Network.HTTP.Types.Status
import qualified Network.HTTP.Types as Network.HTTP.Types.URI
import qualified StripeAPI.Common
import StripeAPI.Types
import qualified Prelude as GHC.Integer.Type
import qualified Prelude as GHC.Maybe

-- | > POST /v1/identity/verification_sessions/{session}/redact
--
-- \<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact
-- the VerificationSession and all objects related to it, including VerificationReports, Events,
-- request logs, etc.\<\/p>
--
-- \<p>A VerificationSession object can be redacted when it is in \<code>requires_input\<\/code> or \<code>verified\<\/code>
-- \<a href=\"\/docs\/identity\/how-sessions-work\">status\<\/a>. Redacting a VerificationSession in \<code>requires_action\<\/code>
-- state will automatically cancel it.\<\/p>
--
-- \<p>The redaction process may take up to four days. When the redaction process is in progress, the
-- VerificationSession’s \<code>redaction.status\<\/code> field will be set to \<code>processing\<\/code>; when the process is
-- finished, it will change to \<code>redacted\<\/code> and an \<code>identity.verification_session.redacted\<\/code> event
-- will be emitted.\<\/p>
--
-- \<p>Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
-- fields that contain personal data will be replaced by the string \<code>[redacted]\<\/code> or a similar
-- placeholder. The \<code>metadata\<\/code> field will also be erased. Redacted objects cannot be updated or
-- used for any purpose.\<\/p>
--
-- \<p>\<a href=\"\/docs\/identity\/verification-sessions\#redact\">Learn more\<\/a>.\<\/p>
postIdentityVerificationSessionsSessionRedact ::
  forall m.
  StripeAPI.Common.MonadHTTP m =>
  -- | session | Constraints: Maximum length of 5000
  Data.Text.Internal.Text ->
  -- | The request body to send
  GHC.Maybe.Maybe PostIdentityVerificationSessionsSessionRedactRequestBody ->
  -- | Monadic computation which returns the result of the operation
  StripeAPI.Common.StripeT m (Network.HTTP.Client.Types.Response PostIdentityVerificationSessionsSessionRedactResponse)
postIdentityVerificationSessionsSessionRedact :: Text
-> Maybe PostIdentityVerificationSessionsSessionRedactRequestBody
-> StripeT
     m (Response PostIdentityVerificationSessionsSessionRedactResponse)
postIdentityVerificationSessionsSessionRedact
  Text
session
  Maybe PostIdentityVerificationSessionsSessionRedactRequestBody
body =
    (Response ByteString
 -> Response PostIdentityVerificationSessionsSessionRedactResponse)
-> StripeT m (Response ByteString)
-> StripeT
     m (Response PostIdentityVerificationSessionsSessionRedactResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
      ( \Response ByteString
response_0 ->
          (ByteString
 -> PostIdentityVerificationSessionsSessionRedactResponse)
-> Response ByteString
-> Response PostIdentityVerificationSessionsSessionRedactResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
            ( (String -> PostIdentityVerificationSessionsSessionRedactResponse)
-> (PostIdentityVerificationSessionsSessionRedactResponse
    -> PostIdentityVerificationSessionsSessionRedactResponse)
-> Either
     String PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
Data.Either.either String -> PostIdentityVerificationSessionsSessionRedactResponse
PostIdentityVerificationSessionsSessionRedactResponseError PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse
forall a. a -> a
GHC.Base.id
                (Either
   String PostIdentityVerificationSessionsSessionRedactResponse
 -> PostIdentityVerificationSessionsSessionRedactResponse)
-> (ByteString
    -> Either
         String PostIdentityVerificationSessionsSessionRedactResponse)
-> ByteString
-> PostIdentityVerificationSessionsSessionRedactResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
GHC.Base.. ( \Response ByteString
response ByteString
body ->
                               if
                                   | (\Status
status_1 -> Status -> Int
Network.HTTP.Types.Status.statusCode Status
status_1 Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
GHC.Classes.== Int
200) (Response ByteString -> Status
forall body. Response body -> Status
Network.HTTP.Client.Types.responseStatus Response ByteString
response) ->
                                     Identity'verificationSession
-> PostIdentityVerificationSessionsSessionRedactResponse
PostIdentityVerificationSessionsSessionRedactResponse200
                                       (Identity'verificationSession
 -> PostIdentityVerificationSessionsSessionRedactResponse)
-> Either String Identity'verificationSession
-> Either
     String PostIdentityVerificationSessionsSessionRedactResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> ( ByteString -> Either String Identity'verificationSession
forall a. FromJSON a => ByteString -> Either String a
Data.Aeson.eitherDecodeStrict ByteString
body ::
                                                            Data.Either.Either
                                                              GHC.Base.String
                                                              Identity'verificationSession
                                                        )
                                   | Bool -> Status -> Bool
forall a b. a -> b -> a
GHC.Base.const Bool
GHC.Types.True (Response ByteString -> Status
forall body. Response body -> Status
Network.HTTP.Client.Types.responseStatus Response ByteString
response) ->
                                     Error -> PostIdentityVerificationSessionsSessionRedactResponse
PostIdentityVerificationSessionsSessionRedactResponseDefault
                                       (Error -> PostIdentityVerificationSessionsSessionRedactResponse)
-> Either String Error
-> Either
     String PostIdentityVerificationSessionsSessionRedactResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> ( ByteString -> Either String Error
forall a. FromJSON a => ByteString -> Either String a
Data.Aeson.eitherDecodeStrict ByteString
body ::
                                                            Data.Either.Either
                                                              GHC.Base.String
                                                              Error
                                                        )
                                   | Bool
GHC.Base.otherwise -> String
-> Either
     String PostIdentityVerificationSessionsSessionRedactResponse
forall a b. a -> Either a b
Data.Either.Left String
"Missing default response type"
                           )
                  Response ByteString
response_0
            )
            Response ByteString
response_0
      )
      (Text
-> Text
-> [QueryParameter]
-> Maybe PostIdentityVerificationSessionsSessionRedactRequestBody
-> RequestBodyEncoding
-> StripeT m (Response ByteString)
forall (m :: * -> *) body.
(MonadHTTP m, ToJSON body) =>
Text
-> Text
-> [QueryParameter]
-> Maybe body
-> RequestBodyEncoding
-> StripeT m (Response ByteString)
StripeAPI.Common.doBodyCallWithConfigurationM (Text -> Text
Data.Text.toUpper (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
GHC.Base.$ String -> Text
Data.Text.pack String
"POST") (String -> Text
Data.Text.pack (String
"/v1/identity/verification_sessions/" String -> String -> String
forall a. [a] -> [a] -> [a]
GHC.Base.++ (ByteString -> String
Data.ByteString.Char8.unpack (Bool -> ByteString -> ByteString
Network.HTTP.Types.URI.urlEncode Bool
GHC.Types.True (ByteString -> ByteString) -> ByteString -> ByteString
forall a b. (a -> b) -> a -> b
GHC.Base.$ (String -> ByteString
Data.ByteString.Char8.pack (String -> ByteString) -> String -> ByteString
forall a b. (a -> b) -> a -> b
GHC.Base.$ Text -> String
forall a. StringifyModel a => a -> String
StripeAPI.Common.stringifyModel Text
session)) String -> String -> String
forall a. [a] -> [a] -> [a]
GHC.Base.++ String
"/redact"))) [QueryParameter]
forall a. Monoid a => a
GHC.Base.mempty Maybe PostIdentityVerificationSessionsSessionRedactRequestBody
body RequestBodyEncoding
StripeAPI.Common.RequestBodyEncodingFormData)

-- | Defines the object schema located at @paths.\/v1\/identity\/verification_sessions\/{session}\/redact.POST.requestBody.content.application\/x-www-form-urlencoded.schema@ in the specification.
data PostIdentityVerificationSessionsSessionRedactRequestBody = PostIdentityVerificationSessionsSessionRedactRequestBody
  { -- | expand: Specifies which fields in the response should be expanded.
    PostIdentityVerificationSessionsSessionRedactRequestBody
-> Maybe [Text]
postIdentityVerificationSessionsSessionRedactRequestBodyExpand :: (GHC.Maybe.Maybe ([Data.Text.Internal.Text]))
  }
  deriving
    ( Int
-> PostIdentityVerificationSessionsSessionRedactRequestBody
-> String
-> String
[PostIdentityVerificationSessionsSessionRedactRequestBody]
-> String -> String
PostIdentityVerificationSessionsSessionRedactRequestBody -> String
(Int
 -> PostIdentityVerificationSessionsSessionRedactRequestBody
 -> String
 -> String)
-> (PostIdentityVerificationSessionsSessionRedactRequestBody
    -> String)
-> ([PostIdentityVerificationSessionsSessionRedactRequestBody]
    -> String -> String)
-> Show PostIdentityVerificationSessionsSessionRedactRequestBody
forall a.
(Int -> a -> String -> String)
-> (a -> String) -> ([a] -> String -> String) -> Show a
showList :: [PostIdentityVerificationSessionsSessionRedactRequestBody]
-> String -> String
$cshowList :: [PostIdentityVerificationSessionsSessionRedactRequestBody]
-> String -> String
show :: PostIdentityVerificationSessionsSessionRedactRequestBody -> String
$cshow :: PostIdentityVerificationSessionsSessionRedactRequestBody -> String
showsPrec :: Int
-> PostIdentityVerificationSessionsSessionRedactRequestBody
-> String
-> String
$cshowsPrec :: Int
-> PostIdentityVerificationSessionsSessionRedactRequestBody
-> String
-> String
GHC.Show.Show,
      PostIdentityVerificationSessionsSessionRedactRequestBody
-> PostIdentityVerificationSessionsSessionRedactRequestBody -> Bool
(PostIdentityVerificationSessionsSessionRedactRequestBody
 -> PostIdentityVerificationSessionsSessionRedactRequestBody
 -> Bool)
-> (PostIdentityVerificationSessionsSessionRedactRequestBody
    -> PostIdentityVerificationSessionsSessionRedactRequestBody
    -> Bool)
-> Eq PostIdentityVerificationSessionsSessionRedactRequestBody
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PostIdentityVerificationSessionsSessionRedactRequestBody
-> PostIdentityVerificationSessionsSessionRedactRequestBody -> Bool
$c/= :: PostIdentityVerificationSessionsSessionRedactRequestBody
-> PostIdentityVerificationSessionsSessionRedactRequestBody -> Bool
== :: PostIdentityVerificationSessionsSessionRedactRequestBody
-> PostIdentityVerificationSessionsSessionRedactRequestBody -> Bool
$c== :: PostIdentityVerificationSessionsSessionRedactRequestBody
-> PostIdentityVerificationSessionsSessionRedactRequestBody -> Bool
GHC.Classes.Eq
    )

instance Data.Aeson.Types.ToJSON.ToJSON PostIdentityVerificationSessionsSessionRedactRequestBody where
  toJSON :: PostIdentityVerificationSessionsSessionRedactRequestBody -> Value
toJSON PostIdentityVerificationSessionsSessionRedactRequestBody
obj = [Pair] -> Value
Data.Aeson.Types.Internal.object (Text
"expand" Text -> Maybe [Text] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= PostIdentityVerificationSessionsSessionRedactRequestBody
-> Maybe [Text]
postIdentityVerificationSessionsSessionRedactRequestBodyExpand PostIdentityVerificationSessionsSessionRedactRequestBody
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: [Pair]
forall a. Monoid a => a
GHC.Base.mempty)
  toEncoding :: PostIdentityVerificationSessionsSessionRedactRequestBody
-> Encoding
toEncoding PostIdentityVerificationSessionsSessionRedactRequestBody
obj = Series -> Encoding
Data.Aeson.Encoding.Internal.pairs (Text
"expand" Text -> Maybe [Text] -> Series
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Data.Aeson.Types.ToJSON..= PostIdentityVerificationSessionsSessionRedactRequestBody
-> Maybe [Text]
postIdentityVerificationSessionsSessionRedactRequestBodyExpand PostIdentityVerificationSessionsSessionRedactRequestBody
obj)

instance Data.Aeson.Types.FromJSON.FromJSON PostIdentityVerificationSessionsSessionRedactRequestBody where
  parseJSON :: Value
-> Parser PostIdentityVerificationSessionsSessionRedactRequestBody
parseJSON = String
-> (Object
    -> Parser PostIdentityVerificationSessionsSessionRedactRequestBody)
-> Value
-> Parser PostIdentityVerificationSessionsSessionRedactRequestBody
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.Aeson.Types.FromJSON.withObject String
"PostIdentityVerificationSessionsSessionRedactRequestBody" (\Object
obj -> (Maybe [Text]
 -> PostIdentityVerificationSessionsSessionRedactRequestBody)
-> Parser
     (Maybe [Text]
      -> PostIdentityVerificationSessionsSessionRedactRequestBody)
forall (f :: * -> *) a. Applicative f => a -> f a
GHC.Base.pure Maybe [Text]
-> PostIdentityVerificationSessionsSessionRedactRequestBody
PostIdentityVerificationSessionsSessionRedactRequestBody Parser
  (Maybe [Text]
   -> PostIdentityVerificationSessionsSessionRedactRequestBody)
-> Parser (Maybe [Text])
-> Parser PostIdentityVerificationSessionsSessionRedactRequestBody
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
GHC.Base.<*> (Object
obj Object -> Text -> Parser (Maybe [Text])
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Data.Aeson.Types.FromJSON..:? Text
"expand"))

-- | Create a new 'PostIdentityVerificationSessionsSessionRedactRequestBody' with all required fields.
mkPostIdentityVerificationSessionsSessionRedactRequestBody :: PostIdentityVerificationSessionsSessionRedactRequestBody
mkPostIdentityVerificationSessionsSessionRedactRequestBody :: PostIdentityVerificationSessionsSessionRedactRequestBody
mkPostIdentityVerificationSessionsSessionRedactRequestBody = PostIdentityVerificationSessionsSessionRedactRequestBody :: Maybe [Text]
-> PostIdentityVerificationSessionsSessionRedactRequestBody
PostIdentityVerificationSessionsSessionRedactRequestBody {postIdentityVerificationSessionsSessionRedactRequestBodyExpand :: Maybe [Text]
postIdentityVerificationSessionsSessionRedactRequestBodyExpand = Maybe [Text]
forall a. Maybe a
GHC.Maybe.Nothing}

-- | Represents a response of the operation 'postIdentityVerificationSessionsSessionRedact'.
--
-- The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), 'PostIdentityVerificationSessionsSessionRedactResponseError' is used.
data PostIdentityVerificationSessionsSessionRedactResponse
  = -- | Means either no matching case available or a parse error
    PostIdentityVerificationSessionsSessionRedactResponseError GHC.Base.String
  | -- | Successful response.
    PostIdentityVerificationSessionsSessionRedactResponse200 Identity'verificationSession
  | -- | Error response.
    PostIdentityVerificationSessionsSessionRedactResponseDefault Error
  deriving (Int
-> PostIdentityVerificationSessionsSessionRedactResponse
-> String
-> String
[PostIdentityVerificationSessionsSessionRedactResponse]
-> String -> String
PostIdentityVerificationSessionsSessionRedactResponse -> String
(Int
 -> PostIdentityVerificationSessionsSessionRedactResponse
 -> String
 -> String)
-> (PostIdentityVerificationSessionsSessionRedactResponse
    -> String)
-> ([PostIdentityVerificationSessionsSessionRedactResponse]
    -> String -> String)
-> Show PostIdentityVerificationSessionsSessionRedactResponse
forall a.
(Int -> a -> String -> String)
-> (a -> String) -> ([a] -> String -> String) -> Show a
showList :: [PostIdentityVerificationSessionsSessionRedactResponse]
-> String -> String
$cshowList :: [PostIdentityVerificationSessionsSessionRedactResponse]
-> String -> String
show :: PostIdentityVerificationSessionsSessionRedactResponse -> String
$cshow :: PostIdentityVerificationSessionsSessionRedactResponse -> String
showsPrec :: Int
-> PostIdentityVerificationSessionsSessionRedactResponse
-> String
-> String
$cshowsPrec :: Int
-> PostIdentityVerificationSessionsSessionRedactResponse
-> String
-> String
GHC.Show.Show, PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse -> Bool
(PostIdentityVerificationSessionsSessionRedactResponse
 -> PostIdentityVerificationSessionsSessionRedactResponse -> Bool)
-> (PostIdentityVerificationSessionsSessionRedactResponse
    -> PostIdentityVerificationSessionsSessionRedactResponse -> Bool)
-> Eq PostIdentityVerificationSessionsSessionRedactResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse -> Bool
$c/= :: PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse -> Bool
== :: PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse -> Bool
$c== :: PostIdentityVerificationSessionsSessionRedactResponse
-> PostIdentityVerificationSessionsSessionRedactResponse -> Bool
GHC.Classes.Eq)