| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetOrders
Description
Contains the different functions to run the operation getOrders
Synopsis
- getOrders :: forall m. MonadHTTP m => GetOrdersParameters -> ClientT m (Response GetOrdersResponse)
- data GetOrdersParameters = GetOrdersParameters {
- getOrdersParametersQueryCreated :: Maybe GetOrdersParametersQueryCreated'Variants
- getOrdersParametersQueryCustomer :: Maybe Text
- getOrdersParametersQueryEndingBefore :: Maybe Text
- getOrdersParametersQueryExpand :: Maybe [Text]
- getOrdersParametersQueryIds :: Maybe [Text]
- getOrdersParametersQueryLimit :: Maybe Int
- getOrdersParametersQueryStartingAfter :: Maybe Text
- getOrdersParametersQueryStatus :: Maybe Text
- getOrdersParametersQueryStatusTransitions :: Maybe GetOrdersParametersQueryStatusTransitions'
- getOrdersParametersQueryUpstreamIds :: Maybe [Text]
- mkGetOrdersParameters :: GetOrdersParameters
- data GetOrdersParametersQueryCreated'OneOf1 = GetOrdersParametersQueryCreated'OneOf1 {}
- mkGetOrdersParametersQueryCreated'OneOf1 :: GetOrdersParametersQueryCreated'OneOf1
- data GetOrdersParametersQueryCreated'Variants
- data GetOrdersParametersQueryStatusTransitions' = GetOrdersParametersQueryStatusTransitions' {
- getOrdersParametersQueryStatusTransitions'Canceled :: Maybe GetOrdersParametersQueryStatusTransitions'Canceled'Variants
- getOrdersParametersQueryStatusTransitions'Fulfilled :: Maybe GetOrdersParametersQueryStatusTransitions'Fulfilled'Variants
- getOrdersParametersQueryStatusTransitions'Paid :: Maybe GetOrdersParametersQueryStatusTransitions'Paid'Variants
- getOrdersParametersQueryStatusTransitions'Returned :: Maybe GetOrdersParametersQueryStatusTransitions'Returned'Variants
- mkGetOrdersParametersQueryStatusTransitions' :: GetOrdersParametersQueryStatusTransitions'
- data GetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 = GetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 {}
- mkGetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Canceled'OneOf1
- data GetOrdersParametersQueryStatusTransitions'Canceled'Variants
- data GetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 = GetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 {}
- mkGetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1
- data GetOrdersParametersQueryStatusTransitions'Fulfilled'Variants
- data GetOrdersParametersQueryStatusTransitions'Paid'OneOf1 = GetOrdersParametersQueryStatusTransitions'Paid'OneOf1 {}
- mkGetOrdersParametersQueryStatusTransitions'Paid'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Paid'OneOf1
- data GetOrdersParametersQueryStatusTransitions'Paid'Variants
- data GetOrdersParametersQueryStatusTransitions'Returned'OneOf1 = GetOrdersParametersQueryStatusTransitions'Returned'OneOf1 {}
- mkGetOrdersParametersQueryStatusTransitions'Returned'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Returned'OneOf1
- data GetOrdersParametersQueryStatusTransitions'Returned'Variants
- data GetOrdersResponse
- data GetOrdersResponseBody200 = GetOrdersResponseBody200 {}
- mkGetOrdersResponseBody200 :: [Order] -> Bool -> Text -> GetOrdersResponseBody200
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => GetOrdersParameters | Contains all available parameters of this operation (query and path parameters) |
| -> ClientT m (Response GetOrdersResponse) | Monadic computation which returns 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>
data GetOrdersParameters Source #
Defines the object schema located at paths./v1/orders.GET.parameters in the specification.
Constructors
| GetOrdersParameters | |
Fields
| |
Instances
| Eq GetOrdersParameters Source # | |
Defined in StripeAPI.Operations.GetOrders Methods (==) :: GetOrdersParameters -> GetOrdersParameters -> Bool # (/=) :: GetOrdersParameters -> GetOrdersParameters -> Bool # | |
| Show GetOrdersParameters Source # | |
Defined in StripeAPI.Operations.GetOrders Methods showsPrec :: Int -> GetOrdersParameters -> ShowS # show :: GetOrdersParameters -> String # showList :: [GetOrdersParameters] -> ShowS # | |
| ToJSON GetOrdersParameters Source # | |
Defined in StripeAPI.Operations.GetOrders Methods toJSON :: GetOrdersParameters -> Value # toEncoding :: GetOrdersParameters -> Encoding # toJSONList :: [GetOrdersParameters] -> Value # toEncodingList :: [GetOrdersParameters] -> Encoding # | |
| FromJSON GetOrdersParameters Source # | |
Defined in StripeAPI.Operations.GetOrders Methods parseJSON :: Value -> Parser GetOrdersParameters # parseJSONList :: Value -> Parser [GetOrdersParameters] # | |
mkGetOrdersParameters :: GetOrdersParameters Source #
Create a new GetOrdersParameters with all required fields.
data GetOrdersParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/orders.GET.parameters.properties.queryCreated.anyOf in the specification.
Constructors
| GetOrdersParametersQueryCreated'OneOf1 | |
Instances
mkGetOrdersParametersQueryCreated'OneOf1 :: GetOrdersParametersQueryCreated'OneOf1 Source #
Create a new GetOrdersParametersQueryCreated'OneOf1 with all required fields.
data GetOrdersParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/orders.GET.parameters.properties.queryCreated.anyOf in the specification.
Represents the parameter named 'created'
Date this order was created.
Constructors
| GetOrdersParametersQueryCreated'GetOrdersParametersQueryCreated'OneOf1 GetOrdersParametersQueryCreated'OneOf1 | |
| GetOrdersParametersQueryCreated'Int Int |
Instances
data GetOrdersParametersQueryStatusTransitions' Source #
Defines the object schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions in the specification.
Represents the parameter named 'status_transitions'
Filter orders based on when they were paid, fulfilled, canceled, or returned.
Constructors
Instances
mkGetOrdersParametersQueryStatusTransitions' :: GetOrdersParametersQueryStatusTransitions' Source #
Create a new GetOrdersParametersQueryStatusTransitions' with all required fields.
data GetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 Source #
Defines the object schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.canceled.anyOf in the specification.
Constructors
Instances
mkGetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 Source #
Create a new GetOrdersParametersQueryStatusTransitions'Canceled'OneOf1 with all required fields.
data GetOrdersParametersQueryStatusTransitions'Canceled'Variants Source #
Defines the oneOf schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.canceled.anyOf in the specification.
Constructors
Instances
data GetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 Source #
Defines the object schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.fulfilled.anyOf in the specification.
Constructors
Instances
mkGetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 Source #
Create a new GetOrdersParametersQueryStatusTransitions'Fulfilled'OneOf1 with all required fields.
data GetOrdersParametersQueryStatusTransitions'Fulfilled'Variants Source #
Defines the oneOf schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.fulfilled.anyOf in the specification.
Constructors
Instances
data GetOrdersParametersQueryStatusTransitions'Paid'OneOf1 Source #
Defines the object schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.paid.anyOf in the specification.
Instances
mkGetOrdersParametersQueryStatusTransitions'Paid'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Paid'OneOf1 Source #
Create a new GetOrdersParametersQueryStatusTransitions'Paid'OneOf1 with all required fields.
data GetOrdersParametersQueryStatusTransitions'Paid'Variants Source #
Defines the oneOf schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.paid.anyOf in the specification.
Constructors
Instances
data GetOrdersParametersQueryStatusTransitions'Returned'OneOf1 Source #
Defines the object schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.returned.anyOf in the specification.
Constructors
Instances
mkGetOrdersParametersQueryStatusTransitions'Returned'OneOf1 :: GetOrdersParametersQueryStatusTransitions'Returned'OneOf1 Source #
Create a new GetOrdersParametersQueryStatusTransitions'Returned'OneOf1 with all required fields.
data GetOrdersParametersQueryStatusTransitions'Returned'Variants Source #
Defines the oneOf schema located at paths./v1/orders.GET.parameters.properties.queryStatus_transitions.properties.returned.anyOf in the specification.
Constructors
Instances
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 object schema located at paths./v1/orders.GET.responses.200.content.application/json.schema in the specification.
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] # | |
mkGetOrdersResponseBody200 Source #
Arguments
| :: [Order] | |
| -> Bool | |
| -> Text | |
| -> GetOrdersResponseBody200 |
Create a new GetOrdersResponseBody200 with all required fields.