lithic 0.1.0.pre.alpha.55 → 0.1.0.pre.alpha.56

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 (196) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/models/account_activity_list_response.rb +60 -148
  6. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +60 -151
  7. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -51
  8. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -51
  9. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +260 -0
  10. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +8 -53
  11. data/lib/lithic/models/auth_rules/conditional_operation.rb +26 -0
  12. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +254 -0
  13. data/lib/lithic/models/auth_rules/conditional_value.rb +27 -0
  14. data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -5
  15. data/lib/lithic/models/auth_rules/v2_create_response.rb +21 -8
  16. data/lib/lithic/models/auth_rules/v2_draft_params.rb +7 -3
  17. data/lib/lithic/models/auth_rules/v2_draft_response.rb +21 -8
  18. data/lib/lithic/models/auth_rules/v2_list_params.rb +3 -0
  19. data/lib/lithic/models/auth_rules/v2_list_response.rb +21 -8
  20. data/lib/lithic/models/auth_rules/v2_promote_response.rb +21 -8
  21. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +21 -8
  22. data/lib/lithic/models/auth_rules/v2_update_response.rb +21 -8
  23. data/lib/lithic/models/book_transfer_response.rb +1 -0
  24. data/lib/lithic/models/category_details.rb +27 -0
  25. data/lib/lithic/models/dispute.rb +242 -510
  26. data/lib/lithic/models/dispute_v2.rb +555 -0
  27. data/lib/lithic/models/disputes_v2_list_params.rb +84 -0
  28. data/lib/lithic/models/disputes_v2_retrieve_params.rb +14 -0
  29. data/lib/lithic/models/external_bank_account_address.rb +2 -2
  30. data/lib/lithic/models/external_bank_account_create_response.rb +18 -18
  31. data/lib/lithic/models/external_bank_account_list_response.rb +18 -18
  32. data/lib/lithic/models/external_bank_account_retrieve_response.rb +18 -18
  33. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +18 -18
  34. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +18 -18
  35. data/lib/lithic/models/external_bank_account_unpause_params.rb +14 -0
  36. data/lib/lithic/models/external_bank_account_unpause_response.rb +242 -0
  37. data/lib/lithic/models/external_bank_account_update_response.rb +18 -18
  38. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +18 -18
  39. data/lib/lithic/models/external_payment.rb +3 -2
  40. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  41. data/lib/lithic/models/financial_account.rb +4 -3
  42. data/lib/lithic/models/financial_accounts/category_balances.rb +29 -0
  43. data/lib/lithic/models/financial_accounts/loan_tape.rb +35 -520
  44. data/lib/lithic/models/financial_accounts/statement.rb +73 -275
  45. data/lib/lithic/models/financial_event.rb +148 -0
  46. data/lib/lithic/models/financial_transaction.rb +3 -146
  47. data/lib/lithic/models/management_operation_list_params.rb +1 -0
  48. data/lib/lithic/models/management_operation_transaction.rb +5 -4
  49. data/lib/lithic/models/merchant.rb +70 -0
  50. data/lib/lithic/models/payment.rb +7 -5
  51. data/lib/lithic/models/payment_return_params.rb +62 -0
  52. data/lib/lithic/models/statement_totals.rb +100 -0
  53. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +9 -9
  54. data/lib/lithic/models/transaction.rb +3 -69
  55. data/lib/lithic/models/transactions/events/enhanced_data.rb +49 -40
  56. data/lib/lithic/models/transfer.rb +3 -146
  57. data/lib/lithic/models.rb +18 -0
  58. data/lib/lithic/resources/auth_rules/v2.rb +2 -2
  59. data/lib/lithic/resources/disputes.rb +10 -10
  60. data/lib/lithic/resources/disputes_v2.rb +74 -0
  61. data/lib/lithic/resources/external_bank_accounts.rb +19 -0
  62. data/lib/lithic/resources/payments.rb +48 -0
  63. data/lib/lithic/version.rb +1 -1
  64. data/lib/lithic.rb +16 -5
  65. data/rbi/lithic/client.rbi +3 -0
  66. data/rbi/lithic/models/account_activity_list_response.rbi +121 -544
  67. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +121 -544
  68. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +13 -139
  69. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +13 -153
  70. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +789 -0
  71. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +13 -153
  72. data/rbi/lithic/models/auth_rules/conditional_operation.rbi +74 -0
  73. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +674 -0
  74. data/rbi/lithic/models/auth_rules/conditional_value.rbi +28 -0
  75. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +33 -7
  76. data/rbi/lithic/models/auth_rules/v2_create_response.rbi +33 -7
  77. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +12 -4
  78. data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +33 -7
  79. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +15 -0
  80. data/rbi/lithic/models/auth_rules/v2_list_response.rbi +33 -7
  81. data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +33 -7
  82. data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +33 -7
  83. data/rbi/lithic/models/auth_rules/v2_update_response.rbi +33 -7
  84. data/rbi/lithic/models/book_transfer_response.rbi +2 -0
  85. data/rbi/lithic/models/category_details.rbi +43 -0
  86. data/rbi/lithic/models/dispute.rbi +395 -942
  87. data/rbi/lithic/models/dispute_v2.rbi +965 -0
  88. data/rbi/lithic/models/disputes_v2_list_params.rbi +129 -0
  89. data/rbi/lithic/models/disputes_v2_retrieve_params.rbi +27 -0
  90. data/rbi/lithic/models/external_bank_account_address.rbi +3 -6
  91. data/rbi/lithic/models/external_bank_account_create_response.rbi +31 -51
  92. data/rbi/lithic/models/external_bank_account_list_response.rbi +31 -51
  93. data/rbi/lithic/models/external_bank_account_retrieve_response.rbi +31 -51
  94. data/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +31 -51
  95. data/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi +31 -51
  96. data/rbi/lithic/models/external_bank_account_unpause_params.rbi +30 -0
  97. data/rbi/lithic/models/external_bank_account_unpause_response.rbi +375 -0
  98. data/rbi/lithic/models/external_bank_account_update_response.rbi +31 -51
  99. data/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +31 -51
  100. data/rbi/lithic/models/external_payment.rbi +5 -6
  101. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  102. data/rbi/lithic/models/financial_account.rbi +12 -4
  103. data/rbi/lithic/models/financial_accounts/category_balances.rbi +42 -0
  104. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +47 -802
  105. data/rbi/lithic/models/financial_accounts/statement.rbi +118 -430
  106. data/rbi/lithic/models/financial_event.rbi +409 -0
  107. data/rbi/lithic/models/financial_transaction.rbi +3 -509
  108. data/rbi/lithic/models/management_operation_list_params.rbi +5 -0
  109. data/rbi/lithic/models/management_operation_transaction.rbi +11 -12
  110. data/rbi/lithic/models/merchant.rbi +89 -0
  111. data/rbi/lithic/models/payment.rbi +16 -7
  112. data/rbi/lithic/models/payment_return_params.rbi +85 -0
  113. data/rbi/lithic/models/statement_totals.rbi +128 -0
  114. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +12 -12
  115. data/rbi/lithic/models/transaction.rbi +4 -90
  116. data/rbi/lithic/models/transactions/events/enhanced_data.rbi +74 -133
  117. data/rbi/lithic/models/transfer.rbi +4 -436
  118. data/rbi/lithic/models.rbi +19 -0
  119. data/rbi/lithic/resources/auth_rules/v2.rbi +8 -3
  120. data/rbi/lithic/resources/disputes.rbi +5 -7
  121. data/rbi/lithic/resources/disputes_v2.rbi +64 -0
  122. data/rbi/lithic/resources/external_bank_accounts.rbi +10 -0
  123. data/rbi/lithic/resources/payments.rbi +46 -0
  124. data/sig/lithic/client.rbs +2 -0
  125. data/sig/lithic/models/account_activity_list_response.rbs +67 -221
  126. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +67 -221
  127. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +10 -61
  128. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -61
  129. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +293 -0
  130. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +10 -61
  131. data/sig/lithic/models/auth_rules/conditional_operation.rbs +34 -0
  132. data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +237 -0
  133. data/sig/lithic/models/auth_rules/conditional_value.rbs +15 -0
  134. data/sig/lithic/models/auth_rules/v2_create_params.rbs +11 -1
  135. data/sig/lithic/models/auth_rules/v2_create_response.rbs +13 -1
  136. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +2 -0
  137. data/sig/lithic/models/auth_rules/v2_draft_response.rbs +13 -1
  138. data/sig/lithic/models/auth_rules/v2_list_params.rbs +9 -1
  139. data/sig/lithic/models/auth_rules/v2_list_response.rbs +13 -1
  140. data/sig/lithic/models/auth_rules/v2_promote_response.rbs +13 -1
  141. data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +13 -1
  142. data/sig/lithic/models/auth_rules/v2_update_response.rbs +13 -1
  143. data/sig/lithic/models/book_transfer_response.rbs +3 -1
  144. data/sig/lithic/models/category_details.rbs +26 -0
  145. data/sig/lithic/models/dispute.rbs +157 -417
  146. data/sig/lithic/models/dispute_v2.rbs +438 -0
  147. data/sig/lithic/models/disputes_v2_list_params.rbs +77 -0
  148. data/sig/lithic/models/disputes_v2_retrieve_params.rbs +15 -0
  149. data/sig/lithic/models/external_bank_account_address.rbs +4 -6
  150. data/sig/lithic/models/external_bank_account_create_response.rbs +36 -56
  151. data/sig/lithic/models/external_bank_account_list_response.rbs +36 -56
  152. data/sig/lithic/models/external_bank_account_retrieve_response.rbs +36 -56
  153. data/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs +36 -56
  154. data/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +36 -56
  155. data/sig/lithic/models/external_bank_account_unpause_params.rbs +15 -0
  156. data/sig/lithic/models/external_bank_account_unpause_response.rbs +162 -0
  157. data/sig/lithic/models/external_bank_account_update_response.rbs +36 -56
  158. data/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs +36 -56
  159. data/sig/lithic/models/external_payment.rbs +7 -7
  160. data/sig/lithic/models/external_payment_list_params.rbs +3 -1
  161. data/sig/lithic/models/financial_account.rbs +4 -4
  162. data/sig/lithic/models/financial_accounts/category_balances.rbs +24 -0
  163. data/sig/lithic/models/financial_accounts/loan_tape.rbs +48 -464
  164. data/sig/lithic/models/financial_accounts/statement.rbs +59 -244
  165. data/sig/lithic/models/financial_event.rbs +216 -0
  166. data/sig/lithic/models/financial_transaction.rbs +4 -217
  167. data/sig/lithic/models/management_operation_list_params.rbs +3 -1
  168. data/sig/lithic/models/management_operation_transaction.rbs +11 -13
  169. data/sig/lithic/models/merchant.rbs +50 -0
  170. data/sig/lithic/models/payment.rbs +9 -5
  171. data/sig/lithic/models/payment_return_params.rbs +46 -0
  172. data/sig/lithic/models/statement_totals.rbs +76 -0
  173. data/sig/lithic/models/transaction.rbs +4 -51
  174. data/sig/lithic/models/transactions/events/enhanced_data.rbs +78 -124
  175. data/sig/lithic/models/transfer.rbs +6 -219
  176. data/sig/lithic/models.rbs +18 -0
  177. data/sig/lithic/resources/disputes.rbs +5 -5
  178. data/sig/lithic/resources/disputes_v2.rbs +24 -0
  179. data/sig/lithic/resources/external_bank_accounts.rbs +5 -0
  180. data/sig/lithic/resources/payments.rbs +10 -0
  181. metadata +50 -17
  182. data/lib/lithic/models/dispute_create_response.rb +0 -326
  183. data/lib/lithic/models/dispute_delete_response.rb +0 -326
  184. data/lib/lithic/models/dispute_list_response.rb +0 -326
  185. data/lib/lithic/models/dispute_retrieve_response.rb +0 -326
  186. data/lib/lithic/models/dispute_update_response.rb +0 -326
  187. data/rbi/lithic/models/dispute_create_response.rbi +0 -599
  188. data/rbi/lithic/models/dispute_delete_response.rbi +0 -599
  189. data/rbi/lithic/models/dispute_list_response.rbi +0 -582
  190. data/rbi/lithic/models/dispute_retrieve_response.rbi +0 -601
  191. data/rbi/lithic/models/dispute_update_response.rbi +0 -599
  192. data/sig/lithic/models/dispute_create_response.rbs +0 -210
  193. data/sig/lithic/models/dispute_delete_response.rbs +0 -210
  194. data/sig/lithic/models/dispute_list_response.rbs +0 -210
  195. data/sig/lithic/models/dispute_retrieve_response.rbs +0 -210
  196. data/sig/lithic/models/dispute_update_response.rbs +0 -210
