Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetFilesFile

Description

Contains the different functions to run the operation getFilesFile

Synopsis

getFilesFile :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetFilesFileRequestBody -> m (Either HttpException (Response GetFilesFileResponse))
getFilesFileRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> String -> GetFilesFileRequestBody -> m (Either HttpException (Response ByteString))
getFilesFileM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetFilesFileRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetFilesFileResponse))
getFilesFileRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetFilesFileRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetFilesFileRequestBody = GetFilesFileRequestBody {
}
data GetFilesFileResponse

Documentation

getFilesFile 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	file \| Constraints: Maximum length of 5000
-> GetFilesFileRequestBody	The request body to send
-> m (Either HttpException (Response GetFilesFileResponse))	Monad containing the result of the operation

GET /v1/files/{file}

<p>Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the <a href="/docs/file-upload#download-file-contents">File Upload Guide</a>.</p>

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

GET /v1/files/{file}

The same as getFilesFile but returns the raw ByteString

getFilesFileM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> String -> GetFilesFileRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetFilesFileResponse)) Source #

GET /v1/files/{file}

Monadic version of getFilesFile (use with runWithConfiguration)

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

GET /v1/files/{file}

Monadic version of getFilesFileRaw (use with runWithConfiguration)

data GetFilesFileRequestBody Source #

Defines the data type for the schema getFilesFileRequestBody

Constructors

GetFilesFileRequestBody

Instances

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

data GetFilesFileResponse Source #

Represents a response of the operation getFilesFile.

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

Constructors

GetFilesFileResponseError String	Means either no matching case available or a parse error
GetFilesFileResponse200 File	Successful response.
GetFilesFileResponseDefault Error	Error response.

Instances

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