-
Notifications
You must be signed in to change notification settings - Fork 724
/
EventsResource.d.ts
63 lines (55 loc) · 2.22 KB
/
EventsResource.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface EventRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface EventListParams extends PaginationParams {
/**
* Only return events that were created during the given date interval.
*/
created?: Stripe.RangeQueryParam | number;
/**
* 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.
*/
delivery_success?: boolean;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<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.
*/
type?: 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.
*/
types?: Array<string>;
}
class EventsResource {
/**
* Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
*/
retrieve(
id: string,
params?: EventRetrieveParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Event>>;
retrieve(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Event>>;
/**
* 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](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
*/
list(
params?: EventListParams,
options?: RequestOptions
): ApiListPromise<Stripe.Event>;
list(options?: RequestOptions): ApiListPromise<Stripe.Event>;
}
}
}