Class: Stripe::Treasury::TransactionListParams

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

Defined Under Namespace

Classes: Created, StatusTransitions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, ending_before: nil, expand: nil, financial_account: nil, limit: nil, order_by: nil, starting_after: nil, status: nil, status_transitions: nil) ⇒ TransactionListParams

Returns a new instance of TransactionListParams.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 69

def initialize(
  created: nil,
  ending_before: nil,
  expand: nil,
  financial_account: nil,
  limit: nil,
  order_by: nil,
  starting_after: nil,
  status: nil,
  status_transitions: nil
)
  @created = created
  @ending_before = ending_before
  @expand = expand
  @financial_account = 
  @limit = limit
  @order_by = order_by
  @starting_after = starting_after
  @status = status
  @status_transitions = status_transitions
end

Instance Attribute Details

#created ⇒ Object

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



51
52
53
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 51

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.



53
54
55
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 53

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



55
56
57
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 55

def expand
  @expand
end

#financial_account ⇒ Object

Returns objects associated with this FinancialAccount.



57
58
59
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 57

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



59
60
61
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 59

def limit
  @limit
end

#order_by ⇒ Object

The results are in reverse chronological order by ‘created` or `posted_at`. The default is `created`.



61
62
63
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 61

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



63
64
65
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 63

def starting_after
  @starting_after
end

#status ⇒ Object

Only return Transactions that have the given status: ‘open`, `posted`, or `void`.



65
66
67
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 65

def status
  @status
end

#status_transitions ⇒ Object

A filter for the ‘status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.



67
68
69
 
# File 'lib/stripe/params/treasury/transaction_list_params.rb', line 67

def status_transitions
  @status_transitions
end