lithic 0.18.0 → 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 (127) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +48 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/internal/type/union.rb +7 -21
  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/conditional_ach_action_parameters.rb +3 -0
  9. data/lib/lithic/models/auth_rules/velocity_limit_period.rb +1 -1
  10. data/lib/lithic/models/book_transfer_create_params.rb +4 -0
  11. data/lib/lithic/models/book_transfer_list_params.rb +1 -0
  12. data/lib/lithic/models/book_transfer_response.rb +4 -0
  13. data/lib/lithic/models/card_authorization.rb +7 -6
  14. data/lib/lithic/models/embed_session_generated_webhook_event.rb +83 -0
  15. data/lib/lithic/models/embed_viewed_webhook_event.rb +85 -0
  16. data/lib/lithic/models/event.rb +44 -12
  17. data/lib/lithic/models/event_list_params.rb +23 -6
  18. data/lib/lithic/models/event_subscription.rb +23 -6
  19. data/lib/lithic/models/events/subscription_create_params.rb +23 -6
  20. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -0
  21. data/lib/lithic/models/events/subscription_update_params.rb +23 -6
  22. data/lib/lithic/models/external_payment_list_params.rb +3 -3
  23. data/lib/lithic/models/financial_accounts/balance_list_params.rb +4 -3
  24. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +7 -0
  25. data/lib/lithic/models/financial_event.rb +5 -0
  26. data/lib/lithic/models/fraud/transaction_report_response.rb +8 -8
  27. data/lib/lithic/models/fraud/transaction_retrieve_response.rb +10 -8
  28. data/lib/lithic/models/parsed_webhook_event.rb +5 -1
  29. data/lib/lithic/models/payment.rb +28 -1
  30. data/lib/lithic/models/payment_list_params.rb +1 -0
  31. data/lib/lithic/models/transaction_monitoring/case_transaction.rb +120 -43
  32. data/lib/lithic/models/transaction_monitoring/case_update_params.rb +5 -11
  33. data/lib/lithic/models/transaction_monitoring/monitoring_case.rb +5 -11
  34. data/lib/lithic/models/transaction_monitoring/queue.rb +10 -1
  35. data/lib/lithic/models/transaction_monitoring/queue_create_params.rb +14 -1
  36. data/lib/lithic/models/transaction_monitoring/queue_update_params.rb +15 -1
  37. data/lib/lithic/models/transaction_simulate_clearing_params.rb +4 -3
  38. data/lib/lithic/models.rb +4 -0
  39. data/lib/lithic/resources/card_authorizations.rb +1 -1
  40. data/lib/lithic/resources/cards.rb +5 -0
  41. data/lib/lithic/resources/external_payments.rb +1 -1
  42. data/lib/lithic/resources/three_ds/decisioning.rb +1 -1
  43. data/lib/lithic/resources/transaction_monitoring/cases.rb +2 -2
  44. data/lib/lithic/resources/transaction_monitoring/queues.rb +12 -2
  45. data/lib/lithic/resources/transactions.rb +4 -3
  46. data/lib/lithic/resources/webhooks.rb +1 -1
  47. data/lib/lithic/version.rb +1 -1
  48. data/lib/lithic.rb +2 -1
  49. data/rbi/lithic/models/account_activity_list_params.rbi +10 -0
  50. data/rbi/lithic/models/account_activity_list_response.rbi +10 -0
  51. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +10 -0
  52. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +8 -0
  53. data/rbi/lithic/models/auth_rules/velocity_limit_period.rbi +2 -2
  54. data/rbi/lithic/models/book_transfer_create_params.rbi +20 -0
  55. data/rbi/lithic/models/book_transfer_list_params.rbi +5 -0
  56. data/rbi/lithic/models/book_transfer_response.rbi +20 -0
  57. data/rbi/lithic/models/card_authorization.rbi +12 -10
  58. data/rbi/lithic/models/embed_session_generated_webhook_event.rbi +157 -0
  59. data/rbi/lithic/models/embed_viewed_webhook_event.rbi +146 -0
  60. data/rbi/lithic/models/event.rbi +70 -18
  61. data/rbi/lithic/models/event_list_params.rbi +31 -6
  62. data/rbi/lithic/models/event_subscription.rbi +31 -6
  63. data/rbi/lithic/models/events/subscription_create_params.rbi +31 -6
  64. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +10 -0
  65. data/rbi/lithic/models/events/subscription_update_params.rbi +31 -6
  66. data/rbi/lithic/models/external_payment_list_params.rbi +3 -3
  67. data/rbi/lithic/models/financial_accounts/balance_list_params.rbi +8 -6
  68. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +35 -0
  69. data/rbi/lithic/models/financial_event.rbi +22 -0
  70. data/rbi/lithic/models/fraud/transaction_report_response.rbi +16 -29
  71. data/rbi/lithic/models/fraud/transaction_retrieve_response.rbi +16 -29
  72. data/rbi/lithic/models/parsed_webhook_event.rbi +2 -0
  73. data/rbi/lithic/models/payment.rbi +47 -0
  74. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  75. data/rbi/lithic/models/transaction_monitoring/case_transaction.rbi +151 -46
  76. data/rbi/lithic/models/transaction_monitoring/case_update_params.rbi +8 -33
  77. data/rbi/lithic/models/transaction_monitoring/monitoring_case.rbi +7 -31
  78. data/rbi/lithic/models/transaction_monitoring/queue.rbi +10 -0
  79. data/rbi/lithic/models/transaction_monitoring/queue_create_params.rbi +12 -0
  80. data/rbi/lithic/models/transaction_monitoring/queue_update_params.rbi +14 -0
  81. data/rbi/lithic/models/transaction_simulate_clearing_params.rbi +8 -6
  82. data/rbi/lithic/models.rbi +5 -0
  83. data/rbi/lithic/resources/card_authorizations.rbi +1 -1
  84. data/rbi/lithic/resources/cards.rbi +3 -0
  85. data/rbi/lithic/resources/external_payments.rbi +1 -1
  86. data/rbi/lithic/resources/financial_accounts/balances.rbi +4 -3
  87. data/rbi/lithic/resources/three_ds/decisioning.rbi +1 -1
  88. data/rbi/lithic/resources/transaction_monitoring/cases.rbi +4 -11
  89. data/rbi/lithic/resources/transaction_monitoring/queues.rbi +11 -0
  90. data/rbi/lithic/resources/transactions.rbi +8 -6
  91. data/rbi/lithic/resources/webhooks.rbi +2 -0
  92. data/sig/lithic/models/account_activity_list_params.rbs +4 -0
  93. data/sig/lithic/models/account_activity_list_response.rbs +4 -0
  94. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +4 -0
  95. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +2 -0
  96. data/sig/lithic/models/book_transfer_create_params.rbs +8 -0
  97. data/sig/lithic/models/book_transfer_list_params.rbs +2 -0
  98. data/sig/lithic/models/book_transfer_response.rbs +8 -0
  99. data/sig/lithic/models/embed_session_generated_webhook_event.rbs +66 -0
  100. data/sig/lithic/models/embed_viewed_webhook_event.rbs +68 -0
  101. data/sig/lithic/models/event.rbs +4 -0
  102. data/sig/lithic/models/event_list_params.rbs +4 -0
  103. data/sig/lithic/models/event_subscription.rbs +4 -0
  104. data/sig/lithic/models/events/subscription_create_params.rbs +4 -0
  105. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +4 -0
  106. data/sig/lithic/models/events/subscription_update_params.rbs +4 -0
  107. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +14 -0
  108. data/sig/lithic/models/financial_event.rbs +10 -0
  109. data/sig/lithic/models/fraud/transaction_report_response.rbs +16 -26
  110. data/sig/lithic/models/fraud/transaction_retrieve_response.rbs +16 -26
  111. data/sig/lithic/models/parsed_webhook_event.rbs +2 -0
  112. data/sig/lithic/models/payment.rbs +15 -0
  113. data/sig/lithic/models/payment_list_params.rbs +2 -1
  114. data/sig/lithic/models/transaction_monitoring/case_transaction.rbs +93 -34
  115. data/sig/lithic/models/transaction_monitoring/case_update_params.rbs +5 -7
  116. data/sig/lithic/models/transaction_monitoring/monitoring_case.rbs +4 -4
  117. data/sig/lithic/models/transaction_monitoring/queue.rbs +5 -0
  118. data/sig/lithic/models/transaction_monitoring/queue_create_params.rbs +9 -1
  119. data/sig/lithic/models/transaction_monitoring/queue_update_params.rbs +10 -1
  120. data/sig/lithic/models.rbs +4 -0
  121. data/sig/lithic/resources/transaction_monitoring/cases.rbs +2 -2
  122. data/sig/lithic/resources/transaction_monitoring/queues.rbs +2 -0
  123. data/sig/lithic/resources/webhooks.rbs +2 -0
  124. metadata +8 -5
  125. data/lib/lithic/models/transaction_monitoring/resolution_outcome.rb +0 -28
  126. data/rbi/lithic/models/transaction_monitoring/resolution_outcome.rbi +0 -61
  127. data/sig/lithic/models/transaction_monitoring/resolution_outcome.rbs +0 -24
