lithic 0.18.1 → 0.20.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 (174) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +66 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/models/account_activity_list_params.rb +2 -0
  6. data/lib/lithic/models/account_activity_list_response.rb +2 -0
  7. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +2 -0
  8. data/lib/lithic/models/auth_rules/ach_payment_update_action.rb +1 -0
  9. data/lib/lithic/models/auth_rules/card_transaction_update_action.rb +1 -0
  10. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +3 -0
  11. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +2 -0
  12. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +24 -1
  13. data/lib/lithic/models/auth_rules/velocity_limit_period.rb +1 -1
  14. data/lib/lithic/models/blockchain_recipient.rb +148 -0
  15. data/lib/lithic/models/blockchain_recipient_create_params.rb +74 -0
  16. data/lib/lithic/models/book_transfer_create_params.rb +4 -0
  17. data/lib/lithic/models/book_transfer_list_params.rb +1 -0
  18. data/lib/lithic/models/book_transfer_response.rb +4 -0
  19. data/lib/lithic/models/card.rb +2 -2
  20. data/lib/lithic/models/card_provision_params.rb +10 -8
  21. data/lib/lithic/models/card_reassign_account_params.rb +29 -0
  22. data/lib/lithic/models/dispute_v2.rb +178 -130
  23. data/lib/lithic/models/disputes_v2_list_params.rb +10 -1
  24. data/lib/lithic/models/embed_session_generated_webhook_event.rb +83 -0
  25. data/lib/lithic/models/embed_viewed_webhook_event.rb +85 -0
  26. data/lib/lithic/models/event.rb +44 -12
  27. data/lib/lithic/models/event_list_params.rb +23 -6
  28. data/lib/lithic/models/event_subscription.rb +23 -6
  29. data/lib/lithic/models/events/subscription_create_params.rb +23 -6
  30. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -0
  31. data/lib/lithic/models/events/subscription_update_params.rb +23 -6
  32. data/lib/lithic/models/external_payment_list_params.rb +3 -3
  33. data/lib/lithic/models/financial_account.rb +14 -1
  34. data/lib/lithic/models/financial_accounts/balance_list_params.rb +4 -3
  35. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +10 -0
  36. data/lib/lithic/models/financial_event.rb +8 -0
  37. data/lib/lithic/models/fraud/transaction_report_response.rb +8 -8
  38. data/lib/lithic/models/fraud/transaction_retrieve_response.rb +10 -8
  39. data/lib/lithic/models/parsed_webhook_event.rb +5 -1
  40. data/lib/lithic/models/payment.rb +91 -6
  41. data/lib/lithic/models/payment_list_params.rb +1 -0
  42. data/lib/lithic/models/tokenization_simulate_params.rb +2 -2
  43. data/lib/lithic/models/transaction_monitoring/case_entity.rb +13 -4
  44. data/lib/lithic/models/transaction_monitoring/case_list_params.rb +4 -2
  45. data/lib/lithic/models/transaction_monitoring/case_update_params.rb +5 -11
  46. data/lib/lithic/models/transaction_monitoring/monitoring_case.rb +5 -11
  47. data/lib/lithic/models/transaction_monitoring/queue.rb +10 -1
  48. data/lib/lithic/models/transaction_monitoring/queue_create_params.rb +14 -1
  49. data/lib/lithic/models/transaction_monitoring/queue_update_params.rb +15 -1
  50. data/lib/lithic/models/transaction_simulate_clearing_params.rb +4 -3
  51. data/lib/lithic/models.rb +10 -0
  52. data/lib/lithic/resources/blockchain_recipients.rb +57 -0
  53. data/lib/lithic/resources/card_authorizations.rb +1 -1
  54. data/lib/lithic/resources/cards.rb +34 -2
  55. data/lib/lithic/resources/disputes_v2.rb +3 -1
  56. data/lib/lithic/resources/external_payments.rb +1 -1
  57. data/lib/lithic/resources/three_ds/decisioning.rb +1 -1
  58. data/lib/lithic/resources/tokenizations.rb +1 -1
  59. data/lib/lithic/resources/transaction_monitoring/cases.rb +2 -2
  60. data/lib/lithic/resources/transaction_monitoring/queues.rb +12 -2
  61. data/lib/lithic/resources/transactions.rb +4 -3
  62. data/lib/lithic/resources/webhooks.rb +1 -1
  63. data/lib/lithic/version.rb +1 -1
  64. data/lib/lithic.rb +6 -1
  65. data/rbi/lithic/client.rbi +3 -0
  66. data/rbi/lithic/models/account_activity_list_params.rbi +10 -0
  67. data/rbi/lithic/models/account_activity_list_response.rbi +10 -0
  68. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +10 -0
  69. data/rbi/lithic/models/auth_rules/ach_payment_update_action.rbi +5 -0
  70. data/rbi/lithic/models/auth_rules/card_transaction_update_action.rbi +5 -0
  71. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +8 -0
  72. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +10 -0
  73. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +30 -0
  74. data/rbi/lithic/models/auth_rules/velocity_limit_period.rbi +2 -2
  75. data/rbi/lithic/models/blockchain_recipient.rbi +209 -0
  76. data/rbi/lithic/models/blockchain_recipient_create_params.rbi +102 -0
  77. data/rbi/lithic/models/book_transfer_create_params.rbi +20 -0
  78. data/rbi/lithic/models/book_transfer_list_params.rbi +5 -0
  79. data/rbi/lithic/models/book_transfer_response.rbi +20 -0
  80. data/rbi/lithic/models/card.rbi +2 -2
  81. data/rbi/lithic/models/card_provision_params.rbi +16 -12
  82. data/rbi/lithic/models/card_reassign_account_params.rbi +49 -0
  83. data/rbi/lithic/models/dispute_v2.rbi +285 -181
  84. data/rbi/lithic/models/disputes_v2_list_params.rbi +13 -0
  85. data/rbi/lithic/models/embed_session_generated_webhook_event.rbi +157 -0
  86. data/rbi/lithic/models/embed_viewed_webhook_event.rbi +146 -0
  87. data/rbi/lithic/models/event.rbi +70 -18
  88. data/rbi/lithic/models/event_list_params.rbi +31 -6
  89. data/rbi/lithic/models/event_subscription.rbi +31 -6
  90. data/rbi/lithic/models/events/subscription_create_params.rbi +31 -6
  91. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +10 -0
  92. data/rbi/lithic/models/events/subscription_update_params.rbi +31 -6
  93. data/rbi/lithic/models/external_payment_list_params.rbi +3 -3
  94. data/rbi/lithic/models/financial_account.rbi +12 -0
  95. data/rbi/lithic/models/financial_accounts/balance_list_params.rbi +8 -6
  96. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +50 -0
  97. data/rbi/lithic/models/financial_event.rbi +34 -0
  98. data/rbi/lithic/models/fraud/transaction_report_response.rbi +16 -29
  99. data/rbi/lithic/models/fraud/transaction_retrieve_response.rbi +16 -29
  100. data/rbi/lithic/models/parsed_webhook_event.rbi +2 -0
  101. data/rbi/lithic/models/payment.rbi +147 -4
  102. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  103. data/rbi/lithic/models/tokenization_simulate_params.rbi +2 -2
  104. data/rbi/lithic/models/transaction_monitoring/case_entity.rbi +27 -5
  105. data/rbi/lithic/models/transaction_monitoring/case_list_params.rbi +6 -2
  106. data/rbi/lithic/models/transaction_monitoring/case_update_params.rbi +8 -33
  107. data/rbi/lithic/models/transaction_monitoring/monitoring_case.rbi +7 -31
  108. data/rbi/lithic/models/transaction_monitoring/queue.rbi +10 -0
  109. data/rbi/lithic/models/transaction_monitoring/queue_create_params.rbi +12 -0
  110. data/rbi/lithic/models/transaction_monitoring/queue_update_params.rbi +14 -0
  111. data/rbi/lithic/models/transaction_simulate_clearing_params.rbi +8 -6
  112. data/rbi/lithic/models.rbi +12 -0
  113. data/rbi/lithic/resources/blockchain_recipients.rbi +51 -0
  114. data/rbi/lithic/resources/card_authorizations.rbi +1 -1
  115. data/rbi/lithic/resources/cards.rbi +30 -6
  116. data/rbi/lithic/resources/disputes_v2.rbi +4 -0
  117. data/rbi/lithic/resources/external_payments.rbi +1 -1
  118. data/rbi/lithic/resources/financial_accounts/balances.rbi +4 -3
  119. data/rbi/lithic/resources/three_ds/decisioning.rbi +1 -1
  120. data/rbi/lithic/resources/tokenizations.rbi +1 -1
  121. data/rbi/lithic/resources/transaction_monitoring/cases.rbi +6 -11
  122. data/rbi/lithic/resources/transaction_monitoring/queues.rbi +11 -0
  123. data/rbi/lithic/resources/transactions.rbi +8 -6
  124. data/rbi/lithic/resources/webhooks.rbi +2 -0
  125. data/sig/lithic/client.rbs +2 -0
  126. data/sig/lithic/models/account_activity_list_params.rbs +4 -0
  127. data/sig/lithic/models/account_activity_list_response.rbs +4 -0
  128. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +4 -0
  129. data/sig/lithic/models/auth_rules/ach_payment_update_action.rbs +2 -1
  130. data/sig/lithic/models/auth_rules/card_transaction_update_action.rbs +2 -1
  131. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +2 -0
  132. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +4 -2
  133. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +10 -0
  134. data/sig/lithic/models/blockchain_recipient.rbs +106 -0
  135. data/sig/lithic/models/blockchain_recipient_create_params.rbs +60 -0
  136. data/sig/lithic/models/book_transfer_create_params.rbs +8 -0
  137. data/sig/lithic/models/book_transfer_list_params.rbs +2 -0
  138. data/sig/lithic/models/book_transfer_response.rbs +8 -0
  139. data/sig/lithic/models/card_reassign_account_params.rbs +28 -0
  140. data/sig/lithic/models/dispute_v2.rbs +145 -101
  141. data/sig/lithic/models/disputes_v2_list_params.rbs +7 -0
  142. data/sig/lithic/models/embed_session_generated_webhook_event.rbs +66 -0
  143. data/sig/lithic/models/embed_viewed_webhook_event.rbs +68 -0
  144. data/sig/lithic/models/event.rbs +4 -0
  145. data/sig/lithic/models/event_list_params.rbs +4 -0
  146. data/sig/lithic/models/event_subscription.rbs +4 -0
  147. data/sig/lithic/models/events/subscription_create_params.rbs +4 -0
  148. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +4 -0
  149. data/sig/lithic/models/events/subscription_update_params.rbs +4 -0
  150. data/sig/lithic/models/financial_account.rbs +5 -0
  151. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +20 -0
  152. data/sig/lithic/models/financial_event.rbs +16 -0
  153. data/sig/lithic/models/fraud/transaction_report_response.rbs +16 -26
  154. data/sig/lithic/models/fraud/transaction_retrieve_response.rbs +16 -26
  155. data/sig/lithic/models/parsed_webhook_event.rbs +2 -0
  156. data/sig/lithic/models/payment.rbs +46 -1
  157. data/sig/lithic/models/payment_list_params.rbs +2 -1
  158. data/sig/lithic/models/transaction_monitoring/case_entity.rbs +7 -5
  159. data/sig/lithic/models/transaction_monitoring/case_update_params.rbs +5 -7
  160. data/sig/lithic/models/transaction_monitoring/monitoring_case.rbs +4 -4
  161. data/sig/lithic/models/transaction_monitoring/queue.rbs +5 -0
  162. data/sig/lithic/models/transaction_monitoring/queue_create_params.rbs +9 -1
  163. data/sig/lithic/models/transaction_monitoring/queue_update_params.rbs +10 -1
  164. data/sig/lithic/models.rbs +10 -0
  165. data/sig/lithic/resources/blockchain_recipients.rbs +18 -0
  166. data/sig/lithic/resources/cards.rbs +6 -0
  167. data/sig/lithic/resources/disputes_v2.rbs +1 -0
  168. data/sig/lithic/resources/transaction_monitoring/cases.rbs +1 -1
  169. data/sig/lithic/resources/transaction_monitoring/queues.rbs +2 -0
  170. data/sig/lithic/resources/webhooks.rbs +2 -0
  171. metadata +20 -5
  172. data/lib/lithic/models/transaction_monitoring/resolution_outcome.rb +0 -28
  173. data/rbi/lithic/models/transaction_monitoring/resolution_outcome.rbi +0 -61
  174. data/sig/lithic/models/transaction_monitoring/resolution_outcome.rbs +0 -24