@@ -44,8 +44,8 @@ module Lithic
44
44
  # @!attribute events
45
45
  # A list of all financial events that have modified this financial transaction.
46
46
  #
47
- # @return [Array<Lithic::Models::FinancialTransaction::Event>]
48
- required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event] }
47
+ # @return [Array<Lithic::Models::FinancialEvent>]
48
+ required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] }
49
49
 
50
50
  # @!attribute pending_amount
51
51
  # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
@@ -103,7 +103,7 @@ module Lithic
103
103
  #
104
104
  # @param descriptor [String] A string that provides a description of the financial transaction; may be useful
105
105
  #
106
- # @param events [Array<Lithic::Models::FinancialTransaction::Event>] A list of all financial events that have modified this financial transaction.
106
+ # @param events [Array<Lithic::Models::FinancialEvent>] A list of all financial events that have modified this financial transaction.
107
107
  #
108
108
  # @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
109
109
  #
@@ -136,149 +136,6 @@ module Lithic
136
136
  # @return [Array<Symbol>]
137
137
  end
138
138
 
139
- class Event < Lithic::Internal::Type::BaseModel
140
- # @!attribute token
141
- # Globally unique identifier.
142
- #
143
- # @return [String, nil]
144
- optional :token, String
145
-
146
- # @!attribute amount
147
- # Amount of the financial event that has been settled in the currency's smallest
148
- # unit (e.g., cents).
149
- #
150
- # @return [Integer, nil]
151
- optional :amount, Integer
152
-
153
- # @!attribute created
154
- # Date and time when the financial event occurred. UTC time zone.
155
- #
156
- # @return [Time, nil]
157
- optional :created, Time
158
-
159
- # @!attribute result
160
- # APPROVED financial events were successful while DECLINED financial events were
161
- # declined by user, Lithic, or the network.
162
- #
163
- # @return [Symbol, Lithic::Models::FinancialTransaction::Event::Result, nil]
164
- optional :result, enum: -> { Lithic::FinancialTransaction::Event::Result }
165
-
166
- # @!attribute type
167
- #
168
- # @return [Symbol, Lithic::Models::FinancialTransaction::Event::Type, nil]
169
- optional :type, enum: -> { Lithic::FinancialTransaction::Event::Type }
170
-
171
- # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
172
- # Some parameter documentations has been truncated, see
173
- # {Lithic::Models::FinancialTransaction::Event} for more details.
174
- #
175
- # Financial Event
176
- #
177
- # @param token [String] Globally unique identifier.
178
- #
179
- # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
180
- #
181
- # @param created [Time] Date and time when the financial event occurred. UTC time zone.
182
- #
183
- # @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
184
- #
185
- # @param type [Symbol, Lithic::Models::FinancialTransaction::Event::Type]
186
-
187
- # APPROVED financial events were successful while DECLINED financial events were
188
- # declined by user, Lithic, or the network.
189
- #
190
- # @see Lithic::Models::FinancialTransaction::Event#result
191
- module Result
192
- extend Lithic::Internal::Type::Enum
193
-
194
- APPROVED = :APPROVED
195
- DECLINED = :DECLINED
196
-
197
- # @!method self.values
198
- # @return [Array<Symbol>]
199
- end
200
-
201
- # @see Lithic::Models::FinancialTransaction::Event#type
202
- module Type
203
- extend Lithic::Internal::Type::Enum
204
-
205
- ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
206
- ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
207
- ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
208
- ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
209
- ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED
210
- ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
211
- ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
212
- ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
213
- ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
214
- ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
215
- ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
216
- ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
217
- ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
218
- ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
219
- AUTHORIZATION = :AUTHORIZATION
220
- AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE
221
- AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY
222
- AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL
223
- BALANCE_INQUIRY = :BALANCE_INQUIRY
224
- BILLING_ERROR = :BILLING_ERROR
225
- BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
226
- CARD_TO_CARD = :CARD_TO_CARD
227
- CASH_BACK = :CASH_BACK
228
- CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
229
- CLEARING = :CLEARING
230
- COLLECTION = :COLLECTION
231
- CORRECTION_CREDIT = :CORRECTION_CREDIT
232
- CORRECTION_DEBIT = :CORRECTION_DEBIT
233
- CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
234
- CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE
235
- CURRENCY_CONVERSION = :CURRENCY_CONVERSION
236
- CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
237
- DISPUTE_WON = :DISPUTE_WON
238
- EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
239
- EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
240
- EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
241
- EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
242
- EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
243
- EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
244
- EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
245
- EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
246
- EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
247
- EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
248
- EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
249
- EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
250
- EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
251
- EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
252
- EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
253
- EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
254
- EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
255
- EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
256
- EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
257
- EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
258
- FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
259
- FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
260
- INTEREST = :INTEREST
261
- INTEREST_REVERSAL = :INTEREST_REVERSAL
262
- INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
263
- LATE_PAYMENT = :LATE_PAYMENT
264
- LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
265
- LOSS_WRITE_OFF = :LOSS_WRITE_OFF
266
- PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
267
- PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
268
- SERVICE = :SERVICE
269
- RETURN = :RETURN
270
- RETURN_REVERSAL = :RETURN_REVERSAL
271
- TRANSFER = :TRANSFER
272
- TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS
273
- RETURNED_PAYMENT = :RETURNED_PAYMENT
274
- RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
275
- LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
276
-
277
- # @!method self.values
278
- # @return [Array<Symbol>]
279
- end
280
- end
281
-
282
139
  # APPROVED transactions were successful while DECLINED transactions were declined