@@ -3,50 +3,127 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module TransactionMonitoring
6
+ # A single transaction associated with a case. The `category` field identifies
7
+ # whether this is a card transaction or a payment transaction.
8
+ #
6
9
  # @see Lithic::Resources::TransactionMonitoring::Cases#list_transactions
7
- class CaseTransaction < Lithic::Internal::Type::BaseModel
8
- # @!attribute token
9
- # Globally unique identifier for the transaction
10
- #
11
- # @return [String]
12
- required :token, String
13
-
14
- # @!attribute account_token
15
- # Token of the account the transaction belongs to
16
- #
17
- # @return [String]
18
- required :account_token, String
19
-
20
- # @!attribute added_at
21
- # Date and time at which the transaction was added to the case
22
- #
23
- # @return [Time]
24
- required :added_at, Time
25
-
26
- # @!attribute card_token
27
- # Token of the card the transaction was made on
28
- #
29
- # @return [String]
30
- required :card_token, String
31
-
32
- # @!attribute transaction_created_at
33
- # Date and time at which the transaction was created
34
- #
35
- # @return [Time]
36
- required :transaction_created_at, Time
37
-
38
- # @!method initialize(token:, account_token:, added_at:, card_token:, transaction_created_at:)
39
- # A single transaction associated with a case
40
- #
41
- # @param token [String] Globally unique identifier for the transaction
42
- #
43
- # @param account_token [String] Token of the account the transaction belongs to
44
- #
45
- # @param added_at [Time] Date and time at which the transaction was added to the case
46
- #
47
- # @param card_token [String] Token of the card the transaction was made on
48
- #
49
- # @param transaction_created_at [Time] Date and time at which the transaction was created
10
+ module CaseTransaction
11
+ extend Lithic::Internal::Type::Union
12
+
13
+ discriminator :category
14
+
15
+ # A card transaction associated with a case
16
+ variant -> { Lithic::TransactionMonitoring::CaseTransaction::CardCaseTransaction }
17
+
18
+ # A payment (ACH) transaction associated with a case
19
+ variant -> { Lithic::TransactionMonitoring::CaseTransaction::PaymentCaseTransaction }
20
+
21
+ class CardCaseTransaction < Lithic::Internal::Type::BaseModel
22
+ # @!attribute token
23
+ # Globally unique identifier for the card transaction
24
+ #
25
+ # @return [String]
26
+ required :token, String
27
+
28
+ # @!attribute account_token
29
+ # Token of the account the transaction belongs to
30
+ #
31
+ # @return [String]
32
+ required :account_token, String
33
+
34
+ # @!attribute added_at
35
+ # Date and time at which the transaction was added to the case
36
+ #
37
+ # @return [Time]
38
+ required :added_at, Time
39
+
40
+ # @!attribute card_token
41
+ # Token of the card the transaction was made on
42
+ #
43
+ # @return [String]
44
+ required :card_token, String
45
+
46
+ # @!attribute category
47
+ #
48
+ # @return [Symbol, :CARD]
49
+ required :category, const: :CARD
50
+
51
+ # @!attribute transaction_created_at
52
+ # Date and time at which the transaction was created
53
+ #
54
+ # @return [Time]
55
+ required :transaction_created_at, Time
56
+
57
+ # @!method initialize(token:, account_token:, added_at:, card_token:, transaction_created_at:, category: :CARD)
58
+ # A card transaction associated with a case
59
+ #
60
+ # @param token [String] Globally unique identifier for the card transaction
61
+ #
62
+ # @param account_token [String] Token of the account the transaction belongs to
63
+ #
64
+ # @param added_at [Time] Date and time at which the transaction was added to the case
65
+ #
66
+ # @param card_token [String] Token of the card the transaction was made on
67
+ #
68
+ # @param transaction_created_at [Time] Date and time at which the transaction was created
69
+ #
70
+ # @param category [Symbol, :CARD]
71
+ end
72
+
73
+ class PaymentCaseTransaction < Lithic::Internal::Type::BaseModel
74
+ # @!attribute token
75
+ # Globally unique identifier for the payment transaction
76
+ #
77
+ # @return [String]
78
+ required :token, String
79
+
80
+ # @!attribute added_at
81
+ # Date and time at which the transaction was added to the case
82
+ #
83
+ # @return [Time]
84
+ required :added_at, Time
85
+
86
+ # @!attribute category
87
+ #
88
+ # @return [Symbol, :PAYMENT]
89
+ required :category, const: :PAYMENT
90
+
91
+ # @!attribute financial_account_token
92
+ # Token of the financial account the payment belongs to
93
+ #
94
+ # @return [String]
95
+ required :financial_account_token, String
96
+
97
+ # @!attribute transaction_created_at
98
+ # Date and time at which the transaction was created
99
+ #
100
+ # @return [Time]
101
+ required :transaction_created_at, Time
102
+
103
+ # @!attribute account_token
104
+ # Token of the account the payment belongs to, if applicable
105
+ #
106
+ # @return [String, nil]
107
+ optional :account_token, String
108
+
109
+ # @!method initialize(token:, added_at:, financial_account_token:, transaction_created_at:, account_token: nil, category: :PAYMENT)
110
+ # A payment (ACH) transaction associated with a case
111
+ #
112
+ # @param token [String] Globally unique identifier for the payment transaction
113
+ #
114
+ # @param added_at [Time] Date and time at which the transaction was added to the case
115
+ #
116
+ # @param financial_account_token [String] Token of the financial account the payment belongs to
117
+ #
118
+ # @param transaction_created_at [Time] Date and time at which the transaction was created
119
+ #
120
+ # @param account_token [String] Token of the account the payment belongs to, if applicable
121
+ #
122
+ # @param category [Symbol, :PAYMENT]
123
+ end
124
+
125
+ # @!method self.variants
126
+ # @return [Array(Lithic::Models::TransactionMonitoring::CaseTransaction::CardCaseTransaction, Lithic::Models::TransactionMonitoring::CaseTransaction::PaymentCaseTransaction)]
50
127
  end
