lithic 0.13.0 → 0.15.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 (145) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/internal/transport/base_client.rb +2 -0
  6. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +4 -4
  7. data/lib/lithic/models/account_retrieve_signals_params.rb +20 -0
  8. data/lib/lithic/models/auth_rules/auth_rule.rb +10 -6
  9. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +2 -2
  10. data/lib/lithic/models/auth_rules/auth_rule_version.rb +5 -3
  11. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -6
  12. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +4 -4
  13. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +119 -44
  14. data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +533 -0
  15. data/lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb +18 -14
  16. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +6 -6
  17. data/lib/lithic/models/auth_rules/conditional_value.rb +3 -2
  18. data/lib/lithic/models/auth_rules/v2_create_params.rb +15 -9
  19. data/lib/lithic/models/auth_rules/v2_draft_params.rb +5 -3
  20. data/lib/lithic/models/balance.rb +8 -6
  21. data/lib/lithic/models/card_authorization.rb +1266 -0
  22. data/lib/lithic/models/card_authorization_approval_request_webhook_event.rb +3 -1253
  23. data/lib/lithic/models/card_authorization_challenge_response_params.rb +40 -0
  24. data/lib/lithic/models/card_authorization_challenge_response_webhook_event.rb +1 -0
  25. data/lib/lithic/models/card_authorization_challenge_webhook_event.rb +67 -0
  26. data/lib/lithic/models/card_program.rb +2 -2
  27. data/lib/lithic/models/card_retrieve_signals_params.rb +20 -0
  28. data/lib/lithic/models/event.rb +13 -4
  29. data/lib/lithic/models/event_list_params.rb +7 -2
  30. data/lib/lithic/models/event_subscription.rb +7 -2
  31. data/lib/lithic/models/events/subscription_create_params.rb +7 -2
  32. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  33. data/lib/lithic/models/events/subscription_update_params.rb +7 -2
  34. data/lib/lithic/models/external_bank_account.rb +1 -1
  35. data/lib/lithic/models/external_bank_account_pause_params.rb +20 -0
  36. data/lib/lithic/models/financial_accounts/statement.rb +4 -4
  37. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +3 -2
  38. data/lib/lithic/models/financial_event.rb +1 -0
  39. data/lib/lithic/models/kyb_business_entity.rb +2 -2
  40. data/lib/lithic/models/parsed_webhook_event.rb +4 -1
  41. data/lib/lithic/models/settlement_detail.rb +14 -14
  42. data/lib/lithic/models/signals_response.rb +306 -0
  43. data/lib/lithic/models/statement_totals.rb +6 -6
  44. data/lib/lithic/models/tokenization_decline_reason.rb +1 -0
  45. data/lib/lithic/models/transaction.rb +2 -2
  46. data/lib/lithic/models/transfer_limits_response.rb +12 -12
  47. data/lib/lithic/models.rb +14 -0
  48. data/lib/lithic/resources/accounts.rb +27 -0
  49. data/lib/lithic/resources/auth_rules/v2.rb +1 -1
  50. data/lib/lithic/resources/card_authorizations.rb +45 -0
  51. data/lib/lithic/resources/cards.rb +25 -0
  52. data/lib/lithic/resources/external_bank_accounts.rb +19 -0
  53. data/lib/lithic/resources/webhooks.rb +1 -1
  54. data/lib/lithic/version.rb +1 -1
  55. data/lib/lithic.rb +9 -0
  56. data/rbi/lithic/client.rbi +3 -0
  57. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +6 -12
  58. data/rbi/lithic/models/account_retrieve_signals_params.rbi +35 -0
  59. data/rbi/lithic/models/auth_rules/auth_rule.rbi +8 -4
  60. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +4 -2
  61. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +9 -6
  62. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +3 -3
  63. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +214 -63
  64. data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +1147 -0
  65. data/rbi/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rbi +24 -18
  66. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +6 -6
  67. data/rbi/lithic/models/auth_rules/conditional_value.rbi +1 -1
  68. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +24 -12
  69. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +8 -4
  70. data/rbi/lithic/models/balance.rbi +12 -6
  71. data/rbi/lithic/models/card_authorization.rbi +2540 -0
  72. data/rbi/lithic/models/card_authorization_approval_request_webhook_event.rbi +5 -2758
  73. data/rbi/lithic/models/card_authorization_challenge_response_params.rbi +93 -0
  74. data/rbi/lithic/models/card_authorization_challenge_response_webhook_event.rbi +5 -0
  75. data/rbi/lithic/models/card_authorization_challenge_webhook_event.rbi +119 -0
  76. data/rbi/lithic/models/card_program.rbi +3 -6
  77. data/rbi/lithic/models/card_retrieve_signals_params.rbi +35 -0
  78. data/rbi/lithic/models/event.rbi +23 -6
  79. data/rbi/lithic/models/event_list_params.rbi +11 -2
  80. data/rbi/lithic/models/event_subscription.rbi +11 -2
  81. data/rbi/lithic/models/events/subscription_create_params.rbi +11 -2
  82. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
  83. data/rbi/lithic/models/events/subscription_update_params.rbi +11 -2
  84. data/rbi/lithic/models/external_bank_account_pause_params.rbi +41 -0
  85. data/rbi/lithic/models/financial_accounts/statement.rbi +6 -12
  86. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +8 -6
  87. data/rbi/lithic/models/financial_event.rbi +2 -0
  88. data/rbi/lithic/models/kyb_business_entity.rbi +3 -6
  89. data/rbi/lithic/models/parsed_webhook_event.rbi +1 -0
  90. data/rbi/lithic/models/settlement_detail.rbi +15 -15
  91. data/rbi/lithic/models/signals_response.rbi +352 -0
  92. data/rbi/lithic/models/statement_totals.rbi +9 -18
  93. data/rbi/lithic/models/tokenization_decline_reason.rbi +2 -0
  94. data/rbi/lithic/models/transaction.rbi +3 -3
  95. data/rbi/lithic/models/transfer_limits_response.rbi +48 -48
  96. data/rbi/lithic/models.rbi +17 -0
  97. data/rbi/lithic/resources/accounts.rbi +21 -0
  98. data/rbi/lithic/resources/auth_rules/v2.rbi +2 -1
  99. data/rbi/lithic/resources/card_authorizations.rbi +35 -0
  100. data/rbi/lithic/resources/cards.rbi +19 -0
  101. data/rbi/lithic/resources/external_bank_accounts.rbi +10 -0
  102. data/rbi/lithic/resources/webhooks.rbi +4 -1
  103. data/sig/lithic/client.rbs +2 -0
  104. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +8 -12
  105. data/sig/lithic/models/account_retrieve_signals_params.rbs +23 -0
  106. data/sig/lithic/models/auth_rules/auth_rule.rbs +2 -0
  107. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -0
  108. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +29 -3
  109. data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +276 -0
  110. data/sig/lithic/models/auth_rules/conditional_value.rbs +1 -1
  111. data/sig/lithic/models/auth_rules/v2_create_params.rbs +3 -0
  112. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -0
  113. data/sig/lithic/models/balance.rbs +17 -9
  114. data/sig/lithic/models/card_authorization.rbs +1038 -0
  115. data/sig/lithic/models/card_authorization_approval_request_webhook_event.rbs +7 -1013
  116. data/sig/lithic/models/card_authorization_challenge_response_params.rbs +42 -0
  117. data/sig/lithic/models/card_authorization_challenge_response_webhook_event.rbs +2 -1
  118. data/sig/lithic/models/card_authorization_challenge_webhook_event.rbs +53 -0
  119. data/sig/lithic/models/card_program.rbs +4 -6
  120. data/sig/lithic/models/card_retrieve_signals_params.rbs +23 -0
  121. data/sig/lithic/models/event.rbs +2 -0
  122. data/sig/lithic/models/event_list_params.rbs +2 -0
  123. data/sig/lithic/models/event_subscription.rbs +2 -0
  124. data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
  125. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
  126. data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
  127. data/sig/lithic/models/external_bank_account_pause_params.rbs +24 -0
  128. data/sig/lithic/models/financial_accounts/statement.rbs +8 -12
  129. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +6 -6
  130. data/sig/lithic/models/financial_event.rbs +2 -0
  131. data/sig/lithic/models/kyb_business_entity.rbs +4 -6
  132. data/sig/lithic/models/parsed_webhook_event.rbs +1 -0
  133. data/sig/lithic/models/settlement_detail.rbs +18 -18
  134. data/sig/lithic/models/signals_response.rbs +170 -0
  135. data/sig/lithic/models/statement_totals.rbs +12 -18
  136. data/sig/lithic/models/tokenization_decline_reason.rbs +2 -0
  137. data/sig/lithic/models/transaction.rbs +4 -8
  138. data/sig/lithic/models/transfer_limits_response.rbs +24 -36
  139. data/sig/lithic/models.rbs +14 -0
  140. data/sig/lithic/resources/accounts.rbs +5 -0
  141. data/sig/lithic/resources/card_authorizations.rbs +13 -0
  142. data/sig/lithic/resources/cards.rbs +5 -0
  143. data/sig/lithic/resources/external_bank_accounts.rbs +5 -0
  144. data/sig/lithic/resources/webhooks.rbs +1 -0
  145. metadata +29 -2
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::CardAuthorizations#challenge_response
6
+ class CardAuthorizationChallengeResponseParams < Lithic::Internal::Type::BaseModel
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
8
+ include Lithic::Internal::Type::RequestParameters
9
+
10
+ # @!attribute event_token
11
+ #
12
+ # @return [String]
13
+ required :event_token, String
14
+
15
+ # @!attribute response
16
+ # Whether the cardholder has approved or declined the issued challenge
17
+ #
18
+ # @return [Symbol, Lithic::Models::CardAuthorizationChallengeResponseParams::Response]
19
+ required :response, enum: -> { Lithic::CardAuthorizationChallengeResponseParams::Response }
20
+
21
+ # @!method initialize(event_token:, response:, request_options: {})
22
+ # @param event_token [String]
23
+ #
24
+ # @param response [Symbol, Lithic::Models::CardAuthorizationChallengeResponseParams::Response] Whether the cardholder has approved or declined the issued challenge
25
+ #
26
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
27
+
28
+ # Whether the cardholder has approved or declined the issued challenge
29
+ module Response
30
+ extend Lithic::Internal::Type::Enum
31
+
32
+ APPROVE = :APPROVE
33
+ DECLINE = :DECLINE
34
+
35
+ # @!method self.values
36
+ # @return [Array<Symbol>]
37
+ end
38
+ end
39
+ end
40
+ end
@@ -81,6 +81,7 @@ module Lithic
81
81
  extend Lithic::Internal::Type::Enum
