lithic 0.1.0.pre.alpha.54 → 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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -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/account_holder_simulate_enrollment_review_response.rb +2 -2
  8. data/lib/lithic/models/account_holder_update_response.rb +4 -4
  9. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -51
  10. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -51
  11. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +260 -0
  12. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +207 -0
  13. data/lib/lithic/models/auth_rules/conditional_operation.rb +26 -0
  14. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +254 -0
  15. data/lib/lithic/models/auth_rules/conditional_value.rb +27 -0
  16. data/lib/lithic/models/auth_rules/v2_create_params.rb +46 -283
  17. data/lib/lithic/models/auth_rules/v2_create_response.rb +23 -510
  18. data/lib/lithic/models/auth_rules/v2_draft_params.rb +6 -248
  19. data/lib/lithic/models/auth_rules/v2_draft_response.rb +23 -510
  20. data/lib/lithic/models/auth_rules/v2_list_params.rb +3 -0
  21. data/lib/lithic/models/auth_rules/v2_list_response.rb +23 -510
  22. data/lib/lithic/models/auth_rules/v2_promote_response.rb +23 -510
  23. data/lib/lithic/models/auth_rules/v2_retrieve_features_response.rb +4 -11
  24. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +23 -510
  25. data/lib/lithic/models/auth_rules/v2_update_response.rb +23 -510
  26. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +4 -7
  27. data/lib/lithic/models/auth_rules/velocity_limit_period.rb +154 -0
  28. data/lib/lithic/models/book_transfer_response.rb +6 -5
  29. data/lib/lithic/models/category_details.rb +27 -0
  30. data/lib/lithic/models/dispute_v2.rb +555 -0
  31. data/lib/lithic/models/disputes_v2_list_params.rb +84 -0
  32. data/lib/lithic/models/disputes_v2_retrieve_params.rb +14 -0
  33. data/lib/lithic/models/event.rb +213 -69
  34. data/lib/lithic/models/event_list_params.rb +112 -6
  35. data/lib/lithic/models/event_subscription.rb +112 -6
  36. data/lib/lithic/models/events/subscription_create_params.rb +112 -6
  37. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +12 -6
  38. data/lib/lithic/models/events/subscription_update_params.rb +112 -6
  39. data/lib/lithic/models/external_bank_account_address.rb +2 -2
  40. data/lib/lithic/models/external_bank_account_create_response.rb +18 -18
  41. data/lib/lithic/models/external_bank_account_list_response.rb +18 -18
  42. data/lib/lithic/models/external_bank_account_retrieve_response.rb +18 -18
  43. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +18 -18
  44. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +18 -18
  45. data/lib/lithic/models/external_bank_account_unpause_params.rb +14 -0
  46. data/lib/lithic/models/external_bank_account_unpause_response.rb +242 -0
  47. data/lib/lithic/models/external_bank_account_update_response.rb +18 -18
  48. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +18 -18
  49. data/lib/lithic/models/external_payment.rb +3 -2
  50. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  51. data/lib/lithic/models/financial_account.rb +5 -68
  52. data/lib/lithic/models/financial_accounts/category_balances.rb +29 -0
  53. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +1 -64
  54. data/lib/lithic/models/financial_accounts/loan_tape.rb +35 -424
  55. data/lib/lithic/models/financial_accounts/statement.rb +73 -211
  56. data/lib/lithic/models/financial_event.rb +148 -0
  57. data/lib/lithic/models/financial_transaction.rb +3 -146
  58. data/lib/lithic/models/management_operation_list_params.rb +1 -0
  59. data/lib/lithic/models/management_operation_transaction.rb +5 -4
  60. data/lib/lithic/models/merchant.rb +70 -0
  61. data/lib/lithic/models/payment.rb +16 -14
  62. data/lib/lithic/models/payment_return_params.rb +62 -0
  63. data/lib/lithic/models/payment_simulate_action_params.rb +17 -1
  64. data/lib/lithic/models/statement_totals.rb +100 -0
  65. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +9 -9
  66. data/lib/lithic/models/tokenization.rb +189 -23
  67. data/lib/lithic/models/transaction.rb +15 -185
  68. data/lib/lithic/models/transactions/events/enhanced_data.rb +52 -43
  69. data/lib/lithic/models/transfer.rb +3 -146
  70. data/lib/lithic/models.rb +18 -0
  71. data/lib/lithic/resources/auth_rules/v2/backtests.rb +3 -5
  72. data/lib/lithic/resources/auth_rules/v2.rb +13 -56
  73. data/lib/lithic/resources/disputes_v2.rb +74 -0
  74. data/lib/lithic/resources/external_bank_accounts.rb +19 -0
  75. data/lib/lithic/resources/payments.rb +53 -1
  76. data/lib/lithic/version.rb +1 -1
  77. data/lib/lithic.rb +18 -3
  78. data/rbi/lithic/client.rbi +3 -0
  79. data/rbi/lithic/models/account_activity_list_response.rbi +121 -544
  80. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +121 -544
  81. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +3 -6
  82. data/rbi/lithic/models/account_holder_update_response.rbi +6 -12
  83. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +13 -139
  84. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +13 -153
  85. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +789 -0
  86. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +437 -0
  87. data/rbi/lithic/models/auth_rules/conditional_operation.rbi +74 -0
  88. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +674 -0
  89. data/rbi/lithic/models/auth_rules/conditional_value.rbi +28 -0
  90. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +112 -680
  91. data/rbi/lithic/models/auth_rules/v2_create_response.rbi +33 -1149
  92. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +12 -575
  93. data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +33 -1149
  94. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +15 -0
  95. data/rbi/lithic/models/auth_rules/v2_list_response.rbi +33 -1149
  96. data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +33 -1149
  97. data/rbi/lithic/models/auth_rules/v2_retrieve_features_response.rbi +9 -22
  98. data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +33 -1149
  99. data/rbi/lithic/models/auth_rules/v2_update_response.rbi +33 -1149
  100. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +17 -29
  101. data/rbi/lithic/models/auth_rules/velocity_limit_period.rbi +223 -0
  102. data/rbi/lithic/models/book_transfer_response.rbi +16 -11
  103. data/rbi/lithic/models/category_details.rbi +43 -0
  104. data/rbi/lithic/models/dispute_v2.rbi +965 -0
  105. data/rbi/lithic/models/disputes_v2_list_params.rbi +129 -0
  106. data/rbi/lithic/models/disputes_v2_retrieve_params.rbi +27 -0
  107. data/rbi/lithic/models/event.rbi +348 -111
  108. data/rbi/lithic/models/event_list_params.rbi +155 -25
  109. data/rbi/lithic/models/event_subscription.rbi +155 -25
  110. data/rbi/lithic/models/events/subscription_create_params.rbi +155 -25
  111. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +55 -25
  112. data/rbi/lithic/models/events/subscription_update_params.rbi +155 -25
  113. data/rbi/lithic/models/external_bank_account_address.rbi +3 -6
  114. data/rbi/lithic/models/external_bank_account_create_response.rbi +31 -51
  115. data/rbi/lithic/models/external_bank_account_list_response.rbi +31 -51
  116. data/rbi/lithic/models/external_bank_account_retrieve_response.rbi +31 -51
  117. data/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +31 -51
  118. data/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi +31 -51
  119. data/rbi/lithic/models/external_bank_account_unpause_params.rbi +30 -0
  120. data/rbi/lithic/models/external_bank_account_unpause_response.rbi +375 -0
  121. data/rbi/lithic/models/external_bank_account_update_response.rbi +31 -51
  122. data/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +31 -51
  123. data/rbi/lithic/models/external_payment.rbi +5 -6
  124. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  125. data/rbi/lithic/models/financial_account.rbi +15 -136
  126. data/rbi/lithic/models/financial_accounts/category_balances.rbi +42 -0
  127. data/rbi/lithic/models/financial_accounts/financial_account_credit_config.rbi +3 -136
  128. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +47 -679
  129. data/rbi/lithic/models/financial_accounts/statement.rbi +118 -348
  130. data/rbi/lithic/models/financial_event.rbi +409 -0
  131. data/rbi/lithic/models/financial_transaction.rbi +3 -509
  132. data/rbi/lithic/models/management_operation_list_params.rbi +5 -0
  133. data/rbi/lithic/models/management_operation_transaction.rbi +11 -12
  134. data/rbi/lithic/models/merchant.rbi +89 -0
  135. data/rbi/lithic/models/payment.rbi +27 -21
  136. data/rbi/lithic/models/payment_return_params.rbi +85 -0
  137. data/rbi/lithic/models/payment_simulate_action_params.rbi +22 -0
  138. data/rbi/lithic/models/statement_totals.rbi +128 -0
  139. data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +12 -12
  140. data/rbi/lithic/models/tokenization.rbi +429 -34
  141. data/rbi/lithic/models/transaction.rbi +26 -336
  142. data/rbi/lithic/models/transactions/events/enhanced_data.rbi +77 -136
  143. data/rbi/lithic/models/transfer.rbi +4 -436
  144. data/rbi/lithic/models.rbi +19 -0
  145. data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +0 -3
  146. data/rbi/lithic/resources/auth_rules/v2.rbi +29 -72
  147. data/rbi/lithic/resources/disputes_v2.rbi +64 -0
  148. data/rbi/lithic/resources/external_bank_accounts.rbi +10 -0
  149. data/rbi/lithic/resources/payments.rbi +52 -0
  150. data/sig/lithic/client.rbs +2 -0
  151. data/sig/lithic/models/account_activity_list_response.rbs +67 -221
  152. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +67 -221
  153. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +4 -6
  154. data/sig/lithic/models/account_holder_update_response.rbs +8 -12
  155. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +10 -61
  156. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -61
  157. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +293 -0
  158. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +112 -0
  159. data/sig/lithic/models/auth_rules/conditional_operation.rbs +34 -0
  160. data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +237 -0
  161. data/sig/lithic/models/auth_rules/conditional_value.rbs +15 -0
  162. data/sig/lithic/models/auth_rules/v2_create_params.rbs +32 -188
  163. data/sig/lithic/models/auth_rules/v2_create_response.rbs +15 -319
  164. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +3 -159
  165. data/sig/lithic/models/auth_rules/v2_draft_response.rbs +15 -319
  166. data/sig/lithic/models/auth_rules/v2_list_params.rbs +9 -1
  167. data/sig/lithic/models/auth_rules/v2_list_response.rbs +15 -319
  168. data/sig/lithic/models/auth_rules/v2_promote_response.rbs +15 -319
  169. data/sig/lithic/models/auth_rules/v2_retrieve_features_response.rbs +4 -4
  170. data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +15 -319
  171. data/sig/lithic/models/auth_rules/v2_update_response.rbs +15 -319
  172. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +4 -4
  173. data/sig/lithic/models/auth_rules/velocity_limit_period.rbs +91 -0
  174. data/sig/lithic/models/book_transfer_response.rbs +10 -8
  175. data/sig/lithic/models/category_details.rbs +26 -0
  176. data/sig/lithic/models/dispute_v2.rbs +438 -0
  177. data/sig/lithic/models/disputes_v2_list_params.rbs +77 -0
  178. data/sig/lithic/models/disputes_v2_retrieve_params.rbs +15 -0
  179. data/sig/lithic/models/event.rbs +25 -13
  180. data/sig/lithic/models/event_list_params.rbs +25 -13
  181. data/sig/lithic/models/event_subscription.rbs +25 -13
  182. data/sig/lithic/models/events/subscription_create_params.rbs +25 -13
  183. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +25 -13
  184. data/sig/lithic/models/events/subscription_update_params.rbs +25 -13
  185. data/sig/lithic/models/external_bank_account_address.rbs +4 -6
  186. data/sig/lithic/models/external_bank_account_create_response.rbs +36 -56
  187. data/sig/lithic/models/external_bank_account_list_response.rbs +36 -56
  188. data/sig/lithic/models/external_bank_account_retrieve_response.rbs +36 -56
  189. data/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs +36 -56
  190. data/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +36 -56
  191. data/sig/lithic/models/external_bank_account_unpause_params.rbs +15 -0
  192. data/sig/lithic/models/external_bank_account_unpause_response.rbs +162 -0
  193. data/sig/lithic/models/external_bank_account_update_response.rbs +36 -56
  194. data/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs +36 -56
  195. data/sig/lithic/models/external_payment.rbs +7 -7
  196. data/sig/lithic/models/external_payment_list_params.rbs +3 -1
  197. data/sig/lithic/models/financial_account.rbs +7 -49
  198. data/sig/lithic/models/financial_accounts/category_balances.rbs +24 -0
  199. data/sig/lithic/models/financial_accounts/financial_account_credit_config.rbs +3 -49
  200. data/sig/lithic/models/financial_accounts/loan_tape.rbs +48 -386
  201. data/sig/lithic/models/financial_accounts/statement.rbs +59 -192
  202. data/sig/lithic/models/financial_event.rbs +216 -0
  203. data/sig/lithic/models/financial_transaction.rbs +4 -217
  204. data/sig/lithic/models/management_operation_list_params.rbs +3 -1
  205. data/sig/lithic/models/management_operation_transaction.rbs +11 -13
  206. data/sig/lithic/models/merchant.rbs +50 -0
  207. data/sig/lithic/models/payment.rbs +17 -15
  208. data/sig/lithic/models/payment_return_params.rbs +46 -0
  209. data/sig/lithic/models/payment_simulate_action_params.rbs +14 -0
  210. data/sig/lithic/models/statement_totals.rbs +76 -0
  211. data/sig/lithic/models/tokenization.rbs +160 -13
  212. data/sig/lithic/models/transaction.rbs +17 -145
  213. data/sig/lithic/models/transactions/events/enhanced_data.rbs +78 -124
  214. data/sig/lithic/models/transfer.rbs +6 -219
  215. data/sig/lithic/models.rbs +18 -0
  216. data/sig/lithic/resources/auth_rules/v2.rbs +2 -12
  217. data/sig/lithic/resources/disputes_v2.rbs +24 -0
  218. data/sig/lithic/resources/external_bank_accounts.rbs +5 -0
  219. data/sig/lithic/resources/payments.rbs +12 -0
  220. metadata +56 -11
  221. data/lib/lithic/models/auth_rules/v2_apply_params.rb +0 -56
  222. data/lib/lithic/models/auth_rules/v2_apply_response.rb +0 -766
  223. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +0 -248
  224. data/rbi/lithic/models/auth_rules/v2_apply_params.rbi +0 -86
  225. data/rbi/lithic/models/auth_rules/v2_apply_response.rbi +0 -1638
  226. data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +0 -557
  227. data/sig/lithic/models/auth_rules/v2_apply_params.rbs +0 -54
  228. data/sig/lithic/models/auth_rules/v2_apply_response.rbs +0 -509
  229. data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs +0 -223
