lithic 0.1.0.pre.alpha.52 → 0.1.0.pre.alpha.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/internal/transport/base_client.rb +7 -1
  5. data/lib/lithic/internal/transport/pooled_net_requester.rb +36 -26
  6. data/lib/lithic/internal/type/union.rb +15 -3
  7. data/lib/lithic/models/account_activity_list_response.rb +48 -1141
  8. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +48 -1151
  9. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +3 -0
  10. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +7 -0
  11. data/lib/lithic/models/auth_rules/conditional_attribute.rb +4 -0
  12. data/lib/lithic/models/auth_rules/v2_apply_response.rb +14 -0
  13. data/lib/lithic/models/auth_rules/v2_create_params.rb +7 -0
  14. data/lib/lithic/models/auth_rules/v2_create_response.rb +14 -0
  15. data/lib/lithic/models/auth_rules/v2_draft_params.rb +7 -0
  16. data/lib/lithic/models/auth_rules/v2_draft_response.rb +14 -0
  17. data/lib/lithic/models/auth_rules/v2_list_response.rb +14 -0
  18. data/lib/lithic/models/auth_rules/v2_promote_response.rb +14 -0
  19. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +14 -0
  20. data/lib/lithic/models/auth_rules/v2_update_response.rb +14 -0
  21. data/lib/lithic/models/book_transfer_response.rb +51 -48
  22. data/lib/lithic/models/card_provision_response.rb +25 -3
  23. data/lib/lithic/models/event.rb +0 -1
  24. data/lib/lithic/models/event_list_params.rb +0 -1
  25. data/lib/lithic/models/event_subscription.rb +0 -1
  26. data/lib/lithic/models/events/subscription_create_params.rb +0 -1
  27. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +0 -1
  28. data/lib/lithic/models/events/subscription_update_params.rb +0 -1
  29. data/lib/lithic/models/external_bank_account_create_params.rb +1 -8
  30. data/lib/lithic/models/external_payment.rb +21 -23
  31. data/lib/lithic/models/financial_account.rb +48 -39
  32. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +32 -23
  33. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +1 -0
  34. data/lib/lithic/models/financial_transaction.rb +1 -0
  35. data/lib/lithic/models/management_operation_transaction.rb +21 -23
  36. data/lib/lithic/models/payment.rb +269 -140
  37. data/lib/lithic/models/payment_create_response.rb +2 -0
  38. data/lib/lithic/models/payment_retry_response.rb +2 -0
  39. data/lib/lithic/models/provision_response.rb +30 -0
  40. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +32 -1
  41. data/lib/lithic/models/tokenization.rb +1 -0
  42. data/lib/lithic/models/transaction.rb +4 -0
  43. data/lib/lithic/models/transfer.rb +1 -0
  44. data/lib/lithic/models/verification_method.rb +0 -1
  45. data/lib/lithic/models.rb +2 -0
  46. data/lib/lithic/resources/account_activity.rb +2 -2
  47. data/lib/lithic/resources/auth_rules/v2.rb +0 -72
  48. data/lib/lithic/resources/external_bank_accounts.rb +1 -3
  49. data/lib/lithic/version.rb +1 -1
  50. data/lib/lithic.rb +2 -2
  51. data/manifest.yaml +1 -0
  52. data/rbi/lithic/internal/transport/base_client.rbi +5 -0
  53. data/rbi/lithic/internal/transport/pooled_net_requester.rbi +6 -2
  54. data/rbi/lithic/internal/type/base_model.rbi +8 -4
  55. data/rbi/lithic/models/account_activity_list_response.rbi +158 -2629
  56. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +158 -2629
  57. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +6 -0
  58. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +14 -0
  59. data/rbi/lithic/models/auth_rules/conditional_attribute.rbi +8 -0
  60. data/rbi/lithic/models/auth_rules/v2_apply_response.rbi +28 -0
  61. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +14 -0
  62. data/rbi/lithic/models/auth_rules/v2_create_response.rbi +28 -0
  63. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +14 -0
  64. data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +28 -0
  65. data/rbi/lithic/models/auth_rules/v2_list_response.rbi +28 -0
  66. data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +28 -0
  67. data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +28 -0
  68. data/rbi/lithic/models/auth_rules/v2_update_response.rbi +28 -0
  69. data/rbi/lithic/models/book_transfer_response.rbi +67 -68
  70. data/rbi/lithic/models/card_provision_response.rbi +50 -5
  71. data/rbi/lithic/models/event.rbi +0 -5
  72. data/rbi/lithic/models/event_list_params.rbi +0 -5
  73. data/rbi/lithic/models/event_subscription.rbi +0 -5
  74. data/rbi/lithic/models/events/subscription_create_params.rbi +0 -5
  75. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +0 -5
  76. data/rbi/lithic/models/events/subscription_update_params.rbi +0 -5
  77. data/rbi/lithic/models/external_bank_account_create_params.rbi +0 -6
  78. data/rbi/lithic/models/external_payment.rbi +34 -39
  79. data/rbi/lithic/models/financial_account.rbi +74 -73
  80. data/rbi/lithic/models/financial_accounts/financial_account_credit_config.rbi +46 -33
  81. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +5 -0
  82. data/rbi/lithic/models/financial_transaction.rbi +5 -0
  83. data/rbi/lithic/models/management_operation_transaction.rbi +49 -60
  84. data/rbi/lithic/models/payment.rbi +425 -182
  85. data/rbi/lithic/models/payment_create_response.rbi +1 -0
  86. data/rbi/lithic/models/payment_retry_response.rbi +1 -0
  87. data/rbi/lithic/models/provision_response.rbi +58 -0
  88. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +83 -0
  89. data/rbi/lithic/models/tokenization.rbi +5 -0
  90. data/rbi/lithic/models/transaction.rbi +20 -0
  91. data/rbi/lithic/models/transfer.rbi +5 -0
  92. data/rbi/lithic/models/verification_method.rbi +0 -1
  93. data/rbi/lithic/models.rbi +2 -0
  94. data/rbi/lithic/resources/auth_rules/v2.rbi +0 -64
  95. data/rbi/lithic/resources/external_bank_accounts.rbi +0 -2
  96. data/sig/lithic/internal/transport/base_client.rbs +2 -0
  97. data/sig/lithic/internal/transport/pooled_net_requester.rbs +4 -1
  98. data/sig/lithic/models/account_activity_list_response.rbs +50 -1036
  99. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +50 -1036
  100. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +2 -0
  101. data/sig/lithic/models/auth_rules/conditional_attribute.rbs +2 -0
  102. data/sig/lithic/models/auth_rules/v2_apply_response.rbs +4 -0
  103. data/sig/lithic/models/auth_rules/v2_create_params.rbs +2 -0
  104. data/sig/lithic/models/auth_rules/v2_create_response.rbs +4 -0
  105. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +2 -0
  106. data/sig/lithic/models/auth_rules/v2_draft_response.rbs +4 -0
  107. data/sig/lithic/models/auth_rules/v2_list_response.rbs +4 -0
  108. data/sig/lithic/models/auth_rules/v2_promote_response.rbs +4 -0
  109. data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +4 -0
  110. data/sig/lithic/models/auth_rules/v2_update_response.rbs +4 -0
  111. data/sig/lithic/models/book_transfer_response.rbs +26 -19
  112. data/sig/lithic/models/card_provision_response.rbs +22 -5
  113. data/sig/lithic/models/event.rbs +0 -2
  114. data/sig/lithic/models/event_list_params.rbs +0 -2
  115. data/sig/lithic/models/event_subscription.rbs +0 -2
  116. data/sig/lithic/models/events/subscription_create_params.rbs +0 -2
  117. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +0 -2
  118. data/sig/lithic/models/events/subscription_update_params.rbs +0 -2
  119. data/sig/lithic/models/external_bank_account_create_params.rbs +1 -6
  120. data/sig/lithic/models/external_payment.rbs +19 -26
  121. data/sig/lithic/models/financial_account.rbs +28 -30
  122. data/sig/lithic/models/financial_accounts/financial_account_credit_config.rbs +21 -15
  123. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +2 -0
  124. data/sig/lithic/models/financial_transaction.rbs +2 -0
  125. data/sig/lithic/models/management_operation_transaction.rbs +19 -26
  126. data/sig/lithic/models/payment.rbs +199 -76
  127. data/sig/lithic/models/provision_response.rbs +36 -0
  128. data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +28 -0
  129. data/sig/lithic/models/tokenization.rbs +2 -0
  130. data/sig/lithic/models/transaction.rbs +8 -0
  131. data/sig/lithic/models/transfer.rbs +2 -0
  132. data/sig/lithic/models/verification_method.rbs +1 -7
  133. data/sig/lithic/models.rbs +2 -0
  134. data/sig/lithic/resources/auth_rules/v2.rbs +0 -5
  135. data/sig/lithic/resources/external_bank_accounts.rbs +0 -1
  136. metadata +5 -8
  137. data/lib/lithic/models/auth_rules/v2_report_params.rb +0 -16
  138. data/lib/lithic/models/auth_rules/v2_report_response.rb +0 -18
  139. data/rbi/lithic/models/auth_rules/v2_report_params.rbi +0 -29
  140. data/rbi/lithic/models/auth_rules/v2_report_response.rbi +0 -31
  141. data/sig/lithic/models/auth_rules/v2_report_params.rbs +0 -16
  142. data/sig/lithic/models/auth_rules/v2_report_response.rbs +0 -17
