Skip to content

Commit a9df6e3

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): add WIRE category to account_activity/statements/payment, wire event types, remove field
1 parent d5d3ecb commit a9df6e3

16 files changed

Lines changed: 268 additions & 37 deletions

‎.stats.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 189
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-b0ae5fc46338788b5191870fa233397a5624402f6f30177574fc824c2d6d235f.yml
3-
openapi_spec_hash: 13b104665e60f7d755b0483eb2e8a344
4-
config_hash: 7daa8d0d03697920c0c1ca18ce6d4594
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-716063c7d5d29dd3904168352017d0a065e50eec066f78ed8a3f7c796a48a78b.yml
3+
openapi_spec_hash: 3d930f469199651974e9bfbee65486ef
4+
config_hash: 8799cfd589579f105ef8696a6d664c71

‎lib/lithic/models/account_activity_list_params.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ module Category
110110
extend Lithic::Internal::Type::Enum
111111

112112
ACH = :ACH
113+
WIRE = :WIRE
113114
BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
114115
FEE = :FEE
115116
REWARD = :REWARD

‎lib/lithic/models/account_activity_list_response.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ module Category
149149
extend Lithic::Internal::Type::Enum
150150

151151
ACH = :ACH
152+
WIRE = :WIRE
152153
BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
153154
FEE = :FEE
154155
REWARD = :REWARD

‎lib/lithic/models/account_activity_retrieve_transaction_response.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ module Category
152152
extend Lithic::Internal::Type::Enum
153153

154154
ACH = :ACH
155+
WIRE = :WIRE
155156
BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
156157
FEE = :FEE
157158
REWARD = :REWARD

‎lib/lithic/models/financial_accounts/statements/statement_line_items.rb‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ class Data < Lithic::Internal::Type::BaseModel
3434
required :amount, Integer
3535

3636
# @!attribute category
37+
# Note: Inbound wire transfers are coming soon (availability varies by partner
38+
# bank). The WIRE category is a preview. To learn more, contact your customer
39+
# success manager.
3740
#
3841
# @return [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
3942
required :category, enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category }
@@ -113,7 +116,7 @@ class Data < Lithic::Internal::Type::BaseModel
113116
#
114117
# @param amount [Integer] Transaction amount in cents
115118
#
116-
# @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
119+
# @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category] Note: Inbound wire transfers are coming soon (availability varies by partner ban
117120
#
118121
# @param created [Time] Timestamp of when the line item was generated
119122
#
@@ -137,11 +140,16 @@ class Data < Lithic::Internal::Type::BaseModel
137140
#
138141
# @param loan_tape_date [Date, nil] Date of the loan tape that generated this line item
139142

143+
# Note: Inbound wire transfers are coming soon (availability varies by partner
144+
# bank). The WIRE category is a preview. To learn more, contact your customer
145+
# success manager.
146+
#
140147
# @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#category
141148
module Category
142149
extend Lithic::Internal::Type::Enum
143150

144151
ACH = :ACH
152+
WIRE = :WIRE
145153
BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
146154
FEE = :FEE
147155
REWARD = :REWARD

‎lib/lithic/models/payment.rb‎

Lines changed: 70 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ module Category
189189
extend Lithic::Internal::Type::Enum
190190

191191
ACH = :ACH
192+
WIRE = :WIRE
192193
BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
193194
FEE = :FEE
194195
REWARD = :REWARD
@@ -255,8 +256,14 @@ class Event < Lithic::Internal::Type::BaseModel
255256
required :result, enum: -> { Lithic::Payment::Event::Result }
256257

257258
# @!attribute type
259+
# Note: Inbound wire transfers are coming soon (availability varies by partner
260+
# bank). Wire-related event types below are a preview. To learn more, contact your
261+
# customer success manager.
262+
#
258263
# Event types:
259264
#
265+
# ACH events:
266+
#
260267
# - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
261268
# approval/release from an ACH hold.
262269
# - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
@@ -282,6 +289,26 @@ class Event < Lithic::Internal::Type::BaseModel
282289
# - `ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository
283290
# Financial Institution.
284291
#
292+
# Wire transfer events:
293+
#
294+
# - `WIRE_TRANSFER_INBOUND_RECEIVED` - Inbound wire transfer received from the
295+
# Federal Reserve and pending release to available balance.
296+
# - `WIRE_TRANSFER_INBOUND_SETTLED` - Inbound wire transfer funds released from
297+
# pending to available balance.
298+
# - `WIRE_TRANSFER_INBOUND_BLOCKED` - Inbound wire transfer blocked and funds
299+
# frozen for regulatory review.
300+
#
301+
# Wire return events:
302+
#
303+
# - `WIRE_RETURN_OUTBOUND_INITIATED` - Outbound wire return initiated to return
304+
# funds from an inbound wire transfer.
305+
# - `WIRE_RETURN_OUTBOUND_SENT` - Outbound wire return sent to the Federal Reserve
306+
# and pending acceptance.
307+
# - `WIRE_RETURN_OUTBOUND_SETTLED` - Outbound wire return accepted by the Federal
308+
# Reserve and funds returned to sender.
309+
# - `WIRE_RETURN_OUTBOUND_REJECTED` - Outbound wire return rejected by the Federal
310+
# Reserve.
311+
#
285312
# @return [Symbol, Lithic::Models::Payment::Event::Type]
286313
required :type, enum: -> { Lithic::Payment::Event::Type }
287314

