| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetInvoicesInvoiceLines
Description
Contains the different functions to run the operation getInvoicesInvoiceLines
Synopsis
- getInvoicesInvoiceLines :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> m (Either HttpException (Response GetInvoicesInvoiceLinesResponse))
- getInvoicesInvoiceLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> m (Either HttpException (Response ByteString))
- getInvoicesInvoiceLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesInvoiceLinesResponse))
- getInvoicesInvoiceLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetInvoicesInvoiceLinesRequestBody = GetInvoicesInvoiceLinesRequestBody {
- data GetInvoicesInvoiceLinesResponse
- data GetInvoicesInvoiceLinesResponseBody200 = GetInvoicesInvoiceLinesResponseBody200 {}
- data GetInvoicesInvoiceLinesResponseBody200Object'
Documentation
getInvoicesInvoiceLines Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> 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. |
| -> Text | invoice | 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 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 GetInvoicesInvoiceLinesRequestBody | The request body to send |
| -> m (Either HttpException (Response GetInvoicesInvoiceLinesResponse)) | Monad containing the result of the operation |
GET /v1/invoices/{invoice}/lines<p>When retrieving an invoice, you’ll get a <strong>lines</strong> property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>
getInvoicesInvoiceLinesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/invoices/{invoice}/linesThe same as getInvoicesInvoiceLines but returns the raw ByteString
getInvoicesInvoiceLinesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetInvoicesInvoiceLinesResponse)) Source #
GET /v1/invoices/{invoice}/linesMonadic version of getInvoicesInvoiceLines (use with runWithConfiguration)
getInvoicesInvoiceLinesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Text -> Maybe Integer -> Maybe Text -> Maybe GetInvoicesInvoiceLinesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/invoices/{invoice}/linesMonadic version of getInvoicesInvoiceLinesRaw (use with runWithConfiguration)
data GetInvoicesInvoiceLinesRequestBody Source #
Defines the data type for the schema getInvoicesInvoiceLinesRequestBody
Constructors
| GetInvoicesInvoiceLinesRequestBody | |
Instances
data GetInvoicesInvoiceLinesResponse Source #
Represents a response of the operation getInvoicesInvoiceLines.
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), GetInvoicesInvoiceLinesResponseError is used.
Constructors
| GetInvoicesInvoiceLinesResponseError String | Means either no matching case available or a parse error |
| GetInvoicesInvoiceLinesResponse200 GetInvoicesInvoiceLinesResponseBody200 | Successful response. |
| GetInvoicesInvoiceLinesResponseDefault Error | Error response. |
Instances
data GetInvoicesInvoiceLinesResponseBody200 Source #
Defines the data type for the schema GetInvoicesInvoiceLinesResponseBody200
Constructors
| GetInvoicesInvoiceLinesResponseBody200 | |
Fields
| |
Instances
data GetInvoicesInvoiceLinesResponseBody200Object' Source #
Defines the enum schema GetInvoicesInvoiceLinesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetInvoicesInvoiceLinesResponseBody200Object'EnumOther Value | |
| GetInvoicesInvoiceLinesResponseBody200Object'EnumTyped Text | |
| GetInvoicesInvoiceLinesResponseBody200Object'EnumStringList |