{-# 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 list_related_invoices
module RecurlyClient.Operations.List_related_invoices 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
import qualified Data.ByteString as Data.ByteString.Internal
import qualified Data.ByteString as Data.ByteString.Internal.Type
import qualified Data.Either
import qualified Data.Foldable
import qualified Data.Functor
import qualified Data.Maybe
import qualified Data.Scientific
import qualified Data.Text
import qualified Data.Text as 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 RecurlyClient.Common
import RecurlyClient.Types
import qualified Prelude as GHC.Integer.Type
import qualified Prelude as GHC.Maybe

{- | > GET /invoices/{invoice_id}/related_invoices

Related invoices provide a link between credit invoices and the charge invoices that they are refunding.
For a charge invoice the related invoices will be credit invoices.
For a credit invoice the related invoices will be charge invoices.

See the [Pagination Guide](\/developers\/guides\/pagination.html) to learn how to use pagination in the API and Client Libraries.
-}
list_related_invoices ::
    forall m.
    (RecurlyClient.Common.MonadHTTP m) =>
    -- | invoice_id: Invoice ID or number. For ID no prefix is used e.g. \`e28zov4fw0v2\`. For number use prefix \`number-\`, e.g. \`number-1000\`.
    Data.Text.Internal.Text ->
    -- | Monadic computation which returns the result of the operation
    RecurlyClient.Common.ClientT m (Network.HTTP.Client.Types.Response List_related_invoicesResponse)
list_related_invoices :: forall (m :: * -> *).
MonadHTTP m =>
Text -> ClientT m (Response List_related_invoicesResponse)
list_related_invoices Text
invoice_id =
    (Response ByteString -> Response List_related_invoicesResponse)
-> ClientT m (Response ByteString)
-> ClientT m (Response List_related_invoicesResponse)
forall a b. (a -> b) -> ClientT m a -> ClientT m b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
        ( \Response ByteString
response_0 ->
            (ByteString -> List_related_invoicesResponse)
-> Response ByteString -> Response List_related_invoicesResponse
forall a b. (a -> b) -> Response a -> Response b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
                ( (String -> List_related_invoicesResponse)
-> (List_related_invoicesResponse -> List_related_invoicesResponse)
-> Either String List_related_invoicesResponse
-> List_related_invoicesResponse
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
Data.Either.either String -> List_related_invoicesResponse
List_related_invoicesResponseError List_related_invoicesResponse -> List_related_invoicesResponse
forall a. a -> a
GHC.Base.id
                    (Either String List_related_invoicesResponse
 -> List_related_invoicesResponse)
-> (ByteString -> Either String List_related_invoicesResponse)
-> ByteString
-> List_related_invoicesResponse
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) ->
                                            InvoiceList -> List_related_invoicesResponse
List_related_invoicesResponse200
                                                (InvoiceList -> List_related_invoicesResponse)
-> Either String InvoiceList
-> Either String List_related_invoicesResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> ( ByteString -> Either String InvoiceList
forall a. FromJSON a => ByteString -> Either String a
Data.Aeson.eitherDecodeStrict ByteString
body ::
                                                                    Data.Either.Either
                                                                        GHC.Base.String
                                                                        InvoiceList
                                                                 )
                                        | (\Status
status_2 -> Status -> Int
Network.HTTP.Types.Status.statusCode Status
status_2 Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
GHC.Classes.== Int
404) (Response ByteString -> Status
forall body. Response body -> Status
Network.HTTP.Client.Types.responseStatus Response ByteString
response) ->
                                            Error -> List_related_invoicesResponse
List_related_invoicesResponse404
                                                (Error -> List_related_invoicesResponse)
-> Either String Error
-> Either String List_related_invoicesResponse
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 -> 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 -> List_related_invoicesResponse
List_related_invoicesResponseDefault
                                                (Error -> List_related_invoicesResponse)
-> Either String Error
-> Either String List_related_invoicesResponse
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 List_related_invoicesResponse
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] -> ClientT m (Response ByteString)
forall (m :: * -> *).
MonadHTTP m =>
Text -> Text -> [QueryParameter] -> ClientT m (Response ByteString)
RecurlyClient.Common.doCallWithConfigurationM (Text -> Text
Data.Text.toUpper (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
GHC.Base.$ String -> Text
Data.Text.Internal.pack String
"GET") (Text
"/invoices/" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> (ByteString -> Text
RecurlyClient.Common.byteToText (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.$ (Text -> ByteString
RecurlyClient.Common.textToByte (Text -> ByteString) -> Text -> ByteString
forall a b. (a -> b) -> a -> b
GHC.Base.$ Text -> Text
forall a. ToJSON a => a -> Text
RecurlyClient.Common.stringifyModel Text
invoice_id)) Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> Text
"/related_invoices")) [QueryParameter]
forall a. Monoid a => a
GHC.Base.mempty)

{- | Represents a response of the operation 'list_related_invoices'.

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), 'List_related_invoicesResponseError' is used.
-}
data List_related_invoicesResponse
    = -- | Means either no matching case available or a parse error
      List_related_invoicesResponseError GHC.Base.String
    | -- | A list of the credit or charge invoices associated with the invoice.
      List_related_invoicesResponse200 InvoiceList
    | -- | Incorrect site or invoice ID.
      List_related_invoicesResponse404 Error
    | -- | Unexpected error.
      List_related_invoicesResponseDefault Error
    deriving (Int -> List_related_invoicesResponse -> ShowS
[List_related_invoicesResponse] -> ShowS
List_related_invoicesResponse -> String
(Int -> List_related_invoicesResponse -> ShowS)
-> (List_related_invoicesResponse -> String)
-> ([List_related_invoicesResponse] -> ShowS)
-> Show List_related_invoicesResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> List_related_invoicesResponse -> ShowS
showsPrec :: Int -> List_related_invoicesResponse -> ShowS
$cshow :: List_related_invoicesResponse -> String
show :: List_related_invoicesResponse -> String
$cshowList :: [List_related_invoicesResponse] -> ShowS
showList :: [List_related_invoicesResponse] -> ShowS
GHC.Show.Show, List_related_invoicesResponse
-> List_related_invoicesResponse -> Bool
(List_related_invoicesResponse
 -> List_related_invoicesResponse -> Bool)
-> (List_related_invoicesResponse
    -> List_related_invoicesResponse -> Bool)
-> Eq List_related_invoicesResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: List_related_invoicesResponse
-> List_related_invoicesResponse -> Bool
== :: List_related_invoicesResponse
-> List_related_invoicesResponse -> Bool
$c/= :: List_related_invoicesResponse
-> List_related_invoicesResponse -> Bool
/= :: List_related_invoicesResponse
-> List_related_invoicesResponse -> Bool
GHC.Classes.Eq)

{- | > GET /invoices/{invoice_id}/related_invoices

The same as 'list_related_invoices' but accepts an explicit configuration.
-}
list_related_invoicesWithConfiguration ::
    forall m.
    (RecurlyClient.Common.MonadHTTP m) =>
    -- | The configuration to use in the request
    RecurlyClient.Common.Configuration ->
    -- | invoice_id: Invoice ID or number. For ID no prefix is used e.g. \`e28zov4fw0v2\`. For number use prefix \`number-\`, e.g. \`number-1000\`.
    Data.Text.Internal.Text ->
    -- | Monadic computation which returns the result of the operation
    m (Network.HTTP.Client.Types.Response List_related_invoicesResponse)
list_related_invoicesWithConfiguration :: forall (m :: * -> *).
MonadHTTP m =>
Configuration -> Text -> m (Response List_related_invoicesResponse)
list_related_invoicesWithConfiguration
    Configuration
config
    Text
invoice_id =
        (Response ByteString -> Response List_related_invoicesResponse)
-> m (Response ByteString)
-> m (Response List_related_invoicesResponse)
forall a b. (a -> b) -> m a -> m b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
            ( \Response ByteString
response_3 ->
                (ByteString -> List_related_invoicesResponse)
-> Response ByteString -> Response List_related_invoicesResponse
forall a b. (a -> b) -> Response a -> Response b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
GHC.Base.fmap
                    ( (String -> List_related_invoicesResponse)
-> (List_related_invoicesResponse -> List_related_invoicesResponse)
-> Either String List_related_invoicesResponse
-> List_related_invoicesResponse
forall a c b. (a -> c) -> (b -> c) -> Either a b -> c
Data.Either.either String -> List_related_invoicesResponse
List_related_invoicesResponseError List_related_invoicesResponse -> List_related_invoicesResponse
forall a. a -> a
GHC.Base.id
                        (Either String List_related_invoicesResponse
 -> List_related_invoicesResponse)
-> (ByteString -> Either String List_related_invoicesResponse)
-> ByteString
-> List_related_invoicesResponse
forall b c a. (b -> c) -> (a -> b) -> a -> c
GHC.Base.. ( \Response ByteString
response ByteString
body ->
                                        if
                                            | (\Status
status_4 -> Status -> Int
Network.HTTP.Types.Status.statusCode Status
status_4 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) ->
                                                InvoiceList -> List_related_invoicesResponse
List_related_invoicesResponse200
                                                    (InvoiceList -> List_related_invoicesResponse)
-> Either String InvoiceList
-> Either String List_related_invoicesResponse
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Data.Functor.<$> ( ByteString -> Either String InvoiceList
forall a. FromJSON a => ByteString -> Either String a
Data.Aeson.eitherDecodeStrict ByteString
body ::
                                                                        Data.Either.Either
                                                                            GHC.Base.String
                                                                            InvoiceList
                                                                     )
                                            | (\Status
status_5 -> Status -> Int
Network.HTTP.Types.Status.statusCode Status
status_5 Int -> Int -> Bool
forall a. Eq a => a -> a -> Bool
GHC.Classes.== Int
404) (Response ByteString -> Status
forall body. Response body -> Status
Network.HTTP.Client.Types.responseStatus Response ByteString
response) ->
                                                Error -> List_related_invoicesResponse
List_related_invoicesResponse404
                                                    (Error -> List_related_invoicesResponse)
-> Either String Error
-> Either String List_related_invoicesResponse
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 -> 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 -> List_related_invoicesResponse
List_related_invoicesResponseDefault
                                                    (Error -> List_related_invoicesResponse)
-> Either String Error
-> Either String List_related_invoicesResponse
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 List_related_invoicesResponse
forall a b. a -> Either a b
Data.Either.Left String
"Missing default response type"
                                   )
                            Response ByteString
response_3
                    )
                    Response ByteString
response_3
            )
            (Configuration
-> Text -> Text -> [QueryParameter] -> m (Response ByteString)
forall (m :: * -> *).
MonadHTTP m =>
Configuration
-> Text -> Text -> [QueryParameter] -> m (Response ByteString)
RecurlyClient.Common.doCallWithConfiguration Configuration
config (Text -> Text
Data.Text.toUpper (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
GHC.Base.$ String -> Text
Data.Text.Internal.pack String
"GET") (Text
"/invoices/" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> (ByteString -> Text
RecurlyClient.Common.byteToText (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.$ (Text -> ByteString
RecurlyClient.Common.textToByte (Text -> ByteString) -> Text -> ByteString
forall a b. (a -> b) -> a -> b
GHC.Base.$ Text -> Text
forall a. ToJSON a => a -> Text
RecurlyClient.Common.stringifyModel Text
invoice_id)) Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> Text
"/related_invoices")) [QueryParameter]
forall a. Monoid a => a
GHC.Base.mempty)

{- | > GET /invoices/{invoice_id}/related_invoices

The same as 'list_related_invoices' but returns the raw 'Data.ByteString.ByteString'.
-}
list_related_invoicesRaw ::
    forall m.
    (RecurlyClient.Common.MonadHTTP m) =>
    -- | invoice_id: Invoice ID or number. For ID no prefix is used e.g. \`e28zov4fw0v2\`. For number use prefix \`number-\`, e.g. \`number-1000\`.
    Data.Text.Internal.Text ->
    -- | Monadic computation which returns the result of the operation
    RecurlyClient.Common.ClientT m (Network.HTTP.Client.Types.Response Data.ByteString.Internal.Type.ByteString)
list_related_invoicesRaw :: forall (m :: * -> *).
MonadHTTP m =>
Text -> ClientT m (Response ByteString)
list_related_invoicesRaw Text
invoice_id = ClientT m (Response ByteString) -> ClientT m (Response ByteString)
forall a. a -> a
GHC.Base.id (Text -> Text -> [QueryParameter] -> ClientT m (Response ByteString)
forall (m :: * -> *).
MonadHTTP m =>
Text -> Text -> [QueryParameter] -> ClientT m (Response ByteString)
RecurlyClient.Common.doCallWithConfigurationM (Text -> Text
Data.Text.toUpper (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
GHC.Base.$ String -> Text
Data.Text.Internal.pack String
"GET") (Text
"/invoices/" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> (ByteString -> Text
RecurlyClient.Common.byteToText (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.$ (Text -> ByteString
RecurlyClient.Common.textToByte (Text -> ByteString) -> Text -> ByteString
forall a b. (a -> b) -> a -> b
GHC.Base.$ Text -> Text
forall a. ToJSON a => a -> Text
RecurlyClient.Common.stringifyModel Text
invoice_id)) Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> Text
"/related_invoices")) [QueryParameter]
forall a. Monoid a => a
GHC.Base.mempty)

{- | > GET /invoices/{invoice_id}/related_invoices

The same as 'list_related_invoices' but accepts an explicit configuration and returns the raw 'Data.ByteString.ByteString'.
-}
list_related_invoicesWithConfigurationRaw ::
    forall m.
    (RecurlyClient.Common.MonadHTTP m) =>
    -- | The configuration to use in the request
    RecurlyClient.Common.Configuration ->
    -- | invoice_id: Invoice ID or number. For ID no prefix is used e.g. \`e28zov4fw0v2\`. For number use prefix \`number-\`, e.g. \`number-1000\`.
    Data.Text.Internal.Text ->
    -- | Monadic computation which returns the result of the operation
    m (Network.HTTP.Client.Types.Response Data.ByteString.Internal.Type.ByteString)
list_related_invoicesWithConfigurationRaw :: forall (m :: * -> *).
MonadHTTP m =>
Configuration -> Text -> m (Response ByteString)
list_related_invoicesWithConfigurationRaw
    Configuration
config
    Text
invoice_id = m (Response ByteString) -> m (Response ByteString)
forall a. a -> a
GHC.Base.id (Configuration
-> Text -> Text -> [QueryParameter] -> m (Response ByteString)
forall (m :: * -> *).
MonadHTTP m =>
Configuration
-> Text -> Text -> [QueryParameter] -> m (Response ByteString)
RecurlyClient.Common.doCallWithConfiguration Configuration
config (Text -> Text
Data.Text.toUpper (Text -> Text) -> Text -> Text
forall a b. (a -> b) -> a -> b
GHC.Base.$ String -> Text
Data.Text.Internal.pack String
"GET") (Text
"/invoices/" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> (ByteString -> Text
RecurlyClient.Common.byteToText (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.$ (Text -> ByteString
RecurlyClient.Common.textToByte (Text -> ByteString) -> Text -> ByteString
forall a b. (a -> b) -> a -> b
GHC.Base.$ Text -> Text
forall a. ToJSON a => a -> Text
RecurlyClient.Common.stringifyModel Text
invoice_id)) Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
GHC.Base.<> Text
"/related_invoices")) [QueryParameter]
forall a. Monoid a => a
GHC.Base.mempty)