@@ -28,6 +28,13 @@ module Lithic
28
28
  # @return [String, nil]
29
29
  required :case_id, String, nil?: true
30
30
 
31
+ # @!attribute claim_token
32
+ # Token for the claim this dispute was filed under, in UUID format. Null for
33
+ # disputes not initiated through the Dispute Intake API.
34
+ #
35
+ # @return [String, nil]
36
+ required :claim_token, String, nil?: true
37
+
31
38
  # @!attribute created
32
39
  # When the dispute was created.
33
40
  #
@@ -49,8 +56,8 @@ module Lithic
49
56
  # @!attribute events
50
57
  # Chronological list of events that have occurred in the dispute lifecycle
51
58
  #
52
- # @return [Array<Lithic::Models::DisputeV2::Event>]
53
- required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::DisputeV2::Event] }
59
+ # @return [Array<Lithic::Models::DisputeV2::Event::Workflow, Lithic::Models::DisputeV2::Event::Financial, Lithic::Models::DisputeV2::Event::CardholderLiability>]
60
+ required :events, -> { Lithic::Internal::Type::ArrayOf[union: Lithic::DisputeV2::Event] }
54
61
 
55
62
  # @!attribute liability_allocation
56
63
  # Current breakdown of how liability is allocated for the disputed amount
