View Source ExOAPI.Stripe.SDK.Reporting (exoapi_stripe v0.1.1)

Link to this section Summary

Functions

description: <p>Returns a list of Report Runs, with the most recent appearing first.</p>

description: <p>Retrieves the details of an existing Report Run.</p>

description: <p>Returns a full list of Report Types.</p>

description: <p>Retrieves the details of a Report Type. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p>

description: <p>Creates a new object and begin running the report. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p>

Link to this section Types

Link to this type

get_reporting_report_runs_opts()

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

get_reporting_report_runs_report_run_opts()

View Source
@type get_reporting_report_runs_report_run_opts() :: {:expand, String.t()}
Link to this type

get_reporting_report_types_opts()

View Source
@type get_reporting_report_types_opts() :: {:expand, String.t()}
Link to this type

get_reporting_report_types_report_type_opts()

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

Link to this section Functions

Link to this function

get_reporting_report_runs(client, opts \\ [])

View Source
@spec get_reporting_report_runs(client :: ExOAPI.Client.t(), [
  get_reporting_report_runs_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of Report Runs, with the most recent appearing first.</p>

Link to this function

get_reporting_report_runs_report_run(client, report_run, opts \\ [])

View Source
@spec get_reporting_report_runs_report_run(
  client :: ExOAPI.Client.t(),
  report_run :: String.t(),
  [get_reporting_report_runs_report_run_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves the details of an existing Report Run.</p>

Link to this function

get_reporting_report_types(client, opts \\ [])

View Source
@spec get_reporting_report_types(client :: ExOAPI.Client.t(), [
  get_reporting_report_types_opts()
]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a full list of Report Types.</p>

Link to this function

get_reporting_report_types_report_type(client, report_type, opts \\ [])

View Source
@spec get_reporting_report_types_report_type(
  client :: ExOAPI.Client.t(),
  report_type :: String.t(),
  [get_reporting_report_types_report_type_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves the details of a Report Type. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p>

Link to this function

post_reporting_report_runs(client, body)

View Source
@spec post_reporting_report_runs(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a new object and begin running the report. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)</p>