82
82
 
83
83
  SMS = :SMS
84
+ OUT_OF_BAND = :OUT_OF_BAND
84
85
 
85
86
  # @!method self.values
86
87
  # @return [Array<Symbol>]
@@ -0,0 +1,67 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class CardAuthorizationChallengeWebhookEvent < Lithic::Internal::Type::BaseModel
6
+ # @!attribute authorization
7
+ # The authorization that triggered the challenge
8
+ #
9
+ # @return [Lithic::Models::CardAuthorization]
10
+ required :authorization, -> { Lithic::CardAuthorization }
11
+
12
+ # @!attribute challenge
13
+ # Details of the Authorization Challenge issued during card authorization
14
+ #
15
+ # @return [Lithic::Models::CardAuthorizationChallengeWebhookEvent::Challenge]
16
+ required :challenge, -> { Lithic::CardAuthorizationChallengeWebhookEvent::Challenge }
17
+
18
+ # @!attribute event_type
19
+ # The type of event that occurred.
20
+ #
21
+ # @return [Symbol, :"card_authorization.challenge"]
22
+ required :event_type, const: :"card_authorization.challenge"
23
+
24
+ # @!method initialize(authorization:, challenge:, event_type: :"card_authorization.challenge")
25
+ # @param authorization [Lithic::Models::CardAuthorization] The authorization that triggered the challenge
26
+ #
27
+ # @param challenge [Lithic::Models::CardAuthorizationChallengeWebhookEvent::Challenge] Details of the Authorization Challenge issued during card authorization
28
+ #
29
+ # @param event_type [Symbol, :"card_authorization.challenge"] The type of event that occurred.
30
+
31
+ # @see Lithic::Models::CardAuthorizationChallengeWebhookEvent#challenge
32
+ class Challenge < Lithic::Internal::Type::BaseModel
33
+ # @!attribute event_token
34
+ # Globally unique identifier for the event that triggered the challenge. Use this
35
+ # token when calling the challenge response endpoint
36
+ #
37
+ # @return [String]
38
+ required :event_token, String
39
+
40
+ # @!attribute expiry_time
41
+ # ISO-8601 time at which the challenge expires
42
+ #
43
+ # @return [Time]
44
+ required :expiry_time, Time
45
+
46
+ # @!attribute start_time
47
+ # ISO-8601 time at which the challenge was issued
48
+ #
49
+ # @return [Time]
50
+ required :start_time, Time
51
+
52
+ # @!method initialize(event_token:, expiry_time:, start_time:)
53
+ # Some parameter documentations has been truncated, see
54
+ # {Lithic::Models::CardAuthorizationChallengeWebhookEvent::Challenge} for more
55
+ # details.
56
+ #
57
+ # Details of the Authorization Challenge issued during card authorization
58
+ #
59
+ # @param event_token [String] Globally unique identifier for the event that triggered the challenge. Use this
60
+ #
61
+ # @param expiry_time [Time] ISO-8601 time at which the challenge expires
62
+ #
63
+ # @param start_time [Time] ISO-8601 time at which the challenge was issued
64
+ end
65
+ end
66
+ end
67
+ end
@@ -45,7 +45,7 @@ module Lithic
45
45
  # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