51
128
  end
52
129
  end
@@ -34,17 +34,11 @@ module Lithic
34
34
  optional :priority, enum: -> { Lithic::TransactionMonitoring::CasePriority }
35
35
 
36
36
  # @!attribute resolution
37
- # Outcome recorded when a case is resolved:
37
+ # Resolution to record on the case. Must be one of the `allowed_resolutions`
38
+ # configured on the case's queue, otherwise the request is rejected with a `400`
38
39
  #
39
- # - `CONFIRMED_FRAUD` - The reviewed activity was confirmed to be fraudulent
40
- # - `SUSPICIOUS_ACTIVITY` - The activity is suspicious but not confirmed fraud
41
- # - `FALSE_POSITIVE` - The activity was legitimate and the alert was a false
42
- # positive
43
- # - `NO_ACTION_REQUIRED` - No further action is required
44
- # - `ESCALATED_EXTERNAL` - The case was escalated to an external party
45
- #
46
- # @return [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome, nil]
47
- optional :resolution, enum: -> { Lithic::TransactionMonitoring::ResolutionOutcome }
40
+ # @return [String, nil]
41
+ optional :resolution, String
48
42
 
49
43
  # @!attribute resolution_notes
50
44
  # Notes describing the resolution
@@ -97,7 +91,7 @@ module Lithic
97
91
  #