@@ -88,7 +95,7 @@ module Lithic
88
95
  # @return [Time]
89
96
  required :updated, Time
90
97
 
91
- # @!method initialize(token:, account_token:, card_token:, case_id:, created:, currency:, disposition:, events:, liability_allocation:, merchant:, network:, status:, transaction_series:, updated:)
98
+ # @!method initialize(token:, account_token:, card_token:, case_id:, claim_token:, created:, currency:, disposition:, events:, liability_allocation:, merchant:, network:, status:, transaction_series:, updated:)
92
99
  # Some parameter documentations has been truncated, see
93
100
  # {Lithic::Models::DisputeV2} for more details.
94
101
  #
@@ -102,13 +109,15 @@ module Lithic
102
109
  #
103
110
  # @param case_id [String, nil] Identifier assigned by the network for this dispute.
104
111
  #
112
+ # @param claim_token [String, nil] Token for the claim this dispute was filed under, in UUID format. Null for dispu
113
+ #
105
114
  # @param created [Time] When the dispute was created.
106
115
  #
107
116
  # @param currency [String] Three-letter ISO 4217 currency code.
108
117
  #
109
118
  # @param disposition [Symbol, Lithic::Models::DisputeV2::Disposition, nil] Dispute resolution outcome
110
119
  #