283
140
  # by user, Lithic, or the network.
284
141
  #
@@ -112,6 +112,7 @@ module Lithic
112
112
  DECLINED = :DECLINED
113
113
  REVERSED = :REVERSED
114
114
  CANCELED = :CANCELED
115
+ RETURNED = :RETURNED
115
116
 
116
117
  # @!method self.values
117
118
  # @return [Array<Symbol>]
@@ -92,7 +92,7 @@ module Lithic
92
92
  # @!attribute user_defined_id
93
93
  #
94
94
  # @return [String, nil]
95
- optional :user_defined_id, String
95
+ optional :user_defined_id, String, nil?: true
96
96
 
97
97
  # @!method initialize(token:, created:, status:, updated:, category: nil, currency: nil, direction: nil, events: nil, external_resource: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, settled_amount: nil, transaction_series: nil, user_defined_id: nil)
98
98
  # @param token [String] Unique identifier for the transaction
@@ -125,7 +125,7 @@ module Lithic
125
125
  #
126
126
  # @param transaction_series [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil]
127
127
  #
128
- # @param user_defined_id [String]
128
+ # @param user_defined_id [String, nil]
129
129
 
130
130
  # The status of the transaction
131
131
  #
@@ -138,6 +138,7 @@ module Lithic
138
138
  DECLINED = :DECLINED