98
92
  # @param priority [Symbol, Lithic::Models::TransactionMonitoring::CasePriority] Priority level of a case, controlling queue ordering and SLA urgency
99
93
  #
100
- # @param resolution [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome] Outcome recorded when a case is resolved:
94
+ # @param resolution [String] Resolution to record on the case. Must be one of the
101
95
  #
102
96
  # @param resolution_notes [String] Notes describing the resolution
103
97
  #
@@ -54,17 +54,11 @@ module Lithic
54
54
  required :queue_token, String
55
55
 
56
56
  # @!attribute resolution
57
- # Outcome recorded when a case is resolved:
57
+ # Outcome recorded when the case was resolved, from the `allowed_resolutions`
58
+ # configured on the case's queue
58
59
  #
59
- # - `CONFIRMED_FRAUD` - The reviewed activity was confirmed to be fraudulent
60
- # - `SUSPICIOUS_ACTIVITY` - The activity is suspicious but not confirmed fraud
61
- # - `FALSE_POSITIVE` - The activity was legitimate and the alert was a false
62
- # positive
63
- # - `NO_ACTION_REQUIRED` - No further action is required
64
- # - `ESCALATED_EXTERNAL` - The case was escalated to an external party
65
- #
66
- # @return [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome, nil]
67
- required :resolution, enum: -> { Lithic::TransactionMonitoring::ResolutionOutcome }, nil?: true
60
+ # @return [String, nil]
61
+ required :resolution, String, nil?: true
68
62
 
69
63
  # @!attribute resolution_notes
70
64
  # Free-form notes describing the resolution
@@ -145,7 +139,7 @@ module Lithic
145
139
  #
146
140
  # @param queue_token [String] Token of the queue the case belongs to
147
141
  #
148
- # @param resolution [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome, nil] Outcome recorded when a case is resolved:
142
+ # @param resolution [String, nil] Outcome recorded when the case was resolved, from the `allowed_resolutions`
149
143
  #