111
- # @param events [Array<Lithic::Models::DisputeV2::Event>] Chronological list of events that have occurred in the dispute lifecycle
120
+ # @param events [Array<Lithic::Models::DisputeV2::Event::Workflow, Lithic::Models::DisputeV2::Event::Financial, Lithic::Models::DisputeV2::Event::CardholderLiability>] Chronological list of events that have occurred in the dispute lifecycle
112
121
  #
113
122
  # @param liability_allocation [Lithic::Models::DisputeV2::LiabilityAllocation] Current breakdown of how liability is allocated for the disputed amount
114
123
  #
@@ -138,65 +147,65 @@ module Lithic
138
147
  # @return [Array<Symbol>]
139
148
  end
140
149
 
141
- class Event < Lithic::Internal::Type::BaseModel
142
- # @!attribute token
143
- # Unique identifier for the event, in UUID format
144
- #
145
- # @return [String]
146
- required :token, String
147
-
148
- # @!attribute created
149
- # When the event occurred
150
- #
151
- # @return [Time]
152
- required :created, Time
153
-
154
- # @!attribute data
155
- # Details specific to the event type
156
- #
157
- # @return [Lithic::Models::DisputeV2::Event::Data::Workflow, Lithic::Models::DisputeV2::Event::Data::Financial, Lithic::Models::DisputeV2::Event::Data::CardholderLiability]
158
- required :data, union: -> { Lithic::DisputeV2::Event::Data }
159
-
160
- # @!attribute type
161
- # Type of event
162
- #
163
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Type]
164
- required :type, enum: -> { Lithic::DisputeV2::Event::Type }
165
-
166
- # @!method initialize(token:, created:, data:, type:)
167
- # Event that occurred in the dispute lifecycle
168
- #
169
- # @param token [String] Unique identifier for the event, in UUID format
170
- #
171
- # @param created [Time] When the event occurred
172
- #
173
- # @param data [Lithic::Models::DisputeV2::Event::Data::Workflow, Lithic::Models::DisputeV2::Event::Data::Financial, Lithic::Models::DisputeV2::Event::Data::CardholderLiability] Details specific to the event type
174
- #
175
- # @param type [Symbol, Lithic::Models::DisputeV2::Event::Type] Type of event
176
-
177
- # Details specific to the event type
178
- #
179
- # @see Lithic::Models::DisputeV2::Event#data
180
- module Data
181
- extend Lithic::Internal::Type::Union
182
-
183
- discriminator :type
184
-
185
- # Details specific to workflow events
186
- variant :WORKFLOW, -> { Lithic::DisputeV2::Event::Data::Workflow }
187
-
188
- # Details specific to financial events
189
- variant :FINANCIAL, -> { Lithic::DisputeV2::Event::Data::Financial }
190
-
191
- # Details specific to cardholder liability events
192
- variant :CARDHOLDER_LIABILITY, -> { Lithic::DisputeV2::Event::Data::CardholderLiability }
193
-
194
- class Workflow < Lithic::Internal::Type::BaseModel
150
+ # Event that occurred in the dispute lifecycle. The `type` field identifies the
151
+ # event variant and determines the shape of `data`
152
+ module Event
153
+ extend Lithic::Internal::Type::Union
154
+
155
+ discriminator :type
156
+
157
+ # Event tracking the dispute's case management workflow
158
+ variant :WORKFLOW, -> { Lithic::DisputeV2::Event::Workflow }
159
+
160
+ # Event tracking a funds movement between issuer and acquirer
161
+ variant :FINANCIAL, -> { Lithic::DisputeV2::Event::Financial }
162
+
163
+ # Event tracking a change in cardholder liability
164
+ variant :CARDHOLDER_LIABILITY, -> { Lithic::DisputeV2::Event::CardholderLiability }
165
+
166
+ class Workflow < Lithic::Internal::Type::BaseModel
167
+ # @!attribute token
168
+ # Unique identifier for the event, in UUID format
169
+ #
170
+ # @return [String]
171
+ required :token, String
172
+
173
+ # @!attribute created
174
+ # When the event occurred
175
+ #
176
+ # @return [Time]
177
+ required :created, Time
178
+
179
+ # @!attribute data
180
+ # Details specific to workflow events
181
+ #
182
+ # @return [Lithic::Models::DisputeV2::Event::Workflow::Data]
183
+ required :data, -> { Lithic::DisputeV2::Event::Workflow::Data }
184
+
185
+ # @!attribute type
186
+ # Type of event. Always `WORKFLOW`
187
+ #
188
+ # @return [Symbol, :WORKFLOW]
189
+ required :type, const: :WORKFLOW
190
+
191
+ # @!method initialize(token:, created:, data:, type: :WORKFLOW)
192
+ # Event tracking the dispute's case management workflow
193
+ #
194
+ # @param token [String] Unique identifier for the event, in UUID format
195
+ #
196
+ # @param created [Time] When the event occurred
197
+ #
198
+ # @param data [Lithic::Models::DisputeV2::Event::Workflow::Data] Details specific to workflow events
199
+ #
200
+ # @param type [Symbol, :WORKFLOW] Type of event. Always `WORKFLOW`
201
+
202
+ # @see Lithic::Models::DisputeV2::Event::Workflow#data
203
+ class Data < Lithic::Internal::Type::BaseModel
195
204
  # @!attribute action
