lithic 0.1.0.pre.alpha.40 → 0.1.0.pre.alpha.42

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 (184) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/internal/transport/base_client.rb +1 -1
  6. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -9
  7. data/lib/lithic/internal/type/array_of.rb +1 -0
  8. data/lib/lithic/internal/type/base_model.rb +3 -1
  9. data/lib/lithic/internal/type/converter.rb +27 -0
  10. data/lib/lithic/internal/type/hash_of.rb +1 -0
  11. data/lib/lithic/internal/type/union.rb +9 -7
  12. data/lib/lithic/internal/util.rb +1 -1
  13. data/lib/lithic/models/account_activity_list_params.rb +158 -0
  14. data/lib/lithic/models/account_activity_list_response.rb +1435 -0
  15. data/lib/lithic/models/account_activity_retrieve_transaction_params.rb +14 -0
  16. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1451 -0
  17. data/lib/lithic/models/account_holder.rb +16 -19
  18. data/lib/lithic/models/account_holder_create_params.rb +41 -47
  19. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +1 -3
  20. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +25 -20
  21. data/lib/lithic/models/account_holder_update_params.rb +2 -6
  22. data/lib/lithic/models/account_holder_update_response.rb +25 -20
  23. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +5 -1
  24. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -12
  25. data/lib/lithic/models/auth_rules/v2_apply_params.rb +13 -5
  26. data/lib/lithic/models/auth_rules/v2_apply_response.rb +510 -18
  27. data/lib/lithic/models/auth_rules/v2_create_params.rb +283 -16
  28. data/lib/lithic/models/auth_rules/v2_create_response.rb +510 -18
  29. data/lib/lithic/models/auth_rules/v2_draft_params.rb +239 -3
  30. data/lib/lithic/models/auth_rules/v2_draft_response.rb +510 -18
  31. data/lib/lithic/models/auth_rules/v2_list_params.rb +11 -1
  32. data/lib/lithic/models/auth_rules/v2_list_response.rb +510 -18
  33. data/lib/lithic/models/auth_rules/v2_promote_response.rb +510 -18
  34. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +510 -18
  35. data/lib/lithic/models/auth_rules/v2_update_params.rb +1 -9
  36. data/lib/lithic/models/auth_rules/v2_update_response.rb +510 -18
  37. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +4 -16
  38. data/lib/lithic/models/book_transfer_create_params.rb +34 -6
  39. data/lib/lithic/models/book_transfer_response.rb +124 -28
  40. data/lib/lithic/models/document.rb +1 -3
  41. data/lib/lithic/models/event.rb +6 -0
  42. data/lib/lithic/models/event_list_params.rb +2 -0
  43. data/lib/lithic/models/event_subscription.rb +2 -0
  44. data/lib/lithic/models/events/subscription_create_params.rb +3 -3
  45. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -0
  46. data/lib/lithic/models/events/subscription_update_params.rb +3 -3
  47. data/lib/lithic/models/external_bank_account_list_params.rb +2 -6
  48. data/lib/lithic/models/external_payment.rb +89 -48
  49. data/lib/lithic/models/financial_account.rb +1 -0
  50. data/lib/lithic/models/financial_accounts/loan_tape.rb +5 -18
  51. data/lib/lithic/models/financial_accounts/statement.rb +3 -10
  52. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +2 -7
  53. data/lib/lithic/models/financial_transaction.rb +2 -0
  54. data/lib/lithic/models/instance_financial_account_type.rb +1 -0
  55. data/lib/lithic/models/kyb.rb +2 -2
  56. data/lib/lithic/models/management_operation_transaction.rb +90 -63
  57. data/lib/lithic/models/payment.rb +60 -1
  58. data/lib/lithic/models/reports/settlement_list_details_params.rb +2 -2
  59. data/lib/lithic/models/settlement_detail.rb +1 -0
  60. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +173 -38
  61. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +1 -4
  62. data/lib/lithic/models/tokenization.rb +1 -1
  63. data/lib/lithic/models/transaction.rb +4 -0
  64. data/lib/lithic/models/transactions/events/enhanced_data.rb +3 -11
  65. data/lib/lithic/models/transfer.rb +2 -0
  66. data/lib/lithic/models/wire_party_details.rb +40 -0
  67. data/lib/lithic/models.rb +6 -0
  68. data/lib/lithic/resources/account_activity.rb +80 -0
  69. data/lib/lithic/resources/account_holders.rb +9 -9
  70. data/lib/lithic/resources/auth_rules/v2/backtests.rb +3 -3
  71. data/lib/lithic/resources/auth_rules/v2.rb +19 -13
  72. data/lib/lithic/resources/book_transfers.rb +7 -3
  73. data/lib/lithic/resources/reports/settlement.rb +1 -1
  74. data/lib/lithic/resources/tokenizations.rb +2 -2
  75. data/lib/lithic/version.rb +1 -1
  76. data/lib/lithic.rb +7 -2
  77. data/rbi/lithic/client.rbi +3 -0
  78. data/rbi/lithic/errors.rbi +2 -2
  79. data/rbi/lithic/internal/transport/base_client.rbi +1 -1
  80. data/rbi/lithic/internal/type/converter.rbi +46 -0
  81. data/rbi/lithic/internal/type/union.rbi +7 -2
  82. data/rbi/lithic/models/account_activity_list_params.rbi +347 -0
  83. data/rbi/lithic/models/account_activity_list_response.rbi +3367 -0
  84. data/rbi/lithic/models/account_activity_retrieve_transaction_params.rbi +30 -0
  85. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +3369 -0
  86. data/rbi/lithic/models/account_holder.rbi +21 -23
  87. data/rbi/lithic/models/account_holder_create_params.rbi +87 -65
  88. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +36 -30
  89. data/rbi/lithic/models/account_holder_update_response.rbi +36 -30
  90. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +20 -0
  91. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +20 -0
  92. data/rbi/lithic/models/auth_rules/v2_apply_params.rbi +19 -5
  93. data/rbi/lithic/models/auth_rules/v2_apply_response.rbi +1128 -18
  94. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +646 -21
  95. data/rbi/lithic/models/auth_rules/v2_create_response.rbi +1128 -18
  96. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +554 -4
  97. data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +1128 -18
  98. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +18 -0
  99. data/rbi/lithic/models/auth_rules/v2_list_response.rbi +1128 -18
  100. data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +1128 -18
  101. data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +1128 -18
  102. data/rbi/lithic/models/auth_rules/v2_update_params.rbi +0 -11
  103. data/rbi/lithic/models/auth_rules/v2_update_response.rbi +1128 -18
  104. data/rbi/lithic/models/book_transfer_create_params.rbi +75 -5
  105. data/rbi/lithic/models/book_transfer_response.rbi +320 -38
  106. data/rbi/lithic/models/event.rbi +16 -0
  107. data/rbi/lithic/models/event_list_params.rbi +10 -0
  108. data/rbi/lithic/models/event_subscription.rbi +10 -0
  109. data/rbi/lithic/models/events/subscription_create_params.rbi +10 -0
  110. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +10 -0
  111. data/rbi/lithic/models/events/subscription_update_params.rbi +10 -0
  112. data/rbi/lithic/models/external_payment.rbi +147 -60
  113. data/rbi/lithic/models/financial_account.rbi +5 -0
  114. data/rbi/lithic/models/financial_transaction.rbi +1 -0
  115. data/rbi/lithic/models/instance_financial_account_type.rbi +5 -0
  116. data/rbi/lithic/models/kyb.rbi +2 -2
  117. data/rbi/lithic/models/management_operation_transaction.rbi +226 -95
  118. data/rbi/lithic/models/payment.rbi +103 -3
  119. data/rbi/lithic/models/reports/settlement_list_details_params.rbi +2 -2
  120. data/rbi/lithic/models/settlement_detail.rbi +2 -0
  121. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +267 -60
  122. data/rbi/lithic/models/transaction.rbi +17 -0
  123. data/rbi/lithic/models/transfer.rbi +1 -0
  124. data/rbi/lithic/models/wire_party_details.rbi +61 -0
  125. data/rbi/lithic/models.rbi +7 -0
  126. data/rbi/lithic/resources/account_activity.rbi +80 -0
  127. data/rbi/lithic/resources/account_holders.rbi +28 -29
  128. data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +3 -3
  129. data/rbi/lithic/resources/auth_rules/v2.rbi +28 -14
  130. data/rbi/lithic/resources/book_transfers.rbi +9 -2
  131. data/rbi/lithic/resources/reports/settlement.rbi +1 -1
  132. data/rbi/lithic/resources/tokenizations.rbi +1 -1
  133. data/sig/lithic/client.rbs +2 -0
  134. data/sig/lithic/internal/transport/base_client.rbs +1 -1
  135. data/sig/lithic/internal/type/converter.rbs +17 -0
  136. data/sig/lithic/internal/type/union.rbs +2 -2
  137. data/sig/lithic/models/account_activity_list_params.rbs +173 -0
  138. data/sig/lithic/models/account_activity_list_response.rbs +1353 -0
  139. data/sig/lithic/models/account_activity_retrieve_transaction_params.rbs +15 -0
  140. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +1353 -0
  141. data/sig/lithic/models/account_holder_create_params.rbs +33 -19
  142. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +10 -3
  143. data/sig/lithic/models/account_holder_update_response.rbs +10 -3
  144. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +8 -0
  145. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +8 -0
  146. data/sig/lithic/models/auth_rules/v2_apply_params.rbs +11 -2
  147. data/sig/lithic/models/auth_rules/v2_apply_response.rbs +317 -2
  148. data/sig/lithic/models/auth_rules/v2_create_params.rbs +188 -4
  149. data/sig/lithic/models/auth_rules/v2_create_response.rbs +317 -2
  150. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +155 -0
  151. data/sig/lithic/models/auth_rules/v2_draft_response.rbs +317 -2
  152. data/sig/lithic/models/auth_rules/v2_list_params.rbs +10 -1
  153. data/sig/lithic/models/auth_rules/v2_list_response.rbs +317 -2
  154. data/sig/lithic/models/auth_rules/v2_promote_response.rbs +317 -2
  155. data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +317 -2
  156. data/sig/lithic/models/auth_rules/v2_update_params.rbs +0 -7
  157. data/sig/lithic/models/auth_rules/v2_update_response.rbs +317 -2
  158. data/sig/lithic/models/book_transfer_create_params.rbs +30 -1
  159. data/sig/lithic/models/book_transfer_response.rbs +134 -15
  160. data/sig/lithic/models/event.rbs +4 -0
  161. data/sig/lithic/models/event_list_params.rbs +4 -0
  162. data/sig/lithic/models/event_subscription.rbs +4 -0
  163. data/sig/lithic/models/events/subscription_create_params.rbs +4 -0
  164. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +4 -0
  165. data/sig/lithic/models/events/subscription_update_params.rbs +4 -0
  166. data/sig/lithic/models/external_payment.rbs +91 -40
  167. data/sig/lithic/models/financial_account.rbs +2 -0
  168. data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
  169. data/sig/lithic/models/management_operation_transaction.rbs +95 -44
  170. data/sig/lithic/models/payment.rbs +61 -3
  171. data/sig/lithic/models/settlement_detail.rbs +2 -0
  172. data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +110 -23
  173. data/sig/lithic/models/transaction.rbs +10 -2
  174. data/sig/lithic/models/wire_party_details.rbs +35 -0
  175. data/sig/lithic/models.rbs +6 -0
  176. data/sig/lithic/resources/account_activity.rbs +27 -0
  177. data/sig/lithic/resources/account_holders.rbs +3 -3
  178. data/sig/lithic/resources/auth_rules/v2.rbs +6 -3
  179. data/sig/lithic/resources/book_transfers.rbs +2 -0
  180. data/sig/lithic/resources/tokenizations.rbs +1 -1
  181. metadata +20 -5
  182. data/lib/lithic/models/tokenization_retrieve_response.rb +0 -16
  183. data/rbi/lithic/models/tokenization_retrieve_response.rbi +0 -31
  184. data/sig/lithic/models/tokenization_retrieve_response.rbs +0 -15
