Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetFileLinks

Description

Contains the different functions to run the operation getFileLinks

Synopsis

getFileLinks :: forall m. MonadHTTP m => GetFileLinksParameters -> StripeT m (Response GetFileLinksResponse)
data GetFileLinksParameters = GetFileLinksParameters {
}
mkGetFileLinksParameters :: GetFileLinksParameters
data GetFileLinksParametersQueryCreated'OneOf1 = GetFileLinksParametersQueryCreated'OneOf1 {
}
mkGetFileLinksParametersQueryCreated'OneOf1 :: GetFileLinksParametersQueryCreated'OneOf1
data GetFileLinksParametersQueryCreated'Variants
- = GetFileLinksParametersQueryCreated'GetFileLinksParametersQueryCreated'OneOf1 GetFileLinksParametersQueryCreated'OneOf1
- | GetFileLinksParametersQueryCreated'Int Int
data GetFileLinksResponse
data GetFileLinksResponseBody200 = GetFileLinksResponseBody200 {
}
mkGetFileLinksResponseBody200 :: [FileLink] -> Bool -> Text -> GetFileLinksResponseBody200

Documentation

getFileLinks Source #

Arguments

:: forall m. MonadHTTP m
=> GetFileLinksParameters	Contains all available parameters of this operation (query and path parameters)
-> StripeT m (Response GetFileLinksResponse)	Monadic computation which returns the result of the operation

GET /v1/file_links

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

data GetFileLinksParameters Source #

Defines the object schema located at paths./v1/file_links.GET.parameters in the specification.

Constructors

GetFileLinksParameters

Fields

getFileLinksParametersQueryCreated :: Maybe GetFileLinksParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
getFileLinksParametersQueryEndingBefore :: Maybe Text
queryEnding_before: Represents the parameter named '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.
getFileLinksParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getFileLinksParametersQueryExpired :: Maybe Bool
queryExpired: Represents the parameter named 'expired'
Filter links by their expiration status. By default, all links are returned.
getFileLinksParametersQueryFile :: Maybe Text
queryFile: Represents the parameter named 'file'
Only return links for the given file.
Constraints:
- Maximum length of 5000
getFileLinksParametersQueryLimit :: Maybe Int
queryLimit: Represents the parameter named 'limit'
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
getFileLinksParametersQueryStartingAfter :: Maybe Text
queryStarting_after: Represents the parameter named '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.

Instances

Instances details

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

mkGetFileLinksParameters :: GetFileLinksParameters Source #

Create a new GetFileLinksParameters with all required fields.

data GetFileLinksParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/file_links.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetFileLinksParametersQueryCreated'OneOf1
Fields getFileLinksParametersQueryCreated'OneOf1Gt :: Maybe Int gt getFileLinksParametersQueryCreated'OneOf1Gte :: Maybe Int gte getFileLinksParametersQueryCreated'OneOf1Lt :: Maybe Int lt getFileLinksParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

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

mkGetFileLinksParametersQueryCreated'OneOf1 :: GetFileLinksParametersQueryCreated'OneOf1 Source #

Create a new GetFileLinksParametersQueryCreated'OneOf1 with all required fields.

data GetFileLinksParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/file_links.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetFileLinksParametersQueryCreated'GetFileLinksParametersQueryCreated'OneOf1 GetFileLinksParametersQueryCreated'OneOf1
GetFileLinksParametersQueryCreated'Int Int

Instances

Instances details

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

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

Instances details

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 object schema located at paths./v1/file_links.GET.responses.200.content.application/json.schema in the specification.

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. getFileLinksResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/file_links'

Instances

Instances details

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

mkGetFileLinksResponseBody200 Source #

Arguments

:: [FileLink]	`getFileLinksResponseBody200Data`
-> Bool	`getFileLinksResponseBody200HasMore`
-> Text	`getFileLinksResponseBody200Url`
-> GetFileLinksResponseBody200

Create a new GetFileLinksResponseBody200 with all required fields.