Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetCreditNotes

Description

Contains the different functions to run the operation getCreditNotes

Synopsis

getCreditNotes :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> m (Either HttpException (Response GetCreditNotesResponse))
getCreditNotesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> m (Either HttpException (Response ByteString))
getCreditNotesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesResponse))
getCreditNotesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetCreditNotesRequestBody = GetCreditNotesRequestBody {
}
data GetCreditNotesResponse
data GetCreditNotesResponseBody200 = GetCreditNotesResponseBody200 {
}
data GetCreditNotesResponseBody200Object'

Documentation

getCreditNotes Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe String	customer: Only return credit notes for the customer specified by this customer ID. \| Constraints: Maximum length of 5000
-> Maybe String	ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. \| Constraints: Maximum length of 5000
-> Maybe String	expand: Specifies which fields in the response should be expanded.
-> Maybe String	invoice: Only return credit notes for the invoice specified by this invoice ID. \| Constraints: Maximum length of 5000
-> Maybe Integer	limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-> Maybe String	starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. \| Constraints: Maximum length of 5000
-> GetCreditNotesRequestBody	The request body to send
-> m (Either HttpException (Response GetCreditNotesResponse))	Monad containing the result of the operation

GET /v1/credit_notes

<p>Returns a list of credit notes.</p>

getCreditNotesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/credit_notes

The same as getCreditNotes but returns the raw ByteString

getCreditNotesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesResponse)) Source #

GET /v1/credit_notes

Monadic version of getCreditNotes (use with runWithConfiguration)

getCreditNotesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCreditNotesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/credit_notes

Monadic version of getCreditNotesRaw (use with runWithConfiguration)

data GetCreditNotesRequestBody Source #

Defines the data type for the schema getCreditNotesRequestBody

Constructors

GetCreditNotesRequestBody

Instances

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

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 #
Instance details Defined in StripeAPI.Operations.GetCreditNotes Methods (==) :: GetCreditNotesResponse -> GetCreditNotesResponse -> Bool # (/=) :: GetCreditNotesResponse -> GetCreditNotesResponse -> Bool #
Show GetCreditNotesResponse Source #
Instance details Defined in StripeAPI.Operations.GetCreditNotes Methods showsPrec :: Int -> GetCreditNotesResponse -> ShowS # show :: GetCreditNotesResponse -> String # showList :: [GetCreditNotesResponse] -> ShowS #

data GetCreditNotesResponseBody200 Source #

Defines the data type for the schema GetCreditNotesResponseBody200

Constructors

GetCreditNotesResponseBody200

Fields

getCreditNotesResponseBody200Data :: [] CreditNote
data
getCreditNotesResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getCreditNotesResponseBody200Object :: GetCreditNotesResponseBody200Object'
object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
getCreditNotesResponseBody200Url :: String
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000

Instances

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

data GetCreditNotesResponseBody200Object' Source #

Defines the enum schema GetCreditNotesResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetCreditNotesResponseBody200Object'EnumOther Value
GetCreditNotesResponseBody200Object'EnumTyped String
GetCreditNotesResponseBody200Object'EnumStringList

Instances

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