@@ -73,6 +73,12 @@ module Lithic
73
73
  # @return [Integer]
74
74
  required :pending_amount, Integer
75
75
 
76
+ # @!attribute related_account_tokens
77
+ # Account tokens related to a payment transaction
78
+ #
79
+ # @return [Lithic::Models::Payment::RelatedAccountTokens]
80
+ required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }
81
+
76
82
  # @!attribute result
77
83
  # APPROVED payments were successful while DECLINED payments were declined by
78
84
  # Lithic or returned.
@@ -121,7 +127,13 @@ module Lithic
121
127
  # @return [Date, nil]
122
128
  optional :expected_release_date, Date
123
129
 
124
- # @!method initialize(token:, category:, created:, currency:, descriptor:, direction:, events:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, pending_amount:, result:, settled_amount:, source:, status:, updated:, user_defined_id:, expected_release_date: nil)
130
+ # @!attribute type
131
+ # Payment type indicating the specific ACH message or Fedwire transfer type
132
+ #
133
+ # @return [Symbol, Lithic::Models::Payment::Type, nil]
134
+ optional :type, enum: -> { Lithic::Payment::Type }
135
+
136
+ # @!method initialize(token:, category:, created:, currency:, descriptor:, direction:, events:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, pending_amount:, related_account_tokens:, result:, settled_amount:, source:, status:, updated:, user_defined_id:, expected_release_date: nil, type: nil)
125
137
  # Some parameter documentations has been truncated, see {Lithic::Models::Payment}
