stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetFileLinks

Description

Contains the different functions to run the operation getFileLinks

Synopsis

Documentation

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

-> Maybe String

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

-> Maybe Bool

expired: Filter links by their expiration status. By default, all links are returned.

-> Maybe String

file: Only return links for the given file. | Constraints: Maximum length of 5000

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

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.

-> GetFileLinksRequestBody

The request body to send

-> m (Either HttpException (Response GetFileLinksResponse))

Monad containing the result of the operation

GET /v1/file_links

<p>Returns a list of file links.</p>

data GetFileLinksResponse Source #

Represents a response of the operation getFileLinks.

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

Constructors

GetFileLinksResponseError String

Means either no matching case available or a parse error

GetFileLinksResponse200 GetFileLinksResponseBody200

Successful response.

GetFileLinksResponseDefault Error

Error response.

data GetFileLinksResponseBody200 Source #

Defines the data type for the schema GetFileLinksResponseBody200

Constructors

GetFileLinksResponseBody200 

Fields

data GetFileLinksResponseBody200Object' Source #

Defines the enum schema GetFileLinksResponseBody200Object'

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