139
139
  REVERSED = :REVERSED
140
140
  CANCELED = :CANCELED
141
+ RETURNED = :RETURNED
141
142
 
142
143
  # @!method self.values
143
144
  # @return [Array<Symbol>]
@@ -213,7 +214,7 @@ module Lithic
213
214
  # @!attribute subtype
214
215
  #
215
216
  # @return [String, nil]
216
- optional :subtype, String
217
+ optional :subtype, String, nil?: true
217
218
 
218
219
  # @!method initialize(token:, amount:, created:, detailed_results:, effective_date:, memo:, result:, type:, subtype: nil)
219
220
  # @param token [String]
@@ -224,7 +225,7 @@ module Lithic
224
225
  # @param memo [String]
225
226
  # @param result [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Result]
226
227
  # @param type [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Type]
227
- # @param subtype [String]
228
+ # @param subtype [String, nil]
228
229
 
229
230
  module DetailedResult
230
231
  extend Lithic::Internal::Type::Enum
@@ -0,0 +1,70 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class Merchant < Lithic::Internal::Type::BaseModel
6
+ # @!attribute acceptor_id
7
+ # Unique alphanumeric identifier for the payment card acceptor (merchant).
8
+ #
9
+ # @return [String]
10
+ required :acceptor_id, String
11
+
12
+ # @!attribute acquiring_institution_id
13
+ # Unique numeric identifier of the acquiring institution.
14
+ #
15
+ # @return [String]
16
+ required :acquiring_institution_id, String
17
+
18
+ # @!attribute city
19
+ # City of card acceptor. Note that in many cases, particularly in card-not-present
20
+ # transactions, merchants may send through a phone number or URL in this field.
21
+ #
22
+ # @return [String]
23
+ required :city, String
24
+
25
+ # @!attribute country
26
+ # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
27
+ # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
28
+ #
29
+ # @return [String]
30
+ required :country, String
31
+
32
+ # @!attribute descriptor
33
+ # Short description of card acceptor.
34
+ #
35
+ # @return [String]
36
+ required :descriptor, String
37
+
38
+ # @!attribute mcc
39
+ # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
40
+ # used to classify a business by the types of goods or services it provides.
41
+ #
42
+ # @return [String]
43
+ required :mcc, String
44
+
45
+ # @!attribute state
46
+ # Geographic state of card acceptor.
47
+ #
48
+ # @return [String]
49
+ required :state, String
50
+
51
+ # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
52
+ # Some parameter documentations has been truncated, see {Lithic::Models::Merchant}
53
+ # for more details.
54
+ #
55
+ # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
56
+ #
57
+ # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
58
+ #
59
+ # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
60
+ #
61
+ # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
62
+ #
63
+ # @param descriptor [String] Short description of card acceptor.
64
+ #
65
+ # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
66
+ #
67
+ # @param state [String] Geographic state of card acceptor.
68
+ end
69
+ end
70
+ end
@@ -71,10 +71,10 @@ module Lithic
71
71
  required :pending_amount, Integer