196
205
  # Action taken in this stage
197
206
  #
198
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Action]
199
- required :action, enum: -> { Lithic::DisputeV2::Event::Data::Workflow::Action }
207
+ # @return [Symbol, Lithic::Models::DisputeV2::Event::Workflow::Data::Action]
208
+ required :action, enum: -> { Lithic::DisputeV2::Event::Workflow::Data::Action }
200
209
 
201
210
  # @!attribute amount
202
211
  # Amount in minor units
@@ -207,10 +216,10 @@ module Lithic
207
216
  # @!attribute disposition
208
217
  # Dispute resolution outcome
209
218
  #
210
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Disposition, nil]
219
+ # @return [Symbol, Lithic::Models::DisputeV2::Event::Workflow::Data::Disposition, nil]
211
220
  required :disposition,
212
221
  enum: -> {
213
- Lithic::DisputeV2::Event::Data::Workflow::Disposition
222
+ Lithic::DisputeV2::Event::Workflow::Data::Disposition
214
223
  },
215
224
  nil?: true
216
225
 
@@ -223,33 +232,25 @@ module Lithic
223
232
  # @!attribute stage
224
233
  # Current stage of the dispute workflow
225
234
  #
226
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Stage]
227
- required :stage, enum: -> { Lithic::DisputeV2::Event::Data::Workflow::Stage }
228
-
229
- # @!attribute type
230
- # Event type discriminator
231
- #
232
- # @return [Symbol, :WORKFLOW]
233
- required :type, const: :WORKFLOW
235
+ # @return [Symbol, Lithic::Models::DisputeV2::Event::Workflow::Data::Stage]
236
+ required :stage, enum: -> { Lithic::DisputeV2::Event::Workflow::Data::Stage }
234
237
 
235
- # @!method initialize(action:, amount:, disposition:, reason:, stage:, type: :WORKFLOW)
238
+ # @!method initialize(action:, amount:, disposition:, reason:, stage:)
236
239
  # Details specific to workflow events
237
240
  #
238
- # @param action [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Action] Action taken in this stage
241
+ # @param action [Symbol, Lithic::Models::DisputeV2::Event::Workflow::Data::Action] Action taken in this stage
239
242
  #
240
243
  # @param amount [Integer, nil] Amount in minor units
241
244
  #
