StripeAPI.Operations.GetFilesFile

Contains the different functions to run the operation getFilesFile

Documentation

getFilesFile

Arguments

:: forall m. MonadHTTP m

=> GetFilesFileParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetFilesFileResponse)

Monadic computation which returns 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>

data GetFilesFileParameters

Defines the object schema located at paths./v1/files/{file}.GET.parameters in the specification.

Constructors

GetFilesFileParameters

Fields

• getFilesFileParametersPathFile :: Text

  pathFile: Represents the parameter named 'file'

  Constraints:

  • Maximum length of 5000
• getFilesFileParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

Instances

Eq GetFilesFileParameters

Defined in StripeAPI.Operations.GetFilesFile

Methods

(==) :: GetFilesFileParameters -> GetFilesFileParameters -> Bool

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

Show GetFilesFileParameters

Defined in StripeAPI.Operations.GetFilesFile

Methods

showsPrec :: Int -> GetFilesFileParameters -> ShowS

show :: GetFilesFileParameters -> String

showList :: [GetFilesFileParameters] -> ShowS

ToJSON GetFilesFileParameters

Defined in StripeAPI.Operations.GetFilesFile

Methods

toJSON :: GetFilesFileParameters -> Value

toEncoding :: GetFilesFileParameters -> Encoding

toJSONList :: [GetFilesFileParameters] -> Value

toEncodingList :: [GetFilesFileParameters] -> Encoding

FromJSON GetFilesFileParameters

Defined in StripeAPI.Operations.GetFilesFile

Methods

parseJSON :: Value -> Parser GetFilesFileParameters

parseJSONList :: Value -> Parser [GetFilesFileParameters]

mkGetFilesFileParameters

Arguments

:: Text

getFilesFileParametersPathFile

-> GetFilesFileParameters

Create a new GetFilesFileParameters with all required fields.

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