46
46
  #
47
47
  # @return [String, nil]
48
- optional :cardholder_currency, String
48
+ optional :cardholder_currency, String, nil?: true
49
49
 
50
50
  # @!attribute settlement_currencies
51
51
  # List of 3-character alphabetic ISO 4217 codes for the currencies that the card
@@ -70,7 +70,7 @@ module Lithic
70
70
  #
71
71
  # @param pan_range_start [String] The first digits of the card number that this card program starts with.
72
72
  #
73
- # @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
73
+ # @param cardholder_currency [String, nil] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
74
74
  #
75
75
  # @param settlement_currencies [Array<String>] List of 3-character alphabetic ISO 4217 codes for the currencies that the card p
76
76
  end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::Cards#retrieve_signals
6
+ class CardRetrieveSignalsParams < Lithic::Internal::Type::BaseModel
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
8
+ include Lithic::Internal::Type::RequestParameters
9
+
10
+ # @!attribute card_token
11
+ #
12
+ # @return [String]
13
+ required :card_token, String
14
+
15
+ # @!method initialize(card_token:, request_options: {})
16
+ # @param card_token [String]
17
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -33,8 +33,12 @@ module Lithic
33
33
  # created.
34
34
  # - book_transfer_transaction.updated: Occurs when a book transfer transaction is
