Class: Stripe::Treasury::TransactionEntry::ListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/treasury/transaction_entry.rb

Defined Under Namespace

Classes: Created, EffectiveAt

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, effective_at: nil, ending_before: nil, expand: nil, financial_account: nil, limit: nil, order_by: nil, starting_after: nil, transaction: nil) ⇒ ListParams

Returns a new instance of ListParams.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 138

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

Instance Attribute Details

#created ⇒ Object

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



112
113
114
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 112

def created
  @created
end

#effective_at ⇒ Object

Attribute for param field effective_at



115
116
117
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 115

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



118
119
120
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 118

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



121
122
123
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 121

def expand
  @expand
end

#financial_account ⇒ Object

Returns objects associated with this FinancialAccount.



124
125
126
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 124

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.



127
128
129
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 127

def limit
  @limit
end

#order_by ⇒ Object

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



130
131
132
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 130

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.



133
134
135
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 133

def starting_after
  @starting_after
end

#transaction ⇒ Object

Only return TransactionEntries associated with this Transaction.



136
137
138
 
# File 'lib/stripe/resources/treasury/transaction_entry.rb', line 136

def transaction
  @transaction
end