Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostCreditNotesId

Description

Contains the different functions to run the operation postCreditNotesId

Synopsis

postCreditNotesId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCreditNotesIdRequestBody -> m (Either HttpException (Response PostCreditNotesIdResponse))
postCreditNotesIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostCreditNotesIdRequestBody -> m (Either HttpException (Response ByteString))
postCreditNotesIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCreditNotesIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCreditNotesIdResponse))
postCreditNotesIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCreditNotesIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostCreditNotesIdRequestBody = PostCreditNotesIdRequestBody {
}
data PostCreditNotesIdRequestBodyMetadata' = PostCreditNotesIdRequestBodyMetadata' {
}
data PostCreditNotesIdResponse

Documentation

postCreditNotesId Source #

Arguments

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

POST /v1/credit_notes/{id}

<p>Updates an existing credit note.</p>

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

POST /v1/credit_notes/{id}

The same as postCreditNotesId but returns the raw ByteString

postCreditNotesIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostCreditNotesIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCreditNotesIdResponse)) Source #

POST /v1/credit_notes/{id}

Monadic version of postCreditNotesId (use with runWithConfiguration)

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

POST /v1/credit_notes/{id}

Monadic version of postCreditNotesIdRaw (use with runWithConfiguration)

data PostCreditNotesIdRequestBody Source #

Defines the data type for the schema postCreditNotesIdRequestBody

Constructors

PostCreditNotesIdRequestBody

Fields

postCreditNotesIdRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postCreditNotesIdRequestBodyMemo :: Maybe Text
memo: Credit note memo.
Constraints:
- Maximum length of 5000
postCreditNotesIdRequestBodyMetadata :: Maybe PostCreditNotesIdRequestBodyMetadata'
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Instances

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

data PostCreditNotesIdRequestBodyMetadata' Source #

Defines the data type for the schema postCreditNotesIdRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostCreditNotesIdRequestBodyMetadata'

Instances

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

data PostCreditNotesIdResponse Source #

Represents a response of the operation postCreditNotesId.

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

Constructors

PostCreditNotesIdResponseError String	Means either no matching case available or a parse error
PostCreditNotesIdResponse200 CreditNote	Successful response.
PostCreditNotesIdResponseDefault Error	Error response.

Instances

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