Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetOrderReturns

Description

Contains the different functions to run the operation getOrderReturns

Synopsis

getOrderReturns :: forall m. MonadHTTP m => GetOrderReturnsParameters -> ClientT m (Response GetOrderReturnsResponse)
data GetOrderReturnsParameters = GetOrderReturnsParameters {
}
mkGetOrderReturnsParameters :: GetOrderReturnsParameters
data GetOrderReturnsParametersQueryCreated'OneOf1 = GetOrderReturnsParametersQueryCreated'OneOf1 {
}
mkGetOrderReturnsParametersQueryCreated'OneOf1 :: GetOrderReturnsParametersQueryCreated'OneOf1
data GetOrderReturnsParametersQueryCreated'Variants
- = GetOrderReturnsParametersQueryCreated'GetOrderReturnsParametersQueryCreated'OneOf1 GetOrderReturnsParametersQueryCreated'OneOf1
- | GetOrderReturnsParametersQueryCreated'Int Int
data GetOrderReturnsResponse
data GetOrderReturnsResponseBody200 = GetOrderReturnsResponseBody200 {
}
mkGetOrderReturnsResponseBody200 :: [OrderReturn] -> Bool -> Text -> GetOrderReturnsResponseBody200

Documentation

getOrderReturns Source #

Arguments

:: forall m. MonadHTTP m
=> GetOrderReturnsParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetOrderReturnsResponse)	Monadic computation which returns the result of the operation

GET /v1/order_returns

<p>Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.</p>

data GetOrderReturnsParameters Source #

Defines the object schema located at paths./v1/order_returns.GET.parameters in the specification.

Constructors

GetOrderReturnsParameters

Fields

getOrderReturnsParametersQueryCreated :: Maybe GetOrderReturnsParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
Date this return was created.
getOrderReturnsParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named '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
getOrderReturnsParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getOrderReturnsParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getOrderReturnsParametersQueryOrder :: Maybe Text
queryOrder: Represents the parameter named 'order'
The order to retrieve returns for.
Constraints:
- Maximum length of 5000
getOrderReturnsParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named '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

Instances

Instances details

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

mkGetOrderReturnsParameters :: GetOrderReturnsParameters Source #

Create a new GetOrderReturnsParameters with all required fields.

data GetOrderReturnsParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/order_returns.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetOrderReturnsParametersQueryCreated'OneOf1
Fields getOrderReturnsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getOrderReturnsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getOrderReturnsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getOrderReturnsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetOrderReturnsParametersQueryCreated'OneOf1 :: GetOrderReturnsParametersQueryCreated'OneOf1 Source #

Create a new GetOrderReturnsParametersQueryCreated'OneOf1 with all required fields.

data GetOrderReturnsParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/order_returns.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Date this return was created.

Constructors

GetOrderReturnsParametersQueryCreated'GetOrderReturnsParametersQueryCreated'OneOf1 GetOrderReturnsParametersQueryCreated'OneOf1
GetOrderReturnsParametersQueryCreated'Int Int

Instances

Instances details

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

data GetOrderReturnsResponse Source #

Represents a response of the operation getOrderReturns.

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), GetOrderReturnsResponseError is used.

Constructors

GetOrderReturnsResponseError String	Means either no matching case available or a parse error
GetOrderReturnsResponse200 GetOrderReturnsResponseBody200	Successful response.
GetOrderReturnsResponseDefault Error	Error response.

Instances

Instances details

Eq GetOrderReturnsResponse Source #
Instance details Defined in StripeAPI.Operations.GetOrderReturns Methods (==) :: GetOrderReturnsResponse -> GetOrderReturnsResponse -> Bool # (/=) :: GetOrderReturnsResponse -> GetOrderReturnsResponse -> Bool #
Show GetOrderReturnsResponse Source #
Instance details Defined in StripeAPI.Operations.GetOrderReturns Methods showsPrec :: Int -> GetOrderReturnsResponse -> ShowS # show :: GetOrderReturnsResponse -> String # showList :: [GetOrderReturnsResponse] -> ShowS #

data GetOrderReturnsResponseBody200 Source #

Defines the object schema located at paths./v1/order_returns.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetOrderReturnsResponseBody200
Fields getOrderReturnsResponseBody200Data :: [OrderReturn] data getOrderReturnsResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getOrderReturnsResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/order_returns'

Instances

Instances details

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

mkGetOrderReturnsResponseBody200 Source #

Arguments

:: [OrderReturn]	`getOrderReturnsResponseBody200Data`
-> Bool	`getOrderReturnsResponseBody200HasMore`
-> Text	`getOrderReturnsResponseBody200Url`
-> GetOrderReturnsResponseBody200

Create a new GetOrderReturnsResponseBody200 with all required fields.