exoapi_stripe v0.1.4

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

Link to this section Summary

Types

get_events_id_opts()
get_events_opts()

Functions

get_events(client, opts \\ [])

description: <p>List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href="/docs/api/events/object">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).</p>

get_events_id(client, id, opts \\ [])

description: <p>Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.</p>

Link to this section Types

Link to this type

get_events_id_opts()

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

get_events_opts()

View Source 
@type get_events_opts() ::
  {:types, String.t()}
  | {:type, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:delivery_success, String.t()}
  | {:created, String.t()}

Link to this section Functions

Link to this function

get_events(client, opts \\ [])

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

description: <p>List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href="/docs/api/events/object">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).</p>

Link to this function

get_events_id(client, id, opts \\ [])

View Source 
@spec get_events_id(client :: ExOAPI.Client.t(), id :: String.t(), [
  get_events_id_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Event.t() | map()}
  | {:error, any()}

description: <p>Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.</p>