{-# 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 postCreditNotesIdVoid
module StripeAPI.Operations.PostCreditNotesIdVoid 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/credit_notes/{id}/void
--
-- \<p>Marks a credit note as void. Learn more about \<a href=\"\/docs\/billing\/invoices\/credit-notes\#voiding\">voiding credit notes\<\/a>.\<\/p>
postCreditNotesIdVoid ::
  forall m.
  StripeAPI.Common.MonadHTTP m =>
  -- | id | Constraints: Maximum length of 5000
  Data.Text.Internal.Text ->
  -- | The request body to send
  GHC.Maybe.Maybe PostCreditNotesIdVoidRequestBody ->
  -- | Monadic computation which returns the result of the operation
  StripeAPI.Common.StripeT m (Network.HTTP.Client.Types.Response PostCreditNotesIdVoidResponse)
postCreditNotesIdVoid :: Text
-> Maybe PostCreditNotesIdVoidRequestBody
-> StripeT m (Response PostCreditNotesIdVoidResponse)
postCreditNotesIdVoid
  Text
id
  Maybe PostCreditNotesIdVoidRequestBody
body =
    (Response ByteString -> Response PostCreditNotesIdVoidResponse)
-> StripeT m (Response ByteString)
-> StripeT m (Response PostCreditNotesIdVoidResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
      ( \Response ByteString
response_0 ->
          (ByteString -> PostCreditNotesIdVoidResponse)
-> Response ByteString -> Response PostCreditNotesIdVoidResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
            ( (String -> PostCreditNotesIdVoidResponse)
-> (PostCreditNotesIdVoidResponse -> PostCreditNotesIdVoidResponse)
-> Either String PostCreditNotesIdVoidResponse
-> PostCreditNotesIdVoidResponse
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
Data.Either.either String -> PostCreditNotesIdVoidResponse
PostCreditNotesIdVoidResponseError PostCreditNotesIdVoidResponse -> PostCreditNotesIdVoidResponse
forall a. a -> a
GHC.Base.id
                (Either String PostCreditNotesIdVoidResponse
 -> PostCreditNotesIdVoidResponse)
-> (ByteString -> Either String PostCreditNotesIdVoidResponse)
-> ByteString
-> PostCreditNotesIdVoidResponse
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) ->
                                     CreditNote -> PostCreditNotesIdVoidResponse
PostCreditNotesIdVoidResponse200
                                       (CreditNote -> PostCreditNotesIdVoidResponse)
-> Either String CreditNote
-> Either String PostCreditNotesIdVoidResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> ( ByteString -> Either String CreditNote
forall a. FromJSON a => ByteString -> Either String a
Data.Aeson.eitherDecodeStrict ByteString
body ::
                                                            Data.Either.Either
                                                              GHC.Base.String
                                                              CreditNote
                                                        )
                                   | 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 -> PostCreditNotesIdVoidResponse
PostCreditNotesIdVoidResponseDefault
                                       (Error -> PostCreditNotesIdVoidResponse)
-> Either String Error
-> Either String PostCreditNotesIdVoidResponse
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 PostCreditNotesIdVoidResponse
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 PostCreditNotesIdVoidRequestBody
-> 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/credit_notes/" 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
id)) String -> String -> String
forall a. [a] -> [a] -> [a]
GHC.Base.++ String
"/void"))) [QueryParameter]
forall a. Monoid a => a
GHC.Base.mempty Maybe PostCreditNotesIdVoidRequestBody
body RequestBodyEncoding
StripeAPI.Common.RequestBodyEncodingFormData)

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

instance Data.Aeson.Types.ToJSON.ToJSON PostCreditNotesIdVoidRequestBody where
  toJSON :: PostCreditNotesIdVoidRequestBody -> Value
toJSON PostCreditNotesIdVoidRequestBody
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..= PostCreditNotesIdVoidRequestBody -> Maybe [Text]
postCreditNotesIdVoidRequestBodyExpand PostCreditNotesIdVoidRequestBody
obj Pair -> [Pair] -> [Pair]
forall a. a -> [a] -> [a]
: [Pair]
forall a. Monoid a => a
GHC.Base.mempty)
  toEncoding :: PostCreditNotesIdVoidRequestBody -> Encoding