35
35
  # updated.
36
- # - card_authorization.challenge_response: Occurs when a cardholder responds to an
37
- # SMS challenge during card authorization.
36
+ # - card_authorization.challenge: Occurs when an Out of Band challenge is issued
37
+ # during card authorization. The card program should issue its own challenge to
38
+ # the cardholder and then respond via
39
+ # [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge).
40
+ # - card_authorization.challenge_response: Occurs when a cardholder responds to a
41
+ # challenge during card authorization.
38
42
  # - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
39
43
  # data is processed for a transaction event.
40
44
  # - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
@@ -156,8 +160,12 @@ module Lithic
156
160
  # created.
157
161
  # - book_transfer_transaction.updated: Occurs when a book transfer transaction is
158
162
  # updated.
159
- # - card_authorization.challenge_response: Occurs when a cardholder responds to an
160
- # SMS challenge during card authorization.
163
+ # - card_authorization.challenge: Occurs when an Out of Band challenge is issued
164
+ # during card authorization. The card program should issue its own challenge to
165
+ # the cardholder and then respond via
166
+ # [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge).
167
+ # - card_authorization.challenge_response: Occurs when a cardholder responds to a
168
+ # challenge during card authorization.
161
169
  # - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
162
170
  # data is processed for a transaction event.
