class Stripe::EventsApi
- Stripe::EventsApi
- Reference
- Object
Defined in:
stripe/api/events_api.crConstant Summary
-
GET_EVENTS_ID_MAX_LENGTH_FOR_ID =
5000
-
GET_EVENTS_MAX_LENGTH_FOR__TYPE =
5000
-
GET_EVENTS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_EVENTS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_events(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, types : Array(Array(String)) | Nil = nil, delivery_success : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_events_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_events(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, types : Array(Array(String)) | Nil = nil, delivery_success : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::NotificationEventList
List events, going back up to 30 days.
-
#get_events(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, types : Array(Array(String)) | Nil = nil, delivery_success : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>List events, going back up to 30 days.
-
#get_events_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Event
Retrieves the details of an event if it was created in the last 30 days.
-
#get_events_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the details of an event if it was created in the last 30 days.
-
#get_events_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Event, Int32, Hash(String, Array(String) | String))
<p>Retrieves the details of an event if it was created in the last 30 days.
-
#get_events_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, _type : String | Nil = nil, types : Array(Array(String)) | Nil = nil, delivery_success : Bool | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::NotificationEventList, Int32, Hash(String, Array(String) | String))
<p>List events, going back up to 30 days.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version
attribute (not according to your current Stripe API version or Stripe-Version
header).
<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="https://docs.stripe.com/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>
@optional @param ending_before [String?] 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.
@optional @param starting_after [String?] 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.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param _type [String?] 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.
@optional @param types [Array(Array(String))?] 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.
@optional @param delivery_success [Bool?] 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.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return events that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
@required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Event]<p>Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Event, Integer, Hash)] Stripe::Event, response status code and response headers
<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="https://docs.stripe.com/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>
@optional @param ending_before [String?] 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.
@optional @param starting_after [String?] 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.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param _type [String?] 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.
@optional @param types [Array(Array(String))?] 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.
@optional @param delivery_success [Bool?] 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.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return events that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::NotificationEventList, Integer, Hash)] Stripe::NotificationEventList, response status code and response headers