lithic 0.5.0 → 0.6.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 (98) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/models/account_holders/account_holder_entity.rb +183 -0
  5. data/lib/lithic/models/account_holders/entity_create_params.rb +159 -0
  6. data/lib/lithic/models/account_holders/entity_create_response.rb +113 -0
  7. data/lib/lithic/models/account_holders/entity_delete_params.rb +22 -0
  8. data/lib/lithic/models/auth_rules/auth_rule.rb +6 -2
  9. data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +3 -0
  10. data/lib/lithic/models/auth_rules/v2_create_params.rb +5 -2
  11. data/lib/lithic/models/auth_rules/v2_draft_params.rb +1 -0
  12. data/lib/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rb +9 -9
  13. data/lib/lithic/models/financial_account.rb +1 -0
  14. data/lib/lithic/models/financial_account_update_status_params.rb +1 -0
  15. data/lib/lithic/models/financial_accounts/category_tier.rb +28 -0
  16. data/lib/lithic/models/financial_accounts/interest_tier_schedule.rb +50 -0
  17. data/lib/lithic/models/financial_accounts/interest_tier_schedule_create_params.rb +16 -0
  18. data/lib/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rb +22 -0
  19. data/lib/lithic/models/financial_accounts/interest_tier_schedule_list_params.rb +40 -0
  20. data/lib/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rb +22 -0
  21. data/lib/lithic/models/financial_accounts/interest_tier_schedule_update_params.rb +44 -0
  22. data/lib/lithic/models/financial_accounts/loan_tape.rb +1 -0
  23. data/lib/lithic/models/financial_accounts/loan_tape_configuration.rb +63 -0
  24. data/lib/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rb +16 -0
  25. data/lib/lithic/models/financial_accounts/loan_tape_rebuild_configuration.rb +36 -0
  26. data/lib/lithic/models/financial_accounts/statement.rb +1 -0
  27. data/lib/lithic/models/{digital_wallet_token_metadata.rb → token_metadata.rb} +18 -19
  28. data/lib/lithic/models/tokenization_approval_request_webhook_event.rb +9 -9
  29. data/lib/lithic/models/tokenization_decisioning_request_webhook_event.rb +9 -9
  30. data/lib/lithic/models.rb +4 -2
  31. data/lib/lithic/resources/account_holders/entities.rb +89 -0
  32. data/lib/lithic/resources/account_holders.rb +4 -0
  33. data/lib/lithic/resources/financial_accounts/interest_tier_schedule.rb +205 -0
  34. data/lib/lithic/resources/financial_accounts/loan_tape_configuration.rb +36 -0
  35. data/lib/lithic/resources/financial_accounts.rb +9 -0
  36. data/lib/lithic/version.rb +1 -1
  37. data/lib/lithic.rb +18 -1
  38. data/rbi/lithic/models/account_holders/account_holder_entity.rbi +296 -0
  39. data/rbi/lithic/models/account_holders/entity_create_params.rbi +242 -0
  40. data/rbi/lithic/models/account_holders/entity_create_response.rbi +292 -0
  41. data/rbi/lithic/models/account_holders/entity_delete_params.rbi +43 -0
  42. data/rbi/lithic/models/auth_rules/auth_rule.rbi +6 -3
  43. data/rbi/lithic/models/auth_rules/conditional_block_parameters.rbi +1 -0
  44. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +6 -3
  45. data/rbi/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rbi +15 -17
  46. data/rbi/lithic/models/financial_account.rbi +5 -0
  47. data/rbi/lithic/models/financial_account_update_status_params.rbi +5 -0
  48. data/rbi/lithic/models/financial_accounts/category_tier.rbi +45 -0
  49. data/rbi/lithic/models/financial_accounts/interest_tier_schedule.rbi +75 -0
  50. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_create_params.rbi +32 -0
  51. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rbi +43 -0
  52. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_list_params.rbi +73 -0
  53. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rbi +43 -0
  54. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbi +70 -0
  55. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +5 -0
  56. data/rbi/lithic/models/financial_accounts/loan_tape_configuration.rbi +99 -0
  57. data/rbi/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rbi +32 -0
  58. data/rbi/lithic/models/financial_accounts/loan_tape_rebuild_configuration.rbi +65 -0
  59. data/rbi/lithic/models/financial_accounts/statement.rbi +5 -0
  60. data/rbi/lithic/models/{digital_wallet_token_metadata.rbi → token_metadata.rbi} +34 -41
  61. data/rbi/lithic/models/tokenization_approval_request_webhook_event.rbi +11 -17
  62. data/rbi/lithic/models/tokenization_decisioning_request_webhook_event.rbi +15 -17
  63. data/rbi/lithic/models.rbi +4 -2
  64. data/rbi/lithic/resources/account_holders/entities.rbi +80 -0
  65. data/rbi/lithic/resources/account_holders.rbi +3 -0
  66. data/rbi/lithic/resources/auth_rules/v2.rbi +2 -1
  67. data/rbi/lithic/resources/financial_accounts/interest_tier_schedule.rbi +156 -0
  68. data/rbi/lithic/resources/financial_accounts/loan_tape_configuration.rbi +30 -0
  69. data/rbi/lithic/resources/financial_accounts.rbi +10 -0
  70. data/sig/lithic/models/account_holders/account_holder_entity.rbs +137 -0
  71. data/sig/lithic/models/account_holders/entity_create_params.rbs +118 -0
  72. data/sig/lithic/models/account_holders/entity_create_response.rbs +117 -0
  73. data/sig/lithic/models/account_holders/entity_delete_params.rbs +26 -0
  74. data/sig/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rbs +5 -9
  75. data/sig/lithic/models/financial_account.rbs +2 -0
  76. data/sig/lithic/models/financial_account_update_status_params.rbs +2 -0
  77. data/sig/lithic/models/financial_accounts/category_tier.rbs +21 -0
  78. data/sig/lithic/models/financial_accounts/interest_tier_schedule.rbs +41 -0
  79. data/sig/lithic/models/financial_accounts/interest_tier_schedule_create_params.rbs +17 -0
  80. data/sig/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rbs +26 -0
  81. data/sig/lithic/models/financial_accounts/interest_tier_schedule_list_params.rbs +40 -0
  82. data/sig/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rbs +26 -0
  83. data/sig/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbs +38 -0
  84. data/sig/lithic/models/financial_accounts/loan_tape.rbs +2 -0
  85. data/sig/lithic/models/financial_accounts/loan_tape_configuration.rbs +60 -0
  86. data/sig/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rbs +17 -0
  87. data/sig/lithic/models/financial_accounts/loan_tape_rebuild_configuration.rbs +32 -0
  88. data/sig/lithic/models/financial_accounts/statement.rbs +2 -0
  89. data/sig/lithic/models/{digital_wallet_token_metadata.rbs → token_metadata.rbs} +19 -17
  90. data/sig/lithic/models/tokenization_approval_request_webhook_event.rbs +5 -9
  91. data/sig/lithic/models/tokenization_decisioning_request_webhook_event.rbs +5 -9
  92. data/sig/lithic/models.rbs +4 -2
  93. data/sig/lithic/resources/account_holders/entities.rbs +28 -0
  94. data/sig/lithic/resources/account_holders.rbs +2 -0
  95. data/sig/lithic/resources/financial_accounts/interest_tier_schedule.rbs +46 -0
  96. data/sig/lithic/resources/financial_accounts/loan_tape_configuration.rbs +14 -0
  97. data/sig/lithic/resources/financial_accounts.rbs +4 -0
  98. metadata +56 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3304bf0ccf6dceb8b20be0b0dd50668a3ca9db38a498cd71744ca697fadd450a
