StripeAPI.Types.Reporting_ReportRun

Contains the types generated from the schema Reporting_ReportRun

Documentation

data Reporting'reportRun

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.

Constructors

Reporting'reportRun

Fields

• reporting'reportRunCreated :: Int

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

• reporting'reportRunError :: Maybe Text

  error: If something should go wrong during the run, a message about the failure (populated when `status=failed`).

  Constraints:

  • Maximum length of 5000
• reporting'reportRunId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• reporting'reportRunLivemode :: Bool

  livemode: `true` if the report is run on live mode data and `false` if it is run on test mode data.

• reporting'reportRunParameters :: FinancialReportingFinanceReportRunRunParameters

  parameters:

• reporting'reportRunReportType :: Text

  report_type: The ID of the report type to run, such as `"balance.summary.1"`.

  Constraints:

  • Maximum length of 5000
• reporting'reportRunResult :: Maybe Reporting'reportRunResult'

  result: The file object representing the result of the report run (populated when `status=succeeded`).

• reporting'reportRunStatus :: Text

  status: Status of this report run. This will be `pending` when the run is initially created. When the run finishes, this will be set to `succeeded` and the `result` field will be populated. Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.

  Constraints:

  • Maximum length of 5000
• reporting'reportRunSucceededAt :: Maybe Int

  succeeded_at: Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch.

Instances

Eq Reporting'reportRun

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

(==) :: Reporting'reportRun -> Reporting'reportRun -> Bool

(/=) :: Reporting'reportRun -> Reporting'reportRun -> Bool

Show Reporting'reportRun

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

showsPrec :: Int -> Reporting'reportRun -> ShowS

show :: Reporting'reportRun -> String