@@ -28,12 +28,6 @@ module Lithic
28
28
  # @return [Time]
29
29
  required :created_at, Time
30
30
 
31
- # @!attribute device_id
32
- # The device identifier associated with the tokenization.
33
- #
34
- # @return [String, nil]
35
- required :device_id, String, nil?: true
36
-
37
31
  # @!attribute dpan
38
32
  # The dynamic pan assigned to the token by the network.
39
33
  #
@@ -47,11 +41,12 @@ module Lithic
47
41
  required :status, enum: -> { Lithic::Tokenization::Status }
48
42
 
49
43
  # @!attribute token_requestor_name
50
- # The entity that requested the tokenization. Represents a Digital Wallet or
51
- # merchant.
44
+ # The entity that requested the tokenization. For digital wallets, this will be
45
+ # one of the defined wallet types. For merchant tokenizations, this will be a
46
+ # free-form merchant name string.
52
47
  #
53
- # @return [Symbol, Lithic::Models::Tokenization::TokenRequestorName]
54
- required :token_requestor_name, enum: -> { Lithic::Tokenization::TokenRequestorName }
48
+ # @return [Symbol, String, Lithic::Models::Tokenization::TokenRequestorName]
49
+ required :token_requestor_name, union: -> { Lithic::Tokenization::TokenRequestorName }
55
50
 