@@ -2,7 +2,11 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
- # Response containing multiple transaction types
5
+ # Response containing multiple transaction types. The `family` field determines
6
+ # which transaction type is returned: INTERNAL returns FinancialTransaction,
7
+ # TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT
8
+ # returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse,
9
+ # and MANAGEMENT_OPERATION returns ManagementOperationTransaction
6
10
  #
7
11
  # @see Lithic::Resources::AccountActivity#list
8
12
  module AccountActivityListResponse
@@ -11,22 +15,22 @@ module Lithic
11
15
  discriminator :family
12
16
 
13
17
  # Financial transaction with inheritance from unified base transaction
14
- variant -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction }
18
+ variant :INTERNAL, -> { Lithic::Models::AccountActivityListResponse::Internal }
15
19
 
16
20
  # Book transfer transaction
17
- variant -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction }
21
+ variant :TRANSFER, -> { Lithic::BookTransferResponse }
18
22
 
19
- # Base class for all transaction types in the ledger service
20
- variant -> { Lithic::Models::AccountActivityListResponse::CardTransaction }
23
+ # Card transaction with ledger base properties
24
+ variant :CARD, -> { Lithic::Models::AccountActivityListResponse::Card }
21
25
 
22
26
  # Payment transaction
23
- variant -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction }
27
+ variant :PAYMENT, -> { Lithic::Payment }
24
28
 
25
- variant -> { Lithic::ExternalPayment }
29
+ variant :EXTERNAL_PAYMENT, -> { Lithic::ExternalPayment }
26
30
 
27
- variant -> { Lithic::ManagementOperationTransaction }
31
+ variant :MANAGEMENT_OPERATION, -> { Lithic::ManagementOperationTransaction }
28
32
 
29
- class FinancialTransaction < Lithic::Internal::Type::BaseModel
33
+ class Internal < Lithic::Internal::Type::BaseModel
30
34
  # @!attribute token
31
35
  # Unique identifier for the transaction
32
36
  #
@@ -36,9 +40,8 @@ module Lithic
36
40
  # @!attribute category
37
41
  # Transaction category
38
42
  #
39
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Category]
40
- required :category,
41
- enum: -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction::Category }
43
+ # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Category]
44
+ required :category, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Category }
42
45
 
43
46
  # @!attribute created
44
47
  # ISO 8601 timestamp of when the transaction was created
@@ -61,14 +64,15 @@ module Lithic
61
64
  # @!attribute events
62
65
  # List of transaction events
63
66
  #
64
- # @return [Array<Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event>]
67
+ # @return [Array<Lithic::Models::AccountActivityListResponse::Internal::Event>]
65
68
  required :events,
66
- -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event] }
69
+ -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityListResponse::Internal::Event] }
67
70
 
68
71
  # @!attribute family
72
+ # INTERNAL - Financial Transaction
69
73
  #
70
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Family]
71
- required :family, enum: -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction::Family }
74
+ # @return [Symbol, :INTERNAL]
75
+ required :family, const: :INTERNAL
72
76
 
73
77
  # @!attribute financial_account_token
74
78
  # Financial account token associated with the transaction
@@ -85,8 +89,8 @@ module Lithic
85
89
  # @!attribute result
86
90
  # Transaction result
87
91
  #
88
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Result]
89
- required :result, enum: -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction::Result }
92
+ # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Result]
93
+ required :result, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Result }
90
94
 
91
95
  # @!attribute settled_amount
92
96
  # Settled amount in cents
@@ -97,8 +101,8 @@ module Lithic
97
101
  # @!attribute status
98
102
  # The status of the transaction
99
103
  #
100
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Status]
101
- required :status, enum: -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction::Status }
104
+ # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Status]
105
+ required :status, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Status }
102
106
 
103
107
  # @!attribute updated
104
108
  # ISO 8601 timestamp of when the transaction was last updated
@@ -106,12 +110,12 @@ module Lithic
106
110
  # @return [Time]
107
111
  required :updated, Time
108
112
 
109
- # @!method initialize(token:, category:, created:, currency:, descriptor:, events:, family:, financial_account_token:, pending_amount:, result:, settled_amount:, status:, updated:)
113
+ # @!method initialize(token:, category:, created:, currency:, descriptor:, events:, financial_account_token:, pending_amount:, result:, settled_amount:, status:, updated:, family: :INTERNAL)
110
114
  # Financial transaction with inheritance from unified base transaction
111
115
  #
112
116
  # @param token [String] Unique identifier for the transaction
113
117
  #