242
- # @param disposition [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Disposition, nil] Dispute resolution outcome
245
+ # @param disposition [Symbol, Lithic::Models::DisputeV2::Event::Workflow::Data::Disposition, nil] Dispute resolution outcome
243
246
  #
244
247
  # @param reason [String, nil] Reason for the action
245
248
  #
246
- # @param stage [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Stage] Current stage of the dispute workflow
247
- #
248
- # @param type [Symbol, :WORKFLOW] Event type discriminator
249
+ # @param stage [Symbol, Lithic::Models::DisputeV2::Event::Workflow::Data::Stage] Current stage of the dispute workflow
249
250
 
250
251
  # Action taken in this stage
251
252
  #
252
- # @see Lithic::Models::DisputeV2::Event::Data::Workflow#action
253
+ # @see Lithic::Models::DisputeV2::Event::Workflow::Data#action
253
254
  module Action
254
255
  extend Lithic::Internal::Type::Enum
255
256
 
@@ -263,7 +264,7 @@ module Lithic
263
264
 
264
265
  # Dispute resolution outcome
265
266
  #
266
- # @see Lithic::Models::DisputeV2::Event::Data::Workflow#disposition
267
+ # @see Lithic::Models::DisputeV2::Event::Workflow::Data#disposition
267
268
  module Disposition
268
269
  extend Lithic::Internal::Type::Enum
269
270
 
@@ -279,7 +280,7 @@ module Lithic
279
280
 
280
281
  # Current stage of the dispute workflow
281
282
  #
282
- # @see Lithic::Models::DisputeV2::Event::Data::Workflow#stage
283
+ # @see Lithic::Models::DisputeV2::Event::Workflow::Data#stage
283
284
  module Stage
284
285
  extend Lithic::Internal::Type::Enum
285
286
 
@@ -289,8 +290,46 @@ module Lithic
289
290
  # @return [Array<Symbol>]
290
291
  end
291
292
  end
293
+ end
292
294
 
293
- class Financial < Lithic::Internal::Type::BaseModel
295
+ class Financial < Lithic::Internal::Type::BaseModel
296
+ # @!attribute token
297
+ # Unique identifier for the event, in UUID format
298
+ #
299
+ # @return [String]
300
+ required :token, String
301
+
302
+ # @!attribute created
303
+ # When the event occurred
304
+ #
305
+ # @return [Time]
306
+ required :created, Time
307
+
308
+ # @!attribute data
309
+ # Details specific to financial events
310
+ #
311
+ # @return [Lithic::Models::DisputeV2::Event::Financial::Data]
312
+ required :data, -> { Lithic::DisputeV2::Event::Financial::Data }
313
+
314
+ # @!attribute type
315
+ # Type of event. Always `FINANCIAL`
316
+ #
317
+ # @return [Symbol, :FINANCIAL]
318
+ required :type, const: :FINANCIAL
319
+
320
+ # @!method initialize(token:, created:, data:, type: :FINANCIAL)
321
+ # Event tracking a funds movement between issuer and acquirer
322
+ #
323
+ # @param token [String] Unique identifier for the event, in UUID format
324
+ #
325
+ # @param created [Time] When the event occurred
326
+ #
327
+ # @param data [Lithic::Models::DisputeV2::Event::Financial::Data] Details specific to financial events
328
+ #
329
+ # @param type [Symbol, :FINANCIAL] Type of event. Always `FINANCIAL`
330
+
331
+ # @see Lithic::Models::DisputeV2::Event::Financial#data
332
+ class Data < Lithic::Internal::Type::BaseModel
294
333
  # @!attribute amount
295
334
  # Amount in minor units
296
335
  #
@@ -300,35 +339,27 @@ module Lithic
300
339
  # @!attribute polarity
301
340
  # Direction of funds flow
302
341
  #
303
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Polarity]
304
- required :polarity, enum: -> { Lithic::DisputeV2::Event::Data::Financial::Polarity }
342
+ # @return [Symbol, Lithic::Models::DisputeV2::Event::Financial::Data::Polarity]
343
+ required :polarity, enum: -> { Lithic::DisputeV2::Event::Financial::Data::Polarity }
305
344
 
306
345
  # @!attribute stage
307
346
  # Stage at which the financial event occurred
308
347
  #
309
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Stage]
310
- required :stage, enum: -> { Lithic::DisputeV2::Event::Data::Financial::Stage }
311
-
312
- # @!attribute type
313
- # Event type discriminator
314
- #
315
- # @return [Symbol, :FINANCIAL]
316
- required :type, const: :FINANCIAL
348
+ # @return [Symbol, Lithic::Models::DisputeV2::Event::Financial::Data::Stage]
349
+ required :stage, enum: -> { Lithic::DisputeV2::Event::Financial::Data::Stage }
317
350
 
