stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetFiles

Description

Contains the different functions to run the operation getFiles

Synopsis

Documentation

getFiles Source #

Arguments

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

The configuration to use in the request

-> Maybe String

created

-> Maybe String

ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000

-> Maybe String

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

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

purpose: The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. | Constraints: Maximum length of 5000

-> Maybe String

starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000

-> GetFilesRequestBody

The request body to send

-> m (Either HttpException (Response GetFilesResponse))

Monad containing the result of the operation

GET /v1/files

<p>Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.</p>

data GetFilesResponse Source #

Represents a response of the operation getFiles.

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

Constructors

GetFilesResponseError String

Means either no matching case available or a parse error

GetFilesResponse200 GetFilesResponseBody200

Successful response.

GetFilesResponseDefault Error

Error response.

data GetFilesResponseBody200 Source #

Defines the data type for the schema GetFilesResponseBody200

Constructors

GetFilesResponseBody200 

Fields

data GetFilesResponseBody200Object' Source #

Defines the enum schema GetFilesResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.