StripeAPI.Operations.GetFiles

Contains the different functions to run the operation getFiles

Documentation

getFiles

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

created

-> Maybe Text

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 Text

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 Text

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 Text

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

-> Maybe 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>

getFilesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetFilesRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/files

The same as getFiles but returns the raw ByteString

getFilesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetFilesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetFilesResponse))

GET /v1/files

Monadic version of getFiles (use with runWithConfiguration)

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

GET /v1/files

Monadic version of getFilesRaw (use with runWithConfiguration)

data GetFilesRequestBody

Defines the data type for the schema getFilesRequestBody

Constructors

GetFilesRequestBody

Instances

Eq GetFilesRequestBody

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesRequestBody -> GetFilesRequestBody -> Bool

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

Show GetFilesRequestBody

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesRequestBody -> ShowS

show :: GetFilesRequestBody -> String

showList :: [GetFilesRequestBody] -> ShowS

ToJSON GetFilesRequestBody

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesRequestBody -> Value

toEncoding :: GetFilesRequestBody -> Encoding

toJSONList :: [GetFilesRequestBody] -> Value

toEncodingList :: [GetFilesRequestBody] -> Encoding

FromJSON GetFilesRequestBody

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesRequestBody

parseJSONList :: Value -> Parser [GetFilesRequestBody]

data GetFilesResponse

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.

Instances

Eq GetFilesResponse

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesResponse -> GetFilesResponse -> Bool

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

Show GetFilesResponse

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesResponse -> ShowS

show :: GetFilesResponse -> String

showList :: [GetFilesResponse] -> ShowS

data GetFilesResponseBody200

Defines the data type for the schema GetFilesResponseBody200

Constructors

GetFilesResponseBody200

Fields

• getFilesResponseBody200Data :: [] File

  data

• getFilesResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getFilesResponseBody200Object :: GetFilesResponseBody200Object'

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

• getFilesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/files'

Instances

Eq GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesResponseBody200 -> GetFilesResponseBody200 -> Bool

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

Show GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesResponseBody200 -> ShowS

show :: GetFilesResponseBody200 -> String

showList :: [GetFilesResponseBody200] -> ShowS

ToJSON GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesResponseBody200 -> Value

toEncoding :: GetFilesResponseBody200 -> Encoding

toJSONList :: [GetFilesResponseBody200] -> Value

toEncodingList :: [GetFilesResponseBody200] -> Encoding

FromJSON GetFilesResponseBody200

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesResponseBody200

parseJSONList :: Value -> Parser [GetFilesResponseBody200]

data GetFilesResponseBody200Object'

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`.

Constructors

GetFilesResponseBody200Object'EnumOther Value

GetFilesResponseBody200Object'EnumTyped Text

GetFilesResponseBody200Object'EnumStringList

Instances

Eq GetFilesResponseBody200Object'

Defined in StripeAPI.Operations.GetFiles

Methods

(==) :: GetFilesResponseBody200Object' -> GetFilesResponseBody200Object' -> Bool

(/=) :: GetFilesResponseBody200Object' -> GetFilesResponseBody200Object' -> Bool

Show GetFilesResponseBody200Object'

Defined in StripeAPI.Operations.GetFiles

Methods

showsPrec :: Int -> GetFilesResponseBody200Object' -> ShowS

show :: GetFilesResponseBody200Object' -> String

showList :: [GetFilesResponseBody200Object'] -> ShowS

ToJSON GetFilesResponseBody200Object'

Defined in StripeAPI.Operations.GetFiles

Methods

toJSON :: GetFilesResponseBody200Object' -> Value

toEncoding :: GetFilesResponseBody200Object' -> Encoding

toJSONList :: [GetFilesResponseBody200Object'] -> Value

toEncodingList :: [GetFilesResponseBody200Object'] -> Encoding

FromJSON GetFilesResponseBody200Object'

Defined in StripeAPI.Operations.GetFiles

Methods

parseJSON :: Value -> Parser GetFilesResponseBody200Object'

parseJSONList :: Value -> Parser [GetFilesResponseBody200Object']