StripeAPI.Types.FileLink

Contains the types generated from the schema FileLink

Documentation

data FileLink

Defines the object schema located at components.schemas.file_link in the specification.

To share the contents of a `File` object with non-Stripe users, you can create a `FileLink`. `FileLink`s contain a URL that can be used to retrieve the contents of the file without authentication.

Constructors

FileLink

Fields

• fileLinkCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• fileLinkExpired :: Bool

  expired: Whether this link is already expired.

• fileLinkExpiresAt :: Maybe Int

  expires_at: Time at which the link expires.

• fileLinkFile :: FileLinkFile'Variants

  file: The file object this link points to.

• fileLinkId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• fileLinkLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• fileLinkMetadata :: Object

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• fileLinkUrl :: Maybe Text

  url: The publicly accessible URL to download the file.

  Constraints:

  • Maximum length of 5000

Instances

Eq FileLink

Defined in StripeAPI.Types.FileLink

Methods

(==) :: FileLink -> FileLink -> Bool

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

Show FileLink

Defined in StripeAPI.Types.FileLink

Methods

showsPrec :: Int -> FileLink -> ShowS

show :: FileLink -> String

showList :: [FileLink] -> ShowS

ToJSON FileLink

Defined in StripeAPI.Types.FileLink

Methods

toJSON :: FileLink -> Value

toEncoding :: FileLink -> Encoding

toJSONList :: [FileLink] -> Value

toEncodingList :: [FileLink] -> Encoding

FromJSON FileLink

Defined in StripeAPI.Types.FileLink

Methods

parseJSON :: Value -> Parser FileLink

parseJSONList :: Value -> Parser [FileLink]

mkFileLink

Arguments

:: Int

fileLinkCreated

-> Bool

fileLinkExpired

-> FileLinkFile'Variants

fileLinkFile

-> Text

fileLinkId

-> Bool

fileLinkLivemode

-> Object

fileLinkMetadata

-> FileLink

Create a new FileLink with all required fields.

data FileLinkFile'Variants

Defines the oneOf schema located at components.schemas.file_link.properties.file.anyOf in the specification.

The file object this link points to.

Constructors

FileLinkFile'Text Text

FileLinkFile'File File

Instances

Eq FileLinkFile'Variants

Defined in StripeAPI.Types.FileLink

Methods

(==) :: FileLinkFile'Variants -> FileLinkFile'Variants -> Bool

(/=) :: FileLinkFile'Variants -> FileLinkFile'Variants -> Bool

Show FileLinkFile'Variants

Defined in StripeAPI.Types.FileLink

Methods

showsPrec :: Int -> FileLinkFile'Variants -> ShowS

show :: FileLinkFile'Variants -> String

showList :: [FileLinkFile'Variants] -> ShowS

ToJSON FileLinkFile'Variants

Defined in StripeAPI.Types.FileLink

Methods

toJSON :: FileLinkFile'Variants -> Value

toEncoding :: FileLinkFile'Variants -> Encoding

toJSONList :: [FileLinkFile'Variants] -> Value

toEncodingList :: [FileLinkFile'Variants] -> Encoding

FromJSON FileLinkFile'Variants

Defined in StripeAPI.Types.FileLink

Methods

parseJSON :: Value -> Parser FileLinkFile'Variants

parseJSONList :: Value -> Parser [FileLinkFile'Variants]