150
144
  # @param resolution_notes [String, nil] Free-form notes describing the resolution
151
145
  #
@@ -11,6 +11,13 @@ module Lithic
11
11
  # @return [String]
12
12
  required :token, String
13
13
 
14
+ # @!attribute allowed_resolutions
15
+ # Resolutions that can be recorded on cases in this queue. Always the effective
16
+ # list: the queue's own values when it defines them, otherwise the default list
17
+ #
18
+ # @return [Array<String>]
19
+ required :allowed_resolutions, Lithic::Internal::Type::ArrayOf[String]
20
+
14
21
  # @!attribute case_counts
15
22
  # Number of cases in the queue, broken down by status. A status is omitted when
16
23
  # the queue has no cases in that status
@@ -42,7 +49,7 @@ module Lithic
42
49
  # @return [Time]
43
50
  required :updated, Time
44
51
 
45
- # @!method initialize(token:, case_counts:, created:, description:, name:, updated:)
52
+ # @!method initialize(token:, allowed_resolutions:, case_counts:, created:, description:, name:, updated:)
46
53
  # Some parameter documentations has been truncated, see
47
54
  # {Lithic::Models::TransactionMonitoring::Queue} for more details.
48
55
  #
@@ -50,6 +57,8 @@ module Lithic
50
57
  #
51
58
  # @param token [String] Globally unique identifier for the queue
52
59
  #
60
+ # @param allowed_resolutions [Array<String>] Resolutions that can be recorded on cases in this queue. Always the effective
61
+ #
53
62
  # @param case_counts [Lithic::Models::TransactionMonitoring::Queue::CaseCounts] Number of cases in the queue, broken down by status. A status is omitted
54
63
  #
55
64
  # @param created [Time] Date and time at which the queue was created
@@ -14,15 +14,28 @@ module Lithic
14
14
  # @return [String]
15
15
  required :name, String
16
16
 
17
+ # @!attribute allowed_resolutions
18
+ # Resolutions that can be recorded on cases in this queue. Omit or send `null` to
19
+ # use the default list. Values are free-form labels and must be non-empty and
20
+ # unique
21
+ #
22
+ # @return [Array<String>, nil]
23
+ optional :allowed_resolutions, Lithic::Internal::Type::ArrayOf[String], nil?: true
24
+
17
25
  # @!attribute description
18
26
  # Optional description of the queue
19
27
  #
20
28
  # @return [String, nil]
21
29
  optional :description, String, nil?: true
22
30
 
23
- # @!method initialize(name:, description: nil, request_options: {})
31
+ # @!method initialize(name:, allowed_resolutions: nil, description: nil, request_options: {})
32
+ # Some parameter documentations has been truncated, see
33
+ # {Lithic::Models::TransactionMonitoring::QueueCreateParams} for more details.
34
+ #
24
35
  # @param name [String] Human-readable name of the queue
25
36
  #
37
+ # @param allowed_resolutions [Array<String>, nil] Resolutions that can be recorded on cases in this queue. Omit or send `null` to
38
+ #
26
39
  # @param description [String, nil] Optional description of the queue
27
40
  #
28
41
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
@@ -13,6 +13,15 @@ module Lithic
13
13
  # @return [String]
14
14
  required :queue_token, String
15
15
 
16
+ # @!attribute allowed_resolutions
17
+ # New list of resolutions that can be recorded on cases in this queue, or `null`
18
+ # to revert to the default list. Values are free-form labels and must be non-empty
19
+ # and unique. Changing the list only affects what is selectable going forward; the
20
+ # `resolution` already stored on a case is preserved as-is
21
+ #
22
+ # @return [Array<String>, nil]
23
+ optional :allowed_resolutions, Lithic::Internal::Type::ArrayOf[String], nil?: true
24
+
16
25
  # @!attribute description
17
26
  # New description for the queue, or `null` to clear it
18
27
  #
@@ -25,9 +34,14 @@ module Lithic
25
34
  # @return [String, nil]
26
35
  optional :name, String
27
36
 
28
- # @!method initialize(queue_token:, description: nil, name: nil, request_options: {})
37
+ # @!method initialize(queue_token:, allowed_resolutions: nil, description: nil, name: nil, request_options: {})
38
+ # Some parameter documentations has been truncated, see
39
+ # {Lithic::Models::TransactionMonitoring::QueueUpdateParams} for more details.
40
+ #
29
41
  # @param queue_token [String]
30
42
  #
43
+ # @param allowed_resolutions [Array<String>, nil] New list of resolutions that can be recorded on cases in this queue, or `null` t
44
+ #
31
45
  # @param description [String, nil] New description for the queue, or `null` to clear it
32
46
  #
