Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostInvoicesInvoiceFinalize

Description

Contains the different functions to run the operation postInvoicesInvoiceFinalize

Synopsis

postInvoicesInvoiceFinalize :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> m (Either HttpException (Response PostInvoicesInvoiceFinalizeResponse))
postInvoicesInvoiceFinalizeRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> m (Either HttpException (Response ByteString))
postInvoicesInvoiceFinalizeM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceFinalizeResponse))
postInvoicesInvoiceFinalizeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostInvoicesInvoiceFinalizeRequestBody = PostInvoicesInvoiceFinalizeRequestBody {
- postInvoicesInvoiceFinalizeRequestBodyAutoAdvance :: Maybe Bool
- postInvoicesInvoiceFinalizeRequestBodyExpand :: Maybe ([] Text)
}
data PostInvoicesInvoiceFinalizeResponse

Documentation

postInvoicesInvoiceFinalize Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	invoice \| Constraints: Maximum length of 5000
-> Maybe PostInvoicesInvoiceFinalizeRequestBody	The request body to send
-> m (Either HttpException (Response PostInvoicesInvoiceFinalizeResponse))	Monad containing the result of the operation

POST /v1/invoices/{invoice}/finalize

<p>Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.</p>

postInvoicesInvoiceFinalizeRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/invoices/{invoice}/finalize

The same as postInvoicesInvoiceFinalize but returns the raw ByteString

postInvoicesInvoiceFinalizeM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostInvoicesInvoiceFinalizeResponse)) Source #

POST /v1/invoices/{invoice}/finalize

Monadic version of postInvoicesInvoiceFinalize (use with runWithConfiguration)

postInvoicesInvoiceFinalizeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostInvoicesInvoiceFinalizeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/invoices/{invoice}/finalize

Monadic version of postInvoicesInvoiceFinalizeRaw (use with runWithConfiguration)

data PostInvoicesInvoiceFinalizeRequestBody Source #

Defines the data type for the schema postInvoicesInvoiceFinalizeRequestBody

Constructors

PostInvoicesInvoiceFinalizeRequestBody
Fields postInvoicesInvoiceFinalizeRequestBodyAutoAdvance :: Maybe Bool auto_advance: Controls whether Stripe will perform automatic collection of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. postInvoicesInvoiceFinalizeRequestBodyExpand :: Maybe ([] Text) expand: Specifies which fields in the response should be expanded.

Instances

Eq PostInvoicesInvoiceFinalizeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceFinalize Methods (==) :: PostInvoicesInvoiceFinalizeRequestBody -> PostInvoicesInvoiceFinalizeRequestBody -> Bool # (/=) :: PostInvoicesInvoiceFinalizeRequestBody -> PostInvoicesInvoiceFinalizeRequestBody -> Bool #
Show PostInvoicesInvoiceFinalizeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceFinalize Methods showsPrec :: Int -> PostInvoicesInvoiceFinalizeRequestBody -> ShowS # show :: PostInvoicesInvoiceFinalizeRequestBody -> String # showList :: [PostInvoicesInvoiceFinalizeRequestBody] -> ShowS #
ToJSON PostInvoicesInvoiceFinalizeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceFinalize Methods toJSON :: PostInvoicesInvoiceFinalizeRequestBody -> Value # toEncoding :: PostInvoicesInvoiceFinalizeRequestBody -> Encoding # toJSONList :: [PostInvoicesInvoiceFinalizeRequestBody] -> Value # toEncodingList :: [PostInvoicesInvoiceFinalizeRequestBody] -> Encoding #
FromJSON PostInvoicesInvoiceFinalizeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceFinalize Methods parseJSON :: Value -> Parser PostInvoicesInvoiceFinalizeRequestBody # parseJSONList :: Value -> Parser [PostInvoicesInvoiceFinalizeRequestBody] #

data PostInvoicesInvoiceFinalizeResponse Source #

Represents a response of the operation postInvoicesInvoiceFinalize.

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), PostInvoicesInvoiceFinalizeResponseError is used.

Constructors

PostInvoicesInvoiceFinalizeResponseError String	Means either no matching case available or a parse error
PostInvoicesInvoiceFinalizeResponse200 Invoice	Successful response.
PostInvoicesInvoiceFinalizeResponseDefault Error	Error response.

Instances

Eq PostInvoicesInvoiceFinalizeResponse Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceFinalize Methods (==) :: PostInvoicesInvoiceFinalizeResponse -> PostInvoicesInvoiceFinalizeResponse -> Bool # (/=) :: PostInvoicesInvoiceFinalizeResponse -> PostInvoicesInvoiceFinalizeResponse -> Bool #
Show PostInvoicesInvoiceFinalizeResponse Source #
Instance details Defined in StripeAPI.Operations.PostInvoicesInvoiceFinalize Methods showsPrec :: Int -> PostInvoicesInvoiceFinalizeResponse -> ShowS # show :: PostInvoicesInvoiceFinalizeResponse -> String # showList :: [PostInvoicesInvoiceFinalizeResponse] -> ShowS #