lithic 0.21.0 → 0.23.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 (235) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +50 -0
  3. data/README.md +1 -10
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/internal/type/union.rb +21 -7
  6. data/lib/lithic/models/account_activity_list_params.rb +1 -0
  7. data/lib/lithic/models/account_activity_list_response.rb +2 -24
  8. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +2 -24
  9. data/lib/lithic/models/account_holder_create_params.rb +4 -2
  10. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +120 -66
  11. data/lib/lithic/models/account_holder_update_params.rb +6 -3
  12. data/lib/lithic/models/account_holder_update_response.rb +156 -86
  13. data/lib/lithic/models/account_holder_updated_webhook_event.rb +120 -66
  14. data/lib/lithic/models/account_holders/account_holder_entity.rb +35 -19
  15. data/lib/lithic/models/account_holders/entity_create_params.rb +39 -21
  16. data/lib/lithic/models/address.rb +33 -19
  17. data/lib/lithic/models/address_update.rb +27 -11
  18. data/lib/lithic/models/auth_rules/auth_rule.rb +55 -27
  19. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +189 -6
  20. data/lib/lithic/models/auth_rules/auth_rule_entities.rb +47 -0
  21. data/lib/lithic/models/auth_rules/auth_rule_entities_response.rb +31 -0
  22. data/lib/lithic/models/auth_rules/auth_rule_entity.rb +150 -0
  23. data/lib/lithic/models/auth_rules/auth_rule_version.rb +3 -6
  24. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +33 -6
  25. data/lib/lithic/models/auth_rules/conditional_attribute.rb +101 -5
  26. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +3 -439
  27. data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +7 -0
  28. data/lib/lithic/models/auth_rules/merchant_lock_parameters.rb +11 -1
  29. data/lib/lithic/models/auth_rules/v2_create_params.rb +203 -45
  30. data/lib/lithic/models/auth_rules/v2_draft_params.rb +3 -6
  31. data/lib/lithic/models/auth_rules/v2_list_params.rb +5 -3
  32. data/lib/lithic/models/auth_rules/v2_update_entities_params.rb +39 -0
  33. data/lib/lithic/models/auth_rules/v2_update_params.rb +133 -12
  34. data/lib/lithic/models/book_transfer_create_params.rb +1 -0
  35. data/lib/lithic/models/book_transfer_response.rb +1 -0
  36. data/lib/lithic/models/card_authorization.rb +12 -1
  37. data/lib/lithic/models/card_create_params.rb +11 -1
  38. data/lib/lithic/models/card_update_params.rb +12 -1
  39. data/lib/lithic/models/cards/financial_transaction_list_params.rb +9 -1
  40. data/lib/lithic/models/claim_created_webhook_event.rb +15 -1
  41. data/lib/lithic/models/claim_updated_webhook_event.rb +15 -1
  42. data/lib/lithic/models/financial_account_balance.rb +6 -6
  43. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +9 -2
  44. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +9 -1
  45. data/lib/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rb +279 -0
  46. data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb +106 -0
  47. data/lib/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rb +42 -0
  48. data/lib/lithic/models/financial_accounts/interest_tier_schedule.rb +6 -6
  49. data/lib/lithic/models/financial_accounts/interest_tier_schedule_update_params.rb +6 -6
  50. data/lib/lithic/models/financial_accounts/loan_tape.rb +71 -2
  51. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +5 -0
  52. data/lib/lithic/models/financial_event.rb +4 -0
  53. data/lib/lithic/models/funding_event_list_params.rb +28 -1
  54. data/lib/lithic/models/hold.rb +24 -28
  55. data/lib/lithic/models/ip_range_retrieve_params.rb +14 -0
  56. data/lib/lithic/models/ip_range_retrieve_response.rb +25 -0
  57. data/lib/lithic/models/kyb.rb +4 -2
  58. data/lib/lithic/models/kyb_business_entity.rb +35 -19
  59. data/lib/lithic/models/kyc.rb +2 -1
  60. data/lib/lithic/models/non_pci_card.rb +11 -1
  61. data/lib/lithic/models/parsed_webhook_event.rb +120 -66
  62. data/lib/lithic/models/payment.rb +3 -1
  63. data/lib/lithic/models/transaction.rb +11 -4
  64. data/lib/lithic/models/transaction_simulate_authorization_params.rb +28 -4
  65. data/lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb +11 -1
  66. data/lib/lithic/models/transaction_simulate_return_params.rb +24 -1
  67. data/lib/lithic/models/transactions/events/enhanced_data.rb +27 -3
  68. data/lib/lithic/models/transfer_limits_response.rb +9 -1
  69. data/lib/lithic/models.rb +2 -0
  70. data/lib/lithic/resources/auth_rules/v2/backtests.rb +8 -8
  71. data/lib/lithic/resources/auth_rules/v2.rb +44 -8
  72. data/lib/lithic/resources/cards/financial_transactions.rb +5 -3
  73. data/lib/lithic/resources/cards.rb +6 -2
  74. data/lib/lithic/resources/financial_accounts/credit_configuration.rb +9 -2
  75. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +5 -3
  76. data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb +107 -0
  77. data/lib/lithic/resources/financial_accounts/installment_plans.rb +4 -0
  78. data/lib/lithic/resources/financial_accounts/interest_tier_schedule.rb +6 -6
  79. data/lib/lithic/resources/funding_events.rb +8 -2
  80. data/lib/lithic/resources/ip_ranges.rb +36 -0
  81. data/lib/lithic/resources/transactions.rb +17 -4
  82. data/lib/lithic/resources/webhooks.rb +20 -0
  83. data/lib/lithic/version.rb +1 -1
  84. data/lib/lithic.rb +11 -1
  85. data/rbi/lithic/client.rbi +3 -0
  86. data/rbi/lithic/models/account_activity_list_params.rbi +5 -0
  87. data/rbi/lithic/models/account_activity_list_response.rbi +6 -75
  88. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +6 -75
  89. data/rbi/lithic/models/account_holder_create_params.rbi +8 -4
  90. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +195 -90
  91. data/rbi/lithic/models/account_holder_update_params.rbi +12 -6
  92. data/rbi/lithic/models/account_holder_update_response.rbi +254 -117
  93. data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +195 -90
  94. data/rbi/lithic/models/account_holders/account_holder_entity.rbi +59 -27
  95. data/rbi/lithic/models/account_holders/entity_create_params.rbi +65 -30
  96. data/rbi/lithic/models/address.rbi +57 -29
  97. data/rbi/lithic/models/address_update.rbi +50 -24
  98. data/rbi/lithic/models/auth_rules/auth_rule.rbi +53 -19
  99. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +442 -13
  100. data/rbi/lithic/models/auth_rules/auth_rule_entities.rbi +163 -0
  101. data/rbi/lithic/models/auth_rules/auth_rule_entities_response.rbi +72 -0
  102. data/rbi/lithic/models/auth_rules/auth_rule_entity.rbi +199 -0
  103. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +0 -2
  104. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +67 -9
  105. data/rbi/lithic/models/auth_rules/conditional_attribute.rbi +193 -5
  106. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +3 -939
  107. data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +14 -0
  108. data/rbi/lithic/models/auth_rules/merchant_lock_parameters.rbi +14 -3
  109. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +325 -50
  110. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +0 -4
  111. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +6 -3
  112. data/rbi/lithic/models/auth_rules/v2_update_entities_params.rbi +68 -0
  113. data/rbi/lithic/models/auth_rules/v2_update_params.rbi +198 -5
  114. data/rbi/lithic/models/book_transfer_create_params.rbi +5 -0
  115. data/rbi/lithic/models/book_transfer_response.rbi +5 -0
  116. data/rbi/lithic/models/card_authorization.rbi +14 -0
  117. data/rbi/lithic/models/card_create_params.rbi +15 -0
  118. data/rbi/lithic/models/card_update_params.rbi +17 -0
  119. data/rbi/lithic/models/cards/financial_transaction_list_params.rbi +11 -0
  120. data/rbi/lithic/models/claim_created_webhook_event.rbi +14 -0
  121. data/rbi/lithic/models/claim_updated_webhook_event.rbi +14 -0
  122. data/rbi/lithic/models/financial_account_balance.rbi +6 -6
  123. data/rbi/lithic/models/financial_accounts/credit_configuration_update_params.rbi +8 -2
  124. data/rbi/lithic/models/financial_accounts/financial_transaction_list_params.rbi +11 -0
  125. data/rbi/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbi +452 -0
  126. data/rbi/lithic/models/financial_accounts/installment_plans/statement_list_params.rbi +191 -0
  127. data/rbi/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbi +66 -0
  128. data/rbi/lithic/models/financial_accounts/interest_tier_schedule.rbi +9 -18
  129. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbi +9 -18
  130. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +143 -3
  131. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +25 -0
  132. data/rbi/lithic/models/financial_event.rbi +17 -0
  133. data/rbi/lithic/models/funding_event_list_params.rbi +39 -0
  134. data/rbi/lithic/models/hold.rbi +28 -29
  135. data/rbi/lithic/models/ip_range_retrieve_params.rbi +27 -0
  136. data/rbi/lithic/models/ip_range_retrieve_response.rbi +40 -0
  137. data/rbi/lithic/models/kyb.rbi +8 -4
  138. data/rbi/lithic/models/kyb_business_entity.rbi +59 -27
  139. data/rbi/lithic/models/kyc.rbi +4 -2
  140. data/rbi/lithic/models/non_pci_card.rbi +12 -0
  141. data/rbi/lithic/models/parsed_webhook_event.rbi +195 -90
  142. data/rbi/lithic/models/payment.rbi +5 -2
  143. data/rbi/lithic/models/transaction.rbi +15 -6
  144. data/rbi/lithic/models/transaction_simulate_authorization_params.rbi +42 -4
  145. data/rbi/lithic/models/transaction_simulate_credit_authorization_advice_params.rbi +15 -0
  146. data/rbi/lithic/models/transaction_simulate_return_params.rbi +30 -0
  147. data/rbi/lithic/models/transactions/events/enhanced_data.rbi +25 -5
  148. data/rbi/lithic/models/transfer_limits_response.rbi +8 -0
  149. data/rbi/lithic/models.rbi +2 -0
  150. data/rbi/lithic/resources/account_holders/entities.rbi +2 -1
  151. data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +8 -8
  152. data/rbi/lithic/resources/auth_rules/v2.rbi +43 -8
  153. data/rbi/lithic/resources/cards/financial_transactions.rbi +4 -1
  154. data/rbi/lithic/resources/cards.rbi +11 -0
  155. data/rbi/lithic/resources/financial_accounts/credit_configuration.rbi +8 -2
  156. data/rbi/lithic/resources/financial_accounts/financial_transactions.rbi +4 -1
  157. data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi +86 -0
  158. data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +7 -0
  159. data/rbi/lithic/resources/financial_accounts/interest_tier_schedule.rbi +6 -6
  160. data/rbi/lithic/resources/funding_events.rbi +12 -0
  161. data/rbi/lithic/resources/ip_ranges.rbi +25 -0
  162. data/rbi/lithic/resources/transactions.rbi +31 -2
  163. data/sig/lithic/client.rbs +2 -0
  164. data/sig/lithic/models/account_activity_list_params.rbs +2 -0
  165. data/sig/lithic/models/account_activity_list_response.rbs +3 -32
  166. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +3 -32
  167. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +39 -39
  168. data/sig/lithic/models/account_holder_update_response.rbs +52 -52
  169. data/sig/lithic/models/account_holder_updated_webhook_event.rbs +39 -39
  170. data/sig/lithic/models/account_holders/account_holder_entity.rbs +13 -13
  171. data/sig/lithic/models/account_holders/entity_create_params.rbs +13 -13
  172. data/sig/lithic/models/address.rbs +13 -13
  173. data/sig/lithic/models/address_update.rbs +8 -12
  174. data/sig/lithic/models/auth_rules/auth_rule.rbs +8 -7
  175. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +89 -3
  176. data/sig/lithic/models/auth_rules/auth_rule_entities.rbs +37 -0
  177. data/sig/lithic/models/auth_rules/auth_rule_entities_response.rbs +29 -0
  178. data/sig/lithic/models/auth_rules/auth_rule_entity.rbs +80 -0
  179. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -2
  180. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -0
  181. data/sig/lithic/models/auth_rules/conditional_attribute.rbs +46 -0
  182. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +4 -204
  183. data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +2 -0
  184. data/sig/lithic/models/auth_rules/merchant_lock_parameters.rbs +10 -3
  185. data/sig/lithic/models/auth_rules/v2_create_params.rbs +86 -16
  186. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -2
  187. data/sig/lithic/models/auth_rules/v2_update_entities_params.rbs +46 -0
  188. data/sig/lithic/models/auth_rules/v2_update_params.rbs +47 -1
  189. data/sig/lithic/models/book_transfer_create_params.rbs +2 -0
  190. data/sig/lithic/models/book_transfer_response.rbs +2 -0
  191. data/sig/lithic/models/card_authorization.rbs +13 -1
  192. data/sig/lithic/models/card_create_params.rbs +7 -0
  193. data/sig/lithic/models/card_update_params.rbs +8 -1
  194. data/sig/lithic/models/cards/financial_transaction_list_params.rbs +7 -0
  195. data/sig/lithic/models/claim_created_webhook_event.rbs +5 -0
  196. data/sig/lithic/models/claim_updated_webhook_event.rbs +5 -0
  197. data/sig/lithic/models/financial_account_balance.rbs +8 -8
  198. data/sig/lithic/models/financial_accounts/financial_transaction_list_params.rbs +7 -0
  199. data/sig/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbs +191 -0
  200. data/sig/lithic/models/financial_accounts/installment_plans/statement_list_params.rbs +90 -0
  201. data/sig/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbs +40 -0
  202. data/sig/lithic/models/financial_accounts/interest_tier_schedule.rbs +12 -18
  203. data/sig/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbs +12 -18
  204. data/sig/lithic/models/financial_accounts/loan_tape.rbs +55 -3
  205. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +10 -0
  206. data/sig/lithic/models/financial_event.rbs +8 -0
  207. data/sig/lithic/models/funding_event_list_params.rbs +26 -1
  208. data/sig/lithic/models/hold.rbs +22 -30
  209. data/sig/lithic/models/ip_range_retrieve_params.rbs +15 -0
  210. data/sig/lithic/models/ip_range_retrieve_response.rbs +16 -0
  211. data/sig/lithic/models/kyb_business_entity.rbs +13 -13
  212. data/sig/lithic/models/non_pci_card.rbs +5 -0
  213. data/sig/lithic/models/parsed_webhook_event.rbs +39 -39
  214. data/sig/lithic/models/payment.rbs +2 -0
  215. data/sig/lithic/models/transaction.rbs +12 -5
  216. data/sig/lithic/models/transaction_simulate_authorization_params.rbs +14 -0
  217. data/sig/lithic/models/transaction_simulate_credit_authorization_advice_params.rbs +7 -0
  218. data/sig/lithic/models/transaction_simulate_return_params.rbs +19 -1
  219. data/sig/lithic/models/transactions/events/enhanced_data.rbs +13 -3
  220. data/sig/lithic/models/transfer_limits_response.rbs +5 -0
  221. data/sig/lithic/models.rbs +2 -0
  222. data/sig/lithic/resources/auth_rules/v2.rbs +7 -0
  223. data/sig/lithic/resources/cards/financial_transactions.rbs +2 -1
  224. data/sig/lithic/resources/cards.rbs +2 -0
  225. data/sig/lithic/resources/financial_accounts/financial_transactions.rbs +2 -1
  226. data/sig/lithic/resources/financial_accounts/installment_plans/statements.rbs +30 -0
  227. data/sig/lithic/resources/financial_accounts/installment_plans.rbs +2 -0
  228. data/sig/lithic/resources/financial_accounts/interest_tier_schedule.rbs +6 -6
  229. data/sig/lithic/resources/funding_events.rbs +3 -0
  230. data/sig/lithic/resources/ip_ranges.rbs +11 -0
  231. data/sig/lithic/resources/transactions.rbs +5 -0
  232. metadata +36 -10
  233. data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +0 -20
  234. data/rbi/lithic/models/auth_rules/conditional_block_parameters.rbi +0 -37
  235. data/sig/lithic/models/auth_rules/conditional_block_parameters.rbs +0 -20