56
51
  # @!attribute token_unique_reference
57
52
  # The network's unique reference for the tokenization.
@@ -71,14 +66,20 @@ module Lithic
71
66
  # @return [Time]
72
67
  required :updated_at, Time
73
68
 
69
+ # @!attribute device_id
70
+ # The device identifier associated with the tokenization.
71
+ #
72
+ # @return [String, nil]
73
+ optional :device_id, String, nil?: true
74
+
74
75
  # @!attribute digital_card_art_token
75
- # Specifies the digital card art displayed in the users digital wallet after
76
+ # Specifies the digital card art displayed in the user's digital wallet after
76
77
  # tokenization. This will be null if the tokenization was created without an
77
78
  # associated digital card art. See
78
79
  # [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
79
80
  #
80
81
  # @return [String, nil]
81
- optional :digital_card_art_token, String
82
+ optional :digital_card_art_token, String, nil?: true
82
83
 
83
84
  # @!attribute events
84
85
  # A list of events related to the tokenization.
@@ -92,7 +93,7 @@ module Lithic
92
93
  # @return [String, nil]
93
94
  optional :payment_account_reference_id, String, nil?: true
94
95
 
95
- # @!method initialize(token:, account_token:, card_token:, created_at:, device_id:, dpan:, status:, token_requestor_name:, token_unique_reference:, tokenization_channel:, updated_at:, digital_card_art_token: nil, events: nil, payment_account_reference_id: nil)
96
+ # @!method initialize(token:, account_token:, card_token:, created_at:, dpan:, status:, token_requestor_name:, token_unique_reference:, tokenization_channel:, updated_at:, device_id: nil, digital_card_art_token: nil, events: nil, payment_account_reference_id: nil)
96
97
  # Some parameter documentations has been truncated, see
