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
@@ -7,6 +7,20 @@ module Lithic
7
7
  extend Lithic::Internal::Type::RequestParameters::Converter
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute begin_
11
+ # Date string in RFC 3339 format. Only entries created after the specified time
12
+ # will be included. UTC time zone.
13
+ #
14
+ # @return [Time, nil]
15
+ optional :begin_, Time
16
+
17
+ # @!attribute end_
18
+ # Date string in RFC 3339 format. Only entries created before the specified time
19
+ # will be included. UTC time zone.
20
+ #
21
+ # @return [Time, nil]
22
+ optional :end_, Time
23
+
10
24
  # @!attribute ending_before
11
25
  # A cursor representing an item's token before which a page of results should end.
12
26
  # Used to retrieve the previous page of results before this item.
@@ -14,6 +28,13 @@ module Lithic
14
28
  # @return [String, nil]
15
29
  optional :ending_before, String
16
30
 
31
+ # @!attribute network_settlement_date
32
+ # Only funding events with a settlement breakout for this network settlement date
33
+ # will be included.
34
+ #
35
+ # @return [Date, nil]
36
+ optional :network_settlement_date, Date
37
+
17
38
  # @!attribute page_size
18
39
  # Page size (for pagination).
19
40
  #
@@ -27,12 +48,18 @@ module Lithic
27
48
  # @return [String, nil]
28
49
  optional :starting_after, String
29
50
 
30
- # @!method initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
51
+ # @!method initialize(begin_: nil, end_: nil, ending_before: nil, network_settlement_date: nil, page_size: nil, starting_after: nil, request_options: {})
31
52
  # Some parameter documentations has been truncated, see
32
53
  # {Lithic::Models::FundingEventListParams} for more details.
33
54
  #
55
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
56
+ #
57
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
58
+ #
34
59
  # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
35
60
  #
61
+ # @param network_settlement_date [Date] Only funding events with a settlement breakout for this network settlement date
62
+ #
36
63
  # @param page_size [Integer] Page size (for pagination).
37
64
  #
38
65
  # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
@@ -16,12 +16,6 @@ module Lithic
16
16
  # @return [Time]
17
17
  required :created, Time
18
18
 
19
- # @!attribute status
20
- # Status of a hold transaction
21
- #
22
- # @return [Symbol, Lithic::Models::Hold::Status]
23
- required :status, enum: -> { Lithic::Hold::Status }
24
-
25
19
  # @!attribute updated
26
20
  # ISO 8601 timestamp of when the transaction was last updated
27
21
  #
@@ -66,12 +60,18 @@ module Lithic
66
60
  # @return [Symbol, Lithic::Models::Hold::Result, nil]
67
61
  optional :result, enum: -> { Lithic::Hold::Result }
68
62
 
63
+ # @!attribute status
64
+ # Status of a hold transaction
65
+ #
66
+ # @return [Symbol, Lithic::Models::Hold::Status, nil]
67
+ optional :status, enum: -> { Lithic::Hold::Status }
68
+
69
69
  # @!attribute user_defined_id
70
70
  #
71
71
  # @return [String, nil]
72
72
  optional :user_defined_id, String, nil?: true
73
73
 
74
- # @!method initialize(token:, created:, status:, updated:, currency: nil, events: nil, expiration_datetime: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, user_defined_id: nil)
74
+ # @!method initialize(token:, created:, updated:, currency: nil, events: nil, expiration_datetime: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, status: nil, user_defined_id: nil)
75
75
  # A hold transaction representing reserved funds on a financial account. Holds
76
76
  # move funds from available to pending balance in anticipation of future payments.
77
77
  # They can be resolved via settlement (linked to payment), manual release, or
@@ -81,8 +81,6 @@ module Lithic
81
81
  #
82
82
  # @param created [Time] ISO 8601 timestamp of when the transaction was created
83
83
  #
84
- # @param status [Symbol, Lithic::Models::Hold::Status] Status of a hold transaction
85
- #
86
84
  # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
87
85
  #
88
86
  # @param currency [String]