@@ -132,7 +132,8 @@ module Lithic
132
132
 
133
133
  # @!attribute tags
134
134
  # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
135
- # metadata with a resource for your own purposes.
135
+ # metadata with a resource for your own purposes. A resource can have at most 50
136
+ # tags, with keys up to 40 characters and values up to 500 characters
136
137
  #
137
138
  # @return [Hash{Symbol=>String}, nil]
138
139
  optional :tags, Lithic::Internal::Type::HashOf[String]
@@ -211,6 +212,7 @@ module Lithic
211
212
  ACH = :ACH
212
213
  WIRE = :WIRE
213
214
  STABLECOIN = :STABLECOIN
215
+ INTRA_BANK = :INTRA_BANK
214
216
  BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
215
217
  FEE = :FEE
216
218
  REWARD = :REWARD
@@ -140,9 +140,11 @@ module Lithic
140
140
  required :network_risk_score, Integer, nil?: true
141
141
 
142
142
  # @!attribute pos
143
+ # Point of sale data for the transaction. Null when no point of sale data is
144
+ # available, such as clearing-only records that never went through authorization
143
145
  #
144
- # @return [Lithic::Models::Transaction::Pos]
145
- required :pos, -> { Lithic::Transaction::Pos }
146
+ # @return [Lithic::Models::Transaction::Pos, nil]
147
+ required :pos, -> { Lithic::Transaction::Pos }, nil?: true
146
148
 