114
- # @param category [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Category] Transaction category
118
+ # @param category [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Category] Transaction category
115
119
  #
116
120
  # @param created [Time] ISO 8601 timestamp of when the transaction was created
117
121
  #
@@ -119,25 +123,25 @@ module Lithic
119
123
  #
120
124
  # @param descriptor [String] Transaction descriptor
121
125
  #
122
- # @param events [Array<Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event>] List of transaction events
123
- #
124
- # @param family [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Family]
126
+ # @param events [Array<Lithic::Models::AccountActivityListResponse::Internal::Event>] List of transaction events
125
127
  #
126
128
  # @param financial_account_token [String] Financial account token associated with the transaction
127
129
  #
128
130
  # @param pending_amount [Integer] Pending amount in cents
129
131
  #
130
- # @param result [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Result] Transaction result
132
+ # @param result [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Result] Transaction result
131
133
  #
132
134
  # @param settled_amount [Integer] Settled amount in cents
133
135
  #
134
- # @param status [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Status] The status of the transaction
136
+ # @param status [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Status] The status of the transaction
135
137
  #
136
138
  # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
139
+ #
140
+ # @param family [Symbol, :INTERNAL] INTERNAL - Financial Transaction
137
141
 
138
142
  # Transaction category
139
143
  #
140
- # @see Lithic::Models::AccountActivityListResponse::FinancialTransaction#category
144
+ # @see Lithic::Models::AccountActivityListResponse::Internal#category
141
145
  module Category
142
146
  extend Lithic::Internal::Type::Enum
143
147
 
@@ -188,20 +192,17 @@ module Lithic
188
192
  # APPROVED financial events were successful while DECLINED financial events were
189
193
  # declined by user, Lithic, or the network.
190
194
  #
191
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event::Result, nil]
192
- optional :result,
193
- enum: -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event::Result }
195
+ # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Result, nil]
196
+ optional :result, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Event::Result }
194
197
 
195
198
  # @!attribute type
196
199
  #
197
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event::Type, nil]
198
- optional :type,
199
- enum: -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event::Type }
200
+ # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Type, nil]
201
+ optional :type, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Event::Type }
200
202
 
201
203
  # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
202
204
  # Some parameter documentations has been truncated, see
203
- # {Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event} for
204
- # more details.
205
+ # {Lithic::Models::AccountActivityListResponse::Internal::Event} for more details.
205
206
  #
206
207
  # Financial Event
207
208
  #
@@ -211,14 +212,14 @@ module Lithic
211
212
  #
212
213
  # @param created [Time] Date and time when the financial event occurred. UTC time zone.
213
214
  #
214
- # @param result [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
215
+ # @param result [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
215
216
  #
216
- # @param type [Symbol, Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event::Type]
217
+ # @param type [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Type]
217
218
 
218
219
  # APPROVED financial events were successful while DECLINED financial events were
219
220
  # declined by user, Lithic, or the network.
220
221
  #
221
- # @see Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event#result
222
+ # @see Lithic::Models::AccountActivityListResponse::Internal::Event#result
222
223
  module Result
223
224
  extend Lithic::Internal::Type::Enum
224
225
 
@@ -229,7 +230,7 @@ module Lithic
229
230
  # @return [Array<Symbol>]
230
231
  end
231
232
 
232
- # @see Lithic::Models::AccountActivityListResponse::FinancialTransaction::Event#type
233
+ # @see Lithic::Models::AccountActivityListResponse::Internal::Event#type
233
234
  module Type
234
235
  extend Lithic::Internal::Type::Enum
235
236
 
@@ -241,6 +242,7 @@ module Lithic
241
242
  ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
242
243
  ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
243
244
  ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
245
+ ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
244
246
  ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
245
247
  ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
246
248
  ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
@@ -309,368 +311,9 @@ module Lithic
309
311
  end
310
312
  end
311
313
 
312
- # @see Lithic::Models::AccountActivityListResponse::FinancialTransaction#family
313
- module Family
314
- extend Lithic::Internal::Type::Enum
315
-
316
- CARD = :CARD
317
- PAYMENT = :PAYMENT
318
- TRANSFER = :TRANSFER
319
- INTERNAL = :INTERNAL
320
- EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
321
- MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
322
-
323
- # @!method self.values
324
- # @return [Array<Symbol>]
325
- end
326
-
327
314
  # Transaction result
328
315
  #
