Class: Stripe::EventListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/event_list_params.rb

Defined Under Namespace

Classes: Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, delivery_success: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, type: nil, types: nil) ⇒ EventListParams

Returns a new instance of EventListParams.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/stripe/params/event_list_params.rb', line 40

def initialize(
  created: nil,
  delivery_success: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  starting_after: nil,
  type: nil,
  types: nil
)
  @created = created
  @delivery_success = delivery_success
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @starting_after = starting_after
  @type = type
  @types = types
end

Instance Attribute Details

#created ⇒ Object

Only return events that were created during the given date interval.



24
25
26
 
# File 'lib/stripe/params/event_list_params.rb', line 24

def created
  @created
end

#delivery_success ⇒ Object

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.



26
27
28
 
# File 'lib/stripe/params/event_list_params.rb', line 26

def delivery_success
  @delivery_success
end

#ending_before ⇒ Object

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.



28
29
30
 
# File 'lib/stripe/params/event_list_params.rb', line 28

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



30
31
32
 
# File 'lib/stripe/params/event_list_params.rb', line 30

def expand
  @expand
end

#limit ⇒ Object

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.



32
33
34
 
# File 'lib/stripe/params/event_list_params.rb', line 32

def limit
  @limit
end

#starting_after ⇒ Object

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.



34
35
36
 
# File 'lib/stripe/params/event_list_params.rb', line 34

def starting_after
  @starting_after
end

#type ⇒ Object

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.



36
37
38
 
# File 'lib/stripe/params/event_list_params.rb', line 36

def type
  @type
end

#types ⇒ Object

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.



38
39
40
 
# File 'lib/stripe/params/event_list_params.rb', line 38

def types
  @types
end