@@ -99,26 +97,9 @@ module Lithic
99
97
  #
100
98
  # @param result [Symbol, Lithic::Models::Hold::Result]
101
99
  #
102
- # @param user_defined_id [String, nil]
103
-
104
- # Status of a hold transaction
100
+ # @param status [Symbol, Lithic::Models::Hold::Status] Status of a hold transaction
105
101
  #
106
- # @see Lithic::Models::Hold#status
107
- module Status
108
- extend Lithic::Internal::Type::Enum
109
-
110
- PENDING = :PENDING
111
- SETTLED = :SETTLED
112
- EXPIRED = :EXPIRED
113
- VOIDED = :VOIDED
114
- DECLINED = :DECLINED
115
- REVERSED = :REVERSED
116
- CANCELED = :CANCELED
117
- RETURNED = :RETURNED
118
-
119
- # @!method self.values
120
- # @return [Array<Symbol>]
121
- end
102
+ # @param user_defined_id [String, nil]
122
103
 
123
104
  # HOLD - Hold Transaction
124
105
  #
@@ -142,6 +123,21 @@ module Lithic
142
123
  # @!method self.values
143
124
  # @return [Array<Symbol>]
144
125
  end
126
+
127
+ # Status of a hold transaction
128
+ #
129
+ # @see Lithic::Models::Hold#status
130
+ module Status
131
+ extend Lithic::Internal::Type::Enum
132
+
133
+ PENDING = :PENDING
134
+ SETTLED = :SETTLED
135
+ EXPIRED = :EXPIRED
136
+ VOIDED = :VOIDED
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
145
141
  end
146
142
  end
147
143
  end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::IPRanges#retrieve
6
+ class IPRangeRetrieveParams < Lithic::Internal::Type::BaseModel
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
8
+ include Lithic::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ # @see Lithic::Resources::IPRanges#retrieve
6
+ class IPRangeRetrieveResponse < Lithic::Internal::Type::BaseModel
7
+ # @!attribute responders
8
+ # IP ranges that responder requests are sent from, in CIDR notation
9
+ #
10
+ # @return [Array<String>]
11
+ required :responders, Lithic::Internal::Type::ArrayOf[String]
12
+
13
+ # @!attribute updated
14
+ # Date and time the IP ranges were last changed
15
+ #
16
+ # @return [Time]
17
+ required :updated, Time
18
+
19
+ # @!method initialize(responders:, updated:)
20
+ # @param responders [Array<String>] IP ranges that responder requests are sent from, in CIDR notation
21
+ #
22
+ # @param updated [Time] Date and time the IP ranges were last changed
23
+ end
24
+ end
25
+ end
@@ -113,7 +113,8 @@ module Lithic
113
113
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
114
114
  # @!attribute address
115
115
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
116
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
116
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
117
+ # and KYC workflows.
117
118
  #
118
119
  # @return [Lithic::Models::Address]
119
120
  required :address, -> { Lithic::Address }
@@ -246,7 +247,8 @@ module Lithic
246
247
  class ControlPerson < Lithic::Internal::Type::BaseModel
247
248
  # @!attribute address
248
249
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
249
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
250
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
251
+ # and KYC workflows.
250
252
  #
251
253
  # @return [Lithic::Models::Address]
252
254
  required :address, -> { Lithic::Address }
@@ -75,33 +75,49 @@ module Lithic
75
75
  required :city, String
76
76
 
77
77
  # @!attribute country
78
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
79
- # 3166-1 alpha-3 three-character format.
78
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
79
+ # format. Supported countries depend on the onboarding workflow used for the
80
+ # account holder.
80
81
  #
81
82
  # @return [String]
82
83
  required :country, String
83
84
 
85
+ # @!attribute address2
86
+ # Unit or apartment number (if applicable).
87
+ #
88
+ # @return [String, nil]
89
+ optional :address2, String
90
+
84
91
  # @!attribute postal_code
85
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
86
- # five-digit ZIP or nine-digit ZIP+4.
92
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
93
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
94
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
95
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
96
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
97
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
87
98
  #
