increase 1.243.0 → 1.245.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d0e295da15aeecb29c4be017366f5464761d7075423ef1a75275116cc0bc8bce
4
- data.tar.gz: '019a5d091730152904019de802312abccd1867c5a8ee66db6c6df18e36b84f02'
3
+ metadata.gz: 1fb49e2148d54c6e411da14c39835004275a99efb66cf51361ed597224cb0166
4
+ data.tar.gz: 332f30116682e7c30878efd596781ddc837eac715a2a74d2c30bd66fd5a9a02d
5
5
  SHA512:
6
- metadata.gz: '09b7000fc7515a2d688d9d5511fc485a4db02f62c2eac4e72988824846977232982a87b5b3c643ceac2b7e44caf278394a0e8852830965be1dc022cf9c57ac48'
7
- data.tar.gz: 656aa50c9f47b6ff1ca20392b8e2b1f5ea187f3c34fce75d7207fdc395ced126d0fc819276b2172aa2f4fc28cead7a22ae41d5d5edc3439249eb44dbc255ade4
6
+ metadata.gz: 7c74e5b1507d5037d79149e6d9187835f6e9aafabba17190922107dc19a045a9e68731e138a9cddc23ce64cbf5cc33e5bdd494ec54df8ada59e878447b8e88c8
7
+ data.tar.gz: 92e67743e4cfff01765486dc6ba9c08cf0427503e689783f6591181ab1a55109cdd2961cf96b9b70c483c2fa6491f335d53e3468a549dd72365618e8d17c017c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.245.0 (2026-03-12)
4
+
5
+ Full Changelog: [v1.244.0...v1.245.0](https://github.com/Increase/increase-ruby/compare/v1.244.0...v1.245.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([92af05a](https://github.com/Increase/increase-ruby/commit/92af05a3ccbe326343ba547df2276f25455124e3))
10
+
11
+ ## 1.244.0 (2026-03-11)
12
+
13
+ Full Changelog: [v1.243.0...v1.244.0](https://github.com/Increase/increase-ruby/compare/v1.243.0...v1.244.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([5881594](https://github.com/Increase/increase-ruby/commit/5881594091e1695f2d69c17bd8018812c3822fba))
18
+
3
19
  ## 1.243.0 (2026-03-11)
4
20
 
5
21
  Full Changelog: [v1.242.0...v1.243.0](https://github.com/Increase/increase-ruby/compare/v1.242.0...v1.243.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.243.0"
18
+ gem "increase", "~> 1.245.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -20,7 +20,28 @@ module Increase
20
20
  # @return [Increase::Models::BeneficialOwnerUpdateParams::Address, nil]
21
21
  optional :address, -> { Increase::BeneficialOwnerUpdateParams::Address }
22
22
 
23
- # @!method initialize(entity_beneficial_owner_id:, address: nil, request_options: {})
23
+ # @!attribute confirmed_no_us_tax_id
24
+ # The identification method for an individual can only be a passport, driver's
25
+ # license, or other document if you've confirmed the individual does not have a US
26
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
27
+ # Number).
28
+ #
29
+ # @return [Boolean, nil]
30
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
31
+
32
+ # @!attribute identification
33
+ # A means of verifying the person's identity.
34
+ #
35
+ # @return [Increase::Models::BeneficialOwnerUpdateParams::Identification, nil]
36
+ optional :identification, -> { Increase::BeneficialOwnerUpdateParams::Identification }
37
+
38
+ # @!attribute name
39
+ # The individual's legal name.
40
+ #
41
+ # @return [String, nil]
42
+ optional :name, String
43
+
44
+ # @!method initialize(entity_beneficial_owner_id:, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, request_options: {})
24
45
  # Some parameter documentations has been truncated, see
25
46
  # {Increase::Models::BeneficialOwnerUpdateParams} for more details.
26
47
  #
@@ -28,6 +49,12 @@ module Increase
28
49
  #
29
50
  # @param address [Increase::Models::BeneficialOwnerUpdateParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
30
51
  #
52
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
53
+ #
54
+ # @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification] A means of verifying the person's identity.
55
+ #
56
+ # @param name [String] The individual's legal name.
57
+ #
31
58
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
32
59
 
33
60
  class Address < Increase::Internal::Type::BaseModel
@@ -87,6 +114,214 @@ module Increase
87
114
  #
88
115
  # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
89
116
  end
117
+
118
+ class Identification < Increase::Internal::Type::BaseModel
119
+ # @!attribute method_
120
+ # A method that can be used to verify the individual's identity.
121
+ #
122
+ # @return [Symbol, Increase::Models::BeneficialOwnerUpdateParams::Identification::Method]
123
+ required :method_,
124
+ enum: -> { Increase::BeneficialOwnerUpdateParams::Identification::Method },
125
+ api_name: :method
126
+
127
+ # @!attribute number
128
+ # An identification number that can be used to verify the individual's identity,
129
+ # such as a social security number.
130
+ #
131
+ # @return [String]
132
+ required :number, String
133
+
134
+ # @!attribute drivers_license
135
+ # Information about the United States driver's license used for identification.
136
+ # Required if `method` is equal to `drivers_license`.
137
+ #
138
+ # @return [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense, nil]
139
+ optional :drivers_license, -> { Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense }
140
+
141
+ # @!attribute other
142
+ # Information about the identification document provided. Required if `method` is
143
+ # equal to `other`.
144
+ #
145
+ # @return [Increase::Models::BeneficialOwnerUpdateParams::Identification::Other, nil]
146
+ optional :other, -> { Increase::BeneficialOwnerUpdateParams::Identification::Other }
147
+
148
+ # @!attribute passport
149
+ # Information about the passport used for identification. Required if `method` is
150
+ # equal to `passport`.
151
+ #
152
+ # @return [Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport, nil]
153
+ optional :passport, -> { Increase::BeneficialOwnerUpdateParams::Identification::Passport }
154
+
155
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
156
+ # Some parameter documentations has been truncated, see
157
+ # {Increase::Models::BeneficialOwnerUpdateParams::Identification} for more
158
+ # details.
159
+ #
160
+ # A means of verifying the person's identity.
161
+ #
162
+ # @param method_ [Symbol, Increase::Models::BeneficialOwnerUpdateParams::Identification::Method] A method that can be used to verify the individual's identity.
163
+ #
164
+ # @param number [String] An identification number that can be used to verify the individual's identity, s
165
+ #
166
+ # @param drivers_license [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
167
+ #
168
+ # @param other [Increase::Models::BeneficialOwnerUpdateParams::Identification::Other] Information about the identification document provided. Required if `method` is
169
+ #
170
+ # @param passport [Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport] Information about the passport used for identification. Required if `method` is
171
+
172
+ # A method that can be used to verify the individual's identity.
173
+ #
174
+ # @see Increase::Models::BeneficialOwnerUpdateParams::Identification#method_
175
+ module Method
176
+ extend Increase::Internal::Type::Enum
177
+
178
+ # A social security number.
179
+ SOCIAL_SECURITY_NUMBER = :social_security_number
180
+
181
+ # An individual taxpayer identification number (ITIN).
182
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
183
+
184
+ # A passport number.
185
+ PASSPORT = :passport
186
+
187
+ # A driver's license number.
188
+ DRIVERS_LICENSE = :drivers_license
189
+
190
+ # Another identifying document.
191
+ OTHER = :other
192
+
193
+ # @!method self.values
194
+ # @return [Array<Symbol>]
195
+ end
196
+
197
+ # @see Increase::Models::BeneficialOwnerUpdateParams::Identification#drivers_license
198
+ class DriversLicense < Increase::Internal::Type::BaseModel
199
+ # @!attribute expiration_date
200
+ # The driver's license's expiration date in YYYY-MM-DD format.
201
+ #
202
+ # @return [Date]
203
+ required :expiration_date, Date
204
+
205
+ # @!attribute file_id
206
+ # The identifier of the File containing the front of the driver's license.
207
+ #
208
+ # @return [String]
209
+ required :file_id, String
210
+
211
+ # @!attribute state
212
+ # The state that issued the provided driver's license.
213
+ #
214
+ # @return [String]
215
+ required :state, String
216
+
217
+ # @!attribute back_file_id
218
+ # The identifier of the File containing the back of the driver's license.
219
+ #
220
+ # @return [String, nil]
221
+ optional :back_file_id, String
222
+
223
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
224
+ # Information about the United States driver's license used for identification.
225
+ # Required if `method` is equal to `drivers_license`.
226
+ #
227
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
228
+ #
229
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
230
+ #
231
+ # @param state [String] The state that issued the provided driver's license.
232
+ #
233
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
234
+ end
235
+
236
+ # @see Increase::Models::BeneficialOwnerUpdateParams::Identification#other
237
+ class Other < Increase::Internal::Type::BaseModel
238
+ # @!attribute country
239
+ # The two-character ISO 3166-1 code representing the country that issued the
240
+ # document (e.g., `US`).
241
+ #
242
+ # @return [String]
243
+ required :country, String
244
+
245
+ # @!attribute description
246
+ # A description of the document submitted.
247
+ #
248
+ # @return [String]
249
+ required :description, String
250
+
251
+ # @!attribute file_id
252
+ # The identifier of the File containing the front of the document.
253
+ #
254
+ # @return [String]
255
+ required :file_id, String
256
+
257
+ # @!attribute back_file_id
258
+ # The identifier of the File containing the back of the document. Not every
259
+ # document has a reverse side.
260
+ #
261
+ # @return [String, nil]
262
+ optional :back_file_id, String
263
+
264
+ # @!attribute expiration_date
265
+ # The document's expiration date in YYYY-MM-DD format.
266
+ #
267
+ # @return [Date, nil]
268
+ optional :expiration_date, Date
269
+
270
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
271
+ # Some parameter documentations has been truncated, see
272
+ # {Increase::Models::BeneficialOwnerUpdateParams::Identification::Other} for more
273
+ # details.
274
+ #
275
+ # Information about the identification document provided. Required if `method` is
276
+ # equal to `other`.
277
+ #
278
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
279
+ #
280
+ # @param description [String] A description of the document submitted.
281
+ #
282
+ # @param file_id [String] The identifier of the File containing the front of the document.
283
+ #
284
+ # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
285
+ #
286
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
287
+ end
288
+
289
+ # @see Increase::Models::BeneficialOwnerUpdateParams::Identification#passport
290
+ class Passport < Increase::Internal::Type::BaseModel
291
+ # @!attribute country
292
+ # The two-character ISO 3166-1 code representing the country that issued the
293
+ # document (e.g., `US`).
294
+ #
295
+ # @return [String]
296
+ required :country, String
297
+
298
+ # @!attribute expiration_date
299
+ # The passport's expiration date in YYYY-MM-DD format.
300
+ #
301
+ # @return [Date]
302
+ required :expiration_date, Date
303
+
304
+ # @!attribute file_id
305
+ # The identifier of the File containing the passport.
306
+ #
307
+ # @return [String]
308
+ required :file_id, String
309
+
310
+ # @!method initialize(country:, expiration_date:, file_id:)
311
+ # Some parameter documentations has been truncated, see
312
+ # {Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport} for
313
+ # more details.
314
+ #
315
+ # Information about the passport used for identification. Required if `method` is
316
+ # equal to `passport`.
317
+ #
318
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
319
+ #
320
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
321
+ #
322
+ # @param file_id [String] The identifier of the File containing the passport.
323
+ end
324
+ end
90
325
  end
91
326
  end
92
327
  end
@@ -28,12 +28,18 @@ module Increase
28
28
  #
29
29
  # Update a Beneficial Owner
30
30
  #
31
- # @overload update(entity_beneficial_owner_id, address: nil, request_options: {})
31
+ # @overload update(entity_beneficial_owner_id, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, request_options: {})
32
32
  #
33
33
  # @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
34
34
  #
35
35
  # @param address [Increase::Models::BeneficialOwnerUpdateParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
36
36
  #
37
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
38
+ #
39
+ # @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification] A means of verifying the person's identity.
40
+ #
41
+ # @param name [String] The individual's legal name.
42
+ #
37
43
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
38
44
  #
39
45
  # @return [Increase::Models::EntityBeneficialOwner]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.243.0"
4
+ VERSION = "1.245.0"
5
5
  end
@@ -30,10 +30,47 @@ module Increase
30
30
  end
31
31
  attr_writer :address
32
32
 
33
+ # The identification method for an individual can only be a passport, driver's
34
+ # license, or other document if you've confirmed the individual does not have a US
35
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
36
+ # Number).
37
+ sig { returns(T.nilable(T::Boolean)) }
38
+ attr_reader :confirmed_no_us_tax_id
39
+
40
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
41
+ attr_writer :confirmed_no_us_tax_id
42
+
43
+ # A means of verifying the person's identity.
44
+ sig do
45
+ returns(
46
+ T.nilable(Increase::BeneficialOwnerUpdateParams::Identification)
47
+ )
48
+ end
49
+ attr_reader :identification
50
+
51
+ sig do
52
+ params(
53
+ identification:
54
+ Increase::BeneficialOwnerUpdateParams::Identification::OrHash
55
+ ).void
56
+ end
57
+ attr_writer :identification
58
+
59
+ # The individual's legal name.
60
+ sig { returns(T.nilable(String)) }
61
+ attr_reader :name
62
+
63
+ sig { params(name: String).void }
64
+ attr_writer :name
65
+
33
66
  sig do
34
67
  params(
35
68
  entity_beneficial_owner_id: String,
36
69
  address: Increase::BeneficialOwnerUpdateParams::Address::OrHash,
70
+ confirmed_no_us_tax_id: T::Boolean,
71
+ identification:
72
+ Increase::BeneficialOwnerUpdateParams::Identification::OrHash,
73
+ name: String,
37
74
  request_options: Increase::RequestOptions::OrHash
38
75
  ).returns(T.attached_class)
39
76
  end
@@ -43,6 +80,15 @@ module Increase
43
80
  # The individual's physical address. Mail receiving locations like PO Boxes and
44
81
  # PMB's are disallowed.
45
82
  address: nil,
83
+ # The identification method for an individual can only be a passport, driver's
84
+ # license, or other document if you've confirmed the individual does not have a US
85
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
86
+ # Number).
87
+ confirmed_no_us_tax_id: nil,
88
+ # A means of verifying the person's identity.
89
+ identification: nil,
90
+ # The individual's legal name.
91
+ name: nil,
46
92
  request_options: {}
47
93
  )
48
94
  end
@@ -52,6 +98,10 @@ module Increase
52
98
  {
53
99
  entity_beneficial_owner_id: String,
54
100
  address: Increase::BeneficialOwnerUpdateParams::Address,
101
+ confirmed_no_us_tax_id: T::Boolean,
102
+ identification:
103
+ Increase::BeneficialOwnerUpdateParams::Identification,
104
+ name: String,
55
105
  request_options: Increase::RequestOptions
56
106
  }
57
107
  )
@@ -146,6 +196,389 @@ module Increase
146
196
  def to_hash
147
197
  end
148
198
  end
199
+
200
+ class Identification < Increase::Internal::Type::BaseModel
201
+ OrHash =
202
+ T.type_alias do
203
+ T.any(
204
+ Increase::BeneficialOwnerUpdateParams::Identification,
205
+ Increase::Internal::AnyHash
206
+ )
207
+ end
208
+
209
+ # A method that can be used to verify the individual's identity.
210
+ sig do
211
+ returns(
212
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::OrSymbol
213
+ )
214
+ end
215
+ attr_accessor :method_
216
+
217
+ # An identification number that can be used to verify the individual's identity,
218
+ # such as a social security number.
219
+ sig { returns(String) }
220
+ attr_accessor :number
221
+
222
+ # Information about the United States driver's license used for identification.
223
+ # Required if `method` is equal to `drivers_license`.
224
+ sig do
225
+ returns(
226
+ T.nilable(
227
+ Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense
228
+ )
229
+ )
230
+ end
231
+ attr_reader :drivers_license
232
+
233
+ sig do
234
+ params(
235
+ drivers_license:
236
+ Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense::OrHash
237
+ ).void
238
+ end
239
+ attr_writer :drivers_license
240
+
241
+ # Information about the identification document provided. Required if `method` is
242
+ # equal to `other`.
243
+ sig do
244
+ returns(
245
+ T.nilable(
246
+ Increase::BeneficialOwnerUpdateParams::Identification::Other
247
+ )
248
+ )
249
+ end
250
+ attr_reader :other
251
+
252
+ sig do
253
+ params(
254
+ other:
255
+ Increase::BeneficialOwnerUpdateParams::Identification::Other::OrHash
256
+ ).void
257
+ end
258
+ attr_writer :other
259
+
260
+ # Information about the passport used for identification. Required if `method` is
261
+ # equal to `passport`.
262
+ sig do
263
+ returns(
264
+ T.nilable(
265
+ Increase::BeneficialOwnerUpdateParams::Identification::Passport
266
+ )
267
+ )
268
+ end
269
+ attr_reader :passport
270
+
271
+ sig do
272
+ params(
273
+ passport:
274
+ Increase::BeneficialOwnerUpdateParams::Identification::Passport::OrHash
275
+ ).void
276
+ end
277
+ attr_writer :passport
278
+
279
+ # A means of verifying the person's identity.
280
+ sig do
281
+ params(
282
+ method_:
283
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::OrSymbol,
284
+ number: String,
285
+ drivers_license:
286
+ Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense::OrHash,
287
+ other:
288
+ Increase::BeneficialOwnerUpdateParams::Identification::Other::OrHash,
289
+ passport:
290
+ Increase::BeneficialOwnerUpdateParams::Identification::Passport::OrHash
291
+ ).returns(T.attached_class)
292
+ end
293
+ def self.new(
294
+ # A method that can be used to verify the individual's identity.
295
+ method_:,
296
+ # An identification number that can be used to verify the individual's identity,
297
+ # such as a social security number.
298
+ number:,
299
+ # Information about the United States driver's license used for identification.
300
+ # Required if `method` is equal to `drivers_license`.
301
+ drivers_license: nil,
302
+ # Information about the identification document provided. Required if `method` is
303
+ # equal to `other`.
304
+ other: nil,
305
+ # Information about the passport used for identification. Required if `method` is
306
+ # equal to `passport`.
307
+ passport: nil
308
+ )
309
+ end
310
+
311
+ sig do
312
+ override.returns(
313
+ {
314
+ method_:
315
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::OrSymbol,
316
+ number: String,
317
+ drivers_license:
318
+ Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense,
319
+ other:
320
+ Increase::BeneficialOwnerUpdateParams::Identification::Other,
321
+ passport:
322
+ Increase::BeneficialOwnerUpdateParams::Identification::Passport
323
+ }
324
+ )
325
+ end
326
+ def to_hash
327
+ end
328
+
329
+ # A method that can be used to verify the individual's identity.
330
+ module Method
331
+ extend Increase::Internal::Type::Enum
332
+
333
+ TaggedSymbol =
334
+ T.type_alias do
335
+ T.all(
336
+ Symbol,
337
+ Increase::BeneficialOwnerUpdateParams::Identification::Method
338
+ )
339
+ end
340
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
341
+
342
+ # A social security number.
343
+ SOCIAL_SECURITY_NUMBER =
344
+ T.let(
345
+ :social_security_number,
346
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
347
+ )
348
+
349
+ # An individual taxpayer identification number (ITIN).
350
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
351
+ T.let(
352
+ :individual_taxpayer_identification_number,
353
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
354
+ )
355
+
356
+ # A passport number.
357
+ PASSPORT =
358
+ T.let(
359
+ :passport,
360
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
361
+ )
362
+
363
+ # A driver's license number.
364
+ DRIVERS_LICENSE =
365
+ T.let(
366
+ :drivers_license,
367
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
368
+ )
369
+
370
+ # Another identifying document.
371
+ OTHER =
372
+ T.let(
373
+ :other,
374
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
375
+ )
376
+
377
+ sig do
378
+ override.returns(
379
+ T::Array[
380
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
381
+ ]
382
+ )
383
+ end
384
+ def self.values
385
+ end
386
+ end
387
+
388
+ class DriversLicense < Increase::Internal::Type::BaseModel
389
+ OrHash =
390
+ T.type_alias do
391
+ T.any(
392
+ Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense,
393
+ Increase::Internal::AnyHash
394
+ )
395
+ end
396
+
397
+ # The driver's license's expiration date in YYYY-MM-DD format.
398
+ sig { returns(Date) }
399
+ attr_accessor :expiration_date
400
+
401
+ # The identifier of the File containing the front of the driver's license.
402
+ sig { returns(String) }
403
+ attr_accessor :file_id
404
+
405
+ # The state that issued the provided driver's license.
406
+ sig { returns(String) }
407
+ attr_accessor :state
408
+
409
+ # The identifier of the File containing the back of the driver's license.
410
+ sig { returns(T.nilable(String)) }
411
+ attr_reader :back_file_id
412
+
413
+ sig { params(back_file_id: String).void }
414
+ attr_writer :back_file_id
415
+
416
+ # Information about the United States driver's license used for identification.
417
+ # Required if `method` is equal to `drivers_license`.
418
+ sig do
419
+ params(
420
+ expiration_date: Date,
421
+ file_id: String,
422
+ state: String,
423
+ back_file_id: String
424
+ ).returns(T.attached_class)
425
+ end
426
+ def self.new(
427
+ # The driver's license's expiration date in YYYY-MM-DD format.
428
+ expiration_date:,
429
+ # The identifier of the File containing the front of the driver's license.
430
+ file_id:,
431
+ # The state that issued the provided driver's license.
432
+ state:,
433
+ # The identifier of the File containing the back of the driver's license.
434
+ back_file_id: nil
435
+ )
436
+ end
437
+
438
+ sig do
439
+ override.returns(
440
+ {
441
+ expiration_date: Date,
442
+ file_id: String,
443
+ state: String,
444
+ back_file_id: String
445
+ }
446
+ )
447
+ end
448
+ def to_hash
449
+ end
450
+ end
451
+
452
+ class Other < Increase::Internal::Type::BaseModel
453
+ OrHash =
454
+ T.type_alias do
455
+ T.any(
456
+ Increase::BeneficialOwnerUpdateParams::Identification::Other,
457
+ Increase::Internal::AnyHash
458
+ )
459
+ end
460
+
461
+ # The two-character ISO 3166-1 code representing the country that issued the
462
+ # document (e.g., `US`).
463
+ sig { returns(String) }
464
+ attr_accessor :country
465
+
466
+ # A description of the document submitted.
467
+ sig { returns(String) }
468
+ attr_accessor :description
469
+
470
+ # The identifier of the File containing the front of the document.
471
+ sig { returns(String) }
472
+ attr_accessor :file_id
473
+
474
+ # The identifier of the File containing the back of the document. Not every
475
+ # document has a reverse side.
476
+ sig { returns(T.nilable(String)) }
477
+ attr_reader :back_file_id
478
+
479
+ sig { params(back_file_id: String).void }
480
+ attr_writer :back_file_id
481
+
482
+ # The document's expiration date in YYYY-MM-DD format.
483
+ sig { returns(T.nilable(Date)) }
484
+ attr_reader :expiration_date
485
+
486
+ sig { params(expiration_date: Date).void }
487
+ attr_writer :expiration_date
488
+
489
+ # Information about the identification document provided. Required if `method` is
490
+ # equal to `other`.
491
+ sig do
492
+ params(
493
+ country: String,
494
+ description: String,
495
+ file_id: String,
496
+ back_file_id: String,
497
+ expiration_date: Date
498
+ ).returns(T.attached_class)
499
+ end
500
+ def self.new(
501
+ # The two-character ISO 3166-1 code representing the country that issued the
502
+ # document (e.g., `US`).
503
+ country:,
504
+ # A description of the document submitted.
505
+ description:,
506
+ # The identifier of the File containing the front of the document.
507
+ file_id:,
508
+ # The identifier of the File containing the back of the document. Not every
509
+ # document has a reverse side.
510
+ back_file_id: nil,
511
+ # The document's expiration date in YYYY-MM-DD format.
512
+ expiration_date: nil
513
+ )
514
+ end
515
+
516
+ sig do
517
+ override.returns(
518
+ {
519
+ country: String,
520
+ description: String,
521
+ file_id: String,
522
+ back_file_id: String,
523
+ expiration_date: Date
524
+ }
525
+ )
526
+ end
527
+ def to_hash
528
+ end
529
+ end
530
+
531
+ class Passport < Increase::Internal::Type::BaseModel
532
+ OrHash =
533
+ T.type_alias do
534
+ T.any(
535
+ Increase::BeneficialOwnerUpdateParams::Identification::Passport,
536
+ Increase::Internal::AnyHash
537
+ )
538
+ end
539
+
540
+ # The two-character ISO 3166-1 code representing the country that issued the
541
+ # document (e.g., `US`).
542
+ sig { returns(String) }
543
+ attr_accessor :country
544
+
545
+ # The passport's expiration date in YYYY-MM-DD format.
546
+ sig { returns(Date) }
547
+ attr_accessor :expiration_date
548
+
549
+ # The identifier of the File containing the passport.
550
+ sig { returns(String) }
551
+ attr_accessor :file_id
552
+
553
+ # Information about the passport used for identification. Required if `method` is
554
+ # equal to `passport`.
555
+ sig do
556
+ params(
557
+ country: String,
558
+ expiration_date: Date,
559
+ file_id: String
560
+ ).returns(T.attached_class)
561
+ end
562
+ def self.new(
563
+ # The two-character ISO 3166-1 code representing the country that issued the
564
+ # document (e.g., `US`).
565
+ country:,
566
+ # The passport's expiration date in YYYY-MM-DD format.
567
+ expiration_date:,
568
+ # The identifier of the File containing the passport.
569
+ file_id:
570
+ )
571
+ end
572
+
573
+ sig do
574
+ override.returns(
575
+ { country: String, expiration_date: Date, file_id: String }
576
+ )
577
+ end
578
+ def to_hash
579
+ end
580
+ end
581
+ end
149
582
  end
150
583
  end
151
584
  end
@@ -22,6 +22,10 @@ module Increase
22
22
  params(
23
23
  entity_beneficial_owner_id: String,
24
24
  address: Increase::BeneficialOwnerUpdateParams::Address::OrHash,
25
+ confirmed_no_us_tax_id: T::Boolean,
26
+ identification:
27
+ Increase::BeneficialOwnerUpdateParams::Identification::OrHash,
28
+ name: String,
25
29
  request_options: Increase::RequestOptions::OrHash
26
30
  ).returns(Increase::EntityBeneficialOwner)
27
31
  end
@@ -31,6 +35,15 @@ module Increase
31
35
  # The individual's physical address. Mail receiving locations like PO Boxes and
32
36
  # PMB's are disallowed.
33
37
  address: nil,
38
+ # The identification method for an individual can only be a passport, driver's
39
+ # license, or other document if you've confirmed the individual does not have a US
40
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
41
+ # Number).
42
+ confirmed_no_us_tax_id: nil,
43
+ # A means of verifying the person's identity.
44
+ identification: nil,
45
+ # The individual's legal name.
46
+ name: nil,
34
47
  request_options: {}
35
48
  )