318
- # @!method initialize(amount:, polarity:, stage:, type: :FINANCIAL)
351
+ # @!method initialize(amount:, polarity:, stage:)
319
352
  # Details specific to financial events
320
353
  #
321
354
  # @param amount [Integer] Amount in minor units
322
355
  #
323
- # @param polarity [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Polarity] Direction of funds flow
324
- #
325
- # @param stage [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Stage] Stage at which the financial event occurred
356
+ # @param polarity [Symbol, Lithic::Models::DisputeV2::Event::Financial::Data::Polarity] Direction of funds flow
326
357
  #
327
- # @param type [Symbol, :FINANCIAL] Event type discriminator
358
+ # @param stage [Symbol, Lithic::Models::DisputeV2::Event::Financial::Data::Stage] Stage at which the financial event occurred
328
359
 
329
360
  # Direction of funds flow
330
361
  #
331
- # @see Lithic::Models::DisputeV2::Event::Data::Financial#polarity
362
+ # @see Lithic::Models::DisputeV2::Event::Financial::Data#polarity
332
363
  module Polarity
333
364
  extend Lithic::Internal::Type::Enum
334
365
 
@@ -341,7 +372,7 @@ module Lithic
341
372
 
342
373
  # Stage at which the financial event occurred
343
374
  #
344
- # @see Lithic::Models::DisputeV2::Event::Data::Financial#stage
375
+ # @see Lithic::Models::DisputeV2::Event::Financial::Data#stage
345
376
  module Stage
346
377
  extend Lithic::Internal::Type::Enum
347
378
 
@@ -355,13 +386,51 @@ module Lithic
355
386
  # @return [Array<Symbol>]
356
387
  end
357
388
  end
389
+ end
358
390
 
359
- class CardholderLiability < Lithic::Internal::Type::BaseModel
391
+ class CardholderLiability < Lithic::Internal::Type::BaseModel
392
+ # @!attribute token
393
+ # Unique identifier for the event, in UUID format
394
+ #
395
+ # @return [String]
396
+ required :token, String
397
+
398
+ # @!attribute created
399
+ # When the event occurred
400
+ #
401
+ # @return [Time]
402
+ required :created, Time
403
+
404
+ # @!attribute data
405
+ # Details specific to cardholder liability events
406
+ #
407
+ # @return [Lithic::Models::DisputeV2::Event::CardholderLiability::Data]
408
+ required :data, -> { Lithic::DisputeV2::Event::CardholderLiability::Data }
409
+
410
+ # @!attribute type
411
+ # Type of event. Always `CARDHOLDER_LIABILITY`
412
+ #
413
+ # @return [Symbol, :CARDHOLDER_LIABILITY]
414
+ required :type, const: :CARDHOLDER_LIABILITY
415
+
416
+ # @!method initialize(token:, created:, data:, type: :CARDHOLDER_LIABILITY)
417
+ # Event tracking a change in cardholder liability
418
+ #
419
+ # @param token [String] Unique identifier for the event, in UUID format
420
+ #
421
+ # @param created [Time] When the event occurred
422
+ #
423
+ # @param data [Lithic::Models::DisputeV2::Event::CardholderLiability::Data] Details specific to cardholder liability events
424
+ #
425
+ # @param type [Symbol, :CARDHOLDER_LIABILITY] Type of event. Always `CARDHOLDER_LIABILITY`
426
+
427
+ # @see Lithic::Models::DisputeV2::Event::CardholderLiability#data
428
+ class Data < Lithic::Internal::Type::BaseModel
360
429
  # @!attribute action
361
430
  # Action taken regarding cardholder liability
362
431
  #
363
- # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::CardholderLiability::Action]
364
- required :action, enum: -> { Lithic::DisputeV2::Event::Data::CardholderLiability::Action }
432
+ # @return [Symbol, Lithic::Models::DisputeV2::Event::CardholderLiability::Data::Action]
433
+ required :action, enum: -> { Lithic::DisputeV2::Event::CardholderLiability::Data::Action }
365
434
 
366
435
  # @!attribute amount
367
436
  # Amount in minor units
@@ -372,58 +441,37 @@ module Lithic
372
441
  # @!attribute reason
373
442
  # Reason for the action
374
443
  #
375
- # @return [String]
376
- required :reason, String
377
-
378
- # @!attribute type
379
- # Event type discriminator
380
- #
381
- # @return [Symbol, :CARDHOLDER_LIABILITY]
382
- required :type, const: :CARDHOLDER_LIABILITY
444
+ # @return [String, nil]
445
+ required :reason, String, nil?: true
383
446
 