88
- # @return [String]
89
- required :postal_code, String
99
+ # @return [String, nil]
100
+ optional :postal_code, String, nil?: true
90
101
 
91
102
  # @!attribute state
92
- # Valid state code. Only USA state codes are currently supported, entered in
93
- # uppercase ISO 3166-2 two-character format.
103
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
104
+ # code for the country without the country prefix. For example, `CA` for
105
+ # California. Optional unless the address is in one of the following countries,
106
+ # where it is required:
94
107
  #
95
- # @return [String]
96
- required :state, String
97
-
98
- # @!attribute address2
99
- # Unit or apartment number (if applicable).
108
+ # - `USA`
109
+ # - `CAN`
110
+ # - `AUS`
111
+ # - `CHN`
112
+ # - `KOR`
113
+ # - `MEX`
114
+ # - `MYS`
115
+ # - `NZL`
100
116
  #
101
117
  # @return [String, nil]
102
- optional :address2, String
118
+ optional :state, String, nil?: true
103
119
 
104
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
120
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
105
121
  # Some parameter documentations has been truncated, see
106
122
  # {Lithic::Models::KYBBusinessEntity::Address} for more details.
107
123
  #
@@ -112,13 +128,13 @@ module Lithic
112
128
  #
113
129
  # @param city [String] Name of city.
114
130
  #
115
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
131
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
116
132
  #
117
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
133
+ # @param address2 [String] Unit or apartment number (if applicable).
118
134
  #
119
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
135
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
120
136
  #
121
- # @param address2 [String] Unit or apartment number (if applicable).
137
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
122
138
  end
123
139
  end
124
140
  end
@@ -58,7 +58,8 @@ module Lithic
58
58
  class Individual < Lithic::Internal::Type::BaseModel
59
59
  # @!attribute address
60
60
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
61
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
61
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
62
+ # and KYC workflows.
62
63
  #
63
64
  # @return [Lithic::Models::Address]
64
65
  required :address, -> { Lithic::Address }
@@ -91,6 +91,14 @@ module Lithic
91
91
  # @return [Symbol, Lithic::Models::NonPCICard::State]
92
92
  required :state, enum: -> { Lithic::NonPCICard::State }
93
93
 
94
+ # @!attribute tags
95
+ # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
96
+ # metadata with a resource for your own purposes. A resource can have at most 50
97
+ # tags, with keys up to 40 characters and values up to 500 characters
98
+ #
99
+ # @return [Hash{Symbol=>String}]
100
+ required :tags, Lithic::Internal::Type::HashOf[String]
101
+
94
102
  # @!attribute type
95
103
  # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
96
104
  # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
@@ -223,7 +231,7 @@ module Lithic
223
231
  # @return [Symbol, Lithic::Models::NonPCICard::Substatus, nil]
224
232
  optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }, nil?: true
225
233
 
226
- # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
234
+ # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, tags:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
227
235
  # Some parameter documentations has been truncated, see
228
236
  # {Lithic::Models::NonPCICard} for more details.
229
237
  #
@@ -250,6 +258,8 @@ module Lithic
250
258
  # @param state [Symbol, Lithic::Models::NonPCICard::State] Card state values: \* `CLOSED` - Card will no longer approve authorizations.
251
259
  # Clos
252
260
  #
261
+ # @param tags [Hash{Symbol=>String}] Key-value pairs for tagging resources. Tags allow you to associate arbitrary met
262
+ #
253
263
  # @param type [Symbol, Lithic::Models::NonPCICard::Type] Card types: \* `VIRTUAL` - Card will authorize at any merchant and can be added
254
264
  # t
255
265
  #
@@ -273,7 +273,8 @@ module Lithic
273
273
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
274
274
  # @!attribute address
275
275
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
276
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
276
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
277
+ # and KYC workflows.
277
278
  #
278
279
  # @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address, nil]
279
280
  optional :address,
@@ -342,51 +343,68 @@ module Lithic
342
343
  required :city, String
343
344
 
344
345
  # @!attribute country
