Packages
stripity_stripe
3.3.2
3.3.2
3.3.1
3.2.0
3.1.1
3.1.0
3.0.0
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.1
2.15.0
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.3
2.2.2
2.2.1
2.2.0
2.1.0
2.0.1
2.0.0
2.0.0-alpha.11
2.0.0-alpha.10
2.0.0-alpha.9
2.0.0-alpha.8
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.6.2
1.6.1
1.6.0
1.4.0
1.3.0
1.2.0
1.1.0
0.5.0
0.4.0
0.3.0
0.2.0
A Stripe client for Elixir.
Current section
Files
Jump to
Current section
Files
lib/generated/scheduled_query_run.ex
defmodule Stripe.ScheduledQueryRun do
use Stripe.Entity
@moduledoc "If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results."
(
defstruct [
:created,
:data_load_time,
:error,
:file,
:id,
:livemode,
:object,
:result_available_until,
:sql,
:status,
:title
]
@typedoc "The `scheduled_query_run` type.\n\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `data_load_time` When the query was run, Sigma contained a snapshot of your Stripe data at this time.\n * `error` \n * `file` The file object representing the results of the query.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `result_available_until` Time at which the result expires and is no longer available for download.\n * `sql` SQL for the query.\n * `status` The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.\n * `title` Title of the query.\n"
@type t :: %__MODULE__{
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
}
)
(
nil
@doc "<p>Returns a list of scheduled query runs.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/sigma/scheduled_query_runs`\n"
(
@spec list(
params :: %{
optional(:ending_before) => binary,
optional(:expand) => list(binary),
optional(:limit) => integer,
optional(:starting_after) => binary
},
opts :: Keyword.t()
) ::
{:ok, Stripe.List.t(Stripe.ScheduledQueryRun.t())}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def list(params \\ %{}, opts \\ []) do
path = Stripe.OpenApi.Path.replace_path_params("/v1/sigma/scheduled_query_runs", [], [])
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
(
nil
@doc "<p>Retrieves the details of an scheduled query run.</p>\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/sigma/scheduled_query_runs/{scheduled_query_run}`\n"
(
@spec retrieve(
scheduled_query_run :: binary(),
params :: %{optional(:expand) => list(binary)},
opts :: Keyword.t()
) ::
{:ok, Stripe.ScheduledQueryRun.t()}
| {:error, Stripe.ApiErrors.t()}
| {:error, term()}
def retrieve(scheduled_query_run, params \\ %{}, opts \\ []) do
path =
Stripe.OpenApi.Path.replace_path_params(
"/v1/sigma/scheduled_query_runs/{scheduled_query_run}",
[
%{
__struct__: OpenApiGen.Blueprint.Parameter,
in: "path",
name: "scheduled_query_run",
required: true,
schema: %{
__struct__: OpenApiGen.Blueprint.Parameter.Schema,
any_of: [],
items: [],
name: "scheduled_query_run",
properties: [],
title: nil,
type: "string"
}
}
],
[scheduled_query_run]
)
Stripe.Request.new_request(opts)
|> Stripe.Request.put_endpoint(path)
|> Stripe.Request.put_params(params)
|> Stripe.Request.put_method(:get)
|> Stripe.Request.make_request()
end
)
)
end