stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostFiles

Description

Contains the different functions to run the operation postFiles

Synopsis

Documentation

postFiles Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> m (Either HttpException (Response PostFilesResponse))

Monad containing the result of the operation

POST /v1/files

<p>To upload a file to Stripe, you’ll need to send a request of type <code>multipart/form-data</code>. The request should contain the file you would like to upload, as well as the parameters for creating a file.</p>

<p>All of Stripe’s officially supported Client libraries should have support for sending <code>multipart/form-data</code>.</p>

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

POST /v1/files

The same as postFiles but returns the raw ByteString

postFilesM :: forall m s. (MonadHTTP m, SecurityScheme s) => ReaderT (Configuration s) m (Either HttpException (Response PostFilesResponse)) Source #

POST /v1/files

Monadic version of postFiles (use with runWithConfiguration)

postFilesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/files

Monadic version of postFilesRaw (use with runWithConfiguration)

data PostFilesResponse Source #

Represents a response of the operation postFiles.

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

Constructors

PostFilesResponseError String

Means either no matching case available or a parse error

PostFilesResponse200 File

Successful response.

PostFilesResponseDefault Error

Error response.