345
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
346
- # 3166-1 alpha-3 three-character format.
346
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
347
+ # format. Supported countries depend on the onboarding workflow used for the
348
+ # account holder.
347
349
  #
348
350
  # @return [String]
349
351
  required :country, String
350
352
 
351
- # @!attribute postal_code
352
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
353
- # five-digit ZIP or nine-digit ZIP+4.
353
+ # @!attribute address2
354
+ # Unit or apartment number (if applicable).
354
355
  #
355
- # @return [String]
356
- required :postal_code, String
356
+ # @return [String, nil]
357
+ optional :address2, String
357
358
 
358
- # @!attribute state
359
- # Valid state code. Only USA state codes are currently supported, entered in
360
- # uppercase ISO 3166-2 two-character format.
359
+ # @!attribute postal_code
360
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
361
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
362
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
363
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
364
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
365
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
361
366
  #
362
- # @return [String]
363
- required :state, String
367
+ # @return [String, nil]
368
+ optional :postal_code, String, nil?: true
364
369
 
365
- # @!attribute address2
366
- # Unit or apartment number (if applicable).
370
+ # @!attribute state
371
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
372
+ # code for the country without the country prefix. For example, `CA` for
373
+ # California. Optional unless the address is in one of the following countries,
374
+ # where it is required:
375
+ #
376
+ # - `USA`
377
+ # - `CAN`
378
+ # - `AUS`
379
+ # - `CHN`
380
+ # - `KOR`
381
+ # - `MEX`
382
+ # - `MYS`
383
+ # - `NZL`
367
384
  #
368
385
  # @return [String, nil]
369
- optional :address2, String
386
+ optional :state, String, nil?: true
370
387
 
371
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
388
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
372
389
  # Some parameter documentations has been truncated, see
373
390
  # {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address}
374
391
  # for more details.
375
392
  #
376
393
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
377
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
394
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
395
+ # and KYC workflows.
378
396
  #
379
397
  # @param address1 [String] Valid deliverable address (no PO boxes).
380
398
  #
381
399
  # @param city [String] Name of city.
382
400
  #
383
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
401
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
384
402
  #
385
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
403
+ # @param address2 [String] Unit or apartment number (if applicable).
386
404
  #
387
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
405
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
388
406
  #
389
- # @param address2 [String] Unit or apartment number (if applicable).
407
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
390
408
  end
391
409
  end
392
410
 
@@ -394,7 +412,8 @@ module Lithic
394
412
  class ControlPerson < Lithic::Internal::Type::BaseModel
395
413
  # @!attribute address
396
414
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
397
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
415
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
416
+ # and KYC workflows.
398
417
  #
399
418
  # @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address, nil]
400
419
  optional :address, -> { Lithic::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address }
@@ -471,51 +490,68 @@ module Lithic
471
490
  required :city, String
472
491
 
473
492
  # @!attribute country
474
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
475
- # 3166-1 alpha-3 three-character format.
493
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
494
+ # format. Supported countries depend on the onboarding workflow used for the
495
+ # account holder.
476
496
  #
477
497
  # @return [String]
478
498
  required :country, String
479
499
 
480
- # @!attribute postal_code
481
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
482
- # five-digit ZIP or nine-digit ZIP+4.
500
+ # @!attribute address2
501
+ # Unit or apartment number (if applicable).
483
502
  #
484
- # @return [String]
485
- required :postal_code, String
503
+ # @return [String, nil]
504
+ optional :address2, String
486
505
 
487
- # @!attribute state
488
- # Valid state code. Only USA state codes are currently supported, entered in
489
- # uppercase ISO 3166-2 two-character format.
506
+ # @!attribute postal_code
507
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
508
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
509
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
510
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
511
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
512
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
490
513
  #
491
- # @return [String]
492
- required :state, String
514
+ # @return [String, nil]
515
+ optional :postal_code, String, nil?: true
493
516
 
