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