Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema Reporting_ReportRun
Synopsis
- data Reporting'reportRun = Reporting'reportRun {
- reporting'reportRunCreated :: Int
- reporting'reportRunError :: Maybe Text
- reporting'reportRunId :: Text
- reporting'reportRunLivemode :: Bool
- reporting'reportRunParameters :: FinancialReportingFinanceReportRunRunParameters
- reporting'reportRunReportType :: Text
- reporting'reportRunResult :: Maybe Reporting'reportRunResult'
- reporting'reportRunStatus :: Text
- reporting'reportRunSucceededAt :: Maybe Int
- mkReporting'reportRun :: Int -> Text -> Bool -> FinancialReportingFinanceReportRunRunParameters -> Text -> Text -> Reporting'reportRun
- data Reporting'reportRunResult' = Reporting'reportRunResult' {
- reporting'reportRunResult'Created :: Maybe Int
- reporting'reportRunResult'ExpiresAt :: Maybe Int
- reporting'reportRunResult'Filename :: Maybe Text
- reporting'reportRunResult'Id :: Maybe Text
- reporting'reportRunResult'Links :: Maybe Reporting'reportRunResult'Links'
- reporting'reportRunResult'Object :: Maybe Reporting'reportRunResult'Object'
- reporting'reportRunResult'Purpose :: Maybe Reporting'reportRunResult'Purpose'
- reporting'reportRunResult'Size :: Maybe Int
- reporting'reportRunResult'Title :: Maybe Text
- reporting'reportRunResult'Type :: Maybe Text
- reporting'reportRunResult'Url :: Maybe Text
- mkReporting'reportRunResult' :: Reporting'reportRunResult'
- data Reporting'reportRunResult'Links' = Reporting'reportRunResult'Links' {}
- mkReporting'reportRunResult'Links' :: [FileLink] -> Bool -> Text -> Reporting'reportRunResult'Links'
- data Reporting'reportRunResult'Object'
- data Reporting'reportRunResult'Purpose'
- = Reporting'reportRunResult'Purpose'Other Value
- | Reporting'reportRunResult'Purpose'Typed Text
- | Reporting'reportRunResult'Purpose'EnumAccountRequirement
- | Reporting'reportRunResult'Purpose'EnumAdditionalVerification
- | Reporting'reportRunResult'Purpose'EnumBusinessIcon
- | Reporting'reportRunResult'Purpose'EnumBusinessLogo
- | Reporting'reportRunResult'Purpose'EnumCustomerSignature
- | Reporting'reportRunResult'Purpose'EnumDisputeEvidence
- | Reporting'reportRunResult'Purpose'EnumDocumentProviderIdentityDocument
- | Reporting'reportRunResult'Purpose'EnumFinanceReportRun
- | Reporting'reportRunResult'Purpose'EnumIdentityDocument
- | Reporting'reportRunResult'Purpose'EnumIdentityDocumentDownloadable
- | Reporting'reportRunResult'Purpose'EnumPciDocument
- | Reporting'reportRunResult'Purpose'EnumSelfie
- | Reporting'reportRunResult'Purpose'EnumSigmaScheduledQuery
- | Reporting'reportRunResult'Purpose'EnumTaxDocumentUserUpload
Documentation
data Reporting'reportRun Source #
Defines the object schema located at components.schemas.reporting.report_run
in the specification.
The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.
Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.
Reporting'reportRun | |
|
Instances
Eq Reporting'reportRun Source # | |
Defined in StripeAPI.Types.Reporting_ReportRun (==) :: Reporting'reportRun -> Reporting'reportRun -> Bool # (/=) :: Reporting'reportRun -> Reporting'reportRun -> Bool # | |
Show Reporting'reportRun Source # | |
Defined in StripeAPI.Types.Reporting_ReportRun showsPrec :: Int -> Reporting'reportRun -> ShowS # show :: Reporting'reportRun -> String # showList :: [Reporting'reportRun] -> ShowS # | |
ToJSON Reporting'reportRun Source # | |
Defined in StripeAPI.Types.Reporting_ReportRun toJSON :: Reporting'reportRun -> Value # toEncoding :: Reporting'reportRun -> Encoding # toJSONList :: [Reporting'reportRun] -> Value # toEncodingList :: [Reporting'reportRun] -> Encoding # | |
FromJSON Reporting'reportRun Source # | |
Defined in StripeAPI.Types.Reporting_ReportRun parseJSON :: Value -> Parser Reporting'reportRun # parseJSONList :: Value -> Parser [Reporting'reportRun] # |
mkReporting'reportRun Source #
:: Int | |
-> Text | |
-> Bool | |
-> FinancialReportingFinanceReportRunRunParameters | |
-> Text | |
-> Text | |
-> Reporting'reportRun |
Create a new Reporting'reportRun
with all required fields.
data Reporting'reportRunResult' Source #
Defines the object schema located at components.schemas.reporting.report_run.properties.result.anyOf
in the specification.
The file object representing the result of the report run (populated when \`status=succeeded\`).
Reporting'reportRunResult' | |
|
Instances
mkReporting'reportRunResult' :: Reporting'reportRunResult' Source #
Create a new Reporting'reportRunResult'
with all required fields.
data Reporting'reportRunResult'Links' Source #
Defines the object schema located at components.schemas.reporting.report_run.properties.result.anyOf.properties.links
in the specification.
A list of file links that point at this file.
Reporting'reportRunResult'Links' | |
|
mkReporting'reportRunResult'Links' Source #
:: [FileLink] | |
-> Bool | |
-> Text | |
-> Reporting'reportRunResult'Links' |
Create a new Reporting'reportRunResult'Links'
with all required fields.
data Reporting'reportRunResult'Object' Source #
Defines the enum schema located at components.schemas.reporting.report_run.properties.result.anyOf.properties.object
in the specification.
String representing the object's type. Objects of the same type share the same value.
Reporting'reportRunResult'Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
Reporting'reportRunResult'Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
Reporting'reportRunResult'Object'EnumFile | Represents the JSON value |
data Reporting'reportRunResult'Purpose' Source #
Defines the enum schema located at components.schemas.reporting.report_run.properties.result.anyOf.properties.purpose
in the specification.
The purpose of the uploaded file.
Reporting'reportRunResult'Purpose'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
Reporting'reportRunResult'Purpose'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
Reporting'reportRunResult'Purpose'EnumAccountRequirement | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumAdditionalVerification | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumBusinessIcon | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumBusinessLogo | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumCustomerSignature | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumDisputeEvidence | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumDocumentProviderIdentityDocument | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumFinanceReportRun | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumIdentityDocument | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumIdentityDocumentDownloadable | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumPciDocument | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumSelfie | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumSigmaScheduledQuery | Represents the JSON value |
Reporting'reportRunResult'Purpose'EnumTaxDocumentUserUpload | Represents the JSON value |