494
- # @!attribute address2
495
- # Unit or apartment number (if applicable).
517
+ # @!attribute state
518
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
519
+ # code for the country without the country prefix. For example, `CA` for
520
+ # California. Optional unless the address is in one of the following countries,
521
+ # where it is required:
522
+ #
523
+ # - `USA`
524
+ # - `CAN`
525
+ # - `AUS`
526
+ # - `CHN`
527
+ # - `KOR`
528
+ # - `MEX`
529
+ # - `MYS`
530
+ # - `NZL`
496
531
  #
497
532
  # @return [String, nil]
498
- optional :address2, String
533
+ optional :state, String, nil?: true
499
534
 
500
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
535
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
501
536
  # Some parameter documentations has been truncated, see
502
537
  # {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address}
503
538
  # for more details.
504
539
  #
505
540
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
506
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
541
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
542
+ # and KYC workflows.
507
543
  #
508
544
  # @param address1 [String] Valid deliverable address (no PO boxes).
509
545
  #
510
546
  # @param city [String] Name of city.
511
547
  #
512
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
548
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
513
549
  #
514
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
550
+ # @param address2 [String] Unit or apartment number (if applicable).
515
551
  #
516
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
552
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
517
553
  #
518
- # @param address2 [String] Unit or apartment number (if applicable).
554
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
519
555
  end
520
556
  end
521
557
  end
@@ -595,7 +631,8 @@ module Lithic
595
631
  class Individual < Lithic::Internal::Type::BaseModel
596
632
  # @!attribute address
597
633
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
598
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
634
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
635
+ # and KYC workflows.
599
636
  #
600
637
  # @return [Lithic::Models::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address, nil]
601
638
  optional :address, -> { Lithic::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address }
@@ -666,51 +703,68 @@ module Lithic
666
703
  required :city, String
667
704
 
668
705
  # @!attribute country
669
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
670
- # 3166-1 alpha-3 three-character format.
706
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
707
+ # format. Supported countries depend on the onboarding workflow used for the
708
+ # account holder.
671
709
  #
672
710
  # @return [String]
673
711
  required :country, String
674
712
 
675
- # @!attribute postal_code
676
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
677
- # five-digit ZIP or nine-digit ZIP+4.
713
+ # @!attribute address2
714
+ # Unit or apartment number (if applicable).
678
715
  #
679
- # @return [String]
680
- required :postal_code, String
716
+ # @return [String, nil]
717
+ optional :address2, String
681
718
 
682
- # @!attribute state
683
- # Valid state code. Only USA state codes are currently supported, entered in
684
- # uppercase ISO 3166-2 two-character format.
719
+ # @!attribute postal_code
720
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
721
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
722
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
723
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
724
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
725
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
685
726
  #
686
- # @return [String]
687
- required :state, String
727
+ # @return [String, nil]
728
+ optional :postal_code, String, nil?: true
688
729
 
689
- # @!attribute address2
690
- # Unit or apartment number (if applicable).
730
+ # @!attribute state
731
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
732
+ # code for the country without the country prefix. For example, `CA` for
733
+ # California. Optional unless the address is in one of the following countries,
734
+ # where it is required:
735
+ #
736
+ # - `USA`
737
+ # - `CAN`
738
+ # - `AUS`
739
+ # - `CHN`
740
+ # - `KOR`
741
+ # - `MEX`
742
+ # - `MYS`
743
+ # - `NZL`
691
744
  #
692
745
  # @return [String, nil]
693
- optional :address2, String
746
+ optional :state, String, nil?: true
694
747
 
695
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
748
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
696
749
  # Some parameter documentations has been truncated, see
697
750
  # {Lithic::Models::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address}
698
751
  # for more details.
699
752
  #
700
753
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
701
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
754
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
755
+ # and KYC workflows.
702
756
  #
703
757
  # @param address1 [String] Valid deliverable address (no PO boxes).
704
758
  #
705
759
  # @param city [String] Name of city.
706
760
  #
707
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
761
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
708
762
  #
709
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
763
+ # @param address2 [String] Unit or apartment number (if applicable).
710
764
  #
711
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
765
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
712
766
  #
713
- # @param address2 [String] Unit or apartment number (if applicable).
767
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
714
768
  end
715
769
  end
716
770
  end