33
47
  # @param name [String] New name for the queue
@@ -20,9 +20,10 @@ module Lithic
20
20
  # example, entering 100 in this field will result in a -100 amount in the
21
21
  # transaction, if the original authorization is a credit authorization.
22
22
  #
23
- # If `amount` is not set, the full amount of the transaction will be cleared.
24
- # Transactions that have already cleared, either partially or fully, cannot be
25
- # cleared again using this endpoint.
23
+ # If `amount` is not set, the full amount of the transaction will be cleared. This
24
+ # endpoint may be called multiple times against the same authorization to simulate
25
+ # a multiple-completion scenario, with each call creating a separate clearing
26
+ # event.
26
27
  #
27
28
  # @return [Integer, nil]
28
29
  optional :amount, Integer
data/lib/lithic/models.rb CHANGED
@@ -290,6 +290,10 @@ module Lithic
290
290
 
291
291
  Document = Lithic::Models::Document
292
292
 
293
+ EmbedSessionGeneratedWebhookEvent = Lithic::Models::EmbedSessionGeneratedWebhookEvent
294
+
295
+ EmbedViewedWebhookEvent = Lithic::Models::EmbedViewedWebhookEvent
296
+
293
297
  Event = Lithic::Models::Event
294
298
 
295
299
  EventListAttemptsParams = Lithic::Models::EventListAttemptsParams
@@ -8,7 +8,7 @@ module Lithic
8
8
  #
9
9
  # Card program's response to Authorization Challenge. Programs that have
10
10
  # Authorization Challenges configured as Out of Band receive a
11
- # [card_authorization.challenge](https://docs.lithic.com/reference/post_card-authorization-challenge)
11
+ # [card_authorization.challenge](https://docs.lithic.com/reference/cardauthorizationchallengewebhook)
12
12
  # webhook when an authorization attempt triggers a challenge. The card program
13
13
  # should respond using this endpoint after the cardholder completes the challenge.
14
14
  #
@@ -228,6 +228,11 @@ module Lithic
228
228
  )
229
229
  end
230
230
 
231
+ # @deprecated
232
+ #
233
+ # **Deprecated.** Use the modern embedded card flow instead: create a session with
234
+ # `POST /v1/cards/{card_token}/embed` and render it via `GET /v1/embed`.
235
+ #
231
236
  # Handling full card PANs and CVV codes requires that you comply with the Payment
232
237
  # Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce
233
238
  # their compliance obligations by leveraging our embedded card UI solution
@@ -75,7 +75,7 @@ module Lithic
75
75
  #
76
76
  # @param business_account_token [String]
77
77
  #
78
- # @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category] External Payment category to be returned.
78
+ # @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category] The external rail the funds moved on
79
79
  #
80
80
  # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
81
81
  #
@@ -9,7 +9,7 @@ module Lithic
9
9
  #
10
10
  # Card program's response to a 3DS Challenge Request. Challenge Request is emitted
11
11
  # as a webhook
12
- # [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge)
12
+ # [three_ds_authentication.challenge](https://docs.lithic.com/reference/threedsauthenticationchallengewebhook)
13
13
  # and your Card Program needs to be configured with Out of Band (OOB) Challenges
14
14
  # in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for
15
15
  # more information).
@@ -45,7 +45,7 @@ module Lithic
45
45
  #
46
46
  # @param priority [Symbol, Lithic::Models::TransactionMonitoring::CasePriority] Priority level of a case, controlling queue ordering and SLA urgency
47
47
  #
48
- # @param resolution [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome] Outcome recorded when a case is resolved:
48
+ # @param resolution [String] Resolution to record on the case. Must be one of the
49
49
  #
50
50
  # @param resolution_notes [String] Notes describing the resolution
51
51
  #
@@ -178,7 +178,7 @@ module Lithic
178
178
  #
179
179
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
180
180
  #
181
- # @return [Lithic::Internal::CursorPage<Lithic::Models::TransactionMonitoring::CaseTransaction>]
181
+ # @return [Lithic::Internal::CursorPage<Lithic::Models::TransactionMonitoring::CaseTransaction::CardCaseTransaction, Lithic::Models::TransactionMonitoring::CaseTransaction::PaymentCaseTransaction>]
182
182
  #
183
183
  # @see Lithic::Models::TransactionMonitoring::CaseListTransactionsParams
184
184
  def list_transactions(case_token, params = {})
@@ -4,12 +4,17 @@ module Lithic
4
4
  module Resources
5
5
  class TransactionMonitoring
6
6
  class Queues
7
+ # Some parameter documentations has been truncated, see
8
+ # {Lithic::Models::TransactionMonitoring::QueueCreateParams} for more details.
9
+ #
7
10
  # Creates a new queue for grouping transaction monitoring cases.