384
- # @!method initialize(action:, amount:, reason:, type: :CARDHOLDER_LIABILITY)
447
+ # @!method initialize(action:, amount:, reason:)
385
448
  # Details specific to cardholder liability events
386
449
  #
387
- # @param action [Symbol, Lithic::Models::DisputeV2::Event::Data::CardholderLiability::Action] Action taken regarding cardholder liability
450
+ # @param action [Symbol, Lithic::Models::DisputeV2::Event::CardholderLiability::Data::Action] Action taken regarding cardholder liability
388
451
  #
389
452
  # @param amount [Integer] Amount in minor units
390
453
  #
391
- # @param reason [String] Reason for the action
392
- #
393
- # @param type [Symbol, :CARDHOLDER_LIABILITY] Event type discriminator
454
+ # @param reason [String, nil] Reason for the action
394
455
 
395
456
  # Action taken regarding cardholder liability
396
457
  #
397
- # @see Lithic::Models::DisputeV2::Event::Data::CardholderLiability#action
458
+ # @see Lithic::Models::DisputeV2::Event::CardholderLiability::Data#action
398
459
  module Action
399
460
  extend Lithic::Internal::Type::Enum
400
461
 
401
462
  PROVISIONAL_CREDIT_GRANTED = :PROVISIONAL_CREDIT_GRANTED
402
463
  PROVISIONAL_CREDIT_REVERSED = :PROVISIONAL_CREDIT_REVERSED
403
464
  WRITTEN_OFF = :WRITTEN_OFF
465
+ WRITE_OFF_REVERSED = :WRITE_OFF_REVERSED
404
466
 
405
467
  # @!method self.values
406
468
  # @return [Array<Symbol>]
407
469
  end
408
470
  end
409
-
410
- # @!method self.variants
411
- # @return [Array(Lithic::Models::DisputeV2::Event::Data::Workflow, Lithic::Models::DisputeV2::Event::Data::Financial, Lithic::Models::DisputeV2::Event::Data::CardholderLiability)]
412
471
  end
413
472
 
414
- # Type of event
415
- #
416
- # @see Lithic::Models::DisputeV2::Event#type
417
- module Type
418
- extend Lithic::Internal::Type::Enum
419
-
420
- WORKFLOW = :WORKFLOW
421
- FINANCIAL = :FINANCIAL
422
- CARDHOLDER_LIABILITY = :CARDHOLDER_LIABILITY
423
-
424
- # @!method self.values
425
- # @return [Array<Symbol>]
426
- end
473
+ # @!method self.variants
474
+ # @return [Array(Lithic::Models::DisputeV2::Event::Workflow, Lithic::Models::DisputeV2::Event::Financial, Lithic::Models::DisputeV2::Event::CardholderLiability)]
427
475
  end
428
476
 
429
477
  # @see Lithic::Models::DisputeV2#liability_allocation
@@ -25,6 +25,13 @@ module Lithic
25
25
  # @return [String, nil]
26
26
  optional :card_token, String
27
27
 
28
+ # @!attribute claim_token
29
+ # Filter by the token of the claim the dispute was filed under. Returns the
30
+ # disputes created from that claim's disputed transaction events.
31
+ #
32
+ # @return [String, nil]
33
+ optional :claim_token, String
34
+
28
35
  # @!attribute disputed_transaction_token
29
36
  # Filter by the token of the transaction being disputed. Corresponds with
30
37
  # transaction_series.related_transaction_token in the Dispute.
@@ -58,7 +65,7 @@ module Lithic
58
65
  # @return [String, nil]
59
66
  optional :starting_after, String
60
67
 
61
- # @!method initialize(account_token: nil, begin_: nil, card_token: nil, disputed_transaction_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
68
+ # @!method initialize(account_token: nil, begin_: nil, card_token: nil, claim_token: nil, disputed_transaction_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
62
69
  # Some parameter documentations has been truncated, see
63
70
  # {Lithic::Models::DisputesV2ListParams} for more details.
64
71
  #
@@ -68,6 +75,8 @@ module Lithic
68
75
  #
69
76
  # @param card_token [String] Filter by card token.
70
77
  #
78
+ # @param claim_token [String] Filter by the token of the claim the dispute was filed under. Returns the disput
79
+ #
71
80
  # @param disputed_transaction_token [String] Filter by the token of the transaction being disputed. Corresponds with transact
72
81
  #
73
82
  # @param end_ [Time] RFC 3339 timestamp for filtering by created date, inclusive.
@@ -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