97
98
  # {Lithic::Models::Tokenization} for more details.
98
99
  #
@@ -104,13 +105,11 @@ module Lithic
104
105
  #
105
106
  # @param created_at [Time] Date and time when the tokenization first occurred. UTC time zone.
106
107
  #
107
- # @param device_id [String, nil] The device identifier associated with the tokenization.
108
- #
109
108
  # @param dpan [String, nil] The dynamic pan assigned to the token by the network.
110
109
  #
111
110
  # @param status [Symbol, Lithic::Models::Tokenization::Status] The status of the tokenization request
112
111
  #
113
- # @param token_requestor_name [Symbol, Lithic::Models::Tokenization::TokenRequestorName] The entity that requested the tokenization. Represents a Digital Wallet or merch
112
+ # @param token_requestor_name [Symbol, String, Lithic::Models::Tokenization::TokenRequestorName] The entity that requested the tokenization. For digital wallets, this will be on
114
113
  #
115
114
  # @param token_unique_reference [String] The network's unique reference for the tokenization.
116
115
  #
@@ -118,7 +117,9 @@ module Lithic
118
117
  #
119
118
  # @param updated_at [Time] Latest date and time when the tokenization was updated. UTC time zone.
120
119
  #
121
- # @param digital_card_art_token [String] Specifies the digital card art displayed in the user’s digital wallet after toke
120
+ # @param device_id [String, nil] The device identifier associated with the tokenization.
121
+ #
122
+ # @param digital_card_art_token [String, nil] Specifies the digital card art displayed in the user's digital wallet after toke
122
123
  #
123
124
  # @param events [Array<Lithic::Models::Tokenization::Event>] A list of events related to the tokenization.
124
125
  #
@@ -142,12 +143,49 @@ module Lithic
142
143
  # @return [Array<Symbol>]
143
144
  end
144
145
 
145
- # The entity that requested the tokenization. Represents a Digital Wallet or
146
- # merchant.
146
+ # The entity that requested the tokenization. For digital wallets, this will be
147
+ # one of the defined wallet types. For merchant tokenizations, this will be a
148
+ # free-form merchant name string.
147
149
  #
148
150
  # @see Lithic::Models::Tokenization#token_requestor_name
149
151
  module TokenRequestorName