147
149
  # @!attribute result
148
150
  #
@@ -173,7 +175,8 @@ module Lithic
173
175
 
174
176
  # @!attribute tags
175
177
  # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
176
- # metadata with a resource for your own purposes.
178
+ # metadata with a resource for your own purposes. A resource can have at most 50
179
+ # tags, with keys up to 40 characters and values up to 500 characters
177
180
  #
178
181
  # @return [Hash{Symbol=>String}]
179
182
  required :tags, Lithic::Internal::Type::HashOf[String]
@@ -236,7 +239,7 @@ module Lithic
236
239
  #
237
240
  # @param network_risk_score [Integer, nil] Network-provided score assessing risk level associated with a given authorizatio
238
241
  #
239
- # @param pos [Lithic::Models::Transaction::Pos]
242
+ # @param pos [Lithic::Models::Transaction::Pos, nil] Point of sale data for the transaction. Null when no point of sale data is avail
240
243
  #
241
244
  # @param result [Symbol, Lithic::Models::Transaction::Result]
242
245
  #
@@ -433,6 +436,7 @@ module Lithic
433
436
  module Network
434
437
  extend Lithic::Internal::Type::Enum
435
438
 
439
+ ALLPOINT = :ALLPOINT
436
440
  AMEX = :AMEX
