| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetOrders
Description
Contains the different functions to run the operation getOrders
Synopsis
- getOrders :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> m (Either HttpException (Response GetOrdersResponse))
- getOrdersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> m (Either HttpException (Response ByteString))
- getOrdersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetOrdersResponse))
- getOrdersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetOrdersRequestBody = GetOrdersRequestBody {
- data GetOrdersResponse
- data GetOrdersResponseBody200 = GetOrdersResponseBody200 {}
- data GetOrdersResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | created: Date this order was created. |
| -> Maybe String | customer: Only return orders for the given customer. | 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 | ids: Only return orders with the given IDs. |
| -> 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 |
| -> Maybe String | status: Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. | Constraints: Maximum length of 5000 |
| -> Maybe String | status_transitions: Filter orders based on when they were paid, fulfilled, canceled, or returned. |
| -> Maybe String | upstream_ids: Only return orders with the given upstream order IDs. |
| -> GetOrdersRequestBody | The request body to send |
| -> m (Either HttpException (Response GetOrdersResponse)) | Monad containing the result of the operation |
GET /v1/orders
<p>Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.</p>
getOrdersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/orders
The same as getOrders but returns the raw ByteString
getOrdersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetOrdersResponse)) Source #
GET /v1/orders
Monadic version of getOrders (use with runWithConfiguration)
getOrdersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetOrdersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/orders
Monadic version of getOrdersRaw (use with runWithConfiguration)
data GetOrdersRequestBody Source #
Defines the data type for the schema getOrdersRequestBody
Constructors
| GetOrdersRequestBody | |
Instances
| Eq GetOrdersRequestBody Source # | |
Defined in StripeAPI.Operations.GetOrders Methods (==) :: GetOrdersRequestBody -> GetOrdersRequestBody -> Bool # (/=) :: GetOrdersRequestBody -> GetOrdersRequestBody -> Bool # | |
| Show GetOrdersRequestBody Source # | |
Defined in StripeAPI.Operations.GetOrders Methods showsPrec :: Int -> GetOrdersRequestBody -> ShowS # show :: GetOrdersRequestBody -> String # showList :: [GetOrdersRequestBody] -> ShowS # | |
| ToJSON GetOrdersRequestBody Source # | |
Defined in StripeAPI.Operations.GetOrders Methods toJSON :: GetOrdersRequestBody -> Value # toEncoding :: GetOrdersRequestBody -> Encoding # toJSONList :: [GetOrdersRequestBody] -> Value # toEncodingList :: [GetOrdersRequestBody] -> Encoding # | |
| FromJSON GetOrdersRequestBody Source # | |
Defined in StripeAPI.Operations.GetOrders Methods parseJSON :: Value -> Parser GetOrdersRequestBody # parseJSONList :: Value -> Parser [GetOrdersRequestBody] # | |
data GetOrdersResponse Source #
Represents a response of the operation getOrders.
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), GetOrdersResponseError is used.
Constructors
| GetOrdersResponseError String | Means either no matching case available or a parse error |
| GetOrdersResponse200 GetOrdersResponseBody200 | Successful response. |
| GetOrdersResponseDefault Error | Error response. |
Instances
| Eq GetOrdersResponse Source # | |
Defined in StripeAPI.Operations.GetOrders Methods (==) :: GetOrdersResponse -> GetOrdersResponse -> Bool # (/=) :: GetOrdersResponse -> GetOrdersResponse -> Bool # | |
| Show GetOrdersResponse Source # | |
Defined in StripeAPI.Operations.GetOrders Methods showsPrec :: Int -> GetOrdersResponse -> ShowS # show :: GetOrdersResponse -> String # showList :: [GetOrdersResponse] -> ShowS # | |
data GetOrdersResponseBody200 Source #
Defines the data type for the schema GetOrdersResponseBody200
Constructors
| GetOrdersResponseBody200 | |
Fields
| |
Instances
| Eq GetOrdersResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetOrders Methods (==) :: GetOrdersResponseBody200 -> GetOrdersResponseBody200 -> Bool # (/=) :: GetOrdersResponseBody200 -> GetOrdersResponseBody200 -> Bool # | |
| Show GetOrdersResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetOrders Methods showsPrec :: Int -> GetOrdersResponseBody200 -> ShowS # show :: GetOrdersResponseBody200 -> String # showList :: [GetOrdersResponseBody200] -> ShowS # | |
| ToJSON GetOrdersResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetOrders Methods toJSON :: GetOrdersResponseBody200 -> Value # toEncoding :: GetOrdersResponseBody200 -> Encoding # toJSONList :: [GetOrdersResponseBody200] -> Value # | |
| FromJSON GetOrdersResponseBody200 Source # | |
Defined in StripeAPI.Operations.GetOrders Methods parseJSON :: Value -> Parser GetOrdersResponseBody200 # parseJSONList :: Value -> Parser [GetOrdersResponseBody200] # | |
data GetOrdersResponseBody200Object' Source #
Defines the enum schema GetOrdersResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetOrdersResponseBody200Object'EnumOther Value | |
| GetOrdersResponseBody200Object'EnumTyped String | |
| GetOrdersResponseBody200Object'EnumStringList |
Instances
| Eq GetOrdersResponseBody200Object' Source # | |
Defined in StripeAPI.Operations.GetOrders | |
| Show GetOrdersResponseBody200Object' Source # | |
Defined in StripeAPI.Operations.GetOrders Methods showsPrec :: Int -> GetOrdersResponseBody200Object' -> ShowS # | |
| ToJSON GetOrdersResponseBody200Object' Source # | |
Defined in StripeAPI.Operations.GetOrders | |
| FromJSON GetOrdersResponseBody200Object' Source # | |
Defined in StripeAPI.Operations.GetOrders Methods parseJSON :: Value -> Parser GetOrdersResponseBody200Object' # parseJSONList :: Value -> Parser [GetOrdersResponseBody200Object'] # | |