329
- # @see Lithic::Models::AccountActivityListResponse::FinancialTransaction#result
330
- module Result
331
- extend Lithic::Internal::Type::Enum
332
-
333
- APPROVED = :APPROVED
334
- DECLINED = :DECLINED
335
-
336
- # @!method self.values
337
- # @return [Array<Symbol>]
338
- end
339
-
340
- # The status of the transaction
341
- #
342
- # @see Lithic::Models::AccountActivityListResponse::FinancialTransaction#status
343
- module Status
344
- extend Lithic::Internal::Type::Enum
345
-
346
- PENDING = :PENDING
347
- SETTLED = :SETTLED
348
- DECLINED = :DECLINED
349
- REVERSED = :REVERSED
350
- CANCELED = :CANCELED
351
-
352
- # @!method self.values
353
- # @return [Array<Symbol>]
354
- end
355
- end
356
-
357
- class BookTransferTransaction < Lithic::Internal::Type::BaseModel
358
- # @!attribute token
359
- # Unique identifier for the transaction
360
- #
361
- # @return [String]
362
- required :token, String
363
-
364
- # @!attribute category
365
- #
366
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Category]
367
- required :category,
368
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Category }
369
-
370
- # @!attribute created
371
- # ISO 8601 timestamp of when the transaction was created
372
- #
373
- # @return [Time]
374
- required :created, Time
375
-
376
- # @!attribute currency
377
- # Currency of the transaction in ISO 4217 format
378
- #
379
- # @return [String]
380
- required :currency, String
381
-
382
- # @!attribute events
383
- # List of events associated with this book transfer
384
- #
385
- # @return [Array<Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event>]
386
- required :events,
387
- -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event] }
388
-
389
- # @!attribute family
390
- #
391
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Family]
392
- required :family,
393
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Family }
394
-
395
- # @!attribute from_financial_account_token
396
- # Source account token
397
- #
398
- # @return [String]
399
- required :from_financial_account_token, String
400
-
401
- # @!attribute pending_amount
402
- # The pending amount of the transaction in cents
403
- #
404
- # @return [Integer]
405
- required :pending_amount, Integer
406
-
407
- # @!attribute result
408
- #
409
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Result]
410
- required :result,
411
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Result }
412
-
413
- # @!attribute settled_amount
414
- # The settled amount of the transaction in cents
415
- #
416
- # @return [Integer]
417
- required :settled_amount, Integer
418
-
419
- # @!attribute status
420
- # The status of the transaction
421
- #
422
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Status]
423
- required :status,
424
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Status }
425
-
426
- # @!attribute to_financial_account_token
427
- # Destination account token
428
- #
429
- # @return [String]
430
- required :to_financial_account_token, String
431
-
432
- # @!attribute updated
433
- # ISO 8601 timestamp of when the transaction was last updated
434
- #
435
- # @return [Time]
436
- required :updated, Time
437
-
438
- # @!attribute external_id
439
- # External identifier for the transaction
440
- #
441
- # @return [String, nil]
442
- optional :external_id, String
443
-
444
- # @!attribute external_resource
445
- # External resource associated with the management operation
446
- #
447
- # @return [Lithic::Models::ExternalResource, nil]
448
- optional :external_resource, -> { Lithic::ExternalResource }, nil?: true
449
-
450
- # @!attribute transaction_series
451
- #
452
- # @return [Lithic::Models::AccountActivityListResponse::BookTransferTransaction::TransactionSeries, nil]
453
- optional :transaction_series,
454
- -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::TransactionSeries },
455
- nil?: true
456
-
457
- # @!method initialize(token:, category:, created:, currency:, events:, family:, from_financial_account_token:, pending_amount:, result:, settled_amount:, status:, to_financial_account_token:, updated:, external_id: nil, external_resource: nil, transaction_series: nil)
458
- # Book transfer transaction
459
- #
460
- # @param token [String] Unique identifier for the transaction
461
- #
462
- # @param category [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Category]
463
- #
464
- # @param created [Time] ISO 8601 timestamp of when the transaction was created
465
- #
466
- # @param currency [String] Currency of the transaction in ISO 4217 format
467
- #
468
- # @param events [Array<Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event>] List of events associated with this book transfer
469
- #
470
- # @param family [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Family]
471
- #
472
- # @param from_financial_account_token [String] Source account token
473
- #
474
- # @param pending_amount [Integer] The pending amount of the transaction in cents
475
- #
476
- # @param result [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Result]
477
- #
478
- # @param settled_amount [Integer] The settled amount of the transaction in cents
479
- #
480
- # @param status [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Status] The status of the transaction
481
- #
482
- # @param to_financial_account_token [String] Destination account token
483
- #
484
- # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
485
- #
486
- # @param external_id [String] External identifier for the transaction
487
- #
488
- # @param external_resource [Lithic::Models::ExternalResource, nil] External resource associated with the management operation
489
- #
490
- # @param transaction_series [Lithic::Models::AccountActivityListResponse::BookTransferTransaction::TransactionSeries, nil]
491
-
492
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction#category
493
- module Category
494
- extend Lithic::Internal::Type::Enum
495
-
496
- ADJUSTMENT = :ADJUSTMENT
497
- BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
498
- DERECOGNITION = :DERECOGNITION
499
- DISPUTE = :DISPUTE
500
- FEE = :FEE
501
- INTERNAL = :INTERNAL
502
- REWARD = :REWARD
503
- PROGRAM_FUNDING = :PROGRAM_FUNDING
504
- TRANSFER = :TRANSFER
505
-
506
- # @!method self.values
507
- # @return [Array<Symbol>]
508
- end
509
-
510
- class Event < Lithic::Internal::Type::BaseModel
511
- # @!attribute token
512
- # Globally unique identifier.
513
- #
514
- # @return [String]
515
- required :token, String
516
-
517
- # @!attribute amount
518
- # Amount of the financial event that has been settled in the currency's smallest
519
- # unit (e.g., cents).
520
- #
521
- # @return [Integer]
522
- required :amount, Integer
523
-
524
- # @!attribute created
525
- # Date and time when the financial event occurred. UTC time zone.
526
- #
527
- # @return [Time]
528
- required :created, Time
529
-
530
- # @!attribute detailed_results
531
- #
532
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::DetailedResults]
533
- required :detailed_results,
534
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::DetailedResults }
535
-
536
- # @!attribute memo
537
- # Memo for the transfer.
538
- #
539
- # @return [String]
540
- required :memo, String
541
-
542
- # @!attribute result
543
- # APPROVED financial events were successful while DECLINED financial events were
544
- # declined by user, Lithic, or the network.
545
- #
546
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::Result]
547
- required :result,
548
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::Result }
549
-
550
- # @!attribute subtype
551
- # The program specific subtype code for the specified category/type.
552
- #
553
- # @return [String]
554
- required :subtype, String
555
-
556
- # @!attribute type
557
- # Type of the book transfer
558
- #
559
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::Type]
560
- required :type,
561
- enum: -> { Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::Type }
562
-
563
- # @!method initialize(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:)
564
- # Some parameter documentations has been truncated, see
565
- # {Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event}
566
- # for more details.
567
- #
568
- # Book transfer Event
569
- #
570
- # @param token [String] Globally unique identifier.
571
- #
572
- # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
573
- #
574
- # @param created [Time] Date and time when the financial event occurred. UTC time zone.
575
- #
576
- # @param detailed_results [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::DetailedResults]
577
- #
578
- # @param memo [String] Memo for the transfer.
579
- #
580
- # @param result [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
581
- #
582
- # @param subtype [String] The program specific subtype code for the specified category/type.
583
- #
584
- # @param type [Symbol, Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event::Type] Type of the book transfer
585
-
586
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event#detailed_results
587
- module DetailedResults
588
- extend Lithic::Internal::Type::Enum
589
-
590
- APPROVED = :APPROVED
591
- FUNDS_INSUFFICIENT = :FUNDS_INSUFFICIENT
592
-
593
- # @!method self.values
594
- # @return [Array<Symbol>]
595
- end
596
-
597
- # APPROVED financial events were successful while DECLINED financial events were
598
- # declined by user, Lithic, or the network.
599
- #
600
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event#result
601
- module Result
602
- extend Lithic::Internal::Type::Enum
603
-
604
- APPROVED = :APPROVED
605
- DECLINED = :DECLINED
606
-
607
- # @!method self.values
608
- # @return [Array<Symbol>]
609
- end
610
-
611
- # Type of the book transfer
612
- #
613
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction::Event#type
614
- module Type
615
- extend Lithic::Internal::Type::Enum
616
-
617
- ATM_BALANCE_INQUIRY = :ATM_BALANCE_INQUIRY
618
- ATM_WITHDRAWAL = :ATM_WITHDRAWAL
619
- ATM_DECLINE = :ATM_DECLINE
620
- INTERNATIONAL_ATM_WITHDRAWAL = :INTERNATIONAL_ATM_WITHDRAWAL
621
- INACTIVITY = :INACTIVITY
622
- STATEMENT = :STATEMENT
623
- MONTHLY = :MONTHLY
624
- QUARTERLY = :QUARTERLY
625
- ANNUAL = :ANNUAL
626
- CUSTOMER_SERVICE = :CUSTOMER_SERVICE
627
- ACCOUNT_MAINTENANCE = :ACCOUNT_MAINTENANCE
628
- ACCOUNT_ACTIVATION = :ACCOUNT_ACTIVATION
629
- ACCOUNT_CLOSURE = :ACCOUNT_CLOSURE
630
- CARD_REPLACEMENT = :CARD_REPLACEMENT
631
- CARD_DELIVERY = :CARD_DELIVERY
632
- CARD_CREATE = :CARD_CREATE
633
- CURRENCY_CONVERSION = :CURRENCY_CONVERSION
634
- INTEREST = :INTEREST
635
- LATE_PAYMENT = :LATE_PAYMENT
636
- BILL_PAYMENT = :BILL_PAYMENT
637
- CASH_BACK = :CASH_BACK
638
- ACCOUNT_TO_ACCOUNT = :ACCOUNT_TO_ACCOUNT
639
- CARD_TO_CARD = :CARD_TO_CARD
640
- DISBURSE = :DISBURSE
641
- BILLING_ERROR = :BILLING_ERROR
642
- LOSS_WRITE_OFF = :LOSS_WRITE_OFF
643
- EXPIRED_CARD = :EXPIRED_CARD
644
- EARLY_DERECOGNITION = :EARLY_DERECOGNITION
645
- ESCHEATMENT = :ESCHEATMENT
646
- INACTIVITY_FEE_DOWN = :INACTIVITY_FEE_DOWN
647
- PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
648
- DISPUTE_WON = :DISPUTE_WON
649
- SERVICE = :SERVICE
650
- TRANSFER = :TRANSFER
651
- COLLECTION = :COLLECTION
652
-
653
- # @!method self.values
654
- # @return [Array<Symbol>]
655
- end
656
- end
657
-
658
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction#family
659
- module Family
660
- extend Lithic::Internal::Type::Enum
661
-
662
- CARD = :CARD
663
- PAYMENT = :PAYMENT
664
- TRANSFER = :TRANSFER
665
- INTERNAL = :INTERNAL
666
- EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
667
- MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
668
-
669
- # @!method self.values
670
- # @return [Array<Symbol>]
671
- end
672
-
673
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction#result
316
+ # @see Lithic::Models::AccountActivityListResponse::Internal#result
674
317
  module Result
