Packages

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

Current section

Files

Jump to
tiger_stripe lib stripe params event_list_params.ex
Raw

lib/stripe/params/event_list_params.ex

# File generated from our OpenAPI spec
defmodule Stripe.Params.EventListParams do
@moduledoc "Parameters for event list."
@typedoc """
* `created` - Only return events that were created during the given date interval.
* `delivery_success` - Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
* `ending_before` - A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. Max length: 5000.
* `expand` - Specifies which fields in the response should be expanded.
* `limit` - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
* `starting_after` - A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. Max length: 5000.
* `type` - A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. Max length: 5000.
* `types` - An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
"""
@type t :: %__MODULE__{
created: map() | nil,
delivery_success: boolean() | nil,
ending_before: String.t() | nil,
expand: [String.t()] | nil,
limit: integer() | nil,
starting_after: String.t() | nil,
type: String.t() | nil,
types: [String.t()] | nil
}
defstruct [
:created,
:delivery_success,
:ending_before,
:expand,
:limit,
:starting_after,
:type,
:types
]
end