163
171
  # - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
@@ -255,6 +263,7 @@ module Lithic
255
263
  BALANCE_UPDATED = :"balance.updated"
256
264
  BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
257
265
  BOOK_TRANSFER_TRANSACTION_UPDATED = :"book_transfer_transaction.updated"
266
+ CARD_AUTHORIZATION_CHALLENGE = :"card_authorization.challenge"
258
267
  CARD_AUTHORIZATION_CHALLENGE_RESPONSE = :"card_authorization.challenge_response"
259
268
  CARD_TRANSACTION_ENHANCED_DATA_CREATED = :"card_transaction.enhanced_data.created"
260
269
  CARD_TRANSACTION_ENHANCED_DATA_UPDATED = :"card_transaction.enhanced_data.updated"
@@ -87,8 +87,12 @@ module Lithic
87
87
  # created.
88
88
  # - book_transfer_transaction.updated: Occurs when a book transfer transaction is
89
89
  # updated.
90
- # - card_authorization.challenge_response: Occurs when a cardholder responds to an
91
- # SMS challenge during card authorization.
90
+ # - card_authorization.challenge: Occurs when an Out of Band challenge is issued
91
+ # during card authorization. The card program should issue its own challenge to
92
+ # the cardholder and then respond via
93
+ # [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge).
94
+ # - card_authorization.challenge_response: Occurs when a cardholder responds to a
95
+ # challenge during card authorization.
92
96
  # - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
93
97
  # data is processed for a transaction event.
94
98
  # - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
@@ -184,6 +188,7 @@ module Lithic
184
188
  BALANCE_UPDATED = :"balance.updated"
185
189
  BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
186
190
  BOOK_TRANSFER_TRANSACTION_UPDATED = :"book_transfer_transaction.updated"
191
+ CARD_AUTHORIZATION_CHALLENGE = :"card_authorization.challenge"
187
192
  CARD_AUTHORIZATION_CHALLENGE_RESPONSE = :"card_authorization.challenge_response"
188
193
  CARD_TRANSACTION_ENHANCED_DATA_CREATED = :"card_transaction.enhanced_data.created"
189
194
  CARD_TRANSACTION_ENHANCED_DATA_UPDATED = :"card_transaction.enhanced_data.updated"
@@ -60,8 +60,12 @@ module Lithic
60
60
  # created.
61
61
  # - book_transfer_transaction.updated: Occurs when a book transfer transaction is
62
62
  # updated.
63
- # - card_authorization.challenge_response: Occurs when a cardholder responds to an
64
- # SMS challenge during card authorization.
63
+ # - card_authorization.challenge: Occurs when an Out of Band challenge is issued
64
+ # during card authorization. The card program should issue its own challenge to
65
+ # the cardholder and then respond via
66
+ # [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge).
67
+ # - card_authorization.challenge_response: Occurs when a cardholder responds to a
68
+ # challenge during card authorization.
65
69
  # - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
66
70
  # data is processed for a transaction event.
67
71
  # - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
@@ -157,6 +161,7 @@ module Lithic
157
161
  BALANCE_UPDATED = :"balance.updated"
158
162
  BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
159
163
  BOOK_TRANSFER_TRANSACTION_UPDATED = :"book_transfer_transaction.updated"
164
+ CARD_AUTHORIZATION_CHALLENGE = :"card_authorization.challenge"
160
165
  CARD_AUTHORIZATION_CHALLENGE_RESPONSE = :"card_authorization.challenge_response"
161
166
  CARD_TRANSACTION_ENHANCED_DATA_CREATED = :"card_transaction.enhanced_data.created"
162
167
  CARD_TRANSACTION_ENHANCED_DATA_UPDATED = :"card_transaction.enhanced_data.updated"
@@ -62,8 +62,12 @@ module Lithic
62
62
  # created.
63
63
  # - book_transfer_transaction.updated: Occurs when a book transfer transaction is
64
64
  # updated.