@@ -293,7 +320,9 @@ class Event < Lithic::Internal::Type::BaseModel
293320
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Payment::Event::DetailedResult] }
294321

295322
# @!attribute external_id
296-
# Payment event external ID, for example, ACH trace number.
323+
# Payment event external ID. For ACH transactions, this is the ACH trace number.
324+
# For inbound wire transfers, this is the IMAD (Input Message Accountability
325+
# Data).
297326
#
298327
# @return [String, nil]
299328
optional :external_id, String, nil?: true
@@ -302,6 +331,10 @@ class Event < Lithic::Internal::Type::BaseModel
302331
# Some parameter documentations has been truncated, see
303332
# {Lithic::Models::Payment::Event} for more details.
304333
#
334+
# Note: Inbound wire transfers are coming soon (availability varies by partner
335+
# bank). Wire-related fields below are a preview. To learn more, contact your
336+
# customer success manager.
337+
#
305338
# Payment Event
306339
#
307340
# @param token [String] Globally unique identifier.
@@ -312,11 +345,11 @@ class Event < Lithic::Internal::Type::BaseModel
312345
#
313346
# @param result [Symbol, Lithic::Models::Payment::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
314347
#
315-
# @param type [Symbol, Lithic::Models::Payment::Event::Type] Event types:
348+
# @param type [Symbol, Lithic::Models::Payment::Event::Type] Note: Inbound wire transfers are coming soon (availability varies by partner ban
316349
#
317350
# @param detailed_results [Array<Symbol, Lithic::Models::Payment::Event::DetailedResult>] More detailed reasons for the event
318351
#
319-
# @param external_id [String, nil] Payment event external ID, for example, ACH trace number.
352+
# @param external_id [String, nil] Payment event external ID. For ACH transactions, this is the ACH trace number.
320353

321354
# APPROVED financial events were successful while DECLINED financial events were
322355
# declined by user, Lithic, or the network.
@@ -332,8 +365,14 @@ module Result
332365
# @return [Array<Symbol>]
333366
end
334367

368+
# Note: Inbound wire transfers are coming soon (availability varies by partner
369+
# bank). Wire-related event types below are a preview. To learn more, contact your
370+
# customer success manager.
371+
#
335372
# Event types:
336373
#
374+
# ACH events:
375+
#
337376
# - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
338377
# approval/release from an ACH hold.
339378
# - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
@@ -359,6 +398,26 @@ module Result
359398
# - `ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository
360399
# Financial Institution.
361400
#
401+
# Wire transfer events:
402+
#
403+
# - `WIRE_TRANSFER_INBOUND_RECEIVED` - Inbound wire transfer received from the
404+
# Federal Reserve and pending release to available balance.
405+
# - `WIRE_TRANSFER_INBOUND_SETTLED` - Inbound wire transfer funds released from
406+
# pending to available balance.
407+
# - `WIRE_TRANSFER_INBOUND_BLOCKED` - Inbound wire transfer blocked and funds
408+
# frozen for regulatory review.
409+
#
410+
# Wire return events:
411+
#
412+
# - `WIRE_RETURN_OUTBOUND_INITIATED` - Outbound wire return initiated to return
413+
# funds from an inbound wire transfer.
414+
# - `WIRE_RETURN_OUTBOUND_SENT` - Outbound wire return sent to the Federal Reserve
415+
# and pending acceptance.
416+
# - `WIRE_RETURN_OUTBOUND_SETTLED` - Outbound wire return accepted by the Federal
417+
# Reserve and funds returned to sender.
418+
# - `WIRE_RETURN_OUTBOUND_REJECTED` - Outbound wire return rejected by the Federal
419+
# Reserve.
420+
#
362421
# @see Lithic::Models::Payment::Event#type
363422
module Type
364423
extend Lithic::Internal::Type::Enum
@@ -378,6 +437,13 @@ module Type
378437
ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
379438
ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
380439
ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
440+
WIRE_TRANSFER_INBOUND_RECEIVED = :WIRE_TRANSFER_INBOUND_RECEIVED
441+
WIRE_TRANSFER_INBOUND_SETTLED = :WIRE_TRANSFER_INBOUND_SETTLED
442+
WIRE_TRANSFER_INBOUND_BLOCKED = :WIRE_TRANSFER_INBOUND_BLOCKED
443+
WIRE_RETURN_OUTBOUND_INITIATED = :WIRE_RETURN_OUTBOUND_INITIATED
444+
WIRE_RETURN_OUTBOUND_SENT = :WIRE_RETURN_OUTBOUND_SENT
445+
WIRE_RETURN_OUTBOUND_SETTLED = :WIRE_RETURN_OUTBOUND_SETTLED
446+
WIRE_RETURN_OUTBOUND_REJECTED = :WIRE_RETURN_OUTBOUND_REJECTED
381447