126
138
  # for more details.
127
139
  #
@@ -149,6 +161,8 @@ module Lithic
149
161
  #
150
162
  # @param pending_amount [Integer] Pending amount of the payment in the currency's smallest unit (e.g., cents).
151
163
  #
164
+ # @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens] Account tokens related to a payment transaction
165
+ #
152
166
  # @param result [Symbol, Lithic::Models::Payment::Result] APPROVED payments were successful while DECLINED payments were declined by Lithi
153
167
  #
154
168
  # @param settled_amount [Integer] Amount of the payment that has been settled in the currency's smallest unit (e.g
@@ -162,6 +176,8 @@ module Lithic
162
176
  # @param user_defined_id [String, nil]
163
177
  #
164
178
  # @param expected_release_date [Date] Date when the financial transaction expected to be released after settlement
179
+ #
180
+ # @param type [Symbol, Lithic::Models::Payment::Type] Payment type indicating the specific ACH message or Fedwire transfer type
165
181
 
166
182
  # Payment category
167
183
  #
@@ -249,6 +265,8 @@ module Lithic
249
265
  # Some parameter documentations has been truncated, see
250
266
  # {Lithic::Models::Payment::Event} for more details.
251
267
  #
268
+ # Payment Event
269
+ #
252
270
  # @param token [String] Globally unique identifier.