72
72
 
73
73
  # @!attribute related_account_tokens
74
- # Related account tokens for the transaction
74
+ # Account tokens related to a payment transaction
75
75
  #
76
- # @return [Lithic::Models::Payment::RelatedAccountTokens]
77
- required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }
76
+ # @return [Lithic::Models::Payment::RelatedAccountTokens, nil]
77
+ required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }, nil?: true
78
78
 
79
79
  # @!attribute result
80
80
  # Transaction result
@@ -158,7 +158,7 @@ module Lithic
158
158
  #
159
159
  # @param pending_amount [Integer] Pending amount in cents
160
160
  #
161
- # @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens] Related account tokens for the transaction
161
+ # @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens, nil] Account tokens related to a payment transaction
162
162
  #
163
163
  # @param result [Symbol, Lithic::Models::Payment::Result] Transaction result
164
164
  #
@@ -371,6 +371,7 @@ module Lithic
371
371
  extend Lithic::Internal::Type::Enum
372
372
 
373
373
  APPROVED = :APPROVED
374
+ DECLINED = :DECLINED
374
375
  FUNDS_INSUFFICIENT = :FUNDS_INSUFFICIENT
375
376
  ACCOUNT_INVALID = :ACCOUNT_INVALID
376
377
  PROGRAM_TRANSACTION_LIMIT_EXCEEDED = :PROGRAM_TRANSACTION_LIMIT_EXCEEDED
