Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.ScheduledQueryRun

Contains the types generated from the schema ScheduledQueryRun

Synopsis

data ScheduledQueryRun
value mkScheduledQueryRun
data ScheduledQueryRunFile'NonNullable
value mkScheduledQueryRunFile'NonNullable
data ScheduledQueryRunFile'NonNullableLinks'NonNullable
value mkScheduledQueryRunFile'NonNullableLinks'NonNullable
data ScheduledQueryRunFile'NonNullableObject'
data ScheduledQueryRunFile'NonNullablePurpose'

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceScheduledQueryRun.hs

datadata 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
- 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 (Nullable ScheduledQueryRunFile'NonNullable)
  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

Instances4Eq, Show, FromJSON, ToJSON

Eq ScheduledQueryRunDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
Show ScheduledQueryRunDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
FromJSON ScheduledQueryRunDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
ToJSON ScheduledQueryRunDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun

valuemkScheduledQueryRun

:: Int
scheduledQueryRunCreated
-> Int
scheduledQueryRunDataLoadTime
-> Text
scheduledQueryRunId
-> Bool
scheduledQueryRunLivemode
-> Int
scheduledQueryRunResultAvailableUntil
-> Text
scheduledQueryRunSql
-> Text
scheduledQueryRunStatus
-> Text
scheduledQueryRunTitle
-> ScheduledQueryRun

Source#

Create a new ScheduledQueryRun with all required fields.

datadata ScheduledQueryRunFile'NonNullable

Source#

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'NonNullable
- scheduledQueryRunFile'NonNullableCreated :: Maybe Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- scheduledQueryRunFile'NonNullableExpiresAt :: Maybe (Nullable Int)
  expires_at: The time at which the file expires and is no longer available in epoch seconds.
- scheduledQueryRunFile'NonNullableFilename :: Maybe (Nullable Text)
  filename: A filename for the file, suitable for saving to a filesystem.
  Constraints:
  - Maximum length of 5000
- scheduledQueryRunFile'NonNullableId :: Maybe Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- scheduledQueryRunFile'NonNullableLinks :: Maybe (Nullable ScheduledQueryRunFile'NonNullableLinks'NonNullable)
  links: A list of file links that point at this file.
- scheduledQueryRunFile'NonNullableObject :: Maybe ScheduledQueryRunFile'NonNullableObject'
  object: String representing the object's type. Objects of the same type share the same value.
- scheduledQueryRunFile'NonNullablePurpose :: Maybe ScheduledQueryRunFile'NonNullablePurpose'
  purpose: The purpose of the uploaded file.
- scheduledQueryRunFile'NonNullableSize :: Maybe Int
  size: The size in bytes of the file object.
- scheduledQueryRunFile'NonNullableTitle :: Maybe (Nullable Text)
  title: A user friendly title for the document.
  Constraints:
  - Maximum length of 5000
- scheduledQueryRunFile'NonNullableType :: Maybe (Nullable Text)
  type: The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).
  Constraints:
  - Maximum length of 5000
- scheduledQueryRunFile'NonNullableUrl :: 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 ScheduledQueryRunFile'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
Show ScheduledQueryRunFile'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
FromJSON ScheduledQueryRunFile'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
ToJSON ScheduledQueryRunFile'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun

valuemkScheduledQueryRunFile'NonNullable :: ScheduledQueryRunFile'NonNullable

Source#

Create a new ScheduledQueryRunFile'NonNullable with all required fields.

datadata ScheduledQueryRunFile'NonNullableLinks'NonNullable

Source#

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

valuemkScheduledQueryRunFile'NonNullableLinks'NonNullable

:: [FileLink]
scheduledQueryRunFile'NonNullableLinks'NonNullableData
-> Bool
scheduledQueryRunFile'NonNullableLinks'NonNullableHasMore
-> Text
scheduledQueryRunFile'NonNullableLinks'NonNullableUrl
-> ScheduledQueryRunFile'NonNullableLinks'NonNullable

Source#

Create a new ScheduledQueryRunFile'NonNullableLinks'NonNullable with all required fields.

datadata ScheduledQueryRunFile'NonNullableObject'

Source#

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

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

Constructors

ScheduledQueryRunFile'NonNullableObject'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ScheduledQueryRunFile'NonNullableObject'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
ScheduledQueryRunFile'NonNullableObject'EnumFile
Represents the JSON value "file"

Instances4Eq, Show, FromJSON, ToJSON

Eq ScheduledQueryRunFile'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
Show ScheduledQueryRunFile'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
FromJSON ScheduledQueryRunFile'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
ToJSON ScheduledQueryRunFile'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun

datadata ScheduledQueryRunFile'NonNullablePurpose'

Source#

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'NonNullablePurpose'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ScheduledQueryRunFile'NonNullablePurpose'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
ScheduledQueryRunFile'NonNullablePurpose'EnumAccountRequirement
Represents the JSON value "account_requirement"
ScheduledQueryRunFile'NonNullablePurpose'EnumAdditionalVerification
Represents the JSON value "additional_verification"
ScheduledQueryRunFile'NonNullablePurpose'EnumBusinessIcon
Represents the JSON value "business_icon"
ScheduledQueryRunFile'NonNullablePurpose'EnumBusinessLogo
Represents the JSON value "business_logo"
ScheduledQueryRunFile'NonNullablePurpose'EnumCustomerSignature
Represents the JSON value "customer_signature"
ScheduledQueryRunFile'NonNullablePurpose'EnumDisputeEvidence
Represents the JSON value "dispute_evidence"
ScheduledQueryRunFile'NonNullablePurpose'EnumDocumentProviderIdentityDocument
Represents the JSON value "document_provider_identity_document"
ScheduledQueryRunFile'NonNullablePurpose'EnumFinanceReportRun
Represents the JSON value "finance_report_run"
ScheduledQueryRunFile'NonNullablePurpose'EnumIdentityDocument
Represents the JSON value "identity_document"
ScheduledQueryRunFile'NonNullablePurpose'EnumIdentityDocumentDownloadable
Represents the JSON value "identity_document_downloadable"
ScheduledQueryRunFile'NonNullablePurpose'EnumPciDocument
Represents the JSON value "pci_document"
ScheduledQueryRunFile'NonNullablePurpose'EnumSelfie
Represents the JSON value "selfie"
ScheduledQueryRunFile'NonNullablePurpose'EnumSigmaScheduledQuery
Represents the JSON value "sigma_scheduled_query"
ScheduledQueryRunFile'NonNullablePurpose'EnumTaxDocumentUserUpload
Represents the JSON value "tax_document_user_upload"

Instances4Eq, Show, FromJSON, ToJSON

Eq ScheduledQueryRunFile'NonNullablePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
Show ScheduledQueryRunFile'NonNullablePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
FromJSON ScheduledQueryRunFile'NonNullablePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun
ToJSON ScheduledQueryRunFile'NonNullablePurpose'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.ScheduledQueryRun