675
318
  extend Lithic::Internal::Type::Enum
676
319
 
@@ -683,7 +326,7 @@ module Lithic
683
326
 
684
327
  # The status of the transaction
685
328
  #
686
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction#status
329
+ # @see Lithic::Models::AccountActivityListResponse::Internal#status
687
330
  module Status
688
331
  extend Lithic::Internal::Type::Enum
689
332
 
@@ -696,751 +339,15 @@ module Lithic
696
339
  # @!method self.values
697
340
  # @return [Array<Symbol>]
698
341
  end
699
-
700
- # @see Lithic::Models::AccountActivityListResponse::BookTransferTransaction#transaction_series
701
- class TransactionSeries < Lithic::Internal::Type::BaseModel
702
- # @!attribute related_transaction_event_token
703
- #
704
- # @return [String, nil]
705
- required :related_transaction_event_token, String, nil?: true
706
-
707
- # @!attribute related_transaction_token
708
- #
709
- # @return [String, nil]
710
- required :related_transaction_token, String, nil?: true
711
-
712
- # @!attribute type
713
- #
714
- # @return [String]
715
- required :type, String
716
-
717
- # @!method initialize(related_transaction_event_token:, related_transaction_token:, type:)
718
- # @param related_transaction_event_token [String, nil]
719
- # @param related_transaction_token [String, nil]
720
- # @param type [String]
721
- end
722
342
  end
723
343
 