150
- extend Lithic::Internal::Type::Enum
152
+ extend Lithic::Internal::Type::Union
153
+
154
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::AMAZON_ONE }
155
+
156
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::ANDROID_PAY }
157
+
158
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::APPLE_PAY }
159
+
160
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::FACEBOOK }
161
+
162
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::FITBIT_PAY }
163
+
164
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::GARMIN_PAY }
165
+
166
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::GOOGLE_PAY }
167
+
168
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::MICROSOFT_PAY }
169
+
170
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::NETFLIX }
171
+
172
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::SAMSUNG_PAY }
173
+
174
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::UNKNOWN }
175
+
176
+ variant const: -> { Lithic::Models::Tokenization::TokenRequestorName::VISA_CHECKOUT }
177
+
178
+ # Merchant name for merchant tokenizations
179
+ variant String
180
+
181
+ # @!method self.variants
182
+ # @return [Array(Symbol, String)]
183
+
184
+ define_sorbet_constant!(:Variants) do
185
+ T.type_alias { T.any(Lithic::Tokenization::TokenRequestorName::TaggedSymbol, String) }
186
+ end
187
+
188
+ # @!group
151
189
 
152
190
  AMAZON_ONE = :AMAZON_ONE
153
191
  ANDROID_PAY = :ANDROID_PAY
@@ -155,14 +193,14 @@ module Lithic
155
193
  FACEBOOK = :FACEBOOK
156
194
  FITBIT_PAY = :FITBIT_PAY
157
195
  GARMIN_PAY = :GARMIN_PAY
196
+ GOOGLE_PAY = :GOOGLE_PAY
158
197
  MICROSOFT_PAY = :MICROSOFT_PAY
159
198
  NETFLIX = :NETFLIX
160
199
  SAMSUNG_PAY = :SAMSUNG_PAY
161
200
  UNKNOWN = :UNKNOWN
162
201
  VISA_CHECKOUT = :VISA_CHECKOUT
163
202
 
164
- # @!method self.values
165
- # @return [Array<Symbol>]
203
+ # @!endgroup
166
204
  end
167
205
 
168
206
  # The channel through which the tokenization was made.
@@ -197,19 +235,45 @@ module Lithic
197
235
  # @return [Symbol, Lithic::Models::Tokenization::Event::Result, nil]
198
236
  optional :result, enum: -> { Lithic::Tokenization::Event::Result }
199
237
 
238
+ # @!attribute rule_results
239
+ # Results from rules that were evaluated for this tokenization
240
+ #
241
+ # @return [Array<Lithic::Models::Tokenization::Event::RuleResult>, nil]
242
+ optional :rule_results, -> { Lithic::Internal::Type::ArrayOf[Lithic::Tokenization::Event::RuleResult] }
243
+
244
+ # @!attribute tokenization_decline_reasons
245
+ # List of reasons why the tokenization was declined
246
+ #
247
+ # @return [Array<Symbol, Lithic::Models::Tokenization::Event::TokenizationDeclineReason>, nil]
248
+ optional :tokenization_decline_reasons,
249
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Tokenization::Event::TokenizationDeclineReason] }
250
+
251
+ # @!attribute tokenization_tfa_reasons
252
+ # List of reasons why two-factor authentication was required
253
+ #
254
+ # @return [Array<Symbol, Lithic::Models::Tokenization::Event::TokenizationTfaReason>, nil]
255
+ optional :tokenization_tfa_reasons,
256
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Tokenization::Event::TokenizationTfaReason] }
257
+
200
258
  # @!attribute type
201
259
  # Enum representing the type of tokenization event that occurred
202
260
  #
203
261
  # @return [Symbol, Lithic::Models::Tokenization::Event::Type, nil]
204
262
  optional :type, enum: -> { Lithic::Tokenization::Event::Type }
205
263
 
206
- # @!method initialize(token: nil, created_at: nil, result: nil, type: nil)
264
+ # @!method initialize(token: nil, created_at: nil, result: nil, rule_results: nil, tokenization_decline_reasons: nil, tokenization_tfa_reasons: nil, type: nil)
207
265
  # @param token [String] Globally unique identifier for a Tokenization Event
208
266
  #
209
267
  # @param created_at [Time] Date and time when the tokenization event first occurred. UTC time zone.
210
268
  #
211
269
  # @param result [Symbol, Lithic::Models::Tokenization::Event::Result] Enum representing the result of the tokenization event
212
270
  #
271
+ # @param rule_results [Array<Lithic::Models::Tokenization::Event::RuleResult>] Results from rules that were evaluated for this tokenization
272
+ #
273
+ # @param tokenization_decline_reasons [Array<Symbol, Lithic::Models::Tokenization::Event::TokenizationDeclineReason>] List of reasons why the tokenization was declined
274
+ #
275
+ # @param tokenization_tfa_reasons [Array<Symbol, Lithic::Models::Tokenization::Event::TokenizationTfaReason>] List of reasons why two-factor authentication was required
276
+ #
213
277
  # @param type [Symbol, Lithic::Models::Tokenization::Event::Type] Enum representing the type of tokenization event that occurred
214
278
 
215
279
  # Enum representing the result of the tokenization event
@@ -235,6 +299,108 @@ module Lithic
235
299
  # @return [Array<Symbol>]
236
300
  end
