Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.File

Contains the types generated from the schema File

3 types
2 values

Packagestripeapi-3.0.0.0
Exports5
LanguageHaskell2010
LicenceMIT
SourceFile.hs

datadata 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
- fileCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- fileExpiresAt :: Maybe (Nullable Int)
  expires_at: The time at which the file expires and is no longer available in epoch seconds.
- fileFilename :: Maybe (Nullable 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 (Nullable FileLinks'NonNullable)
  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 (Nullable Text)
  title: A user friendly title for the document.
  Constraints:
  - Maximum length of 5000
- fileType :: Maybe (Nullable Text)
  type: The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).
  Constraints:
  - Maximum length of 5000
- fileUrl :: Maybe (Nullable Text)
  url: The URL from which the file can be downloaded using your live secret API key.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq FileDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File
Show FileDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File
FromJSON FileDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File
ToJSON FileDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File

valuemkFile

:: Int
fileCreated
-> Text
fileId
-> FilePurpose'
filePurpose
-> Int
fileSize
-> File

Create a new File with all required fields.

datadata FileLinks'NonNullable

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'NonNullable
- fileLinks'NonNullableData :: [FileLink]
  data: Details about each object.
- fileLinks'NonNullableHasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- fileLinks'NonNullableUrl :: 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 FileLinks'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File
Show FileLinks'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File
FromJSON FileLinks'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File
ToJSON FileLinks'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.File

valuemkFileLinks'NonNullable

:: [FileLink]
fileLinks'NonNullableData
-> Bool
fileLinks'NonNullableHasMore
-> Text
fileLinks'NonNullableUrl
-> FileLinks'NonNullable

Create a new FileLinks'NonNullable with all required fields.

datadata 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"

Instances4Eq, Show, FromJSON, ToJSON

Eq FilePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.File
Show FilePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.File
FromJSON FilePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.File
ToJSON FilePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.File