437
441
  INTERLINK = :INTERLINK
438
442
  MAESTRO = :MAESTRO
@@ -457,6 +461,9 @@ module Lithic
457
461
  required :terminal, -> { Lithic::Transaction::Pos::Terminal }
458
462
 
459
463
  # @!method initialize(entry_mode:, terminal:)
464
+ # Point of sale data for the transaction. Null when no point of sale data is
465
+ # available, such as clearing-only records that never went through authorization
466
+ #
460
467
  # @param entry_mode [Lithic::Models::Transaction::Pos::EntryMode]
461
468
  # @param terminal [Lithic::Models::Transaction::Pos::Terminal]
462
469
 
@@ -29,6 +29,14 @@ module Lithic
29
29
  # @return [String]
30
30
  required :pan, String
31
31
 
32
+ # @!attribute billing_currency
33
+ # 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
34
+ # Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
35
+ # a 422. Defaults to USD
36
+ #
37
+ # @return [String, nil]
38
+ optional :billing_currency, String
39
+
32
40
  # @!attribute mcc
33
41
  # Merchant category code for the transaction to be simulated. A four-digit number
34
42
  # listed in ISO 18245. Supported merchant category codes can be found
@@ -69,8 +77,10 @@ module Lithic
69
77
  optional :merchant_amount, Integer