237
301
 
302
+ class RuleResult < Lithic::Internal::Type::BaseModel
303
+ # @!attribute auth_rule_token
304
+ # The Auth Rule Token associated with the rule. If this is set to null, then the
305
+ # result was not associated with a customer-configured rule. This may happen in
306
+ # cases where a tokenization is declined or requires TFA due to a
307
+ # Lithic-configured security or compliance rule, for example.
308
+ #
309
+ # @return [String, nil]
310
+ required :auth_rule_token, String, nil?: true
311
+
312
+ # @!attribute explanation
313
+ # A human-readable explanation outlining the motivation for the rule's result
314
+ #
315
+ # @return [String, nil]
316
+ required :explanation, String, nil?: true
317
+
318
+ # @!attribute name
319
+ # The name for the rule, if any was configured
320
+ #
321
+ # @return [String, nil]
322
+ required :name, String, nil?: true
323
+
324
+ # @!attribute result
325
+ # The result associated with this rule
326
+ #
327
+ # @return [Symbol, Lithic::Models::Tokenization::Event::RuleResult::Result]
328
+ required :result, enum: -> { Lithic::Tokenization::Event::RuleResult::Result }
329
+
330
+ # @!method initialize(auth_rule_token:, explanation:, name:, result:)
331
+ # Some parameter documentations has been truncated, see
332
+ # {Lithic::Models::Tokenization::Event::RuleResult} for more details.
333
+ #
334
+ # @param auth_rule_token [String, nil] The Auth Rule Token associated with the rule. If this is set to null, then the r
335
+ #
336
+ # @param explanation [String, nil] A human-readable explanation outlining the motivation for the rule's result
337
+ #
338
+ # @param name [String, nil] The name for the rule, if any was configured
339
+ #
340
+ # @param result [Symbol, Lithic::Models::Tokenization::Event::RuleResult::Result] The result associated with this rule
341
+
342
+ # The result associated with this rule
343
+ #
344
+ # @see Lithic::Models::Tokenization::Event::RuleResult#result
345
+ module Result
346
+ extend Lithic::Internal::Type::Enum
347
+
348
+ APPROVED = :APPROVED
349
+ DECLINED = :DECLINED
350
+ REQUIRE_TFA = :REQUIRE_TFA
351
+ ERROR = :ERROR
352
+
353
+ # @!method self.values
354
+ # @return [Array<Symbol>]
355
+ end
356
+ end
357
+
358
+ # Reason code for why a tokenization was declined
359
+ module TokenizationDeclineReason
360
+ extend Lithic::Internal::Type::Enum
361
+
362
+ ACCOUNT_SCORE_1 = :ACCOUNT_SCORE_1
363
+ DEVICE_SCORE_1 = :DEVICE_SCORE_1
364
+ ALL_WALLET_DECLINE_REASONS_PRESENT = :ALL_WALLET_DECLINE_REASONS_PRESENT
365
+ WALLET_RECOMMENDED_DECISION_RED = :WALLET_RECOMMENDED_DECISION_RED
366
+ CVC_MISMATCH = :CVC_MISMATCH
367
+ CARD_EXPIRY_MONTH_MISMATCH = :CARD_EXPIRY_MONTH_MISMATCH
368
+ CARD_EXPIRY_YEAR_MISMATCH = :CARD_EXPIRY_YEAR_MISMATCH
369
+ CARD_INVALID_STATE = :CARD_INVALID_STATE
370
+ CUSTOMER_RED_PATH = :CUSTOMER_RED_PATH
371
+ INVALID_CUSTOMER_RESPONSE = :INVALID_CUSTOMER_RESPONSE
372
+ NETWORK_FAILURE = :NETWORK_FAILURE
373
+ GENERIC_DECLINE = :GENERIC_DECLINE
374
+ DIGITAL_CARD_ART_REQUIRED = :DIGITAL_CARD_ART_REQUIRED
375
+
376
+ # @!method self.values
377
+ # @return [Array<Symbol>]
378
+ end
379
+
380
+ # Reason code for why a tokenization required two-factor authentication
381
+ module TokenizationTfaReason
382
+ extend Lithic::Internal::Type::Enum
383
+
384
+ WALLET_RECOMMENDED_TFA = :WALLET_RECOMMENDED_TFA
385
+ SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
386
+ DEVICE_RECENTLY_LOST = :DEVICE_RECENTLY_LOST
387
+ TOO_MANY_RECENT_ATTEMPTS = :TOO_MANY_RECENT_ATTEMPTS
388
+ TOO_MANY_RECENT_TOKENS = :TOO_MANY_RECENT_TOKENS
389
+ TOO_MANY_DIFFERENT_CARDHOLDERS = :TOO_MANY_DIFFERENT_CARDHOLDERS
390
+ OUTSIDE_HOME_TERRITORY = :OUTSIDE_HOME_TERRITORY
391
+ HAS_SUSPENDED_TOKENS = :HAS_SUSPENDED_TOKENS
392
+ HIGH_RISK = :HIGH_RISK
393
+ ACCOUNT_SCORE_LOW = :ACCOUNT_SCORE_LOW
394
+ DEVICE_SCORE_LOW = :DEVICE_SCORE_LOW
395
+ CARD_STATE_TFA = :CARD_STATE_TFA
396
+ HARDCODED_TFA = :HARDCODED_TFA
397
+ CUSTOMER_RULE_TFA = :CUSTOMER_RULE_TFA
398
+ DEVICE_HOST_CARD_EMULATION = :DEVICE_HOST_CARD_EMULATION
399
+
400
+ # @!method self.values
401
+ # @return [Array<Symbol>]
402
+ end
403
+
238
404
  # Enum representing the type of tokenization event that occurred