toEncoding PostCreditNotesIdVoidRequestBody
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..= PostCreditNotesIdVoidRequestBody -> Maybe [Text]
postCreditNotesIdVoidRequestBodyExpand PostCreditNotesIdVoidRequestBody
obj)

instance Data.Aeson.Types.FromJSON.FromJSON PostCreditNotesIdVoidRequestBody where
  parseJSON :: Value -> Parser PostCreditNotesIdVoidRequestBody
parseJSON = String
-> (Object -> Parser PostCreditNotesIdVoidRequestBody)
-> Value
-> Parser PostCreditNotesIdVoidRequestBody
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.Aeson.Types.FromJSON.withObject String
"PostCreditNotesIdVoidRequestBody" (\Object
obj -> (Maybe [Text] -> PostCreditNotesIdVoidRequestBody)
-> Parser (Maybe [Text] -> PostCreditNotesIdVoidRequestBody)
forall (f :: * -> *) a. Applicative f => a -> f a
GHC.Base.pure Maybe [Text] -> PostCreditNotesIdVoidRequestBody
PostCreditNotesIdVoidRequestBody Parser (Maybe [Text] -> PostCreditNotesIdVoidRequestBody)
-> Parser (Maybe [Text]) -> Parser PostCreditNotesIdVoidRequestBody
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 'PostCreditNotesIdVoidRequestBody' with all required fields.
mkPostCreditNotesIdVoidRequestBody :: PostCreditNotesIdVoidRequestBody
mkPostCreditNotesIdVoidRequestBody :: PostCreditNotesIdVoidRequestBody
mkPostCreditNotesIdVoidRequestBody = PostCreditNotesIdVoidRequestBody :: Maybe [Text] -> PostCreditNotesIdVoidRequestBody
PostCreditNotesIdVoidRequestBody {postCreditNotesIdVoidRequestBodyExpand :: Maybe [Text]
postCreditNotesIdVoidRequestBodyExpand = Maybe [Text]
forall a. Maybe a
GHC.Maybe.Nothing}

-- | Represents a response of the operation 'postCreditNotesIdVoid'.
--
-- 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), 'PostCreditNotesIdVoidResponseError' is used.
data PostCreditNotesIdVoidResponse
  = -- | Means either no matching case available or a parse error
    PostCreditNotesIdVoidResponseError GHC.Base.String
  | -- | Successful response.
    PostCreditNotesIdVoidResponse200 CreditNote
  | -- | Error response.
    PostCreditNotesIdVoidResponseDefault Error
  deriving (Int -> PostCreditNotesIdVoidResponse -> String -> String
[PostCreditNotesIdVoidResponse] -> String -> String
PostCreditNotesIdVoidResponse -> String
(Int -> PostCreditNotesIdVoidResponse -> String -> String)
-> (PostCreditNotesIdVoidResponse -> String)
-> ([PostCreditNotesIdVoidResponse] -> String -> String)
-> Show PostCreditNotesIdVoidResponse
forall a.
(Int -> a -> String -> String)
-> (a -> String) -> ([a] -> String -> String) -> Show a
showList :: [PostCreditNotesIdVoidResponse] -> String -> String
$cshowList :: [PostCreditNotesIdVoidResponse] -> String -> String
show :: PostCreditNotesIdVoidResponse -> String
$cshow :: PostCreditNotesIdVoidResponse -> String
showsPrec :: Int -> PostCreditNotesIdVoidResponse -> String -> String
$cshowsPrec :: Int -> PostCreditNotesIdVoidResponse -> String -> String
GHC.Show.Show, PostCreditNotesIdVoidResponse
-> PostCreditNotesIdVoidResponse -> Bool
(PostCreditNotesIdVoidResponse
 -> PostCreditNotesIdVoidResponse -> Bool)
-> (PostCreditNotesIdVoidResponse
    -> PostCreditNotesIdVoidResponse -> Bool)
-> Eq PostCreditNotesIdVoidResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PostCreditNotesIdVoidResponse
-> PostCreditNotesIdVoidResponse -> Bool
$c/= :: PostCreditNotesIdVoidResponse
-> PostCreditNotesIdVoidResponse -> Bool
== :: PostCreditNotesIdVoidResponse
-> PostCreditNotesIdVoidResponse -> Bool
$c== :: PostCreditNotesIdVoidResponse
-> PostCreditNotesIdVoidResponse -> Bool
GHC.Classes.Eq)