Class: Stripe::TopupService::ListParams
- Inherits:
-
RequestParams
- Object
- RequestParams
- Stripe::TopupService::ListParams
- Defined in:
- lib/stripe/services/topup_service.rb
Defined Under Namespace
Instance Attribute Summary collapse
-
#amount ⇒ Object
A positive integer representing how much to transfer.
-
#created ⇒ Object
A filter on the list, based on the object ‘created` field.
-
#ending_before ⇒ Object
A cursor for use in pagination.
-
#expand ⇒ Object
Specifies which fields in the response should be expanded.
-
#limit ⇒ Object
A limit on the number of objects to be returned.
-
#starting_after ⇒ Object
A cursor for use in pagination.
-
#status ⇒ Object
Only return top-ups that have the given status.
Instance Method Summary collapse
-
#initialize(amount: nil, created: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil) ⇒ ListParams
constructor
A new instance of ListParams.
Methods inherited from RequestParams
Constructor Details
#initialize(amount: nil, created: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil) ⇒ ListParams
Returns a new instance of ListParams.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/stripe/services/topup_service.rb', line 57 def initialize( amount: nil, created: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil ) @amount = amount @created = created @ending_before = ending_before @expand = @limit = limit @starting_after = starting_after @status = status end |
Instance Attribute Details
#amount ⇒ Object
A positive integer representing how much to transfer.
43 44 45 |
# File 'lib/stripe/services/topup_service.rb', line 43 def amount @amount end |
#created ⇒ Object
A filter on the list, based on the object ‘created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
45 46 47 |
# File 'lib/stripe/services/topup_service.rb', line 45 def created @created 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.
47 48 49 |
# File 'lib/stripe/services/topup_service.rb', line 47 def ending_before @ending_before end |
#expand ⇒ Object
Specifies which fields in the response should be expanded.
49 50 51 |
# File 'lib/stripe/services/topup_service.rb', line 49 def @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.
51 52 53 |
# File 'lib/stripe/services/topup_service.rb', line 51 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.
53 54 55 |
# File 'lib/stripe/services/topup_service.rb', line 53 def starting_after @starting_after end |
#status ⇒ Object
Only return top-ups that have the given status. One of ‘canceled`, `failed`, `pending` or `succeeded`.
55 56 57 |
# File 'lib/stripe/services/topup_service.rb', line 55 def status @status end |