253
271
  #
254
272
  # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
@@ -401,6 +419,28 @@ module Lithic
401
419
  end
402
420
  end
403
421
 
422
+ # @see Lithic::Models::Payment#related_account_tokens
423
+ class RelatedAccountTokens < Lithic::Internal::Type::BaseModel
424
+ # @!attribute account_token
425
+ # Globally unique identifier for the account
426
+ #
427
+ # @return [String, nil]
428
+ required :account_token, String, nil?: true
429
+
430
+ # @!attribute business_account_token
431
+ # Globally unique identifier for the business account
432
+ #
433
+ # @return [String, nil]
434
+ required :business_account_token, String, nil?: true
435
+
436
+ # @!method initialize(account_token:, business_account_token:)
437
+ # Account tokens related to a payment transaction
438
+ #
439
+ # @param account_token [String, nil] Globally unique identifier for the account
440
+ #
441
+ # @param business_account_token [String, nil] Globally unique identifier for the business account
442
+ end
443
+
404
444
  # APPROVED payments were successful while DECLINED payments were declined by
405
445
  # Lithic or returned.
406
446
  #
@@ -446,6 +486,25 @@ module Lithic
446
486
  # @!method self.values
447
487
  # @return [Array<Symbol>]
448
488
  end
489
+
490
+ # Payment type indicating the specific ACH message or Fedwire transfer type
491
+ #
492
+ # @see Lithic::Models::Payment#type
493
+ module Type
494
+ extend Lithic::Internal::Type::Enum
495
+
496
+ ORIGINATION_CREDIT = :ORIGINATION_CREDIT
497
+ ORIGINATION_DEBIT = :ORIGINATION_DEBIT
498
+ RECEIPT_CREDIT = :RECEIPT_CREDIT
499
+ RECEIPT_DEBIT = :RECEIPT_DEBIT
500
+ WIRE_INBOUND_PAYMENT = :WIRE_INBOUND_PAYMENT
501
+ WIRE_INBOUND_ADMIN = :WIRE_INBOUND_ADMIN
502
+ WIRE_OUTBOUND_PAYMENT = :WIRE_OUTBOUND_PAYMENT
503
+ WIRE_OUTBOUND_ADMIN = :WIRE_OUTBOUND_ADMIN
504
+
505
+ # @!method self.values
506
+ # @return [Array<Symbol>]
507
+ end
449
508
  end
450
509
  end
451
510
  end
@@ -16,7 +16,7 @@ module Lithic
16
16
  optional :ending_before, String
17
17
 
18
18
  # @!attribute page_size
19
- # Page size (for pagination).
19
+ # Number of records per page.
20
20
  #
21
21
  # @return [Integer, nil]
22
22
  optional :page_size, Integer
@@ -34,7 +34,7 @@ module Lithic
34
34
  #
35
35
  # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
36
36
  #
37
- # @param page_size [Integer] Page size (for pagination).
37
+ # @param page_size [Integer] Number of records per page.
38
38
  #
39
39
  # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
40
40
  #
@@ -221,6 +221,7 @@ module Lithic
221
221
  ARBITRATION = :ARBITRATION
222
222
  CHARGEBACK = :CHARGEBACK
223
223
  CLEARING = :CLEARING
224
+ COLLABORATION = :COLLABORATION
224
225
  FEE = :FEE
225
226
  FINANCIAL = :FINANCIAL
226
227
  NON_FINANCIAL = :"NON-FINANCIAL"
@@ -488,43 +488,45 @@ module Lithic
488
488
 
489
489
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#merchant
490
490
  class Merchant < Lithic::Internal::Type::BaseModel
491
+ # @!attribute risk_indicator
492
+ # Object containing additional data indicating additional risk factors related to
493
+ # the e-commerce transaction.
494
+ #
495
+ # @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator]
496
+ required :risk_indicator,
497
+ -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator }
498
+
491
499
  # @!attribute id
492
500
  # Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
493
- # `acquirerMerchantId`.
501
+ # `acquirerMerchantId`. May not be present for non-payment authentications.
494
502
  #
495
- # @return [String]
496
- required :id, String
503
+ # @return [String, nil]
504
+ optional :id, String, nil?: true
497
505
 
498
506
  # @!attribute country
499
507
  # Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
500
508
  # field `merchantCountryCode`. Permitted values: ISO 3166-1 alpha-3 country code
501
- # (e.g., USA).
509
+ # (e.g., USA). May not be present for non-payment authentications.
502
510
  #