@@ -568,7 +569,7 @@ module Lithic
568
569
  required :business_account_token, String, nil?: true
569
570
 
570
571
  # @!method initialize(account_token:, business_account_token:)
571
- # Related account tokens for the transaction
572
+ # Account tokens related to a payment transaction
572
573
  #
573
574
  # @param account_token [String, nil] Globally unique identifier for the account
574
575
  #
@@ -613,6 +614,7 @@ module Lithic
613
614
  DECLINED = :DECLINED
614
615
  REVERSED = :REVERSED
615
616
  CANCELED = :CANCELED
617
+ RETURNED = :RETURNED
616
618
 
617
619
  # @!method self.values
618
620
  # @return [Array<Symbol>]
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::Payments#return_
6
+ class PaymentReturnParams < Lithic::Internal::Type::BaseModel
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
8
+ include Lithic::Internal::Type::RequestParameters
9
+
10
+ # @!attribute financial_account_token
11
+ # Globally unique identifier for the financial account
12
+ #
13
+ # @return [String]
14
+ required :financial_account_token, String
15
+
16
+ # @!attribute return_reason_code
17
+ # ACH return reason code indicating the reason for returning the payment.
18
+ # Supported codes include R01-R53 and R80-R85. For a complete list of return codes
19
+ # and their meanings, see
20
+ # [ACH Return Reasons](https://docs.lithic.com/docs/ach-overview#ach-return-reasons)
21
+ #
22
+ # @return [String]
23
+ required :return_reason_code, String
24
+
25
+ # @!attribute addenda
26
+ # Optional additional information about the return. Limited to 44 characters
27
+ #
28
+ # @return [String, nil]
29
+ optional :addenda, String, nil?: true
30
+
31
+ # @!attribute date_of_death
32
+ # Date of death in YYYY-MM-DD format. Required when using return codes **R14**
33
+ # (representative payee deceased) or **R15** (beneficiary or account holder
34
+ # deceased)
35
+ #
36
+ # @return [Date, nil]
37
+ optional :date_of_death, Date, nil?: true
38
+
39
+ # @!attribute memo
40
+ # Optional memo for the return. Limited to 10 characters
41
+ #
42
+ # @return [String, nil]
43
+ optional :memo, String, nil?: true
44
+
45
+ # @!method initialize(financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {})
46
+ # Some parameter documentations has been truncated, see
47
+ # {Lithic::Models::PaymentReturnParams} for more details.
48
+ #
49
+ # @param financial_account_token [String] Globally unique identifier for the financial account
50
+ #
51
+ # @param return_reason_code [String] ACH return reason code indicating the reason for returning the payment. Supporte
52
+ #
53
+ # @param addenda [String, nil] Optional additional information about the return. Limited to 44 characters
54
+ #
55
+ # @param date_of_death [Date, nil] Date of death in YYYY-MM-DD format. Required when using return codes **R14** (re
56
+ #
57
+ # @param memo [String, nil] Optional memo for the return. Limited to 10 characters
58
+ #
59
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class StatementTotals < Lithic::Internal::Type::BaseModel
6
+ # @!attribute balance_transfers
7
+ # Opening balance transferred from previous account in cents
8
+ #
9
+ # @return [Integer]
10
+ required :balance_transfers, Integer
11
+
12
+ # @!attribute cash_advances
13
+ # ATM and cashback transactions in cents
14
+ #
15
+ # @return [Integer]
16
+ required :cash_advances, Integer
17
+
18
+ # @!attribute credits
19
+ # Volume of credit management operation transactions less any balance transfers in
20
+ # cents
21
+ #
22
+ # @return [Integer]
23
+ required :credits, Integer
24
+
25
+ # @!attribute debits
26
+ # Volume of debit management operation transactions less any interest in cents
27
+ #
28
+ # @return [Integer]
29
+ required :debits, Integer
30
+
31
+ # @!attribute fees
32
+ # Volume of debit management operation transactions less any interest in cents
33
+ #
34
+ # @return [Integer]
35
+ required :fees, Integer
36
+
37
+ # @!attribute interest
38
+ # Interest accrued in cents
39
+ #
40
+ # @return [Integer]
41
+ required :interest, Integer
42
+
43
+ # @!attribute payments
44
+ # Any funds transfers which affective the balance in cents
45
+ #
46
+ # @return [Integer]
47
+ required :payments, Integer
48
+
49
+ # @!attribute purchases
50
+ # Net card transaction volume less any cash advances in cents
51
+ #
52
+ # @return [Integer]
53
+ required :purchases, Integer
54
+
55
+ # @!attribute credit_details
56
+ # Breakdown of credits
57
+ #
58
+ # @return [Object, nil]
59
+ optional :credit_details, Lithic::Internal::Type::Unknown
60
+
61
+ # @!attribute debit_details
62
+ # Breakdown of debits
63
+ #
64
+ # @return [Object, nil]
65
+ optional :debit_details, Lithic::Internal::Type::Unknown
66
+
67
+ # @!attribute payment_details
68
+ # Breakdown of payments
69
+ #
70
+ # @return [Object, nil]
71
+ optional :payment_details, Lithic::Internal::Type::Unknown
72
+
73
+ # @!method initialize(balance_transfers:, cash_advances:, credits:, debits:, fees:, interest:, payments:, purchases:, credit_details: nil, debit_details: nil, payment_details: nil)
74
+ # Some parameter documentations has been truncated, see
75
+ # {Lithic::Models::StatementTotals} for more details.
76
+ #
77
+ # @param balance_transfers [Integer] Opening balance transferred from previous account in cents
78
+ #
79
+ # @param cash_advances [Integer] ATM and cashback transactions in cents
80
+ #
81
+ # @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
82
+ #
83
+ # @param debits [Integer] Volume of debit management operation transactions less any interest in cents
84
+ #
85
+ # @param fees [Integer] Volume of debit management operation transactions less any interest in cents
86
+ #
87
+ # @param interest [Integer] Interest accrued in cents
88
+ #
89
+ # @param payments [Integer] Any funds transfers which affective the balance in cents
90
+ #
91
+ # @param purchases [Integer] Net card transaction volume less any cash advances in cents
92
+ #
93
+ # @param credit_details [Object] Breakdown of credits
94
+ #
95
+ # @param debit_details [Object] Breakdown of debits
96
+ #
97
+ # @param payment_details [Object] Breakdown of payments
98
+ end
99
+ end
100
+ end
@@ -312,22 +312,22 @@ module Lithic
312
312
  optional :name, String, nil?: true