70
78
 
71
79
  # @!attribute merchant_currency
72
- # 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
73
- # GBP, EUR and defaults to GBP if another ISO 4217 code is provided
80
+ # 3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
81
+ # when merchant_amount is set, and defaults to GBP in that case. Without
82
+ # merchant_amount, the merchant amount uses the billing currency. Permitted values
83
+ # are USD, GBP, EUR and CAD, and any other ISO 4217 code returns a 422
74
84
  #
75
85
  # @return [String, nil]
76
86
  optional :merchant_currency, String
@@ -89,6 +99,16 @@ module Lithic
89
99
  # @return [String, nil]
90
100
  optional :pin, String
91
101
 
102
+ # @!attribute settlement_currency
103
+ # 3-character alphabetic ISO 4217 currency code for the settlement amount.
104
+ # Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
105
+ # a 422. Defaults to the value of billing_currency. Only single message
106
+ # (financial) authorizations carry a settlement amount, and the value is ignored
107
+ # for dual message authorizations
108
+ #
109
+ # @return [String, nil]
110
+ optional :settlement_currency, String
111
+
92
112
  # @!attribute status
93
113
  # Type of event to simulate.
94
114
  #
@@ -110,7 +130,7 @@ module Lithic
110
130
  # @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
111
131
  optional :status, enum: -> { Lithic::TransactionSimulateAuthorizationParams::Status }
112
132
 
113
- # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
133
+ # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, settlement_currency: nil, status: nil, request_options: {})
114
134
  # Some parameter documentations has been truncated, see
115
135
  # {Lithic::Models::TransactionSimulateAuthorizationParams} for more details.
116
136
  #
@@ -120,6 +140,8 @@ module Lithic
120
140
  #
121
141
  # @param pan [String] Sixteen digit card number.
122
142
  #
143
+ # @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
144
+ #
123
145
  # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
124
146
  #
125
147
  # @param merchant_acceptor_city [String] Merchant acceptor city
@@ -132,12 +154,14 @@ module Lithic
132
154
  #
133
155
  # @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
134
156
  #
135
- # @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
157
+ # @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
136
158
  #
137
159
  # @param partial_approval_capable [Boolean] Set to true if the terminal is capable of partial approval otherwise false.
138
160
  #
139
161
  # @param pin [String] Simulate entering a PIN. If omitted, PIN check will not be performed.
140
162
  #
163
+ # @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
164
+ #
141
165
  # @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] Type of event to simulate.
142
166
  #
143
167
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
@@ -27,6 +27,14 @@ module Lithic
27
27
  # @return [String]
28
28
  required :pan, String
29
29
 
30
+ # @!attribute billing_currency
31
+ # 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
32
+ # Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
33
+ # a 422. Defaults to USD
34
+ #
35
+ # @return [String, nil]
36
+ optional :billing_currency, String
37
+
30
38
  # @!attribute mcc
31
39
  # Merchant category code for the transaction to be simulated. A four-digit number
32
40
  # listed in ISO 18245. Supported merchant category codes can be found
@@ -59,7 +67,7 @@ module Lithic
59
67
  # @return [String, nil]
60
68
  optional :merchant_acceptor_state, String
61
69
 
62
- # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
70
+ # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
63
71
  # Some parameter documentations has been truncated, see
64
72
  # {Lithic::Models::TransactionSimulateCreditAuthorizationAdviceParams} for more
65
73
  # details.
@@ -70,6 +78,8 @@ module Lithic
70
78
  #
71
79
  # @param pan [String] Sixteen digit card number.
72
80
  #
81
+ # @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
82
+ #
73
83
  # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
74
84
  #
75
85
  # @param merchant_acceptor_city [String] Merchant acceptor city
@@ -25,13 +25,36 @@ module Lithic
25
25
  # @return [String]
26
26
  required :pan, String
27
27
 
28
- # @!method initialize(amount:, descriptor:, pan:, request_options: {})
28
+ # @!attribute billing_currency
29
+ # 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
30
+ # Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
31
+ # a 422. Defaults to USD
32
+ #
33
+ # @return [String, nil]
34
+ optional :billing_currency, String
35
+
36
+ # @!attribute settlement_currency
37
+ # 3-character alphabetic ISO 4217 currency code for the settlement amount.
38
+ # Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
39
+ # a 422. Defaults to the value of billing_currency
40
+ #
41
+ # @return [String, nil]
42
+ optional :settlement_currency, String
43
+
44
+ # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, settlement_currency: nil, request_options: {})
45
+ # Some parameter documentations has been truncated, see
46
+ # {Lithic::Models::TransactionSimulateReturnParams} for more details.
47
+ #
29
48
  # @param amount [Integer] Amount (in cents) to authorize.
30
49
  #
31
50
  # @param descriptor [String] Merchant descriptor.
32
51
  #
33
52
  # @param pan [String] Sixteen digit card number.
34
53
  #
54
+ # @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
55
+ #
56
+ # @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
57
+ #
35
58
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
36
59
  end
37
60
  end
@@ -89,7 +89,10 @@ module Lithic
89
89
 
90
90
  class LineItem < Lithic::Internal::Type::BaseModel
91
91
  # @!attribute amount