503
- # @return [String]
504
- required :country, String
511
+ # @return [String, nil]
512
+ optional :country, String, nil?: true
505
513
 
506
514
  # @!attribute mcc
507
515
  # Merchant category code assigned to the merchant that describes its business
508
- # activity type. Maps to EMV 3DS field `mcc`.
516
+ # activity type. Maps to EMV 3DS field `mcc`. May not be present for non-payment
517
+ # authentications.
509
518
  #
510
- # @return [String]
511
- required :mcc, String
519
+ # @return [String, nil]
520
+ optional :mcc, String, nil?: true
512
521
 
513
522
  # @!attribute name
514
- # Name of the merchant. Maps to EMV 3DS field `merchantName`.
515
- #
516
- # @return [String]
517
- required :name, String
518
-
519
- # @!attribute risk_indicator
520
- # Object containing additional data indicating additional risk factors related to
521
- # the e-commerce transaction.
523
+ # Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present
524
+ # for non-payment authentications.
522
525
  #
523
- # @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator]
524
- required :risk_indicator,
525
- -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator }
526
+ # @return [String, nil]
527
+ optional :name, String, nil?: true
526
528
 
527
- # @!method initialize(id:, country:, mcc:, name:, risk_indicator:)
529
+ # @!method initialize(risk_indicator:, id: nil, country: nil, mcc: nil, name: nil)
528
530
  # Some parameter documentations has been truncated, see
529
531
  # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant} for more
530
532
  # details.
@@ -532,15 +534,15 @@ module Lithic
532
534
  # Object containing data about the merchant involved in the e-commerce
533
535
  # transaction.
534
536
  #
535
- # @param id [String] Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field `acquirer
537
+ # @param risk_indicator [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator] Object containing additional data indicating additional risk factors related to
536
538
  #
537
- # @param country [String] Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS fiel
539
+ # @param id [String, nil] Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field `acquirer
538
540
  #
539
- # @param mcc [String] Merchant category code assigned to the merchant that describes its business acti
541
+ # @param country [String, nil] Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS fiel
540
542
  #
541
- # @param name [String] Name of the merchant. Maps to EMV 3DS field `merchantName`.
543
+ # @param mcc [String, nil] Merchant category code assigned to the merchant that describes its business acti
542
544
  #
543
- # @param risk_indicator [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator] Object containing additional data indicating additional risk factors related to
545
+ # @param name [String, nil] Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present f
544
546
 
545
547
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant#risk_indicator
546
548
  class RiskIndicator < Lithic::Internal::Type::BaseModel
@@ -806,30 +808,101 @@ module Lithic
806
808
 
807
809
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#app
808
810
  class App < Lithic::Internal::Type::BaseModel
811
+ # @!attribute device
812
+ # Device model: e.g. "Apple iPhone 16".
813
+ #
814
+ # @return [String, nil]
815
+ optional :device, String, nil?: true
816
+
809
817
  # @!attribute device_info
810
- # Device information gathered from the cardholder's device - JSON name/value pairs
811
- # that is Base64url encoded. Maps to EMV 3DS field `deviceInfo`.
818
+ # Raw device information - base64-encoded JSON object. Maps to EMV 3DS field
819
+ # `deviceInfo`.
812
820
  #
813
821
  # @return [String, nil]
814
822
  optional :device_info, String, nil?: true
815
823
 
816
824
  # @!attribute ip
817
- # External IP address used by the app generating the 3DS authentication request.
818
- # Maps to EMV 3DS field `appIp`.
825
+ # IP address of the device.
819
826
  #
820
827
  # @return [String, nil]
821
828
  optional :ip, String
822
829
 
823
- # @!method initialize(device_info: nil, ip: nil)
830
+ # @!attribute latitude
831
+ # Latitude coordinate of current device location.
832
+ #
833
+ # @return [Float, nil]
834
+ optional :latitude, Float, nil?: true
835
+
836
+ # @!attribute locale
837
+ # Device locale: e.g. "en-US".
838
+ #
839
+ # @return [String, nil]
840
+ optional :locale, String, nil?: true
841
+
842
+ # @!attribute longitude
843
+ # Longitude coordinate of current device location.
844
+ #
845
+ # @return [Float, nil]
846
+ optional :longitude, Float, nil?: true
847
+
848
+ # @!attribute os
849
+ # Operating System: e.g. "Android 12", "iOS 17.1".
850
+ #
851
+ # @return [String, nil]
852
+ optional :os, String, nil?: true
853
+
854
+ # @!attribute platform
855
+ # Device platform: Android, iOS, Windows, etc.
856
+ #
857
+ # @return [String, nil]
858
+ optional :platform, String, nil?: true
859
+
860
+ # @!attribute screen_height
861
+ # Screen height in pixels.
862
+ #
863
+ # @return [Integer, nil]
864
+ optional :screen_height, Integer, nil?: true
865
+
866
+ # @!attribute screen_width
867
+ # Screen width in pixels.
868
+ #
869
+ # @return [Integer, nil]
870
+ optional :screen_width, Integer, nil?: true
871
+
872
+ # @!attribute time_zone
873
+ # Time zone offset in minutes between UTC and device local time.
874
+ #
875
+ # @return [String, nil]
876
+ optional :time_zone, String, nil?: true
877
+
878
+ # @!method initialize(device: nil, device_info: nil, ip: nil, latitude: nil, locale: nil, longitude: nil, os: nil, platform: nil, screen_height: nil, screen_width: nil, time_zone: nil)
824
879
  # Some parameter documentations has been truncated, see
