View Source ExOAPI.Stripe.Schemas.ScheduledQueryRun (exoapi_stripe v0.1.4)

description: 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.

:created :: :integer

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

:data_load_time :: :integer

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

:error :: ExOAPI.Stripe.Schemas.SigmaScheduledQueryRunError

:file :: ExOAPI.Stripe.Schemas.File

The file object representing the results of the query.

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

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

:object :: :string

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

:result_available_until :: :integer

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

:sql :: :string

SQL for the query.

:status :: :string

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

:title :: :string

Title of the query.

Link to this section Summary

Link to this section Types

@type params() :: map()
@type t() :: %ExOAPI.Stripe.Schemas.ScheduledQueryRun{
  created: integer() | nil,
  data_load_time: integer() | nil,
  error: ExOAPI.Stripe.Schemas.SigmaScheduledQueryRunError.t() | nil,
  file: ExOAPI.EctoTypes.AnyOf.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  object: :scheduled_query_run | nil,
  result_available_until: integer() | nil,
  sql: String.t() | nil,
  status: String.t() | nil,
  title: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source
@spec changeset(t(), params()) :: Ecto.Changeset.t()