StripeAPI.Types.ScheduledQueryRun

Contains the types generated from the schema ScheduledQueryRun

Documentation

data ScheduledQueryRun

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

If you have scheduled a Sigma query, you'll receive a `sigma.scheduled_query_run.created` webhook each time the query runs. The webhook contains a `ScheduledQueryRun` object, which you can use to retrieve the query results.

Constructors

ScheduledQueryRun

Fields

• scheduledQueryRunCreated :: Int

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

• scheduledQueryRunDataLoadTime :: Int

  data_load_time: When the query was run, Sigma contained a snapshot of your Stripe data at this time.

• scheduledQueryRunError :: Maybe SigmaScheduledQueryRunError

  error:

• scheduledQueryRunFile :: Maybe ScheduledQueryRunFile'

  file: The file object representing the results of the query.

• scheduledQueryRunId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• scheduledQueryRunLivemode :: Bool

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

• scheduledQueryRunResultAvailableUntil :: Int

  result_available_until: Time at which the result expires and is no longer available for download.

• scheduledQueryRunSql :: Text

  sql: SQL for the query.

  Constraints:

  • Maximum length of 100000
• scheduledQueryRunStatus :: Text

  status: The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.

  Constraints:

  • Maximum length of 5000
• scheduledQueryRunTitle :: Text

  title: Title of the query.

  Constraints:

  • Maximum length of 5000

Instances

Eq ScheduledQueryRun

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

(==) :: ScheduledQueryRun -> ScheduledQueryRun -> Bool

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

Show ScheduledQueryRun

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

showsPrec :: Int -> ScheduledQueryRun -> ShowS

show :: ScheduledQueryRun -> String

showList :: [ScheduledQueryRun] -> ShowS

ToJSON ScheduledQueryRun

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

toJSON :: ScheduledQueryRun -> Value

toEncoding :: ScheduledQueryRun -> Encoding

toJSONList :: [ScheduledQueryRun] -> Value

toEncodingList :: [ScheduledQueryRun] -> Encoding

FromJSON ScheduledQueryRun

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

parseJSON :: Value -> Parser ScheduledQueryRun

parseJSONList :: Value -> Parser [ScheduledQueryRun]

mkScheduledQueryRun

Arguments

:: Int

scheduledQueryRunCreated

-> Int

scheduledQueryRunDataLoadTime

-> Text

scheduledQueryRunId

-> Bool

scheduledQueryRunLivemode

-> Int

scheduledQueryRunResultAvailableUntil

-> Text

scheduledQueryRunSql

-> Text

scheduledQueryRunStatus

-> Text

scheduledQueryRunTitle

-> ScheduledQueryRun

Create a new ScheduledQueryRun with all required fields.

data ScheduledQueryRunFile'

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

The file object representing the results of the query.

Constructors

ScheduledQueryRunFile'

Fields

• scheduledQueryRunFile'Created :: Maybe Int

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

• scheduledQueryRunFile'ExpiresAt :: Maybe Int

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

• scheduledQueryRunFile'Filename :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• scheduledQueryRunFile'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• scheduledQueryRunFile'Links :: Maybe ScheduledQueryRunFile'Links'

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

• scheduledQueryRunFile'Purpose :: Maybe ScheduledQueryRunFile'Purpose'

  purpose: The purpose of the uploaded file.

• scheduledQueryRunFile'Size :: Maybe Int

  size: The size in bytes of the file object.

• scheduledQueryRunFile'Title :: Maybe Text

  title: A user friendly title for the document.

  Constraints:

  • Maximum length of 5000
• scheduledQueryRunFile'Type :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• scheduledQueryRunFile'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 ScheduledQueryRunFile'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

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

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

Show ScheduledQueryRunFile'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

showsPrec :: Int -> ScheduledQueryRunFile' -> ShowS

show :: ScheduledQueryRunFile' -> String