825
880
  # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App} for more details.
826
881
  #
827
882
  # Object containing data about the app used in the e-commerce transaction. Present
828
883
  # if the channel is 'APP_BASED'.
829
884
  #
830
- # @param device_info [String, nil] Device information gathered from the cardholder's device - JSON name/value pairs
885
+ # @param device [String, nil] Device model: e.g. "Apple iPhone 16".
886
+ #
887
+ # @param device_info [String, nil] Raw device information - base64-encoded JSON object. Maps to EMV 3DS field `devi
888
+ #
889
+ # @param ip [String] IP address of the device.
831
890
  #
832
- # @param ip [String] External IP address used by the app generating the 3DS authentication request. M
891
+ # @param latitude [Float, nil] Latitude coordinate of current device location.
892
+ #
893
+ # @param locale [String, nil] Device locale: e.g. "en-US".
894
+ #
895
+ # @param longitude [Float, nil] Longitude coordinate of current device location.
896
+ #
897
+ # @param os [String, nil] Operating System: e.g. "Android 12", "iOS 17.1".
898
+ #
899
+ # @param platform [String, nil] Device platform: Android, iOS, Windows, etc.
900
+ #
901
+ # @param screen_height [Integer, nil] Screen height in pixels.
902
+ #
903
+ # @param screen_width [Integer, nil] Screen width in pixels.
904
+ #
905
+ # @param time_zone [String, nil] Time zone offset in minutes between UTC and device local time.
833
906
  end
834
907
 
835
908
  # Type of authentication request - i.e., the type of transaction or interaction is
@@ -893,9 +966,8 @@ module Lithic
893
966
  optional :language, String, nil?: true
894
967
 
895
968
  # @!attribute time_zone
896
- # Time zone of the cardholder's browser offset in minutes between UTC and the
897
- # cardholder browser's local time. The offset is positive if the local time is
898
- # behind UTC and negative if it is ahead. Maps to EMV 3DS field `browserTz`.
969
+ # Time zone offset in minutes between UTC and browser local time. Maps to EMV 3DS
970
+ # field `browserTz`.
899
971
  #
900
972
  # @return [String, nil]
901
973
  optional :time_zone, String, nil?: true
@@ -924,7 +996,7 @@ module Lithic
924
996
  #
925
997
  # @param language [String, nil] Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS f
926
998
  #
927
- # @param time_zone [String, nil] Time zone of the cardholder's browser offset in minutes between UTC and the card
999
+ # @param time_zone [String, nil] Time zone offset in minutes between UTC and browser local time. Maps to EMV 3DS
928
1000
  #
929
1001
  # @param user_agent [String, nil] Content of the HTTP user-agent header. Maps to EMV 3DS field `browserUserAgent`.
930
1002
  end
@@ -938,18 +1010,46 @@ module Lithic
938
1010
  required :method_type,
939
1011
  enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType }
940
1012
 
1013
+ # @!attribute status
1014
+ # Indicates the status of the challenge
1015
+ #
1016
+ # - SUCCESS - Cardholder completed the challenge successfully
1017
+ # - PENDING - Challenge was issued to the cardholder and was not completed yet
1018
+ # - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
1019
+ # provided phone number. Relevant only for SMS_OTP method
1020
+ # - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
1021
+ # given challenge TTL
1022
+ # - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
1023
+ # "cancel" on the challenge UI
1024
+ # - CANCELED_OOB - Cardholder canceled the challenge out of band
1025
+ # - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
1026
+ # incorrect OTP more than the allowed number of times or requesting a new OTP
1027
+ # more than the allowed number of times
1028
+ # - ABORTED - Merchant aborted authentication after a challenge was requested
1029
+ # - ERROR - The challenge failed for a reason different than those documented
1030
+ #
1031
+ # @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status]
1032
+ required :status,
1033
+ enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status }
1034
+
941
1035
  # @!attribute phone_number
942
1036
  # The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
943
1037
  #
944
1038
  # @return [String, nil]
945
1039
  optional :phone_number, String, nil?: true
946
1040
 
947
- # @!method initialize(method_type:, phone_number: nil)
1041
+ # @!method initialize(method_type:, status:, phone_number: nil)
1042
+ # Some parameter documentations has been truncated, see
1043
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata} for
1044
+ # more details.
1045
+ #
948
1046
  # Metadata about the challenge method and delivery. Only present when a challenge