65
- # - card_authorization.challenge_response: Occurs when a cardholder responds to an
66
- # SMS challenge during card authorization.
65
+ # - card_authorization.challenge: Occurs when an Out of Band challenge is issued
66
+ # during card authorization. The card program should issue its own challenge to
67
+ # the cardholder and then respond via
68
+ # [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge).
69
+ # - card_authorization.challenge_response: Occurs when a cardholder responds to a
70
+ # challenge during card authorization.
67
71
  # - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
68
72
  # data is processed for a transaction event.
69
73
  # - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
@@ -159,6 +163,7 @@ module Lithic
159
163
  BALANCE_UPDATED = :"balance.updated"
160
164
  BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
161
165
  BOOK_TRANSFER_TRANSACTION_UPDATED = :"book_transfer_transaction.updated"
166
+ CARD_AUTHORIZATION_CHALLENGE = :"card_authorization.challenge"
162
167
  CARD_AUTHORIZATION_CHALLENGE_RESPONSE = :"card_authorization.challenge_response"
163
168
  CARD_TRANSACTION_ENHANCED_DATA_CREATED = :"card_transaction.enhanced_data.created"
164
169
  CARD_TRANSACTION_ENHANCED_DATA_UPDATED = :"card_transaction.enhanced_data.updated"
@@ -38,6 +38,7 @@ module Lithic
38
38
  BALANCE_UPDATED = :"balance.updated"
39
39
  BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
40
40
  BOOK_TRANSFER_TRANSACTION_UPDATED = :"book_transfer_transaction.updated"
41
+ CARD_AUTHORIZATION_CHALLENGE = :"card_authorization.challenge"
41
42
  CARD_AUTHORIZATION_CHALLENGE_RESPONSE = :"card_authorization.challenge_response"
42
43
  CARD_TRANSACTION_ENHANCED_DATA_CREATED = :"card_transaction.enhanced_data.created"
43
44
  CARD_TRANSACTION_ENHANCED_DATA_UPDATED = :"card_transaction.enhanced_data.updated"
@@ -69,8 +69,12 @@ module Lithic
69
69
  # created.
70
70
  # - book_transfer_transaction.updated: Occurs when a book transfer transaction is
71
71
  # updated.
72
- # - card_authorization.challenge_response: Occurs when a cardholder responds to an
73
- # SMS challenge during card authorization.
72
+ # - card_authorization.challenge: Occurs when an Out of Band challenge is issued
73
+ # during card authorization. The card program should issue its own challenge to
74
+ # the cardholder and then respond via
75
+ # [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge).
76
+ # - card_authorization.challenge_response: Occurs when a cardholder responds to a
77
+ # challenge during card authorization.
74
78
  # - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial
75
79
  # data is processed for a transaction event.
76
80
  # - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial
@@ -166,6 +170,7 @@ module Lithic
166
170
  BALANCE_UPDATED = :"balance.updated"
167
171
  BOOK_TRANSFER_TRANSACTION_CREATED = :"book_transfer_transaction.created"
168
172
  BOOK_TRANSFER_TRANSACTION_UPDATED = :"book_transfer_transaction.updated"
173
+ CARD_AUTHORIZATION_CHALLENGE = :"card_authorization.challenge"
169
174
  CARD_AUTHORIZATION_CHALLENGE_RESPONSE = :"card_authorization.challenge_response"
170
175
  CARD_TRANSACTION_ENHANCED_DATA_CREATED = :"card_transaction.enhanced_data.created"
171
176
  CARD_TRANSACTION_ENHANCED_DATA_UPDATED = :"card_transaction.enhanced_data.updated"
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
- # @see Lithic::Resources::ExternalBankAccounts#retry_prenote
5
+ # @see Lithic::Resources::ExternalBankAccounts#pause
6
6
  class ExternalBankAccount < Lithic::Internal::Type::BaseModel
7
7
  # @!attribute token
8
8
  # A globally unique identifier for this record of an external bank account
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::ExternalBankAccounts#pause
6
+ class ExternalBankAccountPauseParams < Lithic::Internal::Type::BaseModel
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
8
+ include Lithic::Internal::Type::RequestParameters
9
+
10
+ # @!attribute external_bank_account_token
11
+ #
12
+ # @return [String]
13
+ required :external_bank_account_token, String
14
+
15
+ # @!method initialize(external_bank_account_token:, request_options: {})
16
+ # @param external_bank_account_token [String]
17
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -118,13 +118,13 @@ module Lithic
118
118
  # Date when the next payment is due