showList :: [ScheduledQueryRunFile'] -> ShowS

ToJSON ScheduledQueryRunFile'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

toJSON :: ScheduledQueryRunFile' -> Value

toEncoding :: ScheduledQueryRunFile' -> Encoding

toJSONList :: [ScheduledQueryRunFile'] -> Value

toEncodingList :: [ScheduledQueryRunFile'] -> Encoding

FromJSON ScheduledQueryRunFile'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

parseJSON :: Value -> Parser ScheduledQueryRunFile'

parseJSONList :: Value -> Parser [ScheduledQueryRunFile']

mkScheduledQueryRunFile' :: ScheduledQueryRunFile'

Create a new ScheduledQueryRunFile' with all required fields.

data ScheduledQueryRunFile'Links'

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

A list of file links that point at this file.

Constructors

ScheduledQueryRunFile'Links'

Fields

• scheduledQueryRunFile'Links'Data :: [FileLink]

  data: Details about each object.

• scheduledQueryRunFile'Links'HasMore :: Bool

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

• scheduledQueryRunFile'Links'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq ScheduledQueryRunFile'Links'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

(==) :: ScheduledQueryRunFile'Links' -> ScheduledQueryRunFile'Links' -> Bool

(/=) :: ScheduledQueryRunFile'Links' -> ScheduledQueryRunFile'Links' -> Bool

Show ScheduledQueryRunFile'Links'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

showsPrec :: Int -> ScheduledQueryRunFile'Links' -> ShowS

show :: ScheduledQueryRunFile'Links' -> String

showList :: [ScheduledQueryRunFile'Links'] -> ShowS

ToJSON ScheduledQueryRunFile'Links'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

toJSON :: ScheduledQueryRunFile'Links' -> Value

toEncoding :: ScheduledQueryRunFile'Links' -> Encoding

toJSONList :: [ScheduledQueryRunFile'Links'] -> Value

toEncodingList :: [ScheduledQueryRunFile'Links'] -> Encoding

FromJSON ScheduledQueryRunFile'Links'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

parseJSON :: Value -> Parser ScheduledQueryRunFile'Links'

parseJSONList :: Value -> Parser [ScheduledQueryRunFile'Links']

mkScheduledQueryRunFile'Links'

Arguments

:: [FileLink]

scheduledQueryRunFile'Links'Data

-> Bool

scheduledQueryRunFile'Links'HasMore

-> Text

scheduledQueryRunFile'Links'Url

-> ScheduledQueryRunFile'Links'

Create a new ScheduledQueryRunFile'Links' with all required fields.

data ScheduledQueryRunFile'Purpose'

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

The purpose of the uploaded file.

Constructors

ScheduledQueryRunFile'Purpose'Other Value

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

ScheduledQueryRunFile'Purpose'Typed Text

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

ScheduledQueryRunFile'Purpose'EnumAccountRequirement

Represents the JSON value "account_requirement"

ScheduledQueryRunFile'Purpose'EnumAdditionalVerification

Represents the JSON value "additional_verification"

ScheduledQueryRunFile'Purpose'EnumBusinessIcon

Represents the JSON value "business_icon"

ScheduledQueryRunFile'Purpose'EnumBusinessLogo

Represents the JSON value "business_logo"

ScheduledQueryRunFile'Purpose'EnumCustomerSignature

Represents the JSON value "customer_signature"

ScheduledQueryRunFile'Purpose'EnumDisputeEvidence

Represents the JSON value "dispute_evidence"

ScheduledQueryRunFile'Purpose'EnumDocumentProviderIdentityDocument

Represents the JSON value "document_provider_identity_document"

ScheduledQueryRunFile'Purpose'EnumFinanceReportRun

Represents the JSON value "finance_report_run"

ScheduledQueryRunFile'Purpose'EnumIdentityDocument

Represents the JSON value "identity_document"

ScheduledQueryRunFile'Purpose'EnumIdentityDocumentDownloadable

Represents the JSON value "identity_document_downloadable"

ScheduledQueryRunFile'Purpose'EnumPciDocument

Represents the JSON value "pci_document"

ScheduledQueryRunFile'Purpose'EnumSelfie

Represents the JSON value "selfie"

ScheduledQueryRunFile'Purpose'EnumSigmaScheduledQuery

Represents the JSON value "sigma_scheduled_query"

ScheduledQueryRunFile'Purpose'EnumTaxDocumentUserUpload

Represents the JSON value "tax_document_user_upload"

Instances

Eq ScheduledQueryRunFile'Purpose'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

(==) :: ScheduledQueryRunFile'Purpose' -> ScheduledQueryRunFile'Purpose' -> Bool

(/=) :: ScheduledQueryRunFile'Purpose' -> ScheduledQueryRunFile'Purpose' -> Bool

Show ScheduledQueryRunFile'Purpose'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

showsPrec :: Int -> ScheduledQueryRunFile'Purpose' -> ShowS

show :: ScheduledQueryRunFile'Purpose' -> String

showList :: [ScheduledQueryRunFile'Purpose'] -> ShowS

ToJSON ScheduledQueryRunFile'Purpose'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

toJSON :: ScheduledQueryRunFile'Purpose' -> Value

toEncoding :: ScheduledQueryRunFile'Purpose' -> Encoding

toJSONList :: [ScheduledQueryRunFile'Purpose'] -> Value

toEncodingList :: [ScheduledQueryRunFile'Purpose'] -> Encoding

FromJSON ScheduledQueryRunFile'Purpose'

Defined in StripeAPI.Types.ScheduledQueryRun

Methods

parseJSON :: Value -> Parser ScheduledQueryRunFile'Purpose'

parseJSONList :: Value -> Parser [ScheduledQueryRunFile'Purpose']