36
49
  end
@@ -3,7 +3,10 @@ module Increase
3
3
  type beneficial_owner_update_params =
4
4
  {
5
5
  entity_beneficial_owner_id: String,
6
- address: Increase::BeneficialOwnerUpdateParams::Address
6
+ address: Increase::BeneficialOwnerUpdateParams::Address,
7
+ confirmed_no_us_tax_id: bool,
8
+ identification: Increase::BeneficialOwnerUpdateParams::Identification,
9
+ name: String
7
10
  }
8
11
  & Increase::Internal::Type::request_parameters
9
12
 
@@ -19,15 +22,35 @@ module Increase
19
22
  Increase::BeneficialOwnerUpdateParams::Address
20
23
  ) -> Increase::BeneficialOwnerUpdateParams::Address
21
24
 
25
+ attr_reader confirmed_no_us_tax_id: bool?
26
+
27
+ def confirmed_no_us_tax_id=: (bool) -> bool
28
+
29
+ attr_reader identification: Increase::BeneficialOwnerUpdateParams::Identification?
30
+
31
+ def identification=: (
32
+ Increase::BeneficialOwnerUpdateParams::Identification
33
+ ) -> Increase::BeneficialOwnerUpdateParams::Identification
34
+
35
+ attr_reader name: String?
36
+
37
+ def name=: (String) -> String
38
+
22
39
  def initialize: (
23
40
  entity_beneficial_owner_id: String,
24
41
  ?address: Increase::BeneficialOwnerUpdateParams::Address,
42
+ ?confirmed_no_us_tax_id: bool,
43
+ ?identification: Increase::BeneficialOwnerUpdateParams::Identification,
44
+ ?name: String,
25
45
  ?request_options: Increase::request_opts
26
46
  ) -> void