382448
# @!method self.values
383449
# @return [Array<Symbol>]
@@ -537,13 +603,7 @@ class WireMethodAttributes < Lithic::Internal::Type::BaseModel
537603
# @return [String, nil]
538604
optional :message_id, String, nil?: true
539605

540-
# @!attribute remittance_information
541-
# Payment details or invoice reference
542-
#
543-
# @return [String, nil]
544-
optional :remittance_information, String, nil?: true
545-
546-
# @!method initialize(wire_message_type:, wire_network:, creditor: nil, debtor: nil, message_id: nil, remittance_information: nil)
606+
# @!method initialize(wire_message_type:, wire_network:, creditor: nil, debtor: nil, message_id: nil)
547607
# Some parameter documentations has been truncated, see
548608
# {Lithic::Models::Payment::MethodAttributes::WireMethodAttributes} for more
549609
# details.
@@ -557,8 +617,6 @@ class WireMethodAttributes < Lithic::Internal::Type::BaseModel
557617
# @param debtor [Lithic::Models::WirePartyDetails]
558618
#
559619
# @param message_id [String, nil] Point to point reference identifier, as assigned by the instructing party, used
560-
#
561-
# @param remittance_information [String, nil] Payment details or invoice reference
562620

563621
# Type of wire transfer
564622
#

‎rbi/lithic/models/account_activity_list_params.rbi‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,11 @@ module Lithic
188188

189189
ACH =
190190
T.let(:ACH, Lithic::AccountActivityListParams::Category::TaggedSymbol)
191+
WIRE =
192+
T.let(
193+
:WIRE,
194+
Lithic::AccountActivityListParams::Category::TaggedSymbol
195+
)
191196
BALANCE_OR_FUNDING =
192197
T.let(
193198
:BALANCE_OR_FUNDING,

‎rbi/lithic/models/account_activity_list_response.rbi‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,11 @@ module Lithic
191191
:ACH,
192192
Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
193193
)
194+
WIRE =
195+
T.let(
196+
:WIRE,
197+
Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
198+
)
194199
BALANCE_OR_FUNDING =
195200
T.let(
196201
:BALANCE_OR_FUNDING,

‎rbi/lithic/models/account_activity_retrieve_transaction_response.rbi‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,11 @@ module Lithic
191191
:ACH,
192192
Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
193193
)
194+
WIRE =
195+
T.let(
196+
:WIRE,
197+
Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
198+
)
194199
BALANCE_OR_FUNDING =
195200
T.let(
196201
:BALANCE_OR_FUNDING,

‎rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ module Lithic
7070
sig { returns(Integer) }
7171
attr_accessor :amount
7272

73+
# Note: Inbound wire transfers are coming soon (availability varies by partner
74+
# bank). The WIRE category is a preview. To learn more, contact your customer
75+
# success manager.
7376
sig do
7477
returns(
7578
Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
@@ -155,6 +158,9 @@ module Lithic
155158
token:,
156159
# Transaction amount in cents
157160
amount:,
161+
# Note: Inbound wire transfers are coming soon (availability varies by partner
162+
# bank). The WIRE category is a preview. To learn more, contact your customer
163+
# success manager.
158164
category:,
159165
# Timestamp of when the line item was generated
160166
created:,
@@ -205,6 +211,9 @@ module Lithic
205211
def to_hash
206212
end
207213

214+
# Note: Inbound wire transfers are coming soon (availability varies by partner
215+
# bank). The WIRE category is a preview. To learn more, contact your customer
216+
# success manager.
208217
module Category
209218
extend Lithic::Internal::Type::Enum
210219

@@ -222,6 +231,11 @@ module Lithic
222231
:ACH,
223232
Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
224233
)
234+
WIRE =
235+
T.let(
236+
:WIRE,
237+
Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category::TaggedSymbol
238+
)
225239
BALANCE_OR_FUNDING =
226240
T.let(
227241
:BALANCE_OR_FUNDING,

0 commit comments

Comments
 (0)