92
- # The price of the item purchased in merchant currency.
92
+ # @deprecated
93
+ #
94
+ # Deprecated: Use unit_amount instead. The price of the item purchased in merchant
95
+ # currency.
93
96
  #
94
97
  # @return [String, nil]
95
98
  optional :amount, String, nil?: true
@@ -112,16 +115,37 @@ module Lithic
112
115
  # @return [String, nil]
113
116
  optional :quantity, String, nil?: true
114
117
 
115
- # @!method initialize(amount: nil, description: nil, product_code: nil, quantity: nil)
118
+ # @!attribute total_amount
119
+ # The total cost for the line item in merchant currency, covering all units
120
+ # purchased.
121
+ #
122
+ # @return [String, nil]
123
+ optional :total_amount, String, nil?: true
124
+
125
+ # @!attribute unit_amount
126
+ # The price per individual unit in merchant currency.
127
+ #
128
+ # @return [String, nil]
129
+ optional :unit_amount, String, nil?: true
130
+
131
+ # @!method initialize(amount: nil, description: nil, product_code: nil, quantity: nil, total_amount: nil, unit_amount: nil)
132
+ # Some parameter documentations has been truncated, see
133
+ # {Lithic::Models::Transactions::Events::EnhancedData::Common::LineItem} for more
134
+ # details.
135
+ #
116
136
  # An L2/L3 enhanced commercial data line item.
117
137
  #
118
- # @param amount [String, nil] The price of the item purchased in merchant currency.
138
+ # @param amount [String, nil] Deprecated: Use unit_amount instead. The price of the item purchased in merchant
119
139
  #
120
140
  # @param description [String, nil] A human-readable description of the item.
121
141
  #
122
142
  # @param product_code [String, nil] An identifier for the item purchased.
123
143
  #
124
144
  # @param quantity [String, nil] The quantity of the item purchased.
145
+ #
146
+ # @param total_amount [String, nil] The total cost for the line item in merchant currency, covering all units purcha
147
+ #
148
+ # @param unit_amount [String, nil] The price per individual unit in merchant currency.
125
149
  end
126
150
 
127
151
  # @see Lithic::Models::Transactions::Events::EnhancedData::Common#tax
@@ -39,6 +39,12 @@ module Lithic
39
39
  # @return [Date]
40
40
  required :date, Date
41
41
 
42
+ # @!attribute financial_entity_id
43
+ # Financial entity ID the limits are scoped to
44
+ #
45
+ # @return [String]
46
+ required :financial_entity_id, String
47
+
42
48
  # @!attribute is_fbo
43
49
  # Whether the company is a FBO; based on the company ID prefix
44
50
  #
@@ -58,13 +64,15 @@ module Lithic
58
64
  required :program_limit_per_transaction,
59
65
  -> { Lithic::TransferLimitsResponse::Data::ProgramLimitPerTransaction }
60
66
 
61
- # @!method initialize(company_id:, daily_limit:, date:, is_fbo:, monthly_limit:, program_limit_per_transaction:)
67
+ # @!method initialize(company_id:, daily_limit:, date:, financial_entity_id:, is_fbo:, monthly_limit:, program_limit_per_transaction:)
62
68
  # @param company_id [String] Company ID
63
69
  #
64
70
  # @param daily_limit [Lithic::Models::TransferLimitsResponse::Data::DailyLimit] Daily limits with progress
65
71
  #
66
72
  # @param date [Date] The date for the limit view (ISO format)
67
73
  #
74
+ # @param financial_entity_id [String] Financial entity ID the limits are scoped to
75
+ #
68
76
  # @param is_fbo [Boolean] Whether the company is a FBO; based on the company ID prefix
69
77
  #
70
78
  # @param monthly_limit [Lithic::Models::TransferLimitsResponse::Data::MonthlyLimit] Monthly limits with progress
data/lib/lithic/models.rb CHANGED
@@ -427,6 +427,8 @@ module Lithic
427
427
 
428
428
  InternalTransactionUpdatedWebhookEvent = Lithic::Models::InternalTransactionUpdatedWebhookEvent
429
429
 
430
+ IPRangeRetrieveParams = Lithic::Models::IPRangeRetrieveParams
431
+
430
432
  KYB = Lithic::Models::KYB
431
433
 
432
434
  KYBBusinessEntity = Lithic::Models::KYBBusinessEntity
@@ -22,14 +22,14 @@ module Lithic
22
22
  # `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}`
23
23
  # endpoint.
24
24
  #
25
- # Lithic currently supports backtesting for `CONDITIONAL_BLOCK` /
26
- # `CONDITIONAL_ACTION` rules. Backtesting for `VELOCITY_LIMIT` rules is generally
27
- # not supported. In specific cases (i.e. where Lithic has pre-calculated the
28
- # requested velocity metrics for historical transactions), a backtest may be
29
- # feasible. However, such cases are uncommon and customers should not anticipate
30
- # support for velocity backtests under most configurations. If a historical
31
- # transaction does not feature the required inputs to evaluate the rule, then it
32
- # will not be included in the final backtest report.
25
+ # Lithic currently supports backtesting for `CONDITIONAL_ACTION` rules.
26
+ # Backtesting for `VELOCITY_LIMIT` rules is generally not supported. In specific
27
+ # cases (i.e. where Lithic has pre-calculated the requested velocity metrics for
28
+ # historical transactions), a backtest may be feasible. However, such cases are
29
+ # uncommon and customers should not anticipate support for velocity backtests
30
+ # under most configurations. If a historical transaction does not feature the
31
+ # required inputs to evaluate the rule, then it will not be included in the final
32
+ # backtest report.
33
33
  #
