Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.GetCreditNotes
Description
Contains the different functions to run the operation getCreditNotes
Synopsis
- getCreditNotes :: forall m. MonadHTTP m => GetCreditNotesParameters -> StripeT m (Response GetCreditNotesResponse)
- data GetCreditNotesParameters = GetCreditNotesParameters {
- getCreditNotesParametersQueryCustomer :: Maybe Text
- getCreditNotesParametersQueryEndingBefore :: Maybe Text
- getCreditNotesParametersQueryExpand :: Maybe [Text]
- getCreditNotesParametersQueryInvoice :: Maybe Text
- getCreditNotesParametersQueryLimit :: Maybe Int
- getCreditNotesParametersQueryStartingAfter :: Maybe Text
- mkGetCreditNotesParameters :: GetCreditNotesParameters
- data GetCreditNotesResponse
- data GetCreditNotesResponseBody200 = GetCreditNotesResponseBody200 {}
- mkGetCreditNotesResponseBody200 :: [CreditNote] -> Bool -> Text -> GetCreditNotesResponseBody200
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> GetCreditNotesParameters | Contains all available parameters of this operation (query and path parameters) |
-> StripeT m (Response GetCreditNotesResponse) | Monadic computation which returns the result of the operation |
GET /v1/credit_notes
<p>Returns a list of credit notes.</p>
data GetCreditNotesParameters Source #
Defines the object schema located at paths./v1/credit_notes.GET.parameters
in the specification.
Constructors
GetCreditNotesParameters | |
Fields
|
Instances
Eq GetCreditNotesParameters Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods (==) :: GetCreditNotesParameters -> GetCreditNotesParameters -> Bool # (/=) :: GetCreditNotesParameters -> GetCreditNotesParameters -> Bool # | |
Show GetCreditNotesParameters Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods showsPrec :: Int -> GetCreditNotesParameters -> ShowS # show :: GetCreditNotesParameters -> String # showList :: [GetCreditNotesParameters] -> ShowS # | |
ToJSON GetCreditNotesParameters Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods toJSON :: GetCreditNotesParameters -> Value # toEncoding :: GetCreditNotesParameters -> Encoding # toJSONList :: [GetCreditNotesParameters] -> Value # | |
FromJSON GetCreditNotesParameters Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods parseJSON :: Value -> Parser GetCreditNotesParameters # parseJSONList :: Value -> Parser [GetCreditNotesParameters] # |
mkGetCreditNotesParameters :: GetCreditNotesParameters Source #
Create a new GetCreditNotesParameters
with all required fields.
data GetCreditNotesResponse Source #
Represents a response of the operation getCreditNotes
.
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), GetCreditNotesResponseError
is used.
Constructors
GetCreditNotesResponseError String | Means either no matching case available or a parse error |
GetCreditNotesResponse200 GetCreditNotesResponseBody200 | Successful response. |
GetCreditNotesResponseDefault Error | Error response. |
Instances
Eq GetCreditNotesResponse Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods (==) :: GetCreditNotesResponse -> GetCreditNotesResponse -> Bool # (/=) :: GetCreditNotesResponse -> GetCreditNotesResponse -> Bool # | |
Show GetCreditNotesResponse Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods showsPrec :: Int -> GetCreditNotesResponse -> ShowS # show :: GetCreditNotesResponse -> String # showList :: [GetCreditNotesResponse] -> ShowS # |
data GetCreditNotesResponseBody200 Source #
Defines the object schema located at paths./v1/credit_notes.GET.responses.200.content.application/json.schema
in the specification.
Constructors
GetCreditNotesResponseBody200 | |
Fields
|
Instances
Eq GetCreditNotesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetCreditNotes | |
Show GetCreditNotesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods showsPrec :: Int -> GetCreditNotesResponseBody200 -> ShowS # show :: GetCreditNotesResponseBody200 -> String # showList :: [GetCreditNotesResponseBody200] -> ShowS # | |
ToJSON GetCreditNotesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods toJSON :: GetCreditNotesResponseBody200 -> Value # toEncoding :: GetCreditNotesResponseBody200 -> Encoding # toJSONList :: [GetCreditNotesResponseBody200] -> Value # toEncodingList :: [GetCreditNotesResponseBody200] -> Encoding # | |
FromJSON GetCreditNotesResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetCreditNotes Methods parseJSON :: Value -> Parser GetCreditNotesResponseBody200 # parseJSONList :: Value -> Parser [GetCreditNotesResponseBody200] # |
mkGetCreditNotesResponseBody200 Source #
Arguments
:: [CreditNote] | |
-> Bool | |
-> Text | |
-> GetCreditNotesResponseBody200 |
Create a new GetCreditNotesResponseBody200
with all required fields.