Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetFileLinks

Description

Contains the different functions to run the operation getFileLinks

Synopsis

getFileLinks :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> m (Either HttpException (Response GetFileLinksResponse))
getFileLinksRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> m (Either HttpException (Response ByteString))
getFileLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetFileLinksResponse))
getFileLinksRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data GetFileLinksRequestBody = GetFileLinksRequestBody {
}
data GetFileLinksResponse
data GetFileLinksResponseBody200 = GetFileLinksResponseBody200 {
}
data GetFileLinksResponseBody200Object'

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>

getFileLinksRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/file_links

The same as getFileLinks but returns the raw ByteString

getFileLinksM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetFileLinksResponse)) Source #

GET /v1/file_links

Monadic version of getFileLinks (use with runWithConfiguration)

getFileLinksRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Bool -> Maybe String -> Maybe Integer -> Maybe String -> GetFileLinksRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

GET /v1/file_links

Monadic version of getFileLinksRaw (use with runWithConfiguration)

data GetFileLinksRequestBody Source #

Defines the data type for the schema getFileLinksRequestBody

Constructors

GetFileLinksRequestBody

Instances

Eq GetFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods (==) :: GetFileLinksRequestBody -> GetFileLinksRequestBody -> Bool # (/=) :: GetFileLinksRequestBody -> GetFileLinksRequestBody -> Bool #
Show GetFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods showsPrec :: Int -> GetFileLinksRequestBody -> ShowS # show :: GetFileLinksRequestBody -> String # showList :: [GetFileLinksRequestBody] -> ShowS #
ToJSON GetFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods toJSON :: GetFileLinksRequestBody -> Value # toEncoding :: GetFileLinksRequestBody -> Encoding # toJSONList :: [GetFileLinksRequestBody] -> Value # toEncodingList :: [GetFileLinksRequestBody] -> Encoding #
FromJSON GetFileLinksRequestBody Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods parseJSON :: Value -> Parser GetFileLinksRequestBody # parseJSONList :: Value -> Parser [GetFileLinksRequestBody] #

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.

Instances

Eq GetFileLinksResponse Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods (==) :: GetFileLinksResponse -> GetFileLinksResponse -> Bool # (/=) :: GetFileLinksResponse -> GetFileLinksResponse -> Bool #
Show GetFileLinksResponse Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods showsPrec :: Int -> GetFileLinksResponse -> ShowS # show :: GetFileLinksResponse -> String # showList :: [GetFileLinksResponse] -> ShowS #

data GetFileLinksResponseBody200 Source #

Defines the data type for the schema GetFileLinksResponseBody200

Constructors

GetFileLinksResponseBody200

Fields

getFileLinksResponseBody200Data :: [] FileLink
data
getFileLinksResponseBody200HasMore :: Bool
has_more: True if this list has another page of items after this one that can be fetched.
getFileLinksResponseBody200Object :: GetFileLinksResponseBody200Object'
object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
getFileLinksResponseBody200Url :: String
url: The URL where this list can be accessed.
Constraints:
- Maximum length of 5000
- Must match pattern '^/v1/file_links'

Instances

Eq GetFileLinksResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods (==) :: GetFileLinksResponseBody200 -> GetFileLinksResponseBody200 -> Bool # (/=) :: GetFileLinksResponseBody200 -> GetFileLinksResponseBody200 -> Bool #
Show GetFileLinksResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods showsPrec :: Int -> GetFileLinksResponseBody200 -> ShowS # show :: GetFileLinksResponseBody200 -> String # showList :: [GetFileLinksResponseBody200] -> ShowS #
ToJSON GetFileLinksResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods toJSON :: GetFileLinksResponseBody200 -> Value # toEncoding :: GetFileLinksResponseBody200 -> Encoding # toJSONList :: [GetFileLinksResponseBody200] -> Value # toEncodingList :: [GetFileLinksResponseBody200] -> Encoding #
FromJSON GetFileLinksResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods parseJSON :: Value -> Parser GetFileLinksResponseBody200 # parseJSONList :: Value -> Parser [GetFileLinksResponseBody200] #

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

Constructors

GetFileLinksResponseBody200Object'EnumOther Value
GetFileLinksResponseBody200Object'EnumTyped String
GetFileLinksResponseBody200Object'EnumStringList

Instances

Eq GetFileLinksResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods (==) :: GetFileLinksResponseBody200Object' -> GetFileLinksResponseBody200Object' -> Bool # (/=) :: GetFileLinksResponseBody200Object' -> GetFileLinksResponseBody200Object' -> Bool #
Show GetFileLinksResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods showsPrec :: Int -> GetFileLinksResponseBody200Object' -> ShowS # show :: GetFileLinksResponseBody200Object' -> String # showList :: [GetFileLinksResponseBody200Object'] -> ShowS #
ToJSON GetFileLinksResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods toJSON :: GetFileLinksResponseBody200Object' -> Value # toEncoding :: GetFileLinksResponseBody200Object' -> Encoding # toJSONList :: [GetFileLinksResponseBody200Object'] -> Value # toEncodingList :: [GetFileLinksResponseBody200Object'] -> Encoding #
FromJSON GetFileLinksResponseBody200Object' Source #
Instance details Defined in StripeAPI.Operations.GetFileLinks Methods parseJSON :: Value -> Parser GetFileLinksResponseBody200Object' # parseJSONList :: Value -> Parser [GetFileLinksResponseBody200Object'] #