119
119
  #
120
120
  # @return [Date, nil]
121
- optional :next_payment_due_date, Date
121
+ optional :next_payment_due_date, Date, nil?: true
122
122
 
123
123
  # @!attribute next_statement_end_date
124
124
  # Date when the next billing period will end
125
125
  #
126
126
  # @return [Date, nil]
127
- optional :next_statement_end_date, Date
127
+ optional :next_statement_end_date, Date, nil?: true
128
128
 
129
129
  # @!attribute payoff_details
130
130
  # Details on number and size of payments to pay off balance
@@ -179,9 +179,9 @@ module Lithic
179
179
  #
180
180
  # @param interest_details [Lithic::Models::FinancialAccounts::Statement::InterestDetails, nil]
181
181
  #
182
- # @param next_payment_due_date [Date] Date when the next payment is due
182
+ # @param next_payment_due_date [Date, nil] Date when the next payment is due
183
183
  #
184
- # @param next_statement_end_date [Date] Date when the next billing period will end
184
+ # @param next_statement_end_date [Date, nil] Date when the next billing period will end
185
185
  #
186
186
  # @param payoff_details [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] Details on number and size of payments to pay off balance
187
187
  #
@@ -88,7 +88,7 @@ module Lithic
88
88
  # Globally unique identifier for a card
89
89
  #
90
90
  # @return [String, nil]
91
- optional :card_token, String
91
+ optional :card_token, String, nil?: true
92
92
 
93
93
  # @!attribute descriptor
94
94
  #
@@ -132,7 +132,7 @@ module Lithic
132
132
  #
133
133
  # @param financial_transaction_token [String] Globally unique identifier for a financial transaction
134
134
  #
135
- # @param card_token [String] Globally unique identifier for a card
135
+ # @param card_token [String, nil] Globally unique identifier for a card
136
136
  #
137
137
  # @param descriptor [String]
138
138
  #
@@ -266,6 +266,7 @@ module Lithic
266
266
  QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
267
267
  MONTHLY = :MONTHLY
268
268
  MONTHLY_REVERSAL = :MONTHLY_REVERSAL
269
+ ACCOUNT_TO_ACCOUNT = :ACCOUNT_TO_ACCOUNT
269
270
 
270
271
  # @!method self.values
271
272
  # @return [Array<Symbol>]
@@ -155,6 +155,7 @@ module Lithic
155
155
  QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
156
156
  MONTHLY = :MONTHLY
157
157
  MONTHLY_REVERSAL = :MONTHLY_REVERSAL
158
+ ACCOUNT_TO_ACCOUNT = :ACCOUNT_TO_ACCOUNT
158
159
 
159
160
  # @!method self.values
160
161
  # @return [Array<Symbol>]
@@ -42,7 +42,7 @@ module Lithic
42
42
  # Parent company name (if applicable).
43
43
  #
44
44
  # @return [String, nil]
45
- optional :parent_company, String
45
+ optional :parent_company, String, nil?: true
46
46
 
47
47
  # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
48
48
  # Some parameter documentations has been truncated, see
@@ -58,7 +58,7 @@ module Lithic
58
58
  #
59
59
  # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
60
60
  #
61
- # @param parent_company [String] Parent company name (if applicable).
61
+ # @param parent_company [String, nil] Parent company name (if applicable).
62
62
 
63
63
  # @see Lithic::Models::KYBBusinessEntity#address
64
64
  class Address < Lithic::Internal::Type::BaseModel
@@ -21,8 +21,11 @@ module Lithic
21
21
 
22
22
  variant -> { Lithic::AccountHolderDocumentUpdatedWebhookEvent }
23
23
 
24
+ # The Auth Stream Access request payload that was sent to the ASA responder.
24
25
  variant -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent }
25
26
 
27
+ variant -> { Lithic::CardAuthorizationChallengeWebhookEvent }
28
+
26
29
  variant -> { Lithic::CardAuthorizationChallengeResponseWebhookEvent }
27
30
 
28
31
  variant -> { Lithic::AuthRulesBacktestReportCreatedWebhookEvent }