8
11
  #
9
- # @overload create(name:, description: nil, request_options: {})
12
+ # @overload create(name:, allowed_resolutions: nil, description: nil, request_options: {})
10
13
  #
11
14
  # @param name [String] Human-readable name of the queue
12
15
  #
16
+ # @param allowed_resolutions [Array<String>, nil] Resolutions that can be recorded on cases in this queue. Omit or send `null` to
17
+ #
13
18
  # @param description [String, nil] Optional description of the queue
14
19
  #
15
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -48,12 +53,17 @@ module Lithic
48
53
  )
49
54
  end
50
55
 
56
+ # Some parameter documentations has been truncated, see
57
+ # {Lithic::Models::TransactionMonitoring::QueueUpdateParams} for more details.
58
+ #
51
59
  # Updates a transaction monitoring queue.
52
60
  #
53
- # @overload update(queue_token, description: nil, name: nil, request_options: {})
61
+ # @overload update(queue_token, allowed_resolutions: nil, description: nil, name: nil, request_options: {})
54
62
  #
55
63
  # @param queue_token [String] Globally unique identifier for the queue.
56
64
  #
65
+ # @param allowed_resolutions [Array<String>, nil] New list of resolutions that can be recorded on cases in this queue, or `null` t
66
+ #
57
67
  # @param description [String, nil] New description for the queue, or `null` to clear it
58
68
  #
59
69
  # @param name [String] New name for the queue
@@ -210,9 +210,10 @@ module Lithic
210
210
  # Clears an existing authorization, either debit or credit. After this event, the
211
211
  # transaction transitions from `PENDING` to `SETTLED` status.
212
212
  #
213
- # If `amount` is not set, the full amount of the transaction will be cleared.
214
- # Transactions that have already cleared, either partially or fully, cannot be
215
- # cleared again using this endpoint.
213
+ # If `amount` is not set, the full amount of the transaction will be cleared. This
214
+ # endpoint may be called multiple times against the same authorization to simulate
215
+ # a multiple-completion scenario, with each call creating a separate clearing
216
+ # event.
216
217
  #
217
218
  # @overload simulate_clearing(token:, amount: nil, request_options: {})
218
219
  #
@@ -9,7 +9,7 @@ module Lithic
9
9
  # @param headers [Hash{String => String}] The webhook request headers
10
10
  # @param secret [String, nil] The webhook secret. If not provided, reads from LITHIC_WEBHOOK_SECRET environment variable.
11
11
  #
12
- # @return [Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::CardAuthorizationChallengeWebhookEvent, Lithic::Models::CardAuthorizationChallengeResponseWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::ClaimCreatedWebhookEvent, Lithic::Models::ClaimUpdatedWebhookEvent, Lithic::Models::ClaimDocumentUploadedWebhookEvent, Lithic::Models::ClaimDocumentAcceptedWebhookEvent, Lithic::Models::ClaimDocumentRejectedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent] #
12
+ # @return [Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::CardAuthorizationChallengeWebhookEvent, Lithic::Models::CardAuthorizationChallengeResponseWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::ClaimCreatedWebhookEvent, Lithic::Models::ClaimUpdatedWebhookEvent, Lithic::Models::ClaimDocumentUploadedWebhookEvent, Lithic::Models::ClaimDocumentAcceptedWebhookEvent, Lithic::Models::ClaimDocumentRejectedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::EmbedSessionGeneratedWebhookEvent, Lithic::Models::EmbedViewedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent] #
13
13
  # @raise [ArgumentError] if secret is not provided and LITHIC_WEBHOOK_SECRET env var is not set
14
14
  # @raise [Lithic::Errors::MissingDependencyError] if the standardwebhooks gem is not installed
15
15
  # @raise [StandardWebhooks::WebhookVerificationError] if the signature is invalid
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Lithic
4
- VERSION = "0.18.0"
4
+ VERSION = "0.19.0"
5
5
  end
data/lib/lithic.rb CHANGED
@@ -256,6 +256,8 @@ require_relative "lithic/models/dispute_transaction_updated_webhook_event"
256
256
  require_relative "lithic/models/dispute_updated_webhook_event"
257
257
  require_relative "lithic/models/dispute_update_params"
258
258
  require_relative "lithic/models/document"
259
+ require_relative "lithic/models/embed_session_generated_webhook_event"
260
+ require_relative "lithic/models/embed_viewed_webhook_event"
259
261
  require_relative "lithic/models/event"
260
262
  require_relative "lithic/models/event_list_attempts_params"
261
263
  require_relative "lithic/models/event_list_params"