4
- data.tar.gz: 1bbb7a270b048dbcf98c63b31d6fab72cf3f89f45ffdaeabdd291ff6afcd27c7
3
+ metadata.gz: 37d9177dabd71343c3ba0be9ae82c47b899ac8c61b839359e72b13f35bb9a682
4
+ data.tar.gz: ea676fad5f242c817a9921928107da0be0612b88f7d4271d3b4c8a2d09685188
5
5
  SHA512:
6
- metadata.gz: 6be1b8020fe880a0c212a2ed28febf250c84f5f1862517e7ff1632d5b46c60d0f7bf1ecf57d89b0f04feceab67e06bcd44274691cd0b6a2ee6dc47207c4fbae5
7
- data.tar.gz: 8f7ee13cf8998bef9e4a8ce48337c3b5fe3205db212cd7bfca4db2e743b42168340c510e0d7be6ce41ccf2f5aaa4363acacd530441e34ebd7044f3bd7bd2878e
6
+ metadata.gz: 30978d9d1a737b508380fac34fd692dceed11ec5e5990028f6446c2387181b4e25d3006ad43d536f7094999a2745a516219b6e27d638c63be937271bf23ab4c9
7
+ data.tar.gz: 39c3a61ae93bfffb325b76dd6765990d55c80d8193b39aa57ad49ba034cb6df60fb9ea64cb98a830b50e1d6ea104c80ccd5704400a39c5e3f2fb3256a443dcc4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.6.0 (2026-02-27)
4
+
5
+ Full Changelog: [v0.5.0...v0.6.0](https://github.com/lithic-com/lithic-ruby/compare/v0.5.0...v0.6.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** Add account holder entity endpoints ([508b031](https://github.com/lithic-com/lithic-ruby/commit/508b0315e2ec79e74014759a97e82d209259e2cf))
10
+ * **api:** Add INTEREST_AND_FEES_PAUSED substatus to financial account ([23c7be9](https://github.com/lithic-com/lithic-ruby/commit/23c7be999b5a04a770dd18d2d34ff3967c68a85a))
11
+ * **api:** Expose MIL interest schedules and loan tape configuration endpoints ([a07d19f](https://github.com/lithic-com/lithic-ruby/commit/a07d19f3933cc1e282073f015bec87421a9a76d6))
12
+
13
+
14
+ ### Bug Fixes
15
+
16
+ * **api:** Correct token_metadata field name in tokenization.approval_request schema ([a4d5ae7](https://github.com/lithic-com/lithic-ruby/commit/a4d5ae7a5754d8901469be17c57b020c6c246839))
17
+ * properly mock time in ruby ci tests ([ac193de](https://github.com/lithic-com/lithic-ruby/commit/ac193de27a9ce3b9f5bf3162a57a95da2ea88352))
18
+
19
+
20
+ ### Chores
21
+
22
+ * update mock server docs ([8abd2ee](https://github.com/lithic-com/lithic-ruby/commit/8abd2eee9b45f88f1a5e821200cb657b07c48084))
23
+
24
+
25
+ ### Documentation
26
+
27
+ * Remove CONDITIONAL_BLOCK from docs ([993ab5c](https://github.com/lithic-com/lithic-ruby/commit/993ab5cda8b310bab4083f59713043549cc154f1))
28
+
3
29
  ## 0.5.0 (2026-02-13)
4
30
 
5
31
  Full Changelog: [v0.4.0...v0.5.0](https://github.com/lithic-com/lithic-ruby/compare/v0.4.0...v0.5.0)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "lithic", "~> 0.5.0"
27
+ gem "lithic", "~> 0.6.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -0,0 +1,183 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module AccountHolders
6
+ # @see Lithic::Resources::AccountHolders::Entities#delete
7
+ class AccountHolderEntity < Lithic::Internal::Type::BaseModel
8
+ # @!attribute token
9
+ # Globally unique identifier for the entity
10
+ #
11
+ # @return [String]
12
+ required :token, String
13
+
14
+ # @!attribute account_holder_token
15
+ # Globally unique identifier for the account holder
16
+ #
17
+ # @return [String]
18
+ required :account_holder_token, String
19
+
20
+ # @!attribute address
21
+ # Individual's current address
22
+ #
23
+ # @return [Lithic::Models::AccountHolders::AccountHolderEntity::Address]
24
+ required :address, -> { Lithic::AccountHolders::AccountHolderEntity::Address }
25
+
26
+ # @!attribute dob
27
+ # Individual's date of birth, as an RFC 3339 date
28
+ #
29
+ # @return [String, nil]
30
+ required :dob, String, nil?: true
31
+
32
+ # @!attribute email
33
+ # Individual's email address
34
+ #
35
+ # @return [String, nil]
36
+ required :email, String, nil?: true
37
+
38
+ # @!attribute first_name
39
+ # Individual's first name, as it appears on government-issued identity documents
40
+ #
41
+ # @return [String, nil]
42
+ required :first_name, String, nil?: true
43
+
44
+ # @!attribute last_name
45
+ # Individual's last name, as it appears on government-issued identity documents
46
+ #
47
+ # @return [String, nil]
48
+ required :last_name, String, nil?: true
49
+
50
+ # @!attribute phone_number
51
+ # Individual's phone number, entered in E.164 format
52
+ #
53
+ # @return [String, nil]
54
+ required :phone_number, String, nil?: true
55
+
56
+ # @!attribute status
57
+ # The status of the entity
58
+ #
59
+ # @return [Symbol, Lithic::Models::AccountHolders::AccountHolderEntity::Status]
60
+ required :status, enum: -> { Lithic::AccountHolders::AccountHolderEntity::Status }
61
+
62
+ # @!attribute type
63
+ # The type of entity
64
+ #
65
+ # @return [Symbol, Lithic::Models::AccountHolders::AccountHolderEntity::Type]
66
+ required :type, enum: -> { Lithic::AccountHolders::AccountHolderEntity::Type }
67
+
68
+ # @!method initialize(token:, account_holder_token:, address:, dob:, email:, first_name:, last_name:, phone_number:, status:, type:)
69
+ # Information about an entity associated with an account holder
70
+ #
71
+ # @param token [String] Globally unique identifier for the entity
72
+ #
73
+ # @param account_holder_token [String] Globally unique identifier for the account holder
74
+ #
75
+ # @param address [Lithic::Models::AccountHolders::AccountHolderEntity::Address] Individual's current address
76
+ #
77
+ # @param dob [String, nil] Individual's date of birth, as an RFC 3339 date
78
+ #
79
+ # @param email [String, nil] Individual's email address
80
+ #
81
+ # @param first_name [String, nil] Individual's first name, as it appears on government-issued identity documents
82
+ #
83
+ # @param last_name [String, nil] Individual's last name, as it appears on government-issued identity documents
84
+ #
85
+ # @param phone_number [String, nil] Individual's phone number, entered in E.164 format
86
+ #
87
+ # @param status [Symbol, Lithic::Models::AccountHolders::AccountHolderEntity::Status] The status of the entity
88
+ #
89
+ # @param type [Symbol, Lithic::Models::AccountHolders::AccountHolderEntity::Type] The type of entity
90
+
91
+ # @see Lithic::Models::AccountHolders::AccountHolderEntity#address
92
+ class Address < Lithic::Internal::Type::BaseModel
93
+ # @!attribute address1
94
+ # Valid deliverable address (no PO boxes).
95
+ #
96
+ # @return [String]
97
+ required :address1, String
98
+
99
+ # @!attribute city
100
+ # Name of city.
101
+ #
102
+ # @return [String]
103
+ required :city, String
104
+
105
+ # @!attribute country
106
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
107
+ # 3166-1 alpha-3 three-character format.
108
+ #
109
+ # @return [String]
110
+ required :country, String
111
+
112
+ # @!attribute postal_code
113
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
114
+ # five-digit ZIP or nine-digit ZIP+4.
115
+ #
116
+ # @return [String]
117
+ required :postal_code, String
118
+
119
+ # @!attribute state
120
+ # Valid state code. Only USA state codes are currently supported, entered in
121
+ # uppercase ISO 3166-2 two-character format.
122
+ #
123
+ # @return [String]
124
+ required :state, String
125
+
126
+ # @!attribute address2
127
+ # Unit or apartment number (if applicable).
128
+ #
129
+ # @return [String, nil]
130
+ optional :address2, String
131
+
132
+ # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
133
+ # Some parameter documentations has been truncated, see
134
+ # {Lithic::Models::AccountHolders::AccountHolderEntity::Address} for more details.
135
+ #
136
+ # Individual's current address
137
+ #
138
+ # @param address1 [String] Valid deliverable address (no PO boxes).
139
+ #
140
+ # @param city [String] Name of city.
141
+ #
142
+ # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
143
+ #
144
+ # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
145
+ #
146
+ # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
147
+ #
148
+ # @param address2 [String] Unit or apartment number (if applicable).
149
+ end
150
+
151
+ # The status of the entity
152
+ #
153
+ # @see Lithic::Models::AccountHolders::AccountHolderEntity#status
154
+ module Status
155
+ extend Lithic::Internal::Type::Enum
156
+
157
+ ACCEPTED = :ACCEPTED
158
+ INACTIVE = :INACTIVE
159
+ PENDING_REVIEW = :PENDING_REVIEW
160
+ REJECTED = :REJECTED
161
+
162
+ # @!method self.values
163
+ # @return [Array<Symbol>]
164
+ end
165
+
166
+ # The type of entity
167
+ #
168
+ # @see Lithic::Models::AccountHolders::AccountHolderEntity#type
169
+ module Type
170
+ extend Lithic::Internal::Type::Enum
171
+
172
+ BENEFICIAL_OWNER_INDIVIDUAL = :BENEFICIAL_OWNER_INDIVIDUAL
173
+ CONTROL_PERSON = :CONTROL_PERSON
174
+
175
+ # @!method self.values
176
+ # @return [Array<Symbol>]
177
+ end
178
+ end
179
+ end
180
+
181
+ AccountHolderEntity = AccountHolders::AccountHolderEntity
182
+ end
183
+ end
@@ -0,0 +1,159 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module AccountHolders
6
+ # @see Lithic::Resources::AccountHolders::Entities#create
7
+ class EntityCreateParams < Lithic::Internal::Type::BaseModel
8
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
+ include Lithic::Internal::Type::RequestParameters
10
+
11
+ # @!attribute address
12
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
13
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
14
+ #
15
+ # @return [Lithic::Models::AccountHolders::EntityCreateParams::Address]
16
+ required :address, -> { Lithic::AccountHolders::EntityCreateParams::Address }
17
+
18
+ # @!attribute dob
19
+ # Individual's date of birth, as an RFC 3339 date.
20
+ #
21
+ # @return [String]
22
+ required :dob, String
23
+
24
+ # @!attribute email
25
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
26
+ # customer email address may be used to communicate dispute status and resolution.
27
+ #
28
+ # @return [String]
29
+ required :email, String
30
+
31
+ # @!attribute first_name
32
+ # Individual's first name, as it appears on government-issued identity documents.
33
+ #
34
+ # @return [String]
35
+ required :first_name, String
36
+
37
+ # @!attribute government_id
38
+ # Government-issued identification number (required for identity verification and
39
+ # compliance with banking regulations). Social Security Numbers (SSN) and
40
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
41
+ # entered as full nine-digits, with or without hyphens
42
+ #
43
+ # @return [String]
44
+ required :government_id, String
45
+
46
+ # @!attribute last_name
47
+ # Individual's last name, as it appears on government-issued identity documents.
48
+ #
49
+ # @return [String]
50
+ required :last_name, String
51
+
52
+ # @!attribute phone_number
53
+ # Individual's phone number, entered in E.164 format.
54
+ #
55
+ # @return [String]
56
+ required :phone_number, String
57
+
58
+ # @!attribute type
59
+ # The type of entity to create on the account holder
60
+ #
61
+ # @return [Symbol, Lithic::Models::AccountHolders::EntityCreateParams::Type]
62
+ required :type, enum: -> { Lithic::AccountHolders::EntityCreateParams::Type }
63
+
64
+ # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:, type:, request_options: {})
65
+ # Some parameter documentations has been truncated, see
66
+ # {Lithic::Models::AccountHolders::EntityCreateParams} for more details.
67
+ #
68
+ # @param address [Lithic::Models::AccountHolders::EntityCreateParams::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
69
+ #
70
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
71
+ #
72
+ # @param email [String] Individual's email address. If utilizing Lithic for chargeback processing, this
73
+ #
74
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
75
+ #
76
+ # @param government_id [String] Government-issued identification number (required for identity verification and
77
+ #
78
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
79
+ #
80
+ # @param phone_number [String] Individual's phone number, entered in E.164 format.
81
+ #
82
+ # @param type [Symbol, Lithic::Models::AccountHolders::EntityCreateParams::Type] The type of entity to create on the account holder
83
+ #
84
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
85
+
86
+ class Address < Lithic::Internal::Type::BaseModel
87
+ # @!attribute address1
88
+ # Valid deliverable address (no PO boxes).
89
+ #
90
+ # @return [String]
91
+ required :address1, String
92
+
93
+ # @!attribute city
94
+ # Name of city.
95
+ #
96
+ # @return [String]
97
+ required :city, String
98
+
99
+ # @!attribute country
100
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
101
+ # 3166-1 alpha-3 three-character format.
102
+ #
103
+ # @return [String]
104
+ required :country, String
105
+
106
+ # @!attribute postal_code
107
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
108
+ # five-digit ZIP or nine-digit ZIP+4.
109
+ #
110
+ # @return [String]
111
+ required :postal_code, String
112
+
113
+ # @!attribute state
114
+ # Valid state code. Only USA state codes are currently supported, entered in
115
+ # uppercase ISO 3166-2 two-character format.
116
+ #
117
+ # @return [String]
118
+ required :state, String
119
+
120
+ # @!attribute address2
121
+ # Unit or apartment number (if applicable).
122
+ #
123
+ # @return [String, nil]
124
+ optional :address2, String
125
+
126
+ # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
127
+ # Some parameter documentations has been truncated, see
128
+ # {Lithic::Models::AccountHolders::EntityCreateParams::Address} for more details.
129
+ #
130
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
131
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
132
+ #
133
+ # @param address1 [String] Valid deliverable address (no PO boxes).
134
+ #
135
+ # @param city [String] Name of city.
136
+ #
137
+ # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
138
+ #
139
+ # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
140
+ #
141
+ # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
142
+ #
143
+ # @param address2 [String] Unit or apartment number (if applicable).
144
+ end
145
+
146
+ # The type of entity to create on the account holder
147
+ module Type
148
+ extend Lithic::Internal::Type::Enum
149
+
150
+ BENEFICIAL_OWNER_INDIVIDUAL = :BENEFICIAL_OWNER_INDIVIDUAL
151
+ CONTROL_PERSON = :CONTROL_PERSON
152
+
153
+ # @!method self.values
154
+ # @return [Array<Symbol>]
155
+ end
156
+ end
157
+ end
158
+ end
159
+ end
@@ -0,0 +1,113 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module AccountHolders
6
+ # @see Lithic::Resources::AccountHolders::Entities#create
7
+ class EntityCreateResponse < Lithic::Internal::Type::BaseModel
8
+ # @!attribute token
9
+ # Globally unique identifier for the entity
10
+ #
11
+ # @return [String]
12
+ required :token, String
13
+
14
+ # @!attribute account_holder_token
15
+ # Globally unique identifier for the account holder
16
+ #
17
+ # @return [String]
18
+ required :account_holder_token, String
19
+
20
+ # @!attribute created
21
+ # Timestamp of when the entity was created
22
+ #
23
+ # @return [Time]
24
+ required :created, Time
25
+
26
+ # @!attribute required_documents
27
+ # A list of documents required for the entity to be approved
28
+ #
29
+ # @return [Array<Lithic::Models::RequiredDocument>]
30
+ required :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::RequiredDocument] }
31
+
32
+ # @!attribute status
33
+ # Entity verification status
34
+ #
35
+ # @return [Symbol, Lithic::Models::AccountHolders::EntityCreateResponse::Status]
36
+ required :status, enum: -> { Lithic::Models::AccountHolders::EntityCreateResponse::Status }
37
+
38
+ # @!attribute status_reasons
39
+ # Reason for the evaluation status
40
+ #
41
+ # @return [Array<Symbol, Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason>]
42
+ required :status_reasons,
43
+ -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason] }
44
+
45
+ # @!method initialize(token:, account_holder_token:, created:, required_documents:, status:, status_reasons:)
46
+ # Response body for creating a new beneficial owner or replacing the control
47
+ # person entity on an existing KYB account holder.
48
+ #
49
+ # @param token [String] Globally unique identifier for the entity
50
+ #
51
+ # @param account_holder_token [String] Globally unique identifier for the account holder
52
+ #
53
+ # @param created [Time] Timestamp of when the entity was created
54
+ #
55
+ # @param required_documents [Array<Lithic::Models::RequiredDocument>] A list of documents required for the entity to be approved
56
+ #
57
+ # @param status [Symbol, Lithic::Models::AccountHolders::EntityCreateResponse::Status] Entity verification status
58
+ #
59
+ # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolders::EntityCreateResponse::StatusReason>] Reason for the evaluation status
60
+
61
+ # Entity verification status
62
+ #
63
+ # @see Lithic::Models::AccountHolders::EntityCreateResponse#status
64
+ module Status
65
+ extend Lithic::Internal::Type::Enum
66
+
67
+ ACCEPTED = :ACCEPTED
68
+ INACTIVE = :INACTIVE
69
+ PENDING_REVIEW = :PENDING_REVIEW
70
+ REJECTED = :REJECTED
71
+
72
+ # @!method self.values
73
+ # @return [Array<Symbol>]
74
+ end
75
+
76
+ # Status Reasons for KYC/KYB enrollment states
77
+ module StatusReason
78
+ extend Lithic::Internal::Type::Enum
79
+
80
+ ADDRESS_VERIFICATION_FAILURE = :ADDRESS_VERIFICATION_FAILURE
81
+ AGE_THRESHOLD_FAILURE = :AGE_THRESHOLD_FAILURE
82
+ COMPLETE_VERIFICATION_FAILURE = :COMPLETE_VERIFICATION_FAILURE
83
+ DOB_VERIFICATION_FAILURE = :DOB_VERIFICATION_FAILURE
84
+ ID_VERIFICATION_FAILURE = :ID_VERIFICATION_FAILURE
85
+ MAX_DOCUMENT_ATTEMPTS = :MAX_DOCUMENT_ATTEMPTS
86
+ MAX_RESUBMISSION_ATTEMPTS = :MAX_RESUBMISSION_ATTEMPTS
87
+ NAME_VERIFICATION_FAILURE = :NAME_VERIFICATION_FAILURE
88
+ OTHER_VERIFICATION_FAILURE = :OTHER_VERIFICATION_FAILURE
89
+ RISK_THRESHOLD_FAILURE = :RISK_THRESHOLD_FAILURE
90
+ WATCHLIST_ALERT_FAILURE = :WATCHLIST_ALERT_FAILURE
91
+ PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE = :PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE
92
+ PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE =
93
+ :PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE
94
+ PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE = :PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE
95
+ PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED =
96
+ :PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED
97
+ PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE = :PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE
98
+ PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED = :PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED
99
+ PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE = :PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE
100
+ PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE = :PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE
101
+ PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE = :PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE
102
+ CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE = :CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE
103
+ CONTROL_PERSON_ID_VERIFICATION_FAILURE = :CONTROL_PERSON_ID_VERIFICATION_FAILURE
104
+ CONTROL_PERSON_DOB_VERIFICATION_FAILURE = :CONTROL_PERSON_DOB_VERIFICATION_FAILURE
105
+ CONTROL_PERSON_NAME_VERIFICATION_FAILURE = :CONTROL_PERSON_NAME_VERIFICATION_FAILURE
106
+
107
+ # @!method self.values
108
+ # @return [Array<Symbol>]
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module AccountHolders
6
+ # @see Lithic::Resources::AccountHolders::Entities#delete
7
+ class EntityDeleteParams < Lithic::Internal::Type::BaseModel
8
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
+ include Lithic::Internal::Type::RequestParameters
10
+
11
+ # @!attribute account_holder_token
12
+ #
13
+ # @return [String]
14
+ required :account_holder_token, String
15
+
16
+ # @!method initialize(account_holder_token:, request_options: {})
17
+ # @param account_holder_token [String]
18
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -76,7 +76,8 @@ module Lithic
76
76
  # several event streams, the effective one is defined by the separate
77
77
  # `event_stream` field.
78
78
  #
79
- # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
79
+ # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
80
+ # AUTHORIZATION event stream.
80
81
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
81
82
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
82
83
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -152,6 +153,7 @@ module Lithic
152
153
  module Parameters
153
154
  extend Lithic::Internal::Type::Union
154
155
 
156
+ # Deprecated: Use CONDITIONAL_ACTION instead.
155
157
  variant -> { Lithic::AuthRules::ConditionalBlockParameters }
156
158
 
157
159
  variant -> { Lithic::AuthRules::VelocityLimitParams }
@@ -202,6 +204,7 @@ module Lithic
202
204
  module Parameters
203
205
  extend Lithic::Internal::Type::Union
204
206
 
207
+ # Deprecated: Use CONDITIONAL_ACTION instead.
205
208
  variant -> { Lithic::AuthRules::ConditionalBlockParameters }
206
209
 
207
210
  variant -> { Lithic::AuthRules::VelocityLimitParams }
@@ -239,7 +242,8 @@ module Lithic
239
242
  # several event streams, the effective one is defined by the separate
240
243
  # `event_stream` field.
241
244
  #
242
- # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
245
+ # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
246
+ # AUTHORIZATION event stream.
243
247
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
244
248
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
245
249
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module AuthRules
6
+ # @deprecated
6
7
  class ConditionalBlockParameters < Lithic::Internal::Type::BaseModel
7
8
  # @!attribute conditions
8
9
  #
@@ -10,6 +11,8 @@ module Lithic
10
11
  required :conditions, -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::AuthRuleCondition] }
11
12
 
12
13
  # @!method initialize(conditions:)
14
+ # Deprecated: Use CONDITIONAL_ACTION instead.
15
+ #
13
16
  # @param conditions [Array<Lithic::Models::AuthRules::AuthRuleCondition>]
14
17
  end
15
18
  end
@@ -20,7 +20,8 @@ module Lithic
20
20
  # several event streams, the effective one is defined by the separate
21
21
  # `event_stream` field.
22
22
  #
23
- # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
23
+ # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
24
+ # AUTHORIZATION event stream.
24
25
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
25
26
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
26
27
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -99,6 +100,7 @@ module Lithic
99
100
  module Parameters
100
101
  extend Lithic::Internal::Type::Union
101
102
 
103
+ # Deprecated: Use CONDITIONAL_ACTION instead.
102
104
  variant -> { Lithic::AuthRules::ConditionalBlockParameters }
103
105
 
104
106
  variant -> { Lithic::AuthRules::VelocityLimitParams }
@@ -122,7 +124,8 @@ module Lithic
122
124
  # several event streams, the effective one is defined by the separate
123
125
  # `event_stream` field.
124
126
  #
125
- # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream.
127
+ # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
128
+ # AUTHORIZATION event stream.
126
129
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
127
130
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
128
131
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -23,6 +23,7 @@ module Lithic
23
23
  module Parameters
24
24
  extend Lithic::Internal::Type::Union
25
25
 
26
+ # Deprecated: Use CONDITIONAL_ACTION instead.
26
27
  variant -> { Lithic::AuthRules::ConditionalBlockParameters }
27
28
 
28
29
  variant -> { Lithic::AuthRules::VelocityLimitParams }
@@ -31,6 +31,12 @@ module Lithic
31
31
  },
32
32
  nil?: true
33
33
 
34
+ # @!attribute digital_wallet_token_metadata
35
+ # Contains the metadata for the digital wallet being tokenized.
36
+ #
37
+ # @return [Lithic::Models::TokenMetadata]
38
+ required :digital_wallet_token_metadata, -> { Lithic::TokenMetadata }
39
+
34
40
  # @!attribute event_type
35
41
  # The name of this event
36
42
  #
@@ -68,12 +74,6 @@ module Lithic
68
74
  # @return [Lithic::Models::Device, nil]
69
75
  optional :device, -> { Lithic::Device }
70
76
 
71
- # @!attribute digital_wallet_token_metadata
72
- # Contains the metadata for the digital wallet being tokenized.
73
- #
74
- # @return [Lithic::Models::DigitalWalletTokenMetadata, nil]
75
- optional :digital_wallet_token_metadata, -> { Lithic::DigitalWalletTokenMetadata }
76
-
77
77
  # @!attribute rule_results
78
78
  # Results from rules that were evaluated for this tokenization
79
79
  #
@@ -101,7 +101,7 @@ module Lithic
101
101
  optional :tokenization_tfa_reasons,
102
102
  -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::TokenizationTfaReason] }
103
103
 
104
- # @!method initialize(account_token:, card_token:, created:, customer_tokenization_decision:, event_type:, issuer_decision:, tokenization_channel:, tokenization_token:, wallet_decisioning_info:, device: nil, digital_wallet_token_metadata: nil, rule_results: nil, tokenization_decline_reasons: nil, tokenization_source: nil, tokenization_tfa_reasons: nil)
104
+ # @!method initialize(account_token:, card_token:, created:, customer_tokenization_decision:, digital_wallet_token_metadata:, event_type:, issuer_decision:, tokenization_channel:, tokenization_token:, wallet_decisioning_info:, device: nil, rule_results: nil, tokenization_decline_reasons: nil, tokenization_source: nil, tokenization_tfa_reasons: nil)
105
105
  # Some parameter documentations has been truncated, see
106
106
  # {Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent} for more
107
107
  # details.
@@ -114,6 +114,8 @@ module Lithic
114
114
  #
115
115
  # @param customer_tokenization_decision [Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision, nil] Contains the metadata for the customer tokenization decision.
116
116
  #
117
+ # @param digital_wallet_token_metadata [Lithic::Models::TokenMetadata] Contains the metadata for the digital wallet being tokenized.
118
+ #
117
119
  # @param event_type [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::EventType] The name of this event
118
120
  #
119
121
  # @param issuer_decision [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::IssuerDecision] Whether Lithic decisioned on the token, and if so, what the decision was. APPROV
@@ -126,8 +128,6 @@ module Lithic
126
128
  #
127
129
  # @param device [Lithic::Models::Device]
128
130
  #
129
- # @param digital_wallet_token_metadata [Lithic::Models::DigitalWalletTokenMetadata] Contains the metadata for the digital wallet being tokenized.
130
- #
131
131
  # @param rule_results [Array<Lithic::Models::TokenizationRuleResult>] Results from rules that were evaluated for this tokenization
132
132
  #
133
133
  # @param tokenization_decline_reasons [Array<Symbol, Lithic::Models::TokenizationDeclineReason>] List of reasons why the tokenization was declined