lithic 0.18.1 → 0.19.0

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 (121) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +30 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/models/account_activity_list_params.rb +2 -0
  5. data/lib/lithic/models/account_activity_list_response.rb +2 -0
  6. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +2 -0
  7. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +3 -0
  8. data/lib/lithic/models/auth_rules/velocity_limit_period.rb +1 -1
  9. data/lib/lithic/models/book_transfer_create_params.rb +4 -0
  10. data/lib/lithic/models/book_transfer_list_params.rb +1 -0
  11. data/lib/lithic/models/book_transfer_response.rb +4 -0
  12. data/lib/lithic/models/embed_session_generated_webhook_event.rb +83 -0
  13. data/lib/lithic/models/embed_viewed_webhook_event.rb +85 -0
  14. data/lib/lithic/models/event.rb +44 -12
  15. data/lib/lithic/models/event_list_params.rb +23 -6
  16. data/lib/lithic/models/event_subscription.rb +23 -6
  17. data/lib/lithic/models/events/subscription_create_params.rb +23 -6
  18. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -0
  19. data/lib/lithic/models/events/subscription_update_params.rb +23 -6
  20. data/lib/lithic/models/external_payment_list_params.rb +3 -3
  21. data/lib/lithic/models/financial_accounts/balance_list_params.rb +4 -3
  22. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +7 -0
  23. data/lib/lithic/models/financial_event.rb +5 -0
  24. data/lib/lithic/models/fraud/transaction_report_response.rb +8 -8
  25. data/lib/lithic/models/fraud/transaction_retrieve_response.rb +10 -8
  26. data/lib/lithic/models/parsed_webhook_event.rb +5 -1
  27. data/lib/lithic/models/payment.rb +28 -1
  28. data/lib/lithic/models/payment_list_params.rb +1 -0
  29. data/lib/lithic/models/transaction_monitoring/case_update_params.rb +5 -11
  30. data/lib/lithic/models/transaction_monitoring/monitoring_case.rb +5 -11
  31. data/lib/lithic/models/transaction_monitoring/queue.rb +10 -1
  32. data/lib/lithic/models/transaction_monitoring/queue_create_params.rb +14 -1
  33. data/lib/lithic/models/transaction_monitoring/queue_update_params.rb +15 -1
  34. data/lib/lithic/models/transaction_simulate_clearing_params.rb +4 -3
  35. data/lib/lithic/models.rb +4 -0
  36. data/lib/lithic/resources/card_authorizations.rb +1 -1
  37. data/lib/lithic/resources/cards.rb +5 -0
  38. data/lib/lithic/resources/external_payments.rb +1 -1
  39. data/lib/lithic/resources/three_ds/decisioning.rb +1 -1
  40. data/lib/lithic/resources/transaction_monitoring/cases.rb +1 -1
  41. data/lib/lithic/resources/transaction_monitoring/queues.rb +12 -2
  42. data/lib/lithic/resources/transactions.rb +4 -3
  43. data/lib/lithic/resources/webhooks.rb +1 -1
  44. data/lib/lithic/version.rb +1 -1
  45. data/lib/lithic.rb +2 -1
  46. data/rbi/lithic/models/account_activity_list_params.rbi +10 -0
  47. data/rbi/lithic/models/account_activity_list_response.rbi +10 -0
  48. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +10 -0
  49. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +8 -0
  50. data/rbi/lithic/models/auth_rules/velocity_limit_period.rbi +2 -2
  51. data/rbi/lithic/models/book_transfer_create_params.rbi +20 -0
  52. data/rbi/lithic/models/book_transfer_list_params.rbi +5 -0
  53. data/rbi/lithic/models/book_transfer_response.rbi +20 -0
  54. data/rbi/lithic/models/embed_session_generated_webhook_event.rbi +157 -0
  55. data/rbi/lithic/models/embed_viewed_webhook_event.rbi +146 -0
  56. data/rbi/lithic/models/event.rbi +70 -18
  57. data/rbi/lithic/models/event_list_params.rbi +31 -6
  58. data/rbi/lithic/models/event_subscription.rbi +31 -6
  59. data/rbi/lithic/models/events/subscription_create_params.rbi +31 -6
  60. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +10 -0
  61. data/rbi/lithic/models/events/subscription_update_params.rbi +31 -6
  62. data/rbi/lithic/models/external_payment_list_params.rbi +3 -3
  63. data/rbi/lithic/models/financial_accounts/balance_list_params.rbi +8 -6
  64. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +35 -0
  65. data/rbi/lithic/models/financial_event.rbi +22 -0
  66. data/rbi/lithic/models/fraud/transaction_report_response.rbi +16 -29
  67. data/rbi/lithic/models/fraud/transaction_retrieve_response.rbi +16 -29
  68. data/rbi/lithic/models/parsed_webhook_event.rbi +2 -0
  69. data/rbi/lithic/models/payment.rbi +47 -0
  70. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  71. data/rbi/lithic/models/transaction_monitoring/case_update_params.rbi +8 -33
  72. data/rbi/lithic/models/transaction_monitoring/monitoring_case.rbi +7 -31
  73. data/rbi/lithic/models/transaction_monitoring/queue.rbi +10 -0
  74. data/rbi/lithic/models/transaction_monitoring/queue_create_params.rbi +12 -0
  75. data/rbi/lithic/models/transaction_monitoring/queue_update_params.rbi +14 -0
  76. data/rbi/lithic/models/transaction_simulate_clearing_params.rbi +8 -6
  77. data/rbi/lithic/models.rbi +5 -0
  78. data/rbi/lithic/resources/card_authorizations.rbi +1 -1
  79. data/rbi/lithic/resources/cards.rbi +3 -0
  80. data/rbi/lithic/resources/external_payments.rbi +1 -1
  81. data/rbi/lithic/resources/financial_accounts/balances.rbi +4 -3
  82. data/rbi/lithic/resources/three_ds/decisioning.rbi +1 -1
  83. data/rbi/lithic/resources/transaction_monitoring/cases.rbi +3 -10
  84. data/rbi/lithic/resources/transaction_monitoring/queues.rbi +11 -0
  85. data/rbi/lithic/resources/transactions.rbi +8 -6
  86. data/rbi/lithic/resources/webhooks.rbi +2 -0
  87. data/sig/lithic/models/account_activity_list_params.rbs +4 -0
  88. data/sig/lithic/models/account_activity_list_response.rbs +4 -0
  89. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +4 -0
  90. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +2 -0
  91. data/sig/lithic/models/book_transfer_create_params.rbs +8 -0
  92. data/sig/lithic/models/book_transfer_list_params.rbs +2 -0
  93. data/sig/lithic/models/book_transfer_response.rbs +8 -0
  94. data/sig/lithic/models/embed_session_generated_webhook_event.rbs +66 -0
  95. data/sig/lithic/models/embed_viewed_webhook_event.rbs +68 -0
  96. data/sig/lithic/models/event.rbs +4 -0
  97. data/sig/lithic/models/event_list_params.rbs +4 -0
  98. data/sig/lithic/models/event_subscription.rbs +4 -0
  99. data/sig/lithic/models/events/subscription_create_params.rbs +4 -0
  100. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +4 -0
  101. data/sig/lithic/models/events/subscription_update_params.rbs +4 -0
  102. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +14 -0
  103. data/sig/lithic/models/financial_event.rbs +10 -0
  104. data/sig/lithic/models/fraud/transaction_report_response.rbs +16 -26
  105. data/sig/lithic/models/fraud/transaction_retrieve_response.rbs +16 -26
  106. data/sig/lithic/models/parsed_webhook_event.rbs +2 -0
  107. data/sig/lithic/models/payment.rbs +15 -0
  108. data/sig/lithic/models/payment_list_params.rbs +2 -1
  109. data/sig/lithic/models/transaction_monitoring/case_update_params.rbs +5 -7
  110. data/sig/lithic/models/transaction_monitoring/monitoring_case.rbs +4 -4
  111. data/sig/lithic/models/transaction_monitoring/queue.rbs +5 -0
  112. data/sig/lithic/models/transaction_monitoring/queue_create_params.rbs +9 -1
  113. data/sig/lithic/models/transaction_monitoring/queue_update_params.rbs +10 -1
  114. data/sig/lithic/models.rbs +4 -0
  115. data/sig/lithic/resources/transaction_monitoring/cases.rbs +1 -1
  116. data/sig/lithic/resources/transaction_monitoring/queues.rbs +2 -0
  117. data/sig/lithic/resources/webhooks.rbs +2 -0
  118. metadata +8 -5
  119. data/lib/lithic/models/transaction_monitoring/resolution_outcome.rb +0 -28
  120. data/rbi/lithic/models/transaction_monitoring/resolution_outcome.rbi +0 -61
  121. data/sig/lithic/models/transaction_monitoring/resolution_outcome.rbs +0 -24
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 39c91f51cf5bdeac0ea066eb62ca454e3617be091bf90fbd2dc1a7880341dced
4
- data.tar.gz: 70b13d4f29b3fe30a7ab75fc1d6a377cc15e557207918dacfe648eb186ec43dc
3
+ metadata.gz: 106bded7bf43dfa21ef3e2508bf03ef3342f794cabd4633237802f10825127cb
4
+ data.tar.gz: c3a1a41578d0042e4dd4ec936ffb1b74ee90fb62514056f5d58842b59009aea3
5
5
  SHA512:
6
- metadata.gz: 5ff8da6ba6b878a6096cf5ccfd4c030fcc6caa496718179c7cf9cfcef478b1d36286439743780ec77259eab01773661f5aefdf48a79530893944ded3477a92fc
7
- data.tar.gz: 13bc491847868ff70266b047604a387579271a3aae3a65e223b085d641ba1c59a0e261be1b4446f061440ecb9ecad46af7e76225913656bf8eb7ebfec5a9bab3
6
+ metadata.gz: 6dedf816499b354a2f0673e059ef289773366a0fe1309c828be58580345adbc42afd336d71084979387c6a8f86194fba773d385c5734eb85db4ee0d075b783da
7
+ data.tar.gz: 32f2ce22c41fe321a7b1ea99b7f2956ad07547c1e4c0dd806c31d833cea507e2cc2db1493b106e7576ec85e7b01ac33dc18d1adbb4b45003936ecdf8101d809f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.19.0 (2026-07-30)
4
+
5
+ Full Changelog: [v0.18.1...v0.19.0](https://github.com/lithic-com/lithic-ruby/compare/v0.18.1...v0.19.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** add disposition_reasons to queues, change resolution to string in cases ([81b7499](https://github.com/lithic-com/lithic-ruby/commit/81b74990960f2f1ee8666118fc6afe8b9ac8f0ca))
10
+ * **api:** add PAYMENT type to book transfers ([979bd5d](https://github.com/lithic-com/lithic-ruby/commit/979bd5d73e39028767418a470e10fc39cfb9686f))
11
+ * **api:** add PROGRAM_TRANSFER category, LITHIC/BANK_PROGRAM_TRANSFER type enum values ([774ebfa](https://github.com/lithic-com/lithic-ruby/commit/774ebfa41c6c7c8d249265ba518f781f59e79237))
12
+ * **api:** add RECIPIENT_NAME attribute to auth rules conditional ACH parameters ([7e2398e](https://github.com/lithic-com/lithic-ruby/commit/7e2398e3c0fe3d08ece0c70249da4b73764541f6))
13
+ * **api:** add recipient_name field to payment ACH method attributes ([9ed474c](https://github.com/lithic-com/lithic-ruby/commit/9ed474c7521804e6cb99902aabea5fa4f5178ca1))
14
+ * **api:** add REVERSED status value to payment list params ([f5f2fdb](https://github.com/lithic-com/lithic-ruby/commit/f5f2fdb6c4d34e9f4ab5ed40fb2516872b419418))
15
+ * **api:** add stablecoin support to payments, account activity, financial events ([92a2b8b](https://github.com/lithic-com/lithic-ruby/commit/92a2b8b3ab8ecfab83ed698164de87c4b23ae31d))
16
+ * **api:** Extend velocity Custom period cap to 90 days ([eeb4a32](https://github.com/lithic-com/lithic-ruby/commit/eeb4a3228542f9d61966dc4c09987b40bdfdde3d))
17
+ * **stlc:** configurable CI runner and private-production-repo support in workflow templates ([69b6ead](https://github.com/lithic-com/lithic-ruby/commit/69b6ead528e48ca397c5b14bcfd5868d6819aaca))
18
+
19
+
20
+ ### Bug Fixes
21
+
22
+ * **types:** make optional fields nullable in fraud transaction responses ([796975f](https://github.com/lithic-com/lithic-ruby/commit/796975f199c3f8ad5b1646274d243944398c06e8))
23
+
24
+
25
+ ### Documentation
26
+
27
+ * Add card embed documentation ([0543caa](https://github.com/lithic-com/lithic-ruby/commit/0543caa4d27cde3479e6a3536cdd037073940f03))
28
+ * **api:** clarify last_transaction_event_token parameter in financial_accounts balances ([9dd45f0](https://github.com/lithic-com/lithic-ruby/commit/9dd45f05a127d34a45db81c875446e3fd1df5e42))
29
+ * **api:** clarify simulate_clearing supports multiple calls in transactions ([7a7e783](https://github.com/lithic-com/lithic-ruby/commit/7a7e78338a405f4edb463df0de5f64cf157c0334))
30
+ * **api:** expand dispute event descriptions across Event and subscription models ([4db3479](https://github.com/lithic-com/lithic-ruby/commit/4db3479aaf148f8f3ea7e16ea89eb3c275fe963e))
31
+ * **api:** update category parameter description in external_payments ([db7d72a](https://github.com/lithic-com/lithic-ruby/commit/db7d72a41aaee552817197d85b7989d85f6399c3))
32
+
3
33
  ## 0.18.1 (2026-06-29)
4
34
 
5
35
  Full Changelog: [v0.18.0...v0.18.1](https://github.com/lithic-com/lithic-ruby/compare/v0.18.0...v0.18.1)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "lithic", "~> 0.18.1"
27
+ gem "lithic", "~> 0.19.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -111,6 +111,7 @@ module Lithic
111
111
 
112
112
  ACH = :ACH
113
113
  WIRE = :WIRE
114
+ STABLECOIN = :STABLECOIN
114
115
  BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
115
116
  FEE = :FEE
116
117
  REWARD = :REWARD
@@ -131,6 +132,7 @@ module Lithic
131
132
  MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
132
133
  HOLD = :HOLD
133
134
  PROGRAM_FUNDING = :PROGRAM_FUNDING
135
+ PROGRAM_TRANSFER = :PROGRAM_TRANSFER
134
136
 
135
137
  # @!method self.values
136
138
  # @return [Array<Symbol>]
@@ -150,6 +150,7 @@ module Lithic
150
150
 
151
151
  ACH = :ACH
152
152
  WIRE = :WIRE
153
+ STABLECOIN = :STABLECOIN
153
154
  BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
154
155
  FEE = :FEE
155
156
  REWARD = :REWARD
@@ -170,6 +171,7 @@ module Lithic
170
171
  MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
171
172
  HOLD = :HOLD
172
173
  PROGRAM_FUNDING = :PROGRAM_FUNDING
174
+ PROGRAM_TRANSFER = :PROGRAM_TRANSFER
173
175
 
174
176
  # @!method self.values
175
177
  # @return [Array<Symbol>]
@@ -153,6 +153,7 @@ module Lithic
153
153
 
154
154
  ACH = :ACH
155
155
  WIRE = :WIRE
156
+ STABLECOIN = :STABLECOIN
156
157
  BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
157
158
  FEE = :FEE
158
159
  REWARD = :REWARD
@@ -173,6 +174,7 @@ module Lithic
173
174
  MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
174
175
  HOLD = :HOLD
175
176
  PROGRAM_FUNDING = :PROGRAM_FUNDING
177
+ PROGRAM_TRANSFER = :PROGRAM_TRANSFER
176
178
 
177
179
  # @!method self.values
178
180
  # @return [Array<Symbol>]
@@ -196,6 +196,7 @@ module Lithic
196
196
  # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
197
197
  # (Telephone-Initiated Entry), and others.
198
198
  # - `MEMO`: Optional memo or description field included with the ACH transaction.
199
+ # - `RECIPIENT_NAME`: The name of the recipient of the ACH transaction.
199
200
  #
200
201
  # @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::Attribute]
201
202
  required :attribute, enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute }
@@ -238,6 +239,7 @@ module Lithic
238
239
  # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
239
240
  # (Telephone-Initiated Entry), and others.
240
241
  # - `MEMO`: Optional memo or description field included with the ACH transaction.
242
+ # - `RECIPIENT_NAME`: The name of the recipient of the ACH transaction.
241
243
  #
242
244
  # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition#attribute
243
245
  module Attribute
@@ -249,6 +251,7 @@ module Lithic
249
251
  TRANSACTION_AMOUNT = :TRANSACTION_AMOUNT
250
252
  SEC_CODE = :SEC_CODE
251
253
  MEMO = :MEMO
254
+ RECIPIENT_NAME = :RECIPIENT_NAME
252
255
 
253
256
  # @!method self.values
254
257
  # @return [Array<Symbol>]
@@ -24,7 +24,7 @@ module Lithic
24
24
  class TrailingWindowObject < Lithic::Internal::Type::BaseModel
25
25
  # @!attribute duration
26
26
  # The size of the trailing window to calculate Spend Velocity over in seconds. The
27
- # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
27
+ # minimum value is 10 seconds, and the maximum value is 7776000 seconds (90 days).
28
28
  #
29
29
  # @return [Integer]
30
30
  required :duration, Integer
@@ -115,6 +115,7 @@ module Lithic
115
115
  INTERNAL = :INTERNAL
116
116
  REWARD = :REWARD
117
117
  PROGRAM_FUNDING = :PROGRAM_FUNDING
118
+ PROGRAM_TRANSFER = :PROGRAM_TRANSFER
118
119
  TRANSFER = :TRANSFER
119
120
 
120
121
  # @!method self.values
@@ -145,6 +146,7 @@ module Lithic
145
146
  INTEREST = :INTEREST
146
147
  LATE_PAYMENT = :LATE_PAYMENT
147
148
  BILL_PAYMENT = :BILL_PAYMENT
149
+ PAYMENT_FEE = :PAYMENT_FEE
148
150
  CASH_BACK = :CASH_BACK
149
151
  ACCOUNT_TO_ACCOUNT = :ACCOUNT_TO_ACCOUNT
150
152
  CARD_TO_CARD = :CARD_TO_CARD
@@ -160,6 +162,8 @@ module Lithic
160
162
  SERVICE = :SERVICE
161
163
  TRANSFER = :TRANSFER
162
164
  COLLECTION = :COLLECTION
165
+ LITHIC_PROGRAM_TRANSFER = :LITHIC_PROGRAM_TRANSFER
166
+ BANK_PROGRAM_TRANSFER = :BANK_PROGRAM_TRANSFER
163
167
 
164
168
  # @!method self.values
165
169
  # @return [Array<Symbol>]
@@ -116,6 +116,7 @@ module Lithic
116
116
  INTERNAL = :INTERNAL
117
117
  REWARD = :REWARD
118
118
  PROGRAM_FUNDING = :PROGRAM_FUNDING
119
+ PROGRAM_TRANSFER = :PROGRAM_TRANSFER
119
120
  TRANSFER = :TRANSFER
120
121
 
121
122
  # @!method self.values
@@ -156,6 +156,7 @@ module Lithic
156
156
  INTERNAL = :INTERNAL
157
157
  REWARD = :REWARD
158
158
  PROGRAM_FUNDING = :PROGRAM_FUNDING
159
+ PROGRAM_TRANSFER = :PROGRAM_TRANSFER
159
160
  TRANSFER = :TRANSFER
160
161
 
161
162
  # @!method self.values
@@ -285,6 +286,7 @@ module Lithic
285
286
  INTEREST = :INTEREST
286
287
  LATE_PAYMENT = :LATE_PAYMENT
287
288
  BILL_PAYMENT = :BILL_PAYMENT
289
+ PAYMENT_FEE = :PAYMENT_FEE
288
290
  CASH_BACK = :CASH_BACK
289
291
  ACCOUNT_TO_ACCOUNT = :ACCOUNT_TO_ACCOUNT
290
292
  CARD_TO_CARD = :CARD_TO_CARD
@@ -300,6 +302,8 @@ module Lithic
300
302
  SERVICE = :SERVICE
301
303
  TRANSFER = :TRANSFER
302
304
  COLLECTION = :COLLECTION
305
+ LITHIC_PROGRAM_TRANSFER = :LITHIC_PROGRAM_TRANSFER
306
+ BANK_PROGRAM_TRANSFER = :BANK_PROGRAM_TRANSFER
303
307
 
304
308
  # @!method self.values
305
309
  # @return [Array<Symbol>]
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class EmbedSessionGeneratedWebhookEvent < Lithic::Internal::Type::BaseModel
6
+ # @!attribute account_token
7
+ # The token of the account associated with the card
8
+ #
9
+ # @return [String]
10
+ required :account_token, String
11
+
12
+ # @!attribute card_token
13
+ # The token of the card associated with the embed session
14
+ #
15
+ # @return [String]
16
+ required :card_token, String
17
+
18
+ # @!attribute device_details
19
+ # Details about the request that generated the embed session
20
+ #
21
+ # @return [Lithic::Models::EmbedSessionGeneratedWebhookEvent::DeviceDetails]
22
+ required :device_details, -> { Lithic::EmbedSessionGeneratedWebhookEvent::DeviceDetails }
23
+
24
+ # @!attribute event_type
25
+ # The type of event
26
+ #
27
+ # @return [Symbol, :"embed.session_generated"]
28
+ required :event_type, const: :"embed.session_generated"
29
+
30
+ # @!attribute session_id
31
+ # The identifier shared by webhook events for the same embed session.
32
+ #
33
+ # @return [String]
34
+ required :session_id, String
35
+
36
+ # @!attribute session_type
37
+ # The type of embed session that was generated
38
+ #
39
+ # @return [Symbol, Lithic::Models::EmbedSessionGeneratedWebhookEvent::SessionType]
40
+ required :session_type, enum: -> { Lithic::EmbedSessionGeneratedWebhookEvent::SessionType }
41
+
42
+ # @!method initialize(account_token:, card_token:, device_details:, session_id:, session_type:, event_type: :"embed.session_generated")
43
+ # @param account_token [String] The token of the account associated with the card
44
+ #
45
+ # @param card_token [String] The token of the card associated with the embed session
46
+ #
47
+ # @param device_details [Lithic::Models::EmbedSessionGeneratedWebhookEvent::DeviceDetails] Details about the request that generated the embed session
48
+ #
49
+ # @param session_id [String] The identifier shared by webhook events for the same embed session.
50
+ #
51
+ # @param session_type [Symbol, Lithic::Models::EmbedSessionGeneratedWebhookEvent::SessionType] The type of embed session that was generated
52
+ #
53
+ # @param event_type [Symbol, :"embed.session_generated"] The type of event
54
+
55
+ # @see Lithic::Models::EmbedSessionGeneratedWebhookEvent#device_details
56
+ class DeviceDetails < Lithic::Internal::Type::BaseModel
57
+ # @!attribute ip_address
58
+ # The IP address recorded for the request that generated the event
59
+ #
60
+ # @return [String]
61
+ required :ip_address, String
62
+
63
+ # @!method initialize(ip_address:)
64
+ # Details about the request that generated the embed session
65
+ #
66
+ # @param ip_address [String] The IP address recorded for the request that generated the event
67
+ end
68
+
69
+ # The type of embed session that was generated
70
+ #
71
+ # @see Lithic::Models::EmbedSessionGeneratedWebhookEvent#session_type
72
+ module SessionType
73
+ extend Lithic::Internal::Type::Enum
74
+
75
+ CARD_EMBED = :CARD_EMBED
76
+ PIN_SETTING_EMBED = :PIN_SETTING_EMBED
77
+
78
+ # @!method self.values
79
+ # @return [Array<Symbol>]
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class EmbedViewedWebhookEvent < Lithic::Internal::Type::BaseModel
6
+ # @!attribute account_token
7
+ # The token of the account associated with the card
8
+ #
9
+ # @return [String]
10
+ required :account_token, String
11
+
12
+ # @!attribute card_token
13
+ # The token of the card whose details were revealed
14
+ #
15
+ # @return [String]
16
+ required :card_token, String
17
+
18
+ # @!attribute device_details
19
+ # Details about the request that revealed the card detail
20
+ #
21
+ # @return [Lithic::Models::EmbedViewedWebhookEvent::DeviceDetails]
22
+ required :device_details, -> { Lithic::EmbedViewedWebhookEvent::DeviceDetails }
23
+
24
+ # @!attribute embed_type
25
+ # The type of card detail that was revealed
26
+ #
27
+ # @return [Symbol, Lithic::Models::EmbedViewedWebhookEvent::EmbedType]
28
+ required :embed_type, enum: -> { Lithic::EmbedViewedWebhookEvent::EmbedType }
29
+
30
+ # @!attribute event_type
31
+ # The type of event
32
+ #
33
+ # @return [Symbol, :"embed.viewed"]
34
+ required :event_type, const: :"embed.viewed"
35
+
36
+ # @!attribute session_id
37
+ # The identifier shared by webhook events for the same embed session.
38
+ #
39
+ # @return [String]
40
+ required :session_id, String
41
+
42
+ # @!method initialize(account_token:, card_token:, device_details:, embed_type:, session_id:, event_type: :"embed.viewed")
43
+ # @param account_token [String] The token of the account associated with the card
44
+ #
45
+ # @param card_token [String] The token of the card whose details were revealed
46
+ #
47
+ # @param device_details [Lithic::Models::EmbedViewedWebhookEvent::DeviceDetails] Details about the request that revealed the card detail
48
+ #
49
+ # @param embed_type [Symbol, Lithic::Models::EmbedViewedWebhookEvent::EmbedType] The type of card detail that was revealed
50
+ #
51
+ # @param session_id [String] The identifier shared by webhook events for the same embed session.
52
+ #
53
+ # @param event_type [Symbol, :"embed.viewed"] The type of event
54
+
55
+ # @see Lithic::Models::EmbedViewedWebhookEvent#device_details
56
+ class DeviceDetails < Lithic::Internal::Type::BaseModel
57
+ # @!attribute ip_address
58
+ # The IP address recorded for the request that generated the event
59
+ #
60
+ # @return [String]
61
+ required :ip_address, String
62
+
63
+ # @!method initialize(ip_address:)
64
+ # Details about the request that revealed the card detail
65
+ #
66
+ # @param ip_address [String] The IP address recorded for the request that generated the event
67
+ end
68
+
69
+ # The type of card detail that was revealed
70
+ #
71
+ # @see Lithic::Models::EmbedViewedWebhookEvent#embed_type
72
+ module EmbedType
73
+ extend Lithic::Internal::Type::Enum
74
+
75
+ PAN = :PAN
76
+ CVV = :CVV
77
+ EXP_MONTH = :EXP_MONTH
78
+ EXP_YEAR = :EXP_YEAR
79
+
80
+ # @!method self.values
81
+ # @return [Array<Symbol>]
82
+ end
83
+ end
84
+ end
85
+ end
@@ -22,7 +22,7 @@ module Lithic
22
22
  # The type of event that occurred. Possible values:
23
23
  #
24
24
  # - account_holder_document.updated: Occurs when an account holder's document
25
- # upload status has been updated
25
+ # upload status has been updated.
26
26
  # - account_holder.created: Occurs when a new account_holder is created.
27
27
  # - account_holder.updated: Occurs when an account_holder is updated.
28
28
  # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -86,10 +86,25 @@ module Lithic
86
86
  # This event will be deprecated in the future. We recommend using
87
87
  # `tokenization.updated` instead.
88
88
  #
89
- # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
89
+ # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
90
+ # dispute filed through the Chargebacks API (`/v1/disputes`).
91
+ #
92
+ # This event is not emitted for Managed Disputes.
93
+ #
90
94
  # - dispute_transaction.created: Occurs when a new dispute transaction is created
91
- # - dispute_transaction.updated: Occurs when a dispute transaction is updated
92
- # - dispute.updated: Occurs when a dispute is updated.
95
+ # for a Managed Disputes case.
96
+ # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
97
+ # Disputes case is updated.
98
+ # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
99
+ # (`/v1/disputes`) is created or updated.
100
+ #
101
+ # This event is not emitted for Managed Disputes. Use
102
+ # `dispute_transaction.created` and `dispute_transaction.updated` instead.
103
+ #
104
+ # - embed.session_generated: Occurs when a card embed session is successfully
105
+ # generated.
106
+ # - embed.viewed: Occurs when a card detail is successfully revealed through an
107
+ # embed.
93
108
  # - external_bank_account.created: Occurs when an external bank account is
94
109
  # created.
95
110
  # - external_bank_account.updated: Occurs when an external bank account is
@@ -111,12 +126,12 @@ module Lithic
111
126
  # - payment_transaction.updated: Occurs when a payment transaction is updated.
112
127
  # - settlement_report.updated: Occurs when a settlement report is created or
113
128
  # updated.
114
- # - statements.created: Occurs when a statement has been created
129
+ # - statements.created: Occurs when a statement has been created.
115
130
  # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
116
131
  # event. Upon receiving this request, the Card Program should issue its own
117
132
  # challenge to the cardholder. After a cardholder challenge is successfully
118
133
  # completed, the Card Program needs to respond back to Lithic by call to
119
- # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
134
+ # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
120
135
  # Then the cardholder must navigate back to the merchant checkout flow to
121
136
  # complete the transaction. Some merchants will include an `app_requestor_url`
122
137
  # for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -158,7 +173,7 @@ module Lithic
158
173
  # The type of event that occurred. Possible values:
159
174
  #
160
175
  # - account_holder_document.updated: Occurs when an account holder's document
161
- # upload status has been updated
176
+ # upload status has been updated.
162
177
  # - account_holder.created: Occurs when a new account_holder is created.
163
178
  # - account_holder.updated: Occurs when an account_holder is updated.
164
179
  # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -222,10 +237,25 @@ module Lithic
222
237
  # This event will be deprecated in the future. We recommend using
223
238
  # `tokenization.updated` instead.
224
239
  #
225
- # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
240
+ # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
241
+ # dispute filed through the Chargebacks API (`/v1/disputes`).
242
+ #
243
+ # This event is not emitted for Managed Disputes.
244
+ #
226
245
  # - dispute_transaction.created: Occurs when a new dispute transaction is created
227
- # - dispute_transaction.updated: Occurs when a dispute transaction is updated
228
- # - dispute.updated: Occurs when a dispute is updated.
246
+ # for a Managed Disputes case.
247
+ # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
248
+ # Disputes case is updated.
249
+ # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
250
+ # (`/v1/disputes`) is created or updated.
251
+ #
252
+ # This event is not emitted for Managed Disputes. Use
253
+ # `dispute_transaction.created` and `dispute_transaction.updated` instead.
254
+ #
255
+ # - embed.session_generated: Occurs when a card embed session is successfully
256
+ # generated.
257
+ # - embed.viewed: Occurs when a card detail is successfully revealed through an
258
+ # embed.
229
259
  # - external_bank_account.created: Occurs when an external bank account is
230
260
  # created.
231
261
  # - external_bank_account.updated: Occurs when an external bank account is
@@ -247,12 +277,12 @@ module Lithic
247
277
  # - payment_transaction.updated: Occurs when a payment transaction is updated.
248
278
  # - settlement_report.updated: Occurs when a settlement report is created or
249
279
  # updated.
250
- # - statements.created: Occurs when a statement has been created
280
+ # - statements.created: Occurs when a statement has been created.
251
281
  # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
252
282
  # event. Upon receiving this request, the Card Program should issue its own
253
283
  # challenge to the cardholder. After a cardholder challenge is successfully
254
284
  # completed, the Card Program needs to respond back to Lithic by call to
255
- # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
285
+ # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
256
286
  # Then the cardholder must navigate back to the merchant checkout flow to
257
287
  # complete the transaction. Some merchants will include an `app_requestor_url`
258
288
  # for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -307,6 +337,8 @@ module Lithic
307
337
  DISPUTE_TRANSACTION_CREATED = :"dispute_transaction.created"
308
338
  DISPUTE_TRANSACTION_UPDATED = :"dispute_transaction.updated"
309
339
  DISPUTE_UPDATED = :"dispute.updated"
340
+ EMBED_SESSION_GENERATED = :"embed.session_generated"
341
+ EMBED_VIEWED = :"embed.viewed"
310
342
  EXTERNAL_BANK_ACCOUNT_CREATED = :"external_bank_account.created"
311
343
  EXTERNAL_BANK_ACCOUNT_UPDATED = :"external_bank_account.updated"
312
344
  EXTERNAL_PAYMENT_CREATED = :"external_payment.created"
@@ -76,7 +76,7 @@ module Lithic
76
76
  # The type of event that occurred. Possible values:
77
77
  #
78
78
  # - account_holder_document.updated: Occurs when an account holder's document
79
- # upload status has been updated
79
+ # upload status has been updated.
80
80
  # - account_holder.created: Occurs when a new account_holder is created.
81
81
  # - account_holder.updated: Occurs when an account_holder is updated.
82
82
  # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -140,10 +140,25 @@ module Lithic
140
140
  # This event will be deprecated in the future. We recommend using
141
141
  # `tokenization.updated` instead.
142
142
  #
143
- # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
143
+ # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
144
+ # dispute filed through the Chargebacks API (`/v1/disputes`).
145
+ #
146
+ # This event is not emitted for Managed Disputes.
147
+ #
144
148
  # - dispute_transaction.created: Occurs when a new dispute transaction is created
145
- # - dispute_transaction.updated: Occurs when a dispute transaction is updated
146
- # - dispute.updated: Occurs when a dispute is updated.
149
+ # for a Managed Disputes case.
150
+ # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
151
+ # Disputes case is updated.
152
+ # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
153
+ # (`/v1/disputes`) is created or updated.
154
+ #
155
+ # This event is not emitted for Managed Disputes. Use
156
+ # `dispute_transaction.created` and `dispute_transaction.updated` instead.
157
+ #
158
+ # - embed.session_generated: Occurs when a card embed session is successfully
159
+ # generated.
160
+ # - embed.viewed: Occurs when a card detail is successfully revealed through an
161
+ # embed.
147
162
  # - external_bank_account.created: Occurs when an external bank account is
148
163
  # created.
149
164
  # - external_bank_account.updated: Occurs when an external bank account is
@@ -165,12 +180,12 @@ module Lithic
165
180
  # - payment_transaction.updated: Occurs when a payment transaction is updated.
166
181
  # - settlement_report.updated: Occurs when a settlement report is created or
167
182
  # updated.
168
- # - statements.created: Occurs when a statement has been created
183
+ # - statements.created: Occurs when a statement has been created.
169
184
  # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
170
185
  # event. Upon receiving this request, the Card Program should issue its own
171
186
  # challenge to the cardholder. After a cardholder challenge is successfully
172
187
  # completed, the Card Program needs to respond back to Lithic by call to
173
- # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
188
+ # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
174
189
  # Then the cardholder must navigate back to the merchant checkout flow to
175
190
  # complete the transaction. Some merchants will include an `app_requestor_url`
176
191
  # for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -223,6 +238,8 @@ module Lithic
223
238
  DISPUTE_TRANSACTION_CREATED = :"dispute_transaction.created"
224
239
  DISPUTE_TRANSACTION_UPDATED = :"dispute_transaction.updated"
225
240
  DISPUTE_UPDATED = :"dispute.updated"
241
+ EMBED_SESSION_GENERATED = :"embed.session_generated"
242
+ EMBED_VIEWED = :"embed.viewed"
226
243
  EXTERNAL_BANK_ACCOUNT_CREATED = :"external_bank_account.created"
227
244
  EXTERNAL_BANK_ACCOUNT_UPDATED = :"external_bank_account.updated"
228
245
  EXTERNAL_PAYMENT_CREATED = :"external_payment.created"
@@ -49,7 +49,7 @@ module Lithic
49
49
  # The type of event that occurred. Possible values:
50
50
  #
51
51
  # - account_holder_document.updated: Occurs when an account holder's document
52
- # upload status has been updated
52
+ # upload status has been updated.
53
53
  # - account_holder.created: Occurs when a new account_holder is created.
54
54
  # - account_holder.updated: Occurs when an account_holder is updated.
55
55
  # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -113,10 +113,25 @@ module Lithic
113
113
  # This event will be deprecated in the future. We recommend using
114
114
  # `tokenization.updated` instead.
115
115
  #
116
- # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
116
+ # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
117
+ # dispute filed through the Chargebacks API (`/v1/disputes`).
118
+ #
119
+ # This event is not emitted for Managed Disputes.
120
+ #
117
121
  # - dispute_transaction.created: Occurs when a new dispute transaction is created
118
- # - dispute_transaction.updated: Occurs when a dispute transaction is updated
119
- # - dispute.updated: Occurs when a dispute is updated.
122
+ # for a Managed Disputes case.
123
+ # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
124
+ # Disputes case is updated.
125
+ # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
126
+ # (`/v1/disputes`) is created or updated.
127
+ #
128
+ # This event is not emitted for Managed Disputes. Use
129
+ # `dispute_transaction.created` and `dispute_transaction.updated` instead.
130
+ #
131
+ # - embed.session_generated: Occurs when a card embed session is successfully
132
+ # generated.
133
+ # - embed.viewed: Occurs when a card detail is successfully revealed through an
134
+ # embed.
120
135
  # - external_bank_account.created: Occurs when an external bank account is
121
136
  # created.
122
137
  # - external_bank_account.updated: Occurs when an external bank account is
@@ -138,12 +153,12 @@ module Lithic
138
153
  # - payment_transaction.updated: Occurs when a payment transaction is updated.
139
154
  # - settlement_report.updated: Occurs when a settlement report is created or
140
155
  # updated.
141
- # - statements.created: Occurs when a statement has been created
156
+ # - statements.created: Occurs when a statement has been created.
142
157
  # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
143
158
  # event. Upon receiving this request, the Card Program should issue its own
144
159
  # challenge to the cardholder. After a cardholder challenge is successfully
145
160
  # completed, the Card Program needs to respond back to Lithic by call to
146
- # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
161
+ # [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
147
162
  # Then the cardholder must navigate back to the merchant checkout flow to
148
163
  # complete the transaction. Some merchants will include an `app_requestor_url`
149
164
  # for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -196,6 +211,8 @@ module Lithic
196
211
  DISPUTE_TRANSACTION_CREATED = :"dispute_transaction.created"
197
212
  DISPUTE_TRANSACTION_UPDATED = :"dispute_transaction.updated"
198
213
  DISPUTE_UPDATED = :"dispute.updated"
214
+ EMBED_SESSION_GENERATED = :"embed.session_generated"
215
+ EMBED_VIEWED = :"embed.viewed"
199
216
  EXTERNAL_BANK_ACCOUNT_CREATED = :"external_bank_account.created"
200
217
  EXTERNAL_BANK_ACCOUNT_UPDATED = :"external_bank_account.updated"
201
218
  EXTERNAL_PAYMENT_CREATED = :"external_payment.created"