239
405
  #
240
406
  # @see Lithic::Models::Tokenization::Event#type
@@ -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
  #
@@ -378,23 +378,12 @@ module Lithic
378
378
 
379
379
  # @see Lithic::Models::Transaction#cardholder_authentication
380
380
  class CardholderAuthentication < Lithic::Internal::Type::BaseModel
381
- # @!attribute three_ds_version
382
- # @deprecated
383
- #
384
- # The 3DS version used for the authentication
385
- #
386
- # @return [String, nil]
387
- required :three_ds_version, String, api_name: :"3ds_version", nil?: true
388
-
389
- # @!attribute acquirer_exemption
390
- # @deprecated
391
- #
392
- # Whether an acquirer exemption applied to the transaction. Not currently
393
- # populated and will be removed in the future.
381
+ # @!attribute authentication_method
382
+ # Indicates the method used to authenticate the cardholder.
394
383
  #
395
- # @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption]
396
- required :acquirer_exemption,
397
- enum: -> { Lithic::Transaction::CardholderAuthentication::AcquirerExemption }
384
+ # @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationMethod]
385
+ required :authentication_method,
386
+ enum: -> { Lithic::Transaction::CardholderAuthentication::AuthenticationMethod }
398
387
 
399
388
  # @!attribute authentication_result
400
389
  # Indicates the outcome of the 3DS authentication process.
@@ -433,40 +422,11 @@ module Lithic
433
422
  # @return [String, nil]
434
423
  required :three_ds_authentication_token, String, nil?: true
435
424
 
436
- # @!attribute verification_attempted
437
- # @deprecated
438
- #
439
- # Indicates whether a 3DS challenge flow was used, and if so, what the
440
- # verification method was. (deprecated, use `authentication_result`)
441
- #
442
- # @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationAttempted]
443
- required :verification_attempted,
444
- enum: -> { Lithic::Transaction::CardholderAuthentication::VerificationAttempted }
445
-
446
- # @!attribute verification_result
447
- # @deprecated
448
- #
449
- # Indicates whether a transaction is considered 3DS authenticated. (deprecated,
450
- # use `authentication_result`)
451
- #
452
- # @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationResult]
453
- required :verification_result,
454
- enum: -> { Lithic::Transaction::CardholderAuthentication::VerificationResult }
455
-
456
- # @!attribute authentication_method
457
- # Indicates the method used to authenticate the cardholder.
458
- #
459
- # @return [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationMethod, nil]
460
- optional :authentication_method,
461
- enum: -> { Lithic::Transaction::CardholderAuthentication::AuthenticationMethod }
462
-
463
- # @!method initialize(three_ds_version:, acquirer_exemption:, authentication_result:, decision_made_by:, liability_shift:, three_ds_authentication_token:, verification_attempted:, verification_result:, authentication_method: nil)
425
+ # @!method initialize(authentication_method:, authentication_result:, decision_made_by:, liability_shift:, three_ds_authentication_token:)
464
426
  # Some parameter documentations has been truncated, see
465
427
  # {Lithic::Models::Transaction::CardholderAuthentication} for more details.
466
428
  #
467
- # @param three_ds_version [String, nil] The 3DS version used for the authentication
468
- #
469
- # @param acquirer_exemption [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption] Whether an acquirer exemption applied to the transaction. Not currently populate
429
+ # @param authentication_method [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationMethod] Indicates the method used to authenticate the cardholder.
470
430
  #
471
431
  # @param authentication_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationResult] Indicates the outcome of the 3DS authentication process.
472
432
  #
@@ -475,30 +435,16 @@ module Lithic
475
435
  # @param liability_shift [Symbol, Lithic::Models::Transaction::CardholderAuthentication::LiabilityShift] Indicates whether chargeback liability shift applies to the transaction. Possibl
476
436
  #
477
437
  # @param three_ds_authentication_token [String, nil] Unique identifier you can use to match a given 3DS authentication (available via
478
- #
479
- # @param verification_attempted [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationAttempted] Indicates whether a 3DS challenge flow was used, and if so, what the verificatio
480
- #
481
- # @param verification_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationResult] Indicates whether a transaction is considered 3DS authenticated. (deprecated, us
482
- #
483
- # @param authentication_method [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationMethod] Indicates the method used to authenticate the cardholder.
484
438
 
485
- # @deprecated
486
- #
487
- # Whether an acquirer exemption applied to the transaction. Not currently
488
- # populated and will be removed in the future.
439
+ # Indicates the method used to authenticate the cardholder.
489
440
  #