949
1047
  # is triggered.
950
1048
  #
951
1049
  # @param method_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType] The type of challenge method used for authentication.
952
1050
  #
1051
+ # @param status [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status] Indicates the status of the challenge
1052
+ #
953
1053
  # @param phone_number [String, nil] The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
954
1054
 
955
1055
  # The type of challenge method used for authentication.
@@ -964,6 +1064,41 @@ module Lithic
964
1064
  # @!method self.values
965
1065
  # @return [Array<Symbol>]
966
1066
  end
1067
+
1068
+ # Indicates the status of the challenge
1069
+ #
1070
+ # - SUCCESS - Cardholder completed the challenge successfully
1071
+ # - PENDING - Challenge was issued to the cardholder and was not completed yet
1072
+ # - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
1073
+ # provided phone number. Relevant only for SMS_OTP method
1074
+ # - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
1075
+ # given challenge TTL
1076
+ # - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
1077
+ # "cancel" on the challenge UI
1078
+ # - CANCELED_OOB - Cardholder canceled the challenge out of band
1079
+ # - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
1080
+ # incorrect OTP more than the allowed number of times or requesting a new OTP
1081
+ # more than the allowed number of times
1082
+ # - ABORTED - Merchant aborted authentication after a challenge was requested
1083
+ # - ERROR - The challenge failed for a reason different than those documented
1084
+ #
1085
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata#status
1086
+ module Status
1087
+ extend Lithic::Internal::Type::Enum
1088
+
1089
+ SUCCESS = :SUCCESS
1090
+ PENDING = :PENDING
1091
+ SMS_DELIVERY_FAILED = :SMS_DELIVERY_FAILED
1092
+ CARDHOLDER_TIMEOUT = :CARDHOLDER_TIMEOUT
1093
+ CANCELED_VIA_CHALLENGE_UI = :CANCELED_VIA_CHALLENGE_UI
1094
+ CANCELED_OOB = :CANCELED_OOB
1095
+ ATTEMPTS_EXCEEDED = :ATTEMPTS_EXCEEDED
1096
+ ABORTED = :ABORTED
1097
+ ERROR = :ERROR
1098
+
1099
+ # @!method self.values
1100
+ # @return [Array<Symbol>]
1101
+ end
967
1102
  end
968
1103
 
969
1104
  # Entity that orchestrates the challenge. This won't be set for authentications
@@ -31,10 +31,7 @@ module Lithic
31
31
  # When not set defaults to MATCH
32
32
  #
33
33
  # @return [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck, nil]
34
- optional :card_expiry_check,
35
- enum: -> {
36
- Lithic::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck
37
- }
34
+ optional :card_expiry_check, enum: -> { Lithic::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck }
38
35
 
39
36
  # @!method initialize(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
40
37
  # Some parameter documentations has been truncated, see
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
- # @see Lithic::Resources::Tokenizations#list
5
+ # @see Lithic::Resources::Tokenizations#retrieve
6
6
  class Tokenization < Lithic::Internal::Type::BaseModel
7
7
  # @!attribute token
8
8
  # Globally unique identifier for a Tokenization
@@ -947,6 +947,7 @@ module Lithic
947
947
  module Result
948
948
  extend Lithic::Internal::Type::Enum
949
949
 
950
+ ACCOUNT_PAUSED = :ACCOUNT_PAUSED
950
951
  ACCOUNT_STATE_TRANSACTION_FAIL = :ACCOUNT_STATE_TRANSACTION_FAIL
951
952
  APPROVED = :APPROVED
952
953
  BANK_CONNECTION_ERROR = :BANK_CONNECTION_ERROR
@@ -1250,6 +1251,7 @@ module Lithic
1250
1251
  ACCOUNT_INACTIVE = :ACCOUNT_INACTIVE
1251
1252
  ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED = :ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED
1252
1253
  ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED = :ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED
1254
+ ACCOUNT_PAUSED = :ACCOUNT_PAUSED
1253
1255
  ACCOUNT_UNDER_REVIEW = :ACCOUNT_UNDER_REVIEW
1254
1256
  ADDRESS_INCORRECT = :ADDRESS_INCORRECT
1255
1257
  APPROVED = :APPROVED
@@ -1494,6 +1496,7 @@ module Lithic
1494
1496
  module Result
1495
1497
  extend Lithic::Internal::Type::Enum
1496
1498
 
1499
+ ACCOUNT_PAUSED = :ACCOUNT_PAUSED
1497
1500
  ACCOUNT_STATE_TRANSACTION_FAIL = :ACCOUNT_STATE_TRANSACTION_FAIL
1498
1501
  APPROVED = :APPROVED
1499
1502
  BANK_CONNECTION_ERROR = :BANK_CONNECTION_ERROR