@@ -484,7 +486,6 @@ require_relative "lithic/models/transaction_monitoring/queue_delete_params"
484
486
  require_relative "lithic/models/transaction_monitoring/queue_list_params"
485
487
  require_relative "lithic/models/transaction_monitoring/queue_retrieve_params"
486
488
  require_relative "lithic/models/transaction_monitoring/queue_update_params"
487
- require_relative "lithic/models/transaction_monitoring/resolution_outcome"
488
489
  require_relative "lithic/models/transaction_retrieve_params"
489
490
  require_relative "lithic/models/transaction_route_params"
490
491
  require_relative "lithic/models/transactions/enhanced_commercial_data_retrieve_params"
@@ -193,6 +193,11 @@ module Lithic
193
193
  :WIRE,
194
194
  Lithic::AccountActivityListParams::Category::TaggedSymbol
195
195
  )
196
+ STABLECOIN =
197
+ T.let(
198
+ :STABLECOIN,
199
+ Lithic::AccountActivityListParams::Category::TaggedSymbol
200
+ )
196
201
  BALANCE_OR_FUNDING =
197
202
  T.let(
198
203
  :BALANCE_OR_FUNDING,
@@ -290,6 +295,11 @@ module Lithic
290
295
  :PROGRAM_FUNDING,
291
296
  Lithic::AccountActivityListParams::Category::TaggedSymbol
292
297
  )
298
+ PROGRAM_TRANSFER =
299
+ T.let(
300
+ :PROGRAM_TRANSFER,
301
+ Lithic::AccountActivityListParams::Category::TaggedSymbol
302
+ )
293
303
 
294
304
  sig do
295
305
  override.returns(
@@ -196,6 +196,11 @@ module Lithic
196
196
  :WIRE,
197
197
  Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
198
198
  )
199
+ STABLECOIN =
200
+ T.let(
201
+ :STABLECOIN,
202
+ Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
203
+ )
199
204
  BALANCE_OR_FUNDING =
200
205
  T.let(
201
206
  :BALANCE_OR_FUNDING,
@@ -296,6 +301,11 @@ module Lithic
296
301
  :PROGRAM_FUNDING,
297
302
  Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
298
303
  )
304
+ PROGRAM_TRANSFER =
305
+ T.let(
306
+ :PROGRAM_TRANSFER,
307
+ Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
308
+ )
299
309
 
300
310
  sig do
301
311
  override.returns(
@@ -196,6 +196,11 @@ module Lithic
196
196
  :WIRE,
197
197
  Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
198
198
  )
199
+ STABLECOIN =
200
+ T.let(
201
+ :STABLECOIN,
202
+ Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
203
+ )
199
204
  BALANCE_OR_FUNDING =
200
205
  T.let(
201
206
  :BALANCE_OR_FUNDING,
@@ -296,6 +301,11 @@ module Lithic
296
301
  :PROGRAM_FUNDING,
297
302
  Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
298
303
  )
304
+ PROGRAM_TRANSFER =
305
+ T.let(
306
+ :PROGRAM_TRANSFER,
307
+ Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
308
+ )
299
309
 
300
310
  sig do
301
311
  override.returns(
@@ -654,6 +654,7 @@ module Lithic
654
654
  # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
655
655
  # (Telephone-Initiated Entry), and others.
656
656
  # - `MEMO`: Optional memo or description field included with the ACH transaction.
657
+ # - `RECIPIENT_NAME`: The name of the recipient of the ACH transaction.
657
658
  sig do
658
659
  returns(
659
660
  Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::OrSymbol
@@ -693,6 +694,7 @@ module Lithic
693
694
  # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
694
695
  # (Telephone-Initiated Entry), and others.
695
696
  # - `MEMO`: Optional memo or description field included with the ACH transaction.
697
+ # - `RECIPIENT_NAME`: The name of the recipient of the ACH transaction.
696
698
  attribute:,
697
699
  # The operation to apply to the attribute
698
700
  operation:,
@@ -729,6 +731,7 @@ module Lithic
729
731
  # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL
730
732
  # (Telephone-Initiated Entry), and others.
731
733
  # - `MEMO`: Optional memo or description field included with the ACH transaction.
734
+ # - `RECIPIENT_NAME`: The name of the recipient of the ACH transaction.
732
735
  module Attribute
733
736
  extend Lithic::Internal::Type::Enum
734
737
 
@@ -771,6 +774,11 @@ module Lithic
771
774
  :MEMO,
772
775
  Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol
773
776
  )
777
+ RECIPIENT_NAME =
778
+ T.let(
779
+ :RECIPIENT_NAME,
780
+ Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol
781
+ )
774
782
 
775
783
  sig do
776
784
  override.returns(