showList :: [Reporting'reportRun] -> ShowS

ToJSON Reporting'reportRun

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

toJSON :: Reporting'reportRun -> Value

toEncoding :: Reporting'reportRun -> Encoding

toJSONList :: [Reporting'reportRun] -> Value

toEncodingList :: [Reporting'reportRun] -> Encoding

FromJSON Reporting'reportRun

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

parseJSON :: Value -> Parser Reporting'reportRun

parseJSONList :: Value -> Parser [Reporting'reportRun]

mkReporting'reportRun

Arguments

:: Int

reporting'reportRunCreated

-> Text

reporting'reportRunId

-> Bool

reporting'reportRunLivemode

-> FinancialReportingFinanceReportRunRunParameters

reporting'reportRunParameters

-> Text

reporting'reportRunReportType

-> Text

reporting'reportRunStatus

-> Reporting'reportRun

Create a new Reporting'reportRun with all required fields.

data Reporting'reportRunResult'

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\`).

Constructors

Reporting'reportRunResult'

Fields

• reporting'reportRunResult'Created :: Maybe Int

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

• reporting'reportRunResult'ExpiresAt :: Maybe Int

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

• reporting'reportRunResult'Filename :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• reporting'reportRunResult'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• reporting'reportRunResult'Links :: Maybe Reporting'reportRunResult'Links'

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

• reporting'reportRunResult'Object :: Maybe Reporting'reportRunResult'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• reporting'reportRunResult'Purpose :: Maybe Reporting'reportRunResult'Purpose'

  purpose: The purpose of the uploaded file.

• reporting'reportRunResult'Size :: Maybe Int

  size: The size in bytes of the file object.

• reporting'reportRunResult'Title :: Maybe Text

  title: A user friendly title for the document.

  Constraints:

  • Maximum length of 5000
• reporting'reportRunResult'Type :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• reporting'reportRunResult'Url :: 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 Reporting'reportRunResult'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

(==) :: Reporting'reportRunResult' -> Reporting'reportRunResult' -> Bool

(/=) :: Reporting'reportRunResult' -> Reporting'reportRunResult' -> Bool

Show Reporting'reportRunResult'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

showsPrec :: Int -> Reporting'reportRunResult' -> ShowS

show :: Reporting'reportRunResult' -> String

showList :: [Reporting'reportRunResult'] -> ShowS

ToJSON Reporting'reportRunResult'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

toJSON :: Reporting'reportRunResult' -> Value

toEncoding :: Reporting'reportRunResult' -> Encoding

toJSONList :: [Reporting'reportRunResult'] -> Value

toEncodingList :: [Reporting'reportRunResult'] -> Encoding

FromJSON Reporting'reportRunResult'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

parseJSON :: Value -> Parser Reporting'reportRunResult'

parseJSONList :: Value -> Parser [Reporting'reportRunResult']

mkReporting'reportRunResult' :: Reporting'reportRunResult'

Create a new Reporting'reportRunResult' with all required fields.

data Reporting'reportRunResult'Links'

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.

Constructors

Reporting'reportRunResult'Links'

Fields

• reporting'reportRunResult'Links'Data :: [FileLink]

  data: Details about each object.

• reporting'reportRunResult'Links'HasMore :: Bool

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

• reporting'reportRunResult'Links'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq Reporting'reportRunResult'Links'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

(==) :: Reporting'reportRunResult'Links' -> Reporting'reportRunResult'Links' -> Bool

(/=) :: Reporting'reportRunResult'Links' -> Reporting'reportRunResult'Links' -> Bool

Show Reporting'reportRunResult'Links'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

showsPrec :: Int -> Reporting'reportRunResult'Links' -> ShowS

show :: Reporting'reportRunResult'Links' -> String

showList :: [Reporting'reportRunResult'Links'] -> ShowS

ToJSON Reporting'reportRunResult'Links'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

toJSON :: Reporting'reportRunResult'Links' -> Value

toEncoding :: Reporting'reportRunResult'Links' -> Encoding

toJSONList :: [Reporting'reportRunResult'Links'] -> Value

toEncodingList :: [Reporting'reportRunResult'Links'] -> Encoding

FromJSON Reporting'reportRunResult'Links'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

parseJSON :: Value -> Parser Reporting'reportRunResult'Links'

parseJSONList :: Value -> Parser [Reporting'reportRunResult'Links']

mkReporting'reportRunResult'Links'

Arguments

:: [FileLink]

reporting'reportRunResult'Links'Data

-> Bool

reporting'reportRunResult'Links'HasMore

-> Text

reporting'reportRunResult'Links'Url

-> Reporting'reportRunResult'Links'

Create a new Reporting'reportRunResult'Links' with all required fields.

data Reporting'reportRunResult'Object'

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.

Constructors

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

Instances

Eq Reporting'reportRunResult'Object'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

(==) :: Reporting'reportRunResult'Object' -> Reporting'reportRunResult'Object' -> Bool

(/=) :: Reporting'reportRunResult'Object' -> Reporting'reportRunResult'Object' -> Bool

Show Reporting'reportRunResult'Object'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

showsPrec :: Int -> Reporting'reportRunResult'Object' -> ShowS

show :: Reporting'reportRunResult'Object' -> String

showList :: [Reporting'reportRunResult'Object'] -> ShowS

ToJSON Reporting'reportRunResult'Object'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

toJSON :: Reporting'reportRunResult'Object' -> Value

toEncoding :: Reporting'reportRunResult'Object' -> Encoding

toJSONList :: [Reporting'reportRunResult'Object'] -> Value

toEncodingList :: [Reporting'reportRunResult'Object'] -> Encoding

FromJSON Reporting'reportRunResult'Object'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

parseJSON :: Value -> Parser Reporting'reportRunResult'Object'

parseJSONList :: Value -> Parser [Reporting'reportRunResult'Object']

data Reporting'reportRunResult'Purpose'

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.

Constructors

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

Reporting'reportRunResult'Purpose'EnumAdditionalVerification

Represents the JSON value "additional_verification"

Reporting'reportRunResult'Purpose'EnumBusinessIcon

Represents the JSON value "business_icon"

Reporting'reportRunResult'Purpose'EnumBusinessLogo

Represents the JSON value "business_logo"

Reporting'reportRunResult'Purpose'EnumCustomerSignature

Represents the JSON value "customer_signature"

Reporting'reportRunResult'Purpose'EnumDisputeEvidence

Represents the JSON value "dispute_evidence"

Reporting'reportRunResult'Purpose'EnumDocumentProviderIdentityDocument

Represents the JSON value "document_provider_identity_document"

Reporting'reportRunResult'Purpose'EnumFinanceReportRun

Represents the JSON value "finance_report_run"

Reporting'reportRunResult'Purpose'EnumIdentityDocument

Represents the JSON value "identity_document"

Reporting'reportRunResult'Purpose'EnumIdentityDocumentDownloadable

Represents the JSON value "identity_document_downloadable"

Reporting'reportRunResult'Purpose'EnumPciDocument

Represents the JSON value "pci_document"

Reporting'reportRunResult'Purpose'EnumSelfie

Represents the JSON value "selfie"

Reporting'reportRunResult'Purpose'EnumSigmaScheduledQuery

Represents the JSON value "sigma_scheduled_query"

Reporting'reportRunResult'Purpose'EnumTaxDocumentUserUpload

Represents the JSON value "tax_document_user_upload"

Instances

Eq Reporting'reportRunResult'Purpose'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

(==) :: Reporting'reportRunResult'Purpose' -> Reporting'reportRunResult'Purpose' -> Bool

(/=) :: Reporting'reportRunResult'Purpose' -> Reporting'reportRunResult'Purpose' -> Bool

Show Reporting'reportRunResult'Purpose'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

showsPrec :: Int -> Reporting'reportRunResult'Purpose' -> ShowS

show :: Reporting'reportRunResult'Purpose' -> String

showList :: [Reporting'reportRunResult'Purpose'] -> ShowS

ToJSON Reporting'reportRunResult'Purpose'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

toJSON :: Reporting'reportRunResult'Purpose' -> Value

toEncoding :: Reporting'reportRunResult'Purpose' -> Encoding

toJSONList :: [Reporting'reportRunResult'Purpose'] -> Value

toEncodingList :: [Reporting'reportRunResult'Purpose'] -> Encoding

FromJSON Reporting'reportRunResult'Purpose'

Defined in StripeAPI.Types.Reporting_ReportRun

Methods

parseJSON :: Value -> Parser Reporting'reportRunResult'Purpose'

parseJSONList :: Value -> Parser [Reporting'reportRunResult'Purpose']