Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetFileLinks

Contains the different functions to run the operation getFileLinks

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetFileLinks.hs

valuegetFileLinks

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

GET /v1/file_links

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

datadata GetFileLinksParameters

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFileLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
Show GetFileLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
FromJSON GetFileLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
ToJSON GetFileLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks

valuemkGetFileLinksParameters :: GetFileLinksParameters

Create a new GetFileLinksParameters with all required fields.

datadata GetFileLinksParametersQueryCreated'OneOf1

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFileLinksParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
Show GetFileLinksParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
FromJSON GetFileLinksParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
ToJSON GetFileLinksParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks

valuemkGetFileLinksParametersQueryCreated'OneOf1 :: GetFileLinksParametersQueryCreated'OneOf1

Create a new GetFileLinksParametersQueryCreated'OneOf1 with all required fields.

datadata GetFileLinksParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFileLinksParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
Show GetFileLinksParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
FromJSON GetFileLinksParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
ToJSON GetFileLinksParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks

datadata GetFileLinksResponse

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.

Instances2Eq, Show

Eq GetFileLinksResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
Show GetFileLinksResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks

datadata GetFileLinksResponseBody200

Defines the object schema located at paths./v1/file_links.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetFileLinksResponseBody200
- getFileLinksResponseBody200Data :: [FileLink]
  data: Details about each object.
- 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'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFileLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
Show GetFileLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
FromJSON GetFileLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks
ToJSON GetFileLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFileLinks

valuemkGetFileLinksResponseBody200

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

Create a new GetFileLinksResponseBody200 with all required fields.