34
34
  # @overload create(auth_rule_token, end_: nil, start: nil, request_options: {})
35
35
  #
@@ -11,7 +11,8 @@ module Lithic
11
11
  #
12
12
  # @overload create(body:, request_options: {})
13
13
  #
14
- # @param body [Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule]
14
+ # @param body [Lithic::Models::AuthRules::V2CreateParams::Body::Rule, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule] Deprecated: Use `entities` instead. Cannot be combined with `entities`.
15
+ #
15
16
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
16
17
  #
17
18
  # @return [Lithic::Models::AuthRules::AuthRule]
@@ -47,16 +48,21 @@ module Lithic
47
48
  )
48
49
  end
49
50
 
51
+ # Some parameter documentations has been truncated, see
52
+ # {Lithic::Models::AuthRules::V2UpdateParams} for more details.
53
+ #
50
54
  # Updates a V2 Auth rule's properties
51
55
  #
52
- # If `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`,
53
- # `excluded_account_tokens`, or `excluded_business_account_tokens` is provided,
54
- # this will replace existing associations with the provided list of entities.
56
+ # If `entities` is provided, this will replace the rule's existing entities with
57
+ # the provided `include` and `exclude` lists. To change entities incrementally,
58
+ # use `PATCH /v2/auth_rules/{auth_rule_token}/entities` instead.
55
59
  #
56
60
  # @overload update(auth_rule_token, body:, request_options: {})
57
61
  #
58
62
  # @param auth_rule_token [String]
59
- # @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule]
63
+ #
64
+ # @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::Rule, Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule] Replaces the rule's existing entities with the provided `include` and `exclude`
65
+ #
60
66
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
61
67
  #
62
68
  # @return [Lithic::Models::AuthRules::AuthRule]
@@ -94,7 +100,7 @@ module Lithic
94
100
  #
95
101
  # @param page_size [Integer] Page size (for pagination).
96
102
  #
97
- # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope.
103
+ # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope. When no token is pr
98
104
  #
99
105
  # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
100
106
  #
@@ -144,7 +150,7 @@ module Lithic
144
150
  #
145
151
  # @param auth_rule_token [String]
146
152
  #
147
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
153
+ # @param parameters [Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
148
154
  #
149
155
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
150
156
  #
@@ -256,7 +262,7 @@ module Lithic
256
262
  # - VelocityLimit Rules calculates the current Velocity Feature data. This
257
263
  # requires a `card_token` or `account_token` matching what the rule is Scoped
258
264
  # to.
259
- # - ConditionalBlock Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
265
+ # - ConditionalAction Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
260
266
  # the rule. This requires a `card_token`
261
267
  #
262
268
  # @overload retrieve_features(auth_rule_token, account_token: nil, card_token: nil, request_options: {})
@@ -320,6 +326,36 @@ module Lithic
320
326
  )
321
327
  end
322
328
 
329
+ # Adds entities to and removes entities from a V2 Auth rule's `include` and
330
+ # `exclude` lists
331
+ #
332
+ # To replace all of the rule's entities at once, provide `entities` to
333
+ # `PATCH /v2/auth_rules/{auth_rule_token}` instead.
334
+ #
335
+ # @overload update_entities(auth_rule_token, add: nil, remove: nil, request_options: {})
336
+ #
337
+ # @param auth_rule_token [String]
338
+ #
339
+ # @param add [Lithic::Models::AuthRules::AuthRuleEntities] Entities to add to the rule's `include` and `exclude` lists
340
+ #
341
+ # @param remove [Lithic::Models::AuthRules::AuthRuleEntities] Entities to remove from the rule's `include` and `exclude` lists
342
+ #
343
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
344
+ #
345
+ # @return [Lithic::Models::AuthRules::AuthRule]
346
+ #
347
+ # @see Lithic::Models::AuthRules::V2UpdateEntitiesParams
348
+ def update_entities(auth_rule_token, params = {})
349
+ parsed, options = Lithic::AuthRules::V2UpdateEntitiesParams.dump_request(params)
350
+ @client.request(
351
+ method: :patch,
352
+ path: ["v2/auth_rules/%1$s/entities", auth_rule_token],
353
+ body: parsed,
354
+ model: Lithic::AuthRules::AuthRule,
355
+ options: options
356
+ )
357
+ end
358
+
323
359
  # @api private
324
360
  #
325
361
  # @param client [Lithic::Client]
@@ -36,7 +36,7 @@ module Lithic
36
36
  #
37
37
  # List the financial transactions for a given card.
38
38
  #
39
- # @overload list(card_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
39
+ # @overload list(card_token, begin_: nil, category: nil, end_: nil, ending_before: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
40
40
  #
