StripeAPI.Types.File

Contains the types generated from the schema File

Documentation

data File

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

This is an object representing a file hosted on Stripe's servers. The file may have been uploaded by yourself using the create file request (for example, when uploading dispute evidence) or it may have been created by Stripe (for example, the results of a Sigma scheduled query).

Related guide: File Upload Guide.

Constructors

File

Fields

• fileCreated :: Int

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

• fileExpiresAt :: Maybe Int

  expires_at: The time at which the file expires and is no longer available in epoch seconds.

• fileFilename :: Maybe Text

  filename: A filename for the file, suitable for saving to a filesystem.

  Constraints:

  • Maximum length of 5000
• fileId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• fileLinks :: Maybe FileLinks'

  links: A list of file links that point at this file.

• filePurpose :: FilePurpose'

  purpose: The purpose of the uploaded file.

• fileSize :: Int

  size: The size in bytes of the file object.

• fileTitle :: Maybe Text

  title: A user friendly title for the document.

  Constraints:

  • Maximum length of 5000
• fileType :: Maybe Text

  type: The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).

  Constraints:

  • Maximum length of 5000
• fileUrl :: Maybe Text

  url: The URL from which the file can be downloaded using your live secret API key.

  Constraints:

  • Maximum length of 5000

Instances

Eq File

Defined in StripeAPI.Types.File

Methods

(==) :: File -> File -> Bool

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

Show File

Defined in StripeAPI.Types.File

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

ToJSON File

Defined in StripeAPI.Types.File

Methods

toJSON :: File -> Value

toEncoding :: File -> Encoding

toJSONList :: [File] -> Value

toEncodingList :: [File] -> Encoding

FromJSON File

Defined in StripeAPI.Types.File

Methods

parseJSON :: Value -> Parser File

parseJSONList :: Value -> Parser [File]

mkFile

Arguments

:: Int

fileCreated

-> Text

fileId

-> FilePurpose'

filePurpose

-> Int

fileSize

-> File

Create a new File with all required fields.

data FileLinks'

Defines the object schema located at components.schemas.file.properties.links in the specification.

A list of file links that point at this file.

Constructors

FileLinks'

Fields

• fileLinks'Data :: [FileLink]

  data: Details about each object.

• fileLinks'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• fileLinks'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq FileLinks'

Defined in StripeAPI.Types.File

Methods

(==) :: FileLinks' -> FileLinks' -> Bool

(/=) :: FileLinks' -> FileLinks' -> Bool

Show FileLinks'

Defined in StripeAPI.Types.File

Methods

showsPrec :: Int -> FileLinks' -> ShowS

show :: FileLinks' -> String

showList :: [FileLinks'] -> ShowS

ToJSON FileLinks'

Defined in StripeAPI.Types.File

Methods

toJSON :: FileLinks' -> Value

toEncoding :: FileLinks' -> Encoding

toJSONList :: [FileLinks'] -> Value

toEncodingList :: [FileLinks'] -> Encoding

FromJSON FileLinks'

Defined in StripeAPI.Types.File

Methods

parseJSON :: Value -> Parser FileLinks'

parseJSONList :: Value -> Parser [FileLinks']

mkFileLinks'

Arguments

:: [FileLink]

fileLinks'Data

-> Bool

fileLinks'HasMore

-> Text

fileLinks'Url

-> FileLinks'

Create a new FileLinks' with all required fields.

data FilePurpose'

Defines the enum schema located at components.schemas.file.properties.purpose in the specification.

The purpose of the uploaded file.

Constructors

FilePurpose'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

FilePurpose'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

FilePurpose'EnumAccountRequirement

Represents the JSON value "account_requirement"

FilePurpose'EnumAdditionalVerification

Represents the JSON value "additional_verification"

FilePurpose'EnumBusinessIcon

Represents the JSON value "business_icon"

FilePurpose'EnumBusinessLogo

Represents the JSON value "business_logo"

FilePurpose'EnumCustomerSignature

Represents the JSON value "customer_signature"

FilePurpose'EnumDisputeEvidence

Represents the JSON value "dispute_evidence"

FilePurpose'EnumDocumentProviderIdentityDocument

Represents the JSON value "document_provider_identity_document"

FilePurpose'EnumFinanceReportRun

Represents the JSON value "finance_report_run"

FilePurpose'EnumIdentityDocument

Represents the JSON value "identity_document"

FilePurpose'EnumIdentityDocumentDownloadable

Represents the JSON value "identity_document_downloadable"

FilePurpose'EnumPciDocument

Represents the JSON value "pci_document"

FilePurpose'EnumSelfie

Represents the JSON value "selfie"

FilePurpose'EnumSigmaScheduledQuery

Represents the JSON value "sigma_scheduled_query"

FilePurpose'EnumTaxDocumentUserUpload

Represents the JSON value "tax_document_user_upload"

Instances

Eq FilePurpose'

Defined in StripeAPI.Types.File

Methods

(==) :: FilePurpose' -> FilePurpose' -> Bool

(/=) :: FilePurpose' -> FilePurpose' -> Bool

Show FilePurpose'

Defined in StripeAPI.Types.File

Methods

showsPrec :: Int -> FilePurpose' -> ShowS

show :: FilePurpose' -> String

showList :: [FilePurpose'] -> ShowS

ToJSON FilePurpose'

Defined in StripeAPI.Types.File

Methods

toJSON :: FilePurpose' -> Value

toEncoding :: FilePurpose' -> Encoding

toJSONList :: [FilePurpose'] -> Value

toEncodingList :: [FilePurpose'] -> Encoding

FromJSON FilePurpose'

Defined in StripeAPI.Types.File

Methods

parseJSON :: Value -> Parser FilePurpose'

parseJSONList :: Value -> Parser [FilePurpose']