stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetFilesFile

Description

Contains the different functions to run the operation getFilesFile

Synopsis

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

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.