313
313
 
314
314
  # @!attribute phone_number_home
315
- # Home phone number provided by the cardholder. Maps to EMV 3DS fields
316
- # `homePhone.cc` and `homePhone.subscriber`.
315
+ # Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS
316
+ # fields `homePhone.cc` and `homePhone.subscriber`.
317
317
  #
318
318
  # @return [String, nil]
319
319
  optional :phone_number_home, String, nil?: true
320
320
 
321
321
  # @!attribute phone_number_mobile
322
- # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
323
- # `mobilePhone.cc` and `mobilePhone.subscriber`.
322
+ # Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV
323
+ # 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`.
324
324
  #
325
325
  # @return [String, nil]
326
326
  optional :phone_number_mobile, String, nil?: true
327
327
 
328
328
  # @!attribute phone_number_work
329
- # Work phone number provided by the cardholder. Maps to EMV 3DS fields
330
- # `workPhone.cc` and `workPhone.subscriber`.
329
+ # Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS
330
+ # fields `workPhone.cc` and `workPhone.subscriber`.
331
331
  #
332
332
  # @return [String, nil]
333
333
  optional :phone_number_work, String, nil?: true
@@ -356,11 +356,11 @@ module Lithic
356
356
  #
357
357
  # @param name [String, nil] Name of the cardholder. Maps to EMV 3DS field `cardholderName`.
