exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.Sigma (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_sigma_scheduled_query_runs_opts()
get_sigma_scheduled_query_runs_scheduled_query_run_opts()

Functions

get_sigma_scheduled_query_runs(client, opts \\ [])

description: <p>Returns a list of scheduled query runs.</p>

get_sigma_scheduled_query_runs_scheduled_query_run(client, scheduled_query_run, opts \\ [])

description: <p>Retrieves the details of an scheduled query run.</p>

Link to this section Types

Link to this type

get_sigma_scheduled_query_runs_opts()

View Source 
@type get_sigma_scheduled_query_runs_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
Link to this type

get_sigma_scheduled_query_runs_scheduled_query_run_opts()

View Source 
@type get_sigma_scheduled_query_runs_scheduled_query_run_opts() ::
  {:expand, String.t()}

Link to this section Functions

Link to this function

get_sigma_scheduled_query_runs(client, opts \\ [])

View Source 
@spec get_sigma_scheduled_query_runs(client :: ExOAPI.Client.t(), [
  get_sigma_scheduled_query_runs_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.ScheduledQueryRun.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of scheduled query runs.</p>

Link to this function

get_sigma_scheduled_query_runs_scheduled_query_run(client, scheduled_query_run, opts \\ [])

View Source 
@spec get_sigma_scheduled_query_runs_scheduled_query_run(
  client :: ExOAPI.Client.t(),
  scheduled_query_run :: String.t(),
  [get_sigma_scheduled_query_runs_scheduled_query_run_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ScheduledQueryRun.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the details of an scheduled query run.</p>