StripeAPI.Operations.GetOrdersId

Contains the different functions to run the operation getOrdersId

Documentation

getOrdersId

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

-> GetOrdersIdRequestBody

The request body to send

-> m (Either HttpException (Response GetOrdersIdResponse))

Monad containing the result of the operation

GET /v1/orders/{id}

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

getOrdersIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetOrdersIdRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/orders/{id}

The same as getOrdersId but returns the raw ByteString

getOrdersIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetOrdersIdResponse))

GET /v1/orders/{id}

Monadic version of getOrdersId (use with runWithConfiguration)

getOrdersIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetOrdersIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/orders/{id}

Monadic version of getOrdersIdRaw (use with runWithConfiguration)

data GetOrdersIdRequestBody

Defines the data type for the schema getOrdersIdRequestBody

Constructors

GetOrdersIdRequestBody

Instances

Eq GetOrdersIdRequestBody

Defined in StripeAPI.Operations.GetOrdersId

Methods

(==) :: GetOrdersIdRequestBody -> GetOrdersIdRequestBody -> Bool

(/=) :: GetOrdersIdRequestBody -> GetOrdersIdRequestBody -> Bool

Show GetOrdersIdRequestBody

Defined in StripeAPI.Operations.GetOrdersId

Methods

showsPrec :: Int -> GetOrdersIdRequestBody -> ShowS

show :: GetOrdersIdRequestBody -> String

showList :: [GetOrdersIdRequestBody] -> ShowS

ToJSON GetOrdersIdRequestBody

Defined in StripeAPI.Operations.GetOrdersId

Methods

toJSON :: GetOrdersIdRequestBody -> Value

toEncoding :: GetOrdersIdRequestBody -> Encoding

toJSONList :: [GetOrdersIdRequestBody] -> Value

toEncodingList :: [GetOrdersIdRequestBody] -> Encoding

FromJSON GetOrdersIdRequestBody

Defined in StripeAPI.Operations.GetOrdersId

Methods

parseJSON :: Value -> Parser GetOrdersIdRequestBody

parseJSONList :: Value -> Parser [GetOrdersIdRequestBody]

data GetOrdersIdResponse

Represents a response of the operation getOrdersId.

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

Constructors

GetOrdersIdResponseError String

Means either no matching case available or a parse error

GetOrdersIdResponse200 Order

Successful response.

GetOrdersIdResponseDefault Error

Error response.

Instances

Eq GetOrdersIdResponse

Defined in StripeAPI.Operations.GetOrdersId

Methods

(==) :: GetOrdersIdResponse -> GetOrdersIdResponse -> Bool

(/=) :: GetOrdersIdResponse -> GetOrdersIdResponse -> Bool

Show GetOrdersIdResponse

Defined in StripeAPI.Operations.GetOrdersId

Methods

showsPrec :: Int -> GetOrdersIdResponse -> ShowS

show :: GetOrdersIdResponse -> String

showList :: [GetOrdersIdResponse] -> ShowS