@@ -813,7 +816,7 @@ module Lithic
813
816
  end
814
817
 
815
818
  # @!method self.variants
816
- # @return [Array(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::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::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)]
819
+ # @return [Array(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::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)]
817
820
  end
818
821
  end
819
822
  end
@@ -13,22 +13,22 @@ module Lithic
13
13
  # Globally unique identifier denoting the account that the associated transaction
14
14
  # occurred on.
15
15
  #
16
- # @return [String]
17
- required :account_token, String
16
+ # @return [String, nil]
17
+ required :account_token, String, nil?: true
18
18
 
19
19
  # @!attribute card_program_token
20
20
  # Globally unique identifier denoting the card program that the associated
21
21
  # transaction occurred on.
22
22
  #
23
- # @return [String]
24
- required :card_program_token, String
23
+ # @return [String, nil]
24
+ required :card_program_token, String, nil?: true
25
25
 
26
26
  # @!attribute card_token
27
27
  # Globally unique identifier denoting the card that the associated transaction
28
28
  # occurred on.
29
29
  #
30
- # @return [String]
31
- required :card_token, String
30
+ # @return [String, nil]
31
+ required :card_token, String, nil?: true
32
32
 
33
33
  # @!attribute created
34
34
  # Date and time when the transaction first occurred. UTC time zone.
@@ -108,14 +108,14 @@ module Lithic
108
108
 
109
109
  # @!attribute transaction_token
110
110
  # Globally unique identifier denoting the associated transaction. For settlement
111
- # records with type `CLEARING`, `FINANCIAL`, or `NON-FINANCIAL`, this references a
111
+ # records with type `CLEARING`, `FINANCIAL`, or `NON_FINANCIAL`, this references a
112
112
  # card transaction token. For settlement records with type `CHARGEBACK`,
113
113
  # `REPRESENTMENT`, `PREARBITRATION`, `ARBITRATION`, or `COLLABORATION`, this
114
114
  # references the dispute transaction token. May be null for certain settlement
115
115
  # types.
116
116
  #
117
- # @return [String]
118
- required :transaction_token, String
117
+ # @return [String, nil]
118
+ required :transaction_token, String, nil?: true
119
119
 
120
120
  # @!attribute transactions_gross_amount
121
121
  # The total amount of settlement impacting transactions (excluding interchange,
@@ -148,11 +148,11 @@ module Lithic
148
148
  #
149
149
  # @param token [String] Globally unique identifier denoting the Settlement Detail.
150
150
  #
151
- # @param account_token [String] Globally unique identifier denoting the account that the associated transaction
151
+ # @param account_token [String, nil] Globally unique identifier denoting the account that the associated transaction
152
152
  #
153
- # @param card_program_token [String] Globally unique identifier denoting the card program that the associated transac
153
+ # @param card_program_token [String, nil] Globally unique identifier denoting the card program that the associated transac
154
154
  #
155
- # @param card_token [String] Globally unique identifier denoting the card that the associated transaction occ
155
+ # @param card_token [String, nil] Globally unique identifier denoting the card that the associated transaction occ
156
156
  #
157
157
  # @param created [Time] Date and time when the transaction first occurred. UTC time zone.
158
158
  #
@@ -178,7 +178,7 @@ module Lithic
178
178
  #
179
179
  # @param settlement_date [String] Date of when money movement is triggered for the transaction. One exception appl
180
180
  #
181
- # @param transaction_token [String] Globally unique identifier denoting the associated transaction. For settlement r
181
+ # @param transaction_token [String, nil] Globally unique identifier denoting the associated transaction. For settlement r
182
182
  #
183
183
  # @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
184
184
  #
@@ -231,7 +231,7 @@ module Lithic
231
231
  COLLABORATION = :COLLABORATION
232
232
  FEE = :FEE
233
233
  FINANCIAL = :FINANCIAL
234
- NON_FINANCIAL = :"NON-FINANCIAL"
234
+ NON_FINANCIAL = :NON_FINANCIAL
235
235
  PREARBITRATION = :PREARBITRATION
236
236
  REPRESENTMENT = :REPRESENTMENT
237
237