Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetOrderReturnsId

Description

Contains the different functions to run the operation getOrderReturnsId

Synopsis

getOrderReturnsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetOrderReturnsIdRequestBody -> m (Either HttpException (Response GetOrderReturnsIdResponse))
getOrderReturnsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetOrderReturnsIdRequestBody -> m (Either HttpException (Response ByteString))
getOrderReturnsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetOrderReturnsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetOrderReturnsIdResponse))
getOrderReturnsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetOrderReturnsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetOrderReturnsIdRequestBody = GetOrderReturnsIdRequestBody {
}
data GetOrderReturnsIdResponse

Documentation

getOrderReturnsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe String	expand: Specifies which fields in the response should be expanded.
-> String	id \| Constraints: Maximum length of 5000
-> GetOrderReturnsIdRequestBody	The request body to send
-> m (Either HttpException (Response GetOrderReturnsIdResponse))	Monad containing the result of the operation

GET /v1/order_returns/{id}

<p>Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.</p>

getOrderReturnsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetOrderReturnsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/order_returns/{id}

The same as getOrderReturnsId but returns the raw ByteString

getOrderReturnsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetOrderReturnsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetOrderReturnsIdResponse)) Source #

GET /v1/order_returns/{id}

Monadic version of getOrderReturnsId (use with runWithConfiguration)

getOrderReturnsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetOrderReturnsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/order_returns/{id}

Monadic version of getOrderReturnsIdRaw (use with runWithConfiguration)

data GetOrderReturnsIdRequestBody Source #

Defines the data type for the schema getOrderReturnsIdRequestBody

Constructors

GetOrderReturnsIdRequestBody

Instances

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

data GetOrderReturnsIdResponse Source #

Represents a response of the operation getOrderReturnsId.

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

Constructors

GetOrderReturnsIdResponseError String	Means either no matching case available or a parse error
GetOrderReturnsIdResponse200 OrderReturn	Successful response.
GetOrderReturnsIdResponseDefault Error	Error response.

Instances

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