27
47
 
28
48
  def to_hash: -> {
29
49
  entity_beneficial_owner_id: String,
30
50
  address: Increase::BeneficialOwnerUpdateParams::Address,
51
+ confirmed_no_us_tax_id: bool,
52
+ identification: Increase::BeneficialOwnerUpdateParams::Identification,
53
+ name: String,
31
54
  request_options: Increase::RequestOptions
32
55
  }
33
56
 
@@ -78,6 +101,181 @@ module Increase
78
101
  zip: String
79
102
  }
80
103
  end
104
+
105
+ type identification =
106
+ {
107
+ method_: Increase::Models::BeneficialOwnerUpdateParams::Identification::method_,
108
+ number: String,
109
+ drivers_license: Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense,
110
+ other: Increase::BeneficialOwnerUpdateParams::Identification::Other,
111
+ passport: Increase::BeneficialOwnerUpdateParams::Identification::Passport
112
+ }
113
+
114
+ class Identification < Increase::Internal::Type::BaseModel
115
+ attr_accessor method_: Increase::Models::BeneficialOwnerUpdateParams::Identification::method_
116
+
117
+ attr_accessor number: String
118
+
119
+ attr_reader drivers_license: Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense?
120
+
121
+ def drivers_license=: (
122
+ Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense
123
+ ) -> Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense
124
+
125
+ attr_reader other: Increase::BeneficialOwnerUpdateParams::Identification::Other?
126
+
127
+ def other=: (
128
+ Increase::BeneficialOwnerUpdateParams::Identification::Other
129
+ ) -> Increase::BeneficialOwnerUpdateParams::Identification::Other
130
+
131
+ attr_reader passport: Increase::BeneficialOwnerUpdateParams::Identification::Passport?
132
+
133
+ def passport=: (
134
+ Increase::BeneficialOwnerUpdateParams::Identification::Passport
135
+ ) -> Increase::BeneficialOwnerUpdateParams::Identification::Passport
136
+
137
+ def initialize: (
138
+ method_: Increase::Models::BeneficialOwnerUpdateParams::Identification::method_,
139
+ number: String,
140
+ ?drivers_license: Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense,
141
+ ?other: Increase::BeneficialOwnerUpdateParams::Identification::Other,
142
+ ?passport: Increase::BeneficialOwnerUpdateParams::Identification::Passport
143
+ ) -> void
144
+
145
+ def to_hash: -> {
146
+ method_: Increase::Models::BeneficialOwnerUpdateParams::Identification::method_,
147
+ number: String,
148
+ drivers_license: Increase::BeneficialOwnerUpdateParams::Identification::DriversLicense,
149
+ other: Increase::BeneficialOwnerUpdateParams::Identification::Other,
150
+ passport: Increase::BeneficialOwnerUpdateParams::Identification::Passport
151
+ }
152
+
153
+ type method_ =
154
+ :social_security_number
155
+ | :individual_taxpayer_identification_number
156
+ | :passport
157
+ | :drivers_license
158
+ | :other
159
+
160
+ module Method
161
+ extend Increase::Internal::Type::Enum
162
+
163
+ # A social security number.
164
+ SOCIAL_SECURITY_NUMBER: :social_security_number
165
+
166
+ # An individual taxpayer identification number (ITIN).
167
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER: :individual_taxpayer_identification_number
168
+
169
+ # A passport number.
170
+ PASSPORT: :passport
171
+
172
+ # A driver's license number.
173
+ DRIVERS_LICENSE: :drivers_license
174
+
175
+ # Another identifying document.
176
+ OTHER: :other
177
+
178
+ def self?.values: -> ::Array[Increase::Models::BeneficialOwnerUpdateParams::Identification::method_]
179
+ end
180
+
181
+ type drivers_license =
182
+ {
183
+ expiration_date: Date,
184
+ file_id: String,
185
+ state: String,
186
+ back_file_id: String
187
+ }
188
+
189
+ class DriversLicense < Increase::Internal::Type::BaseModel
190
+ attr_accessor expiration_date: Date
191
+
192
+ attr_accessor file_id: String
193
+
194
+ attr_accessor state: String
195
+
196
+ attr_reader back_file_id: String?
197
+
198
+ def back_file_id=: (String) -> String
199
+
200
+ def initialize: (
201
+ expiration_date: Date,
202
+ file_id: String,
203
+ state: String,
204
+ ?back_file_id: String
205
+ ) -> void
206
+
207
+ def to_hash: -> {
208
+ expiration_date: Date,
209
+ file_id: String,
210
+ state: String,
211
+ back_file_id: String
212
+ }
213
+ end
214
+
215
+ type other =
216
+ {
217
+ country: String,
218
+ description: String,
219
+ file_id: String,
220
+ back_file_id: String,
221
+ expiration_date: Date
222
+ }
223
+
224
+ class Other < Increase::Internal::Type::BaseModel
225
+ attr_accessor country: String
226
+
227
+ attr_accessor description: String
228
+
229
+ attr_accessor file_id: String
230
+
231
+ attr_reader back_file_id: String?
232
+
233
+ def back_file_id=: (String) -> String
234
+
235
+ attr_reader expiration_date: Date?
236
+
237
+ def expiration_date=: (Date) -> Date
238
+
239
+ def initialize: (
240
+ country: String,
241
+ description: String,
242
+ file_id: String,
243
+ ?back_file_id: String,
244
+ ?expiration_date: Date
245
+ ) -> void
246
+
247
+ def to_hash: -> {
248
+ country: String,
249
+ description: String,
250
+ file_id: String,
251
+ back_file_id: String,
252
+ expiration_date: Date
253
+ }
254
+ end
255
+
256
+ type passport =
257
+ { country: String, expiration_date: Date, file_id: String }
258
+
259
+ class Passport < Increase::Internal::Type::BaseModel
260
+ attr_accessor country: String
261
+
262
+ attr_accessor expiration_date: Date
263
+
264
+ attr_accessor file_id: String
265
+
266
+ def initialize: (
267
+ country: String,
268
+ expiration_date: Date,
269
+ file_id: String
270
+ ) -> void
271
+
272
+ def to_hash: -> {
273
+ country: String,
274
+ expiration_date: Date,
275
+ file_id: String
276
+ }
277
+ end
278
+ end
81
279
  end
82
280
  end
83
281
  end
@@ -9,6 +9,9 @@ module Increase
9
9
  def update: (
10
10
  String entity_beneficial_owner_id,
11
11
  ?address: Increase::BeneficialOwnerUpdateParams::Address,
12
+ ?confirmed_no_us_tax_id: bool,
13
+ ?identification: Increase::BeneficialOwnerUpdateParams::Identification,
14
+ ?name: String,
12
15
  ?request_options: Increase::request_opts
13
16
  ) -> Increase::EntityBeneficialOwner
14
17
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.243.0
4
+ version: 1.245.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-03-11 00:00:00.000000000 Z
11
+ date: 2026-03-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi