Class: Stripe::FinancialConnections::AccountService::ListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/financial_connections/account_service.rb

Defined Under Namespace

Classes: AccountHolder

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(account_holder: nil, ending_before: nil, expand: nil, limit: nil, session: nil, starting_after: nil) ⇒ ListParams

Returns a new instance of ListParams.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 39

def initialize(
  account_holder: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  session: nil,
  starting_after: nil
)
  @account_holder = 
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @session = session
  @starting_after = starting_after
end

Instance Attribute Details

#account_holder ⇒ Object

If present, only return accounts that belong to the specified account holder. ‘account_holder` and `account_holder` are mutually exclusive.



27
28
29
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 27

def 
  @account_holder
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.



29
30
31
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 29

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



31
32
33
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 31

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.



33
34
35
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 33

def limit
  @limit
end

#session ⇒ Object

If present, only return accounts that were collected as part of the given session.



35
36
37
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 35

def session
  @session
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.



37
38
39
 
# File 'lib/stripe/services/financial_connections/account_service.rb', line 37

def starting_after
  @starting_after
end