490
- # @see Lithic::Models::Transaction::CardholderAuthentication#acquirer_exemption
491
- module AcquirerExemption
441
+ # @see Lithic::Models::Transaction::CardholderAuthentication#authentication_method
442
+ module AuthenticationMethod
492
443
  extend Lithic::Internal::Type::Enum
493
444
 
494
- AUTHENTICATION_OUTAGE_EXCEPTION = :AUTHENTICATION_OUTAGE_EXCEPTION
495
- LOW_VALUE = :LOW_VALUE
496
- MERCHANT_INITIATED_TRANSACTION = :MERCHANT_INITIATED_TRANSACTION
445
+ FRICTIONLESS = :FRICTIONLESS
446
+ CHALLENGE = :CHALLENGE
497
447
  NONE = :NONE
498
- RECURRING_PAYMENT = :RECURRING_PAYMENT
499
- SECURE_CORPORATE_PAYMENT = :SECURE_CORPORATE_PAYMENT
500
- STRONG_CUSTOMER_AUTHENTICATION_DELEGATION = :STRONG_CUSTOMER_AUTHENTICATION_DELEGATION
501
- TRANSACTION_RISK_ANALYSIS = :TRANSACTION_RISK_ANALYSIS
502
448
 
503
449
  # @!method self.values
504
450
  # @return [Array<Symbol>]
@@ -558,122 +504,6 @@ module Lithic
558
504
  # @!method self.values
559
505
  # @return [Array<Symbol>]
560
506
  end
561
-
562
- # @deprecated
563
- #
564
- # Indicates whether a 3DS challenge flow was used, and if so, what the
565
- # verification method was. (deprecated, use `authentication_result`)
566
- #
567
- # @see Lithic::Models::Transaction::CardholderAuthentication#verification_attempted
568
- module VerificationAttempted
569
- extend Lithic::Internal::Type::Enum
570
-
571
- NONE = :NONE
572
- OTHER = :OTHER
573
-
574
- # @!method self.values
575
- # @return [Array<Symbol>]
576
- end
577
-
578
- # @deprecated
579
- #
580
- # Indicates whether a transaction is considered 3DS authenticated. (deprecated,
581
- # use `authentication_result`)
582
- #
583
- # @see Lithic::Models::Transaction::CardholderAuthentication#verification_result
584
- module VerificationResult
585
- extend Lithic::Internal::Type::Enum
586
-
587
- CANCELLED = :CANCELLED
588
- FAILED = :FAILED
589
- FRICTIONLESS = :FRICTIONLESS
590
- NOT_ATTEMPTED = :NOT_ATTEMPTED
591
- REJECTED = :REJECTED
592
- SUCCESS = :SUCCESS
593
-
594
- # @!method self.values
595
- # @return [Array<Symbol>]
596
- end
597
-
598
- # Indicates the method used to authenticate the cardholder.
599
- #
600
- # @see Lithic::Models::Transaction::CardholderAuthentication#authentication_method
601
- module AuthenticationMethod
602
- extend Lithic::Internal::Type::Enum
603
-
604
- FRICTIONLESS = :FRICTIONLESS
605
- CHALLENGE = :CHALLENGE
606
- NONE = :NONE
607
-
608
- # @!method self.values
609
- # @return [Array<Symbol>]
610
- end
611
- end
612
-
613
- # @see Lithic::Models::Transaction#merchant
614
- class Merchant < Lithic::Internal::Type::BaseModel
615
- # @!attribute acceptor_id
616
- # Unique alphanumeric identifier for the payment card acceptor (merchant).
617
- #
618
- # @return [String]
619
- required :acceptor_id, String
620
-
621
- # @!attribute acquiring_institution_id
622
- # Unique numeric identifier of the acquiring institution.
623
- #
624
- # @return [String]
625
- required :acquiring_institution_id, String
626
-
627
- # @!attribute city
628
- # City of card acceptor. Note that in many cases, particularly in card-not-present
629
- # transactions, merchants may send through a phone number or URL in this field.
630
- #
631
- # @return [String]
632
- required :city, String
633
-
634
- # @!attribute country
635
- # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
636
- # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
637
- #
638
- # @return [String]
639
- required :country, String
640
-
641
- # @!attribute descriptor
642
- # Short description of card acceptor.
643
- #
644
- # @return [String]
645
- required :descriptor, String
646
-
647
- # @!attribute mcc
648
- # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
649
- # used to classify a business by the types of goods or services it provides.
650
- #
651
- # @return [String]
652
- required :mcc, String
653
-
654
- # @!attribute state
655
- # Geographic state of card acceptor.
656
- #
657
- # @return [String]
658
- required :state, String
659
-
660
- # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
661
- # Some parameter documentations has been truncated, see
662
- # {Lithic::Models::Transaction::Merchant} for more details.
663
- #
664
- # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
665
- #
666
- # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
667
- #
668
- # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
669
- #
670
- # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
671
- #
672
- # @param descriptor [String] Short description of card acceptor.
673
- #
674
- # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
675
- #
676
- # @param state [String] Geographic state of card acceptor.
677
507
  end
678
508
 
679
509
  # Card network of the authorization. Value is `UNKNOWN` when Lithic cannot