| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetCreditNotesCreditNoteLines
Description
Contains the different functions to run the operation getCreditNotesCreditNoteLines
Synopsis
- getCreditNotesCreditNoteLines :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> m (Either HttpException (Response GetCreditNotesCreditNoteLinesResponse))
- getCreditNotesCreditNoteLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> m (Either HttpException (Response ByteString))
- getCreditNotesCreditNoteLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesCreditNoteLinesResponse))
- getCreditNotesCreditNoteLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetCreditNotesCreditNoteLinesRequestBody = GetCreditNotesCreditNoteLinesRequestBody {
- data GetCreditNotesCreditNoteLinesResponse
- data GetCreditNotesCreditNoteLinesResponseBody200 = GetCreditNotesCreditNoteLinesResponseBody200 {}
- data GetCreditNotesCreditNoteLinesResponseBody200Object'
Documentation
getCreditNotesCreditNoteLines Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | credit_note | Constraints: Maximum length of 5000 |
| -> Maybe Text | 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 Text | expand: Specifies which fields in the response should be expanded. |
| -> 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 Text | 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 |
| -> Maybe GetCreditNotesCreditNoteLinesRequestBody | The request body to send |
| -> m (Either HttpException (Response GetCreditNotesCreditNoteLinesResponse)) | Monad containing the result of the operation |
GET /v1/credit_notes/{credit_note}/lines<p>When retrieving a credit note, you’ll get a <strong>lines</strong> property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>
getCreditNotesCreditNoteLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/credit_notes/{credit_note}/linesThe same as getCreditNotesCreditNoteLines but returns the raw ByteString
getCreditNotesCreditNoteLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCreditNotesCreditNoteLinesResponse)) Source #
GET /v1/credit_notes/{credit_note}/linesMonadic version of getCreditNotesCreditNoteLines (use with runWithConfiguration)
getCreditNotesCreditNoteLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCreditNotesCreditNoteLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/credit_notes/{credit_note}/linesMonadic version of getCreditNotesCreditNoteLinesRaw (use with runWithConfiguration)
data GetCreditNotesCreditNoteLinesRequestBody Source #
Defines the data type for the schema getCreditNotesCreditNoteLinesRequestBody
Constructors
| GetCreditNotesCreditNoteLinesRequestBody | |
data GetCreditNotesCreditNoteLinesResponse Source #
Represents a response of the operation getCreditNotesCreditNoteLines.
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), GetCreditNotesCreditNoteLinesResponseError is used.
Constructors
| GetCreditNotesCreditNoteLinesResponseError String | Means either no matching case available or a parse error |
| GetCreditNotesCreditNoteLinesResponse200 GetCreditNotesCreditNoteLinesResponseBody200 | Successful response. |
| GetCreditNotesCreditNoteLinesResponseDefault Error | Error response. |
Instances
data GetCreditNotesCreditNoteLinesResponseBody200 Source #
Defines the data type for the schema GetCreditNotesCreditNoteLinesResponseBody200
Constructors
| GetCreditNotesCreditNoteLinesResponseBody200 | |
Fields
| |
Instances
data GetCreditNotesCreditNoteLinesResponseBody200Object' Source #
Defines the enum schema GetCreditNotesCreditNoteLinesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetCreditNotesCreditNoteLinesResponseBody200Object'EnumOther Value | |
| GetCreditNotesCreditNoteLinesResponseBody200Object'EnumTyped Text | |
| GetCreditNotesCreditNoteLinesResponseBody200Object'EnumStringList |