724
- class CardTransaction < Lithic::Models::Transaction
725
- # @!attribute token
726
- # Unique identifier for the transaction
727
- #
728
- # @return [String]
729
- required :token, String
730
-
731
- # @!attribute created
732
- # ISO 8601 timestamp of when the transaction was created
733
- #
734
- # @return [Time]
735
- required :created, Time
736
-
737
- # @!attribute family
738
- #
739
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::CardTransaction::Family]
740
- required :family, enum: -> { Lithic::Models::AccountActivityListResponse::CardTransaction::Family }
741
-
742
- # @!attribute status
743
- # The status of the transaction
744
- #
745
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::CardTransaction::Status]
746
- required :status, enum: -> { Lithic::Models::AccountActivityListResponse::CardTransaction::Status }
747
-
748
- # @!attribute updated
749
- # ISO 8601 timestamp of when the transaction was last updated
750
- #
751
- # @return [Time]
752
- required :updated, Time
753
-
754
- # @!method initialize(token:, created:, family:, status:, updated:)
755
- # Base class for all transaction types in the ledger service
756
- #
757
- # @param token [String] Unique identifier for the transaction
758
- #
759
- # @param created [Time] ISO 8601 timestamp of when the transaction was created
760
- #
761
- # @param family [Symbol, Lithic::Models::AccountActivityListResponse::CardTransaction::Family]
762
- #
763
- # @param status [Symbol, Lithic::Models::AccountActivityListResponse::CardTransaction::Status] The status of the transaction
764
- #
765
- # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
766
-
767
- module Family
768
- extend Lithic::Internal::Type::Enum
769
-
770
- CARD = :CARD
771
- PAYMENT = :PAYMENT
772
- TRANSFER = :TRANSFER
773
- INTERNAL = :INTERNAL
774
- EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
775
- MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
776
-
777
- # @!method self.values
778
- # @return [Array<Symbol>]
779
- end
780
-
781
- # The status of the transaction
782
- module Status
783
- extend Lithic::Internal::Type::Enum
784
-
785
- PENDING = :PENDING
786
- SETTLED = :SETTLED
787
- DECLINED = :DECLINED
788
- REVERSED = :REVERSED
789
- CANCELED = :CANCELED
790
-
791
- # @!method self.values
792
- # @return [Array<Symbol>]
793
- end
794
- end
795
-
796
- class PaymentTransaction < Lithic::Internal::Type::BaseModel
797
- # @!attribute token
798
- # Unique identifier for the transaction
799
- #
800
- # @return [String]
801
- required :token, String
802
-
803
- # @!attribute category
804
- # Transaction category
805
- #
806
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Category]
807
- required :category, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Category }
808
-
809
- # @!attribute created
810
- # ISO 8601 timestamp of when the transaction was created
811
- #
812
- # @return [Time]
813
- required :created, Time
814
-
815
- # @!attribute descriptor
816
- # Transaction descriptor
817
- #
818
- # @return [String]
819
- required :descriptor, String
820
-
821
- # @!attribute direction
822
- # Transfer direction
823
- #
824
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Direction]
825
- required :direction,
826
- enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Direction }
827
-
828
- # @!attribute events
829
- # List of transaction events
830
- #
831
- # @return [Array<Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event>]
832
- required :events,
833
- -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event] }
834
-
835
- # @!attribute family
836
- #
837
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Family]
838
- required :family, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Family }
839
-
840
- # @!attribute financial_account_token
841
- # Financial account token
842
- #
843
- # @return [String]
844
- required :financial_account_token, String
845
-
846
- # @!attribute method_
847
- # Transfer method
848
- #
849
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Method]
850
- required :method_,
851
- enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Method },
852
- api_name: :method
853
-
854
- # @!attribute method_attributes
855
- # Method-specific attributes
856
- #
857
- # @return [Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes]
858
- required :method_attributes,
859
- union: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes }
860
-
861
- # @!attribute pending_amount
862
- # Pending amount in cents
863
- #
864
- # @return [Integer]
865
- required :pending_amount, Integer
866
-
867
- # @!attribute related_account_tokens
868
- # Related account tokens for the transaction
869
- #
870
- # @return [Lithic::Models::AccountActivityListResponse::PaymentTransaction::RelatedAccountTokens]
871
- required :related_account_tokens,
872
- -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::RelatedAccountTokens }
873
-
874
- # @!attribute result
875
- # Transaction result
876
- #
877
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Result]
878
- required :result, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Result }
879
-
880
- # @!attribute settled_amount
881
- # Settled amount in cents
882
- #
883
- # @return [Integer]
884
- required :settled_amount, Integer
885
-
886
- # @!attribute source
887
- # Transaction source
888
- #
889
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Source]
890
- required :source, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Source }
891
-
892
- # @!attribute status
893
- # The status of the transaction
894
- #
895
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Status]
896
- required :status, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Status }
897
-
898
- # @!attribute updated
899
- # ISO 8601 timestamp of when the transaction was last updated
900
- #
901
- # @return [Time]
902
- required :updated, Time
903
-
904
- # @!attribute currency
905
- # Currency of the transaction in ISO 4217 format
906
- #
907
- # @return [String, nil]
908
- optional :currency, String
909
-
910
- # @!attribute expected_release_date
911
- # Expected release date for the transaction
912
- #
913
- # @return [Date, nil]
914
- optional :expected_release_date, Date, nil?: true
915
-
916
- # @!attribute external_bank_account_token
917
- # External bank account token
918
- #
919
- # @return [String, nil]
920
- optional :external_bank_account_token, String, nil?: true
921
-
922
- # @!attribute type
923
- #
924
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Type, nil]
925
- optional :type, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Type }
926
-
927
- # @!attribute user_defined_id
928
- # User-defined identifier
929
- #
930
- # @return [String, nil]
931
- optional :user_defined_id, String, nil?: true
932
-
933
- # @!method initialize(token:, category:, created:, descriptor:, direction:, events:, family:, financial_account_token:, method_:, method_attributes:, pending_amount:, related_account_tokens:, result:, settled_amount:, source:, status:, updated:, currency: nil, expected_release_date: nil, external_bank_account_token: nil, type: nil, user_defined_id: nil)
934
- # Payment transaction
935
- #
936
- # @param token [String] Unique identifier for the transaction
937
- #
938
- # @param category [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Category] Transaction category
939
- #
940
- # @param created [Time] ISO 8601 timestamp of when the transaction was created
941
- #
942
- # @param descriptor [String] Transaction descriptor
943
- #
944
- # @param direction [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Direction] Transfer direction
945
- #
946
- # @param events [Array<Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event>] List of transaction events
947
- #
948
- # @param family [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Family]
949
- #
950
- # @param financial_account_token [String] Financial account token
951
- #
952
- # @param method_ [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Method] Transfer method
953
- #
954
- # @param method_attributes [Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes] Method-specific attributes
955
- #
956
- # @param pending_amount [Integer] Pending amount in cents
957
- #
958
- # @param related_account_tokens [Lithic::Models::AccountActivityListResponse::PaymentTransaction::RelatedAccountTokens] Related account tokens for the transaction
959
- #
960
- # @param result [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Result] Transaction result
961
- #
962
- # @param settled_amount [Integer] Settled amount in cents
963
- #
964
- # @param source [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Source] Transaction source
965
- #
966
- # @param status [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Status] The status of the transaction
967
- #
968
- # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
969
- #
970
- # @param currency [String] Currency of the transaction in ISO 4217 format
971
- #
972
- # @param expected_release_date [Date, nil] Expected release date for the transaction
973
- #
974
- # @param external_bank_account_token [String, nil] External bank account token
975
- #
976
- # @param type [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Type]
977
- #
978
- # @param user_defined_id [String, nil] User-defined identifier
979
-
980
- # Transaction category
981
- #
982
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#category
983
- module Category
984
- extend Lithic::Internal::Type::Enum
985
-
986
- ACH = :ACH
987
- BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
988
- FEE = :FEE
989
- REWARD = :REWARD
990
- ADJUSTMENT = :ADJUSTMENT
991
- DERECOGNITION = :DERECOGNITION
992
- DISPUTE = :DISPUTE
993
- CARD = :CARD
994
- EXTERNAL_ACH = :EXTERNAL_ACH
995
- EXTERNAL_CHECK = :EXTERNAL_CHECK
996
- EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
997
- EXTERNAL_WIRE = :EXTERNAL_WIRE
998
- MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
999
- MANAGEMENT_DISPUTE = :MANAGEMENT_DISPUTE
1000
- MANAGEMENT_FEE = :MANAGEMENT_FEE
1001
- MANAGEMENT_REWARD = :MANAGEMENT_REWARD
1002
- MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
1003
- PROGRAM_FUNDING = :PROGRAM_FUNDING
1004
-
1005
- # @!method self.values
1006
- # @return [Array<Symbol>]
1007
- end
1008
-
1009
- # Transfer direction
1010
- #
1011
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#direction
1012
- module Direction
1013
- extend Lithic::Internal::Type::Enum
1014
-
1015
- CREDIT = :CREDIT
1016
- DEBIT = :DEBIT
1017
-
1018
- # @!method self.values
1019
- # @return [Array<Symbol>]
1020
- end
1021
-
1022
- class Event < Lithic::Internal::Type::BaseModel
1023
- # @!attribute token
1024
- # Globally unique identifier.
1025
- #
1026
- # @return [String]
1027
- required :token, String
1028
-
1029
- # @!attribute amount
1030
- # Amount of the financial event that has been settled in the currency's smallest
1031
- # unit (e.g., cents).
1032
- #
1033
- # @return [Integer]
1034
- required :amount, Integer
1035
-
1036
- # @!attribute created
1037
- # Date and time when the financial event occurred. UTC time zone.
1038
- #
1039
- # @return [Time]
1040
- required :created, Time
1041
-
1042
- # @!attribute result
1043
- # APPROVED financial events were successful while DECLINED financial events were
1044
- # declined by user, Lithic, or the network.
1045
- #
1046
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::Result]
1047
- required :result,
1048
- enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::Result }
1049
-
1050
- # @!attribute type
1051
- # Event types:
1052
- #
1053
- # - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
1054
- # approval/release from an ACH hold.
1055
- # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
1056
- # - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
1057
- # - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
1058
- # the Federal Reserve.
1059
- # - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
1060
- # - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
1061
- # available balance.
1062
- # - `ACH_RETURN_PROCESSED` - ACH origination returned by the Receiving Depository
1063
- # Financial Institution.
1064
- # - `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
1065
- # - `ACH_RETURN_INITIATED` - ACH initiated return for a ACH receipt.
1066
- # - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
1067
- # - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
1068
- # balance.
1069
- # - `ACH_RETURN_SETTLED` - ACH receipt return settled by the Receiving Depository
1070
- # Financial Institution.
1071
- #
1072
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::Type]
1073
- required :type, enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::Type }
1074
-
1075
- # @!attribute detailed_results
1076
- # More detailed reasons for the event
1077
- #
1078
- # @return [Array<Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::DetailedResult>, nil]
1079
- optional :detailed_results,
1080
- -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::DetailedResult] }
1081
-
1082
- # @!method initialize(token:, amount:, created:, result:, type:, detailed_results: nil)
1083
- # Some parameter documentations has been truncated, see
1084
- # {Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event} for
1085
- # more details.
1086
- #
1087
- # Payment Event
1088
- #
1089
- # @param token [String] Globally unique identifier.
1090
- #
1091
- # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
1092
- #
1093
- # @param created [Time] Date and time when the financial event occurred. UTC time zone.
1094
- #
1095
- # @param result [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
1096
- #
1097
- # @param type [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::Type] Event types:
1098
- #
1099
- # @param detailed_results [Array<Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event::DetailedResult>] More detailed reasons for the event
1100
-
1101
- # APPROVED financial events were successful while DECLINED financial events were
1102
- # declined by user, Lithic, or the network.
1103
- #
1104
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event#result
1105
- module Result
1106
- extend Lithic::Internal::Type::Enum
1107
-
1108
- APPROVED = :APPROVED
1109
- DECLINED = :DECLINED
1110
-
1111
- # @!method self.values
1112
- # @return [Array<Symbol>]
1113
- end
1114
-
1115
- # Event types:
1116
- #
1117
- # - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
1118
- # approval/release from an ACH hold.
1119
- # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
1120
- # - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
1121
- # - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
1122
- # the Federal Reserve.
1123
- # - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
1124
- # - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
1125
- # available balance.
1126
- # - `ACH_RETURN_PROCESSED` - ACH origination returned by the Receiving Depository
1127
- # Financial Institution.
1128
- # - `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
1129
- # - `ACH_RETURN_INITIATED` - ACH initiated return for a ACH receipt.
1130
- # - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
1131
- # - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
1132
- # balance.
1133
- # - `ACH_RETURN_SETTLED` - ACH receipt return settled by the Receiving Depository
1134
- # Financial Institution.
1135
- #
1136
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction::Event#type
1137
- module Type
1138
- extend Lithic::Internal::Type::Enum
1139
-
1140
- ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
1141
- ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
1142
- ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
1143
- ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
1144
- ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
1145
- ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
1146
- ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
1147
- ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
1148
- ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
1149
- ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
1150
- ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
1151
-
1152
- # @!method self.values
1153
- # @return [Array<Symbol>]
1154
- end
1155
-
1156
- module DetailedResult
1157
- extend Lithic::Internal::Type::Enum
1158
-
1159
- APPROVED = :APPROVED
1160
- FUNDS_INSUFFICIENT = :FUNDS_INSUFFICIENT
1161
- ACCOUNT_INVALID = :ACCOUNT_INVALID
1162
- PROGRAM_TRANSACTION_LIMIT_EXCEEDED = :PROGRAM_TRANSACTION_LIMIT_EXCEEDED
1163
- PROGRAM_DAILY_LIMIT_EXCEEDED = :PROGRAM_DAILY_LIMIT_EXCEEDED
1164
- PROGRAM_MONTHLY_LIMIT_EXCEEDED = :PROGRAM_MONTHLY_LIMIT_EXCEEDED
1165
-
1166
- # @!method self.values
1167
- # @return [Array<Symbol>]
1168
- end
1169
- end
1170
-
1171
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#family
1172
- module Family
1173
- extend Lithic::Internal::Type::Enum
1174
-
1175
- CARD = :CARD
1176
- PAYMENT = :PAYMENT
1177
- TRANSFER = :TRANSFER
1178
- INTERNAL = :INTERNAL
1179
- EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
1180
- MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
1181
-
1182
- # @!method self.values
1183
- # @return [Array<Symbol>]
1184
- end
1185
-
1186
- # Transfer method
1187
- #
1188
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#method_
1189
- module Method
1190
- extend Lithic::Internal::Type::Enum
1191
-
1192
- ACH_NEXT_DAY = :ACH_NEXT_DAY
1193
- ACH_SAME_DAY = :ACH_SAME_DAY
1194
- WIRE = :WIRE
1195
-
1196
- # @!method self.values
1197
- # @return [Array<Symbol>]
1198
- end
1199
-
1200
- # Method-specific attributes
1201
- #
1202
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#method_attributes
1203
- module MethodAttributes
1204
- extend Lithic::Internal::Type::Union
1205
-
1206
- variant -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes }
1207
-
1208
- variant -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes }
1209
-
1210
- class ACHMethodAttributes < Lithic::Internal::Type::BaseModel
1211
- # @!attribute sec_code
1212
- # SEC code for ACH transaction
1213
- #
1214
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes::SecCode]
1215
- required :sec_code,
1216
- enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes::SecCode }
1217
-
1218
- # @!attribute addenda
1219
- # Addenda information
1220
- #
1221
- # @return [String, nil]
1222
- optional :addenda, String, nil?: true
1223
-
1224
- # @!attribute company_id
1225
- # Company ID for the ACH transaction
1226
- #
1227
- # @return [String, nil]
1228
- optional :company_id, String, nil?: true
1229
-
1230
- # @!attribute receipt_routing_number
1231
- # Receipt routing number
1232
- #
1233
- # @return [String, nil]
1234
- optional :receipt_routing_number, String, nil?: true
1235
-
1236
- # @!attribute retries
1237
- # Number of retries attempted
1238
- #
1239
- # @return [Integer, nil]
1240
- optional :retries, Integer, nil?: true
1241
-
1242
- # @!attribute return_reason_code
1243
- # Return reason code if the transaction was returned
1244
- #
1245
- # @return [String, nil]
1246
- optional :return_reason_code, String, nil?: true
1247
-
1248
- # @!attribute trace_numbers
1249
- # Trace numbers for the ACH transaction
1250
- #
1251
- # @return [Array<String>, nil]
1252
- optional :trace_numbers, Lithic::Internal::Type::ArrayOf[String]
1253
-
1254
- # @!method initialize(sec_code:, addenda: nil, company_id: nil, receipt_routing_number: nil, retries: nil, return_reason_code: nil, trace_numbers: nil)
1255
- # @param sec_code [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes::SecCode] SEC code for ACH transaction
1256
- #
1257
- # @param addenda [String, nil] Addenda information
1258
- #
1259
- # @param company_id [String, nil] Company ID for the ACH transaction
1260
- #
1261
- # @param receipt_routing_number [String, nil] Receipt routing number
1262
- #
1263
- # @param retries [Integer, nil] Number of retries attempted
1264
- #
1265
- # @param return_reason_code [String, nil] Return reason code if the transaction was returned
1266
- #
1267
- # @param trace_numbers [Array<String>] Trace numbers for the ACH transaction
1268
-
1269
- # SEC code for ACH transaction
1270
- #
1271
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes#sec_code
1272
- module SecCode
1273
- extend Lithic::Internal::Type::Enum
1274
-
1275
- CCD = :CCD
1276
- PPD = :PPD
1277
- WEB = :WEB
1278
- TEL = :TEL
1279
- CIE = :CIE
1280
- CTX = :CTX
1281
-
1282
- # @!method self.values
1283
- # @return [Array<Symbol>]
1284
- end
1285
- end
1286
-
1287
- class WireMethodAttributes < Lithic::Internal::Type::BaseModel
1288
- # @!attribute wire_network
1289
- # Type of wire transfer
1290
- #
1291
- # @return [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes::WireNetwork]
1292
- required :wire_network,
1293
- enum: -> { Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes::WireNetwork }
1294
-
1295
- # @!attribute creditor
1296
- #
1297
- # @return [Lithic::Models::WirePartyDetails, nil]
1298
- optional :creditor, -> { Lithic::WirePartyDetails }
1299
-
1300
- # @!attribute debtor
1301
- #
1302
- # @return [Lithic::Models::WirePartyDetails, nil]
1303
- optional :debtor, -> { Lithic::WirePartyDetails }
1304
-
1305
- # @!attribute message_id
1306
- # Point to point reference identifier, as assigned by the instructing party, used
1307
- # for tracking the message through the Fedwire system
1308
- #
1309
- # @return [String, nil]
1310
- optional :message_id, String, nil?: true
1311
-
1312
- # @!attribute remittance_information
1313
- # Payment details or invoice reference
1314
- #
1315
- # @return [String, nil]
1316
- optional :remittance_information, String, nil?: true
1317
-
1318
- # @!attribute wire_message_type
1319
- # Type of wire message
1320
- #
1321
- # @return [String, nil]
1322
- optional :wire_message_type, String
1323
-
1324
- # @!method initialize(wire_network:, creditor: nil, debtor: nil, message_id: nil, remittance_information: nil, wire_message_type: nil)
1325
- # Some parameter documentations has been truncated, see
1326
- # {Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes}
1327
- # for more details.
1328
- #
1329
- # @param wire_network [Symbol, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes::WireNetwork] Type of wire transfer
1330
- #
1331
- # @param creditor [Lithic::Models::WirePartyDetails]
1332
- #
1333
- # @param debtor [Lithic::Models::WirePartyDetails]
1334
- #
1335
- # @param message_id [String, nil] Point to point reference identifier, as assigned by the instructing party, used
1336
- #
1337
- # @param remittance_information [String, nil] Payment details or invoice reference
1338
- #
1339
- # @param wire_message_type [String] Type of wire message
1340
-
1341
- # Type of wire transfer
1342
- #
1343
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes#wire_network
1344
- module WireNetwork
1345
- extend Lithic::Internal::Type::Enum
1346
-
1347
- FEDWIRE = :FEDWIRE
1348
- SWIFT = :SWIFT
1349
-
1350
- # @!method self.values
1351
- # @return [Array<Symbol>]
1352
- end
1353
- end
1354
-
1355
- # @!method self.variants
1356
- # @return [Array(Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::ACHMethodAttributes, Lithic::Models::AccountActivityListResponse::PaymentTransaction::MethodAttributes::WireMethodAttributes)]
1357
- end
1358
-
1359
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#related_account_tokens
1360
- class RelatedAccountTokens < Lithic::Internal::Type::BaseModel
1361
- # @!attribute account_token
1362
- # Globally unique identifier for the account
1363
- #
1364
- # @return [String, nil]
1365
- required :account_token, String, nil?: true
1366
-
1367
- # @!attribute business_account_token
1368
- # Globally unique identifier for the business account
1369
- #
1370
- # @return [String, nil]
1371
- required :business_account_token, String, nil?: true
1372
-
1373
- # @!method initialize(account_token:, business_account_token:)
1374
- # Related account tokens for the transaction
1375
- #
1376
- # @param account_token [String, nil] Globally unique identifier for the account
1377
- #
1378
- # @param business_account_token [String, nil] Globally unique identifier for the business account
1379
- end
1380
-
1381
- # Transaction result
1382
- #
1383
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#result
1384
- module Result
1385
- extend Lithic::Internal::Type::Enum
1386
-
1387
- APPROVED = :APPROVED
1388
- DECLINED = :DECLINED
1389
-
1390
- # @!method self.values
1391
- # @return [Array<Symbol>]
1392
- end
1393
-
1394
- # Transaction source
1395
- #
1396
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#source
1397
- module Source
1398
- extend Lithic::Internal::Type::Enum
1399
-
1400
- LITHIC = :LITHIC
1401
- EXTERNAL = :EXTERNAL
1402
- CUSTOMER = :CUSTOMER
1403
-
1404
- # @!method self.values
1405
- # @return [Array<Symbol>]
1406
- end
1407
-
1408
- # The status of the transaction
1409
- #
1410
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#status
1411
- module Status
1412
- extend Lithic::Internal::Type::Enum
1413
-
1414
- PENDING = :PENDING
1415
- SETTLED = :SETTLED
1416
- DECLINED = :DECLINED
1417
- REVERSED = :REVERSED
1418
- CANCELED = :CANCELED
1419
-
1420
- # @!method self.values
1421
- # @return [Array<Symbol>]
1422
- end
1423
-
1424
- # @see Lithic::Models::AccountActivityListResponse::PaymentTransaction#type
1425
- module Type
1426
- extend Lithic::Internal::Type::Enum
1427
-
1428
- ORIGINATION_CREDIT = :ORIGINATION_CREDIT
1429
- ORIGINATION_DEBIT = :ORIGINATION_DEBIT
1430
- RECEIPT_CREDIT = :RECEIPT_CREDIT
1431
- RECEIPT_DEBIT = :RECEIPT_DEBIT
1432
- WIRE_INBOUND_PAYMENT = :WIRE_INBOUND_PAYMENT
1433
- WIRE_INBOUND_ADMIN = :WIRE_INBOUND_ADMIN
1434
- WIRE_OUTBOUND_PAYMENT = :WIRE_OUTBOUND_PAYMENT
1435
- WIRE_OUTBOUND_ADMIN = :WIRE_OUTBOUND_ADMIN
1436
-
1437
- # @!method self.values
1438
- # @return [Array<Symbol>]
1439
- end
344
+ class Card < Lithic::Models::Transaction
345
+ # @!method initialize
346
+ # Card transaction with ledger base properties
1440
347
  end
1441
348
 
1442
349
  # @!method self.variants
1443
- # @return [Array(Lithic::Models::AccountActivityListResponse::FinancialTransaction, Lithic::Models::AccountActivityListResponse::BookTransferTransaction, Lithic::Models::AccountActivityListResponse::CardTransaction, Lithic::Models::AccountActivityListResponse::PaymentTransaction, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction)]
350
+ # @return [Array(Lithic::Models::AccountActivityListResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityListResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction)]
1444
351
  end
1445
352
  end
1446
353
  end