358
358
  #
359
- # @param phone_number_home [String, nil] Home phone number provided by the cardholder. Maps to EMV 3DS fields `homePhone.
359
+ # @param phone_number_home [String, nil] Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS fi
360
360
  #
361
- # @param phone_number_mobile [String, nil] Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields `mob
361
+ # @param phone_number_mobile [String, nil] Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV
362
362
  #
363
- # @param phone_number_work [String, nil] Work phone number provided by the cardholder. Maps to EMV 3DS fields `workPhone.
363
+ # @param phone_number_work [String, nil] Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS fi
364
364
  #
365
365
  # @param shipping_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress] Object containing data on the shipping address provided during the transaction.
366
366
 
@@ -94,8 +94,8 @@ module Lithic
94
94
 
95
95
  # @!attribute merchant
96
96
  #
97
- # @return [Lithic::Models::Transaction::Merchant]
98
- required :merchant, -> { Lithic::Transaction::Merchant }
97
+ # @return [Lithic::Models::Merchant]
98
+ required :merchant, -> { Lithic::Merchant }
99
99
 
100
100
  # @!attribute merchant_amount
101
101
  # @deprecated
@@ -208,7 +208,7 @@ module Lithic
208
208
  #
209
209
  # @param financial_account_token [String, nil]
210
210
  #
211
- # @param merchant [Lithic::Models::Transaction::Merchant]
211
+ # @param merchant [Lithic::Models::Merchant]
212
212
  #
213
213
  # @param merchant_amount [Integer, nil] Analogous to the 'amount', but in the merchant currency.
214
214
  #
@@ -506,72 +506,6 @@ module Lithic
506
506
  end
507
507
  end
508
508
 
509
- # @see Lithic::Models::Transaction#merchant
510
- class Merchant < Lithic::Internal::Type::BaseModel
511
- # @!attribute acceptor_id
512
- # Unique alphanumeric identifier for the payment card acceptor (merchant).
513
- #
514
- # @return [String]
515
- required :acceptor_id, String
516
-
517
- # @!attribute acquiring_institution_id
518
- # Unique numeric identifier of the acquiring institution.
519
- #
520
- # @return [String]
521
- required :acquiring_institution_id, String
522
-
523
- # @!attribute city
524
- # City of card acceptor. Note that in many cases, particularly in card-not-present
525
- # transactions, merchants may send through a phone number or URL in this field.
526
- #
527
- # @return [String]
528
- required :city, String
529
-
530
- # @!attribute country
531
- # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
532
- # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
533
- #
534
- # @return [String]
535
- required :country, String
536
-
537
- # @!attribute descriptor
538
- # Short description of card acceptor.
539
- #
540
- # @return [String]
541
- required :descriptor, String
542
-
543
- # @!attribute mcc
544
- # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
545
- # used to classify a business by the types of goods or services it provides.
546
- #
547
- # @return [String]
548
- required :mcc, String
549
-
550
- # @!attribute state
551
- # Geographic state of card acceptor.
552
- #
553
- # @return [String]
554
- required :state, String
555
-
556
- # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
557
- # Some parameter documentations has been truncated, see
558
- # {Lithic::Models::Transaction::Merchant} for more details.
559
- #
560
- # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
561
- #
562
- # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
563
- #
564
- # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
565
- #
566
- # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
567
- #
568
- # @param descriptor [String] Short description of card acceptor.
569
- #
570
- # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
571
- #
572
- # @param state [String] Geographic state of card acceptor.
573
- end
574
-
575
509
  # Card network of the authorization. Value is `UNKNOWN` when Lithic cannot
576
510
  # determine the network code from the upstream provider.
577
511
  #