StripeAPI.Operations.GetFilesFile

Contains the different functions to run the operation getFilesFile

Documentation

getFilesFile

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

expand: Specifies which fields in the response should be expanded.

-> Text

file | Constraints: Maximum length of 5000

-> Maybe 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 Text -> Text -> Maybe GetFilesFileRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/files/{file}

The same as getFilesFile but returns the raw ByteString

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

GET /v1/files/{file}

Monadic version of getFilesFile (use with runWithConfiguration)

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

GET /v1/files/{file}

Monadic version of getFilesFileRaw (use with runWithConfiguration)

data GetFilesFileRequestBody

Defines the data type for the schema getFilesFileRequestBody

Constructors

GetFilesFileRequestBody

Instances

Eq GetFilesFileRequestBody

Defined in StripeAPI.Operations.GetFilesFile

Methods

(==) :: GetFilesFileRequestBody -> GetFilesFileRequestBody -> Bool

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

Show GetFilesFileRequestBody

Defined in StripeAPI.Operations.GetFilesFile

Methods

showsPrec :: Int -> GetFilesFileRequestBody -> ShowS

show :: GetFilesFileRequestBody -> String

showList :: [GetFilesFileRequestBody] -> ShowS

ToJSON GetFilesFileRequestBody

Defined in StripeAPI.Operations.GetFilesFile

Methods

toJSON :: GetFilesFileRequestBody -> Value

toEncoding :: GetFilesFileRequestBody -> Encoding

toJSONList :: [GetFilesFileRequestBody] -> Value

toEncodingList :: [GetFilesFileRequestBody] -> Encoding

FromJSON GetFilesFileRequestBody

Defined in StripeAPI.Operations.GetFilesFile

Methods

parseJSON :: Value -> Parser GetFilesFileRequestBody

parseJSONList :: Value -> Parser [GetFilesFileRequestBody]

data GetFilesFileResponse

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

Defined in StripeAPI.Operations.GetFilesFile

Methods

(==) :: GetFilesFileResponse -> GetFilesFileResponse -> Bool

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

Show GetFilesFileResponse

Defined in StripeAPI.Operations.GetFilesFile

Methods

showsPrec :: Int -> GetFilesFileResponse -> ShowS

show :: GetFilesFileResponse -> String

showList :: [GetFilesFileResponse] -> ShowS