@@ -1573,6 +1576,7 @@ module Lithic
1573
1576
  ACCOUNT_INACTIVE = :ACCOUNT_INACTIVE
1574
1577
  ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED = :ACCOUNT_LIFETIME_SPEND_LIMIT_EXCEEDED
1575
1578
  ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED = :ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED
1579
+ ACCOUNT_PAUSED = :ACCOUNT_PAUSED
1576
1580
  ACCOUNT_UNDER_REVIEW = :ACCOUNT_UNDER_REVIEW
1577
1581
  ADDRESS_INCORRECT = :ADDRESS_INCORRECT
1578
1582
  APPROVED = :APPROVED
@@ -26,10 +26,7 @@ module Lithic
26
26
  # @!attribute fleet
27
27
  #
28
28
  # @return [Array<Lithic::Models::Transactions::Events::EnhancedData::Fleet>]
29
- required :fleet,
30
- -> {
31
- Lithic::Internal::Type::ArrayOf[Lithic::Transactions::Events::EnhancedData::Fleet]
32
- }
29
+ required :fleet, -> { Lithic::Internal::Type::ArrayOf[Lithic::Transactions::Events::EnhancedData::Fleet] }
33
30
 
34
31
  # @!attribute transaction_token
35
32
  # The token of the transaction that the enhanced data is associated with.
@@ -54,9 +51,7 @@ module Lithic
54
51
  #
55
52
  # @return [Array<Lithic::Models::Transactions::Events::EnhancedData::Common::LineItem>]
56
53
  required :line_items,
57
- -> {
58
- Lithic::Internal::Type::ArrayOf[Lithic::Transactions::Events::EnhancedData::Common::LineItem]
59
- }
54
+ -> { Lithic::Internal::Type::ArrayOf[Lithic::Transactions::Events::EnhancedData::Common::LineItem] }
60
55
 
61
56
  # @!attribute tax
62
57
  #
@@ -200,10 +195,7 @@ module Lithic
200
195
  # The type of fuel service.
201
196
  #
202
197
  # @return [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::ServiceType, nil]
203
- optional :service_type,
204
- enum: -> {
205
- Lithic::Transactions::Events::EnhancedData::Fleet::ServiceType
206
- }
198
+ optional :service_type, enum: -> { Lithic::Transactions::Events::EnhancedData::Fleet::ServiceType }
207
199
 
208
200
  # @!attribute vehicle_number
209
201
  # The vehicle number entered into the terminal at the time of sale, with leading
@@ -178,6 +178,8 @@ module Lithic
178
178
  # Some parameter documentations has been truncated, see
179
179
  # {Lithic::Models::Transfer::Event} for more details.
180
180
  #
181
+ # Financial Event
182
+ #
181
183
  # @param token [String] Globally unique identifier.
182
184
  #
183
185
  # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class WirePartyDetails < Lithic::Internal::Type::BaseModel
6
+ # @!attribute account_number
7
+ # Account number
8
+ #
9
+ # @return [String, nil]
10
+ optional :account_number, String, nil?: true
11
+
12
+ # @!attribute agent_id
13
+ # Routing number or BIC of the financial institution
14
+ #
15
+ # @return [String, nil]
16
+ optional :agent_id, String, nil?: true
17
+
18
+ # @!attribute agent_name
19
+ # Name of the financial institution
20
+ #
21
+ # @return [String, nil]
22
+ optional :agent_name, String, nil?: true
23
+
24
+ # @!attribute name
25
+ # Name of the person or company
26
+ #
27
+ # @return [String, nil]
28
+ optional :name, String, nil?: true
29
+
30
+ # @!method initialize(account_number: nil, agent_id: nil, agent_name: nil, name: nil)
31
+ # @param account_number [String, nil] Account number
32
+ #
33
+ # @param agent_id [String, nil] Routing number or BIC of the financial institution
34
+ #
35
+ # @param agent_name [String, nil] Name of the financial institution
36
+ #
37
+ # @param name [String, nil] Name of the person or company
38
+ end
39
+ end
40
+ end
data/lib/lithic/models.rb CHANGED
@@ -41,6 +41,10 @@ module Lithic
41
41
 
42
42
  Account = Lithic::Models::Account
43
43
 
44
+ AccountActivityListParams = Lithic::Models::AccountActivityListParams
45
+
46
+ AccountActivityRetrieveTransactionParams = Lithic::Models::AccountActivityRetrieveTransactionParams
47
+
44
48
  AccountFinancialAccountType = Lithic::Models::AccountFinancialAccountType
45
49
 
46
50
  AccountHolder = Lithic::Models::AccountHolder
@@ -385,4 +389,6 @@ module Lithic
385
389
  TransferCreateParams = Lithic::Models::TransferCreateParams
386
390
 
387
391
  VerificationMethod = Lithic::Models::VerificationMethod
392
+
393
+ WirePartyDetails = Lithic::Models::WirePartyDetails
388
394
  end