Striped v0.5.0

View Source Stripe.ScheduledQueryRun (Striped v0.5.0) (generated)

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.

Link to this section Summary

Types

t()

The scheduled_query_run type.

Functions

list(client, params \\ %{}, opts \\ [])

Returns a list of scheduled query runs.

retrieve(client, scheduled_query_run, params \\ %{}, opts \\ [])

Retrieves the details of an scheduled query run.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.ScheduledQueryRun{
  created: integer(),
  data_load_time: integer(),
  error: term(),
  file: Stripe.File.t() | nil,
  id: binary(),
  livemode: boolean(),
  object: binary(),
  result_available_until: integer(),
  sql: binary(),
  status: binary(),
  title: binary()
}

The scheduled_query_run type.

  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.
  • error
  • file The file object representing the results of the query.
  • id Unique identifier for the object.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object String representing the object's type. Objects of the same type share the same value.
  • result_available_until Time at which the result expires and is no longer available for download.
  • sql SQL for the query.
  • status The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.
  • title Title of the query.

Link to this section Functions

Link to this function

list(client, params \\ %{}, opts \\ [])

View Source 
@spec list(
  client :: Stripe.t(),
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of scheduled query runs.

Details

  • Method: get
  • Path: /v1/sigma/scheduled_query_runs
Link to this function

retrieve(client, scheduled_query_run, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  client :: Stripe.t(),
  scheduled_query_run :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an scheduled query run.

Details

  • Method: get
  • Path: /v1/sigma/scheduled_query_runs/{scheduled_query_run}