41
41
  # @param card_token [String]
42
42
  #
@@ -48,6 +48,8 @@ module Lithic
48
48
  #
49
49
  # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
50
50
  #
51
+ # @param page_size [Integer] Page size (for pagination).
52
+ #
51
53
  # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
52
54
  #
53
55
  # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
@@ -56,7 +58,7 @@ module Lithic
56
58
  #
57
59
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
58
60
  #
59
- # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]
61
+ # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialTransaction>]
60
62
  #
61
63
  # @see Lithic::Models::Cards::FinancialTransactionListParams
62
64
  def list(card_token, params = {})
@@ -66,7 +68,7 @@ module Lithic
66
68
  method: :get,
67
69
  path: ["v1/cards/%1$s/financial_transactions", card_token],
68
70
  query: query.transform_keys(begin_: "begin", end_: "end"),
69
- page: Lithic::Internal::SinglePage,
71
+ page: Lithic::Internal::CursorPage,
70
72
  model: Lithic::FinancialTransaction,
71
73
  options: options
72
74
  )
@@ -15,7 +15,7 @@ module Lithic
15
15
  # Create a new virtual or physical card. Parameters `shipping_address` and
16
16
  # `product_id` only apply to physical cards.
17
17
  #
18
- # @overload create(type:, account_token: nil, bulk_order_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, idempotency_key: nil, request_options: {})
18
+ # @overload create(type:, account_token: nil, bulk_order_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, tags: nil, idempotency_key: nil, request_options: {})
19
19
  #
20
20
  # @param type [Symbol, Lithic::Models::CardCreateParams::Type] Body param: Card types:
21
21
  #
@@ -57,6 +57,8 @@ module Lithic
57
57
  #
58
58
  # @param state [Symbol, Lithic::Models::CardCreateParams::State] Body param: Card state values:
59
59
  #
60
+ # @param tags [Hash{Symbol=>String}] Body param: Key-value pairs to tag the card with. A replacement card does not in
61
+ #
60
62
  # @param idempotency_key [String] Header param: Idempotency key for the request
61
63
  #
62
64
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -105,7 +107,7 @@ module Lithic
105
107
  # _Note: setting a card to a `CLOSED` state is a final action that cannot be
106
108
  # undone._
107
109
  #
108
- # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
110
+ # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, tags: nil, request_options: {})
109
111
  #
110
112
  # @param card_token [String]
111
113
  #
@@ -129,6 +131,8 @@ module Lithic
129
131
  #
130
132
  # @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
131
133
  #
134
+ # @param tags [Hash{Symbol=>String, nil}] Key-value pairs to merge into the card's tags. Supplied keys are added or overwr
135
+ #
132
136
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
133
137
  #
134
138
  # @return [Lithic::Models::Card]
@@ -24,7 +24,14 @@ module Lithic
24
24
  )
25
25
  end
26
26
 
27
- # Update an account's credit configuration
27
+ # Some parameter documentations has been truncated, see
28
+ # {Lithic::Models::FinancialAccounts::CreditConfigurationUpdateParams} for more
29
+ # details.
30
+ #
31
+ # Update an account's credit configuration. A credit product can only be attached
32
+ # while the financial account is in the `PENDING` state; once a credit product has
33
+ # been assigned the account transitions to `OPEN` and `credit_product_token` can
34
+ # no longer be changed
28
35
  #
29
36
  # @overload update(financial_account_token, auto_collection_configuration: nil, credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {})
30
37
  #
@@ -34,7 +41,7 @@ module Lithic
34
41
  #
35
42
  # @param credit_limit [Integer]
36
43
  #
37
- # @param credit_product_token [String] Globally unique identifier for the credit product
44
+ # @param credit_product_token [String] Globally unique identifier for the credit product. This can only be set
38
45
  #
39
46
  # @param external_bank_account_token [String]
40
47
  #
@@ -41,7 +41,7 @@ module Lithic
41
41
  #
42
42
  # List the financial transactions for a given financial account.
43
43
  #
44
- # @overload list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
44
+ # @overload list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
45
45
  #
46
46
  # @param financial_account_token [String] Globally unique identifier for financial account.
47
47
  #
@@ -53,6 +53,8 @@ module Lithic
53
53
  #
54
54
  # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
55
55
  #
56
+ # @param page_size [Integer] Page size (for pagination).
57
+ #
56
58
  # @param result [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
57
59
  #
58
60
  # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
@@ -61,7 +63,7 @@ module Lithic
61
63
  #
62
64
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
63
65
  #
64
- # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]
66
+ # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialTransaction>]
65
67
  #
66
68
  # @see Lithic::Models::FinancialAccounts::FinancialTransactionListParams
67
69
  def list(financial_account_token, params = {})
@@ -71,7 +73,7 @@ module Lithic
71
73
  method: :get,
72
74
  path: ["v1/financial_accounts/%1$s/financial_transactions", financial_account_token],
73
75
  query: query.transform_keys(begin_: "begin", end_: "end"),
74
- page: Lithic::Internal::SinglePage,
76
+ page: Lithic::Internal::CursorPage,
75
77
  model: Lithic::FinancialTransaction,
76
78
  options: options
77
79
  )