increase 1.271.0 → 1.274.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 +4 -4
- data/CHANGELOG.md +183 -0
- data/README.md +1 -1
- data/lib/increase/internal/util.rb +1 -2
- data/lib/increase/models/entity.rb +148 -92
- data/lib/increase/models/entity_create_params.rb +130 -90
- data/lib/increase/models/entity_update_params.rb +101 -45
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/entity.rbi +176 -120
- data/rbi/increase/models/entity_create_params.rbi +175 -105
- data/rbi/increase/models/entity_update_params.rbi +198 -56
- data/sig/increase/models/entity.rbs +120 -85
- data/sig/increase/models/entity_create_params.rbs +100 -55
- data/sig/increase/models/entity_update_params.rbs +92 -32
- metadata +2 -2
|
@@ -213,6 +213,25 @@ module Increase
|
|
|
213
213
|
sig { params(industry_code: String).void }
|
|
214
214
|
attr_writer :industry_code
|
|
215
215
|
|
|
216
|
+
# The legal identifier of the corporation. This is usually the Employer
|
|
217
|
+
# Identification Number (EIN).
|
|
218
|
+
sig do
|
|
219
|
+
returns(
|
|
220
|
+
T.nilable(
|
|
221
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier
|
|
222
|
+
)
|
|
223
|
+
)
|
|
224
|
+
end
|
|
225
|
+
attr_reader :legal_identifier
|
|
226
|
+
|
|
227
|
+
sig do
|
|
228
|
+
params(
|
|
229
|
+
legal_identifier:
|
|
230
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::OrHash
|
|
231
|
+
).void
|
|
232
|
+
end
|
|
233
|
+
attr_writer :legal_identifier
|
|
234
|
+
|
|
216
235
|
# The legal name of the corporation.
|
|
217
236
|
sig { returns(T.nilable(String)) }
|
|
218
237
|
attr_reader :name
|
|
@@ -220,13 +239,6 @@ module Increase
|
|
|
220
239
|
sig { params(name: String).void }
|
|
221
240
|
attr_writer :name
|
|
222
241
|
|
|
223
|
-
# The Employer Identification Number (EIN) for the corporation.
|
|
224
|
-
sig { returns(T.nilable(String)) }
|
|
225
|
-
attr_reader :tax_identifier
|
|
226
|
-
|
|
227
|
-
sig { params(tax_identifier: String).void }
|
|
228
|
-
attr_writer :tax_identifier
|
|
229
|
-
|
|
230
242
|
# Details of the corporation entity to update. If you specify this parameter and
|
|
231
243
|
# the entity is not a corporation, the request will fail.
|
|
232
244
|
sig do
|
|
@@ -235,8 +247,9 @@ module Increase
|
|
|
235
247
|
email: String,
|
|
236
248
|
incorporation_state: String,
|
|
237
249
|
industry_code: String,
|
|
238
|
-
|
|
239
|
-
|
|
250
|
+
legal_identifier:
|
|
251
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::OrHash,
|
|
252
|
+
name: String
|
|
240
253
|
).returns(T.attached_class)
|
|
241
254
|
end
|
|
242
255
|
def self.new(
|
|
@@ -254,10 +267,11 @@ module Increase
|
|
|
254
267
|
# `Software Publishers`. A full list of classification codes is available
|
|
255
268
|
# [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
|
|
256
269
|
industry_code: nil,
|
|
270
|
+
# The legal identifier of the corporation. This is usually the Employer
|
|
271
|
+
# Identification Number (EIN).
|
|
272
|
+
legal_identifier: nil,
|
|
257
273
|
# The legal name of the corporation.
|
|
258
|
-
name: nil
|
|
259
|
-
# The Employer Identification Number (EIN) for the corporation.
|
|
260
|
-
tax_identifier: nil
|
|
274
|
+
name: nil
|
|
261
275
|
)
|
|
262
276
|
end
|
|
263
277
|
|
|
@@ -268,8 +282,9 @@ module Increase
|
|
|
268
282
|
email: String,
|
|
269
283
|
incorporation_state: String,
|
|
270
284
|
industry_code: String,
|
|
271
|
-
|
|
272
|
-
|
|
285
|
+
legal_identifier:
|
|
286
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier,
|
|
287
|
+
name: String
|
|
273
288
|
}
|
|
274
289
|
)
|
|
275
290
|
end
|
|
@@ -285,22 +300,17 @@ module Increase
|
|
|
285
300
|
)
|
|
286
301
|
end
|
|
287
302
|
|
|
288
|
-
# The city of the address.
|
|
303
|
+
# The city, district, town, or village of the address.
|
|
289
304
|
sig { returns(String) }
|
|
290
305
|
attr_accessor :city
|
|
291
306
|
|
|
292
|
-
# The
|
|
307
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
293
308
|
sig { returns(String) }
|
|
294
|
-
attr_accessor :
|
|
309
|
+
attr_accessor :country
|
|
295
310
|
|
|
296
|
-
# The
|
|
297
|
-
# the address.
|
|
298
|
-
sig { returns(String) }
|
|
299
|
-
attr_accessor :state
|
|
300
|
-
|
|
301
|
-
# The ZIP code of the address.
|
|
311
|
+
# The first line of the address. This is usually the street number and street.
|
|
302
312
|
sig { returns(String) }
|
|
303
|
-
attr_accessor :
|
|
313
|
+
attr_accessor :line1
|
|
304
314
|
|
|
305
315
|
# The second line of the address. This might be the floor or room number.
|
|
306
316
|
sig { returns(T.nilable(String)) }
|
|
@@ -309,29 +319,47 @@ module Increase
|
|
|
309
319
|
sig { params(line2: String).void }
|
|
310
320
|
attr_writer :line2
|
|
311
321
|
|
|
322
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
323
|
+
# state, province, or region of the address. Required in certain countries.
|
|
324
|
+
sig { returns(T.nilable(String)) }
|
|
325
|
+
attr_reader :state
|
|
326
|
+
|
|
327
|
+
sig { params(state: String).void }
|
|
328
|
+
attr_writer :state
|
|
329
|
+
|
|
330
|
+
# The ZIP or postal code of the address. Required in certain countries.
|
|
331
|
+
sig { returns(T.nilable(String)) }
|
|
332
|
+
attr_reader :zip
|
|
333
|
+
|
|
334
|
+
sig { params(zip: String).void }
|
|
335
|
+
attr_writer :zip
|
|
336
|
+
|
|
312
337
|
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
313
338
|
# are disallowed.
|
|
314
339
|
sig do
|
|
315
340
|
params(
|
|
316
341
|
city: String,
|
|
342
|
+
country: String,
|
|
317
343
|
line1: String,
|
|
344
|
+
line2: String,
|
|
318
345
|
state: String,
|
|
319
|
-
zip: String
|
|
320
|
-
line2: String
|
|
346
|
+
zip: String
|
|
321
347
|
).returns(T.attached_class)
|
|
322
348
|
end
|
|
323
349
|
def self.new(
|
|
324
|
-
# The city of the address.
|
|
350
|
+
# The city, district, town, or village of the address.
|
|
325
351
|
city:,
|
|
352
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
353
|
+
country:,
|
|
326
354
|
# The first line of the address. This is usually the street number and street.
|
|
327
355
|
line1:,
|
|
328
|
-
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
329
|
-
# the address.
|
|
330
|
-
state:,
|
|
331
|
-
# The ZIP code of the address.
|
|
332
|
-
zip:,
|
|
333
356
|
# The second line of the address. This might be the floor or room number.
|
|
334
|
-
line2: nil
|
|
357
|
+
line2: nil,
|
|
358
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
359
|
+
# state, province, or region of the address. Required in certain countries.
|
|
360
|
+
state: nil,
|
|
361
|
+
# The ZIP or postal code of the address. Required in certain countries.
|
|
362
|
+
zip: nil
|
|
335
363
|
)
|
|
336
364
|
end
|
|
337
365
|
|
|
@@ -339,16 +367,116 @@ module Increase
|
|
|
339
367
|
override.returns(
|
|
340
368
|
{
|
|
341
369
|
city: String,
|
|
370
|
+
country: String,
|
|
342
371
|
line1: String,
|
|
372
|
+
line2: String,
|
|
343
373
|
state: String,
|
|
344
|
-
zip: String
|
|
345
|
-
line2: String
|
|
374
|
+
zip: String
|
|
346
375
|
}
|
|
347
376
|
)
|
|
348
377
|
end
|
|
349
378
|
def to_hash
|
|
350
379
|
end
|
|
351
380
|
end
|
|
381
|
+
|
|
382
|
+
class LegalIdentifier < Increase::Internal::Type::BaseModel
|
|
383
|
+
OrHash =
|
|
384
|
+
T.type_alias do
|
|
385
|
+
T.any(
|
|
386
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier,
|
|
387
|
+
Increase::Internal::AnyHash
|
|
388
|
+
)
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# The identifier of the legal identifier.
|
|
392
|
+
sig { returns(String) }
|
|
393
|
+
attr_accessor :value
|
|
394
|
+
|
|
395
|
+
# The category of the legal identifier.
|
|
396
|
+
sig do
|
|
397
|
+
returns(
|
|
398
|
+
T.nilable(
|
|
399
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
|
|
400
|
+
)
|
|
401
|
+
)
|
|
402
|
+
end
|
|
403
|
+
attr_reader :category
|
|
404
|
+
|
|
405
|
+
sig do
|
|
406
|
+
params(
|
|
407
|
+
category:
|
|
408
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
|
|
409
|
+
).void
|
|
410
|
+
end
|
|
411
|
+
attr_writer :category
|
|
412
|
+
|
|
413
|
+
# The legal identifier of the corporation. This is usually the Employer
|
|
414
|
+
# Identification Number (EIN).
|
|
415
|
+
sig do
|
|
416
|
+
params(
|
|
417
|
+
value: String,
|
|
418
|
+
category:
|
|
419
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
|
|
420
|
+
).returns(T.attached_class)
|
|
421
|
+
end
|
|
422
|
+
def self.new(
|
|
423
|
+
# The identifier of the legal identifier.
|
|
424
|
+
value:,
|
|
425
|
+
# The category of the legal identifier.
|
|
426
|
+
category: nil
|
|
427
|
+
)
|
|
428
|
+
end
|
|
429
|
+
|
|
430
|
+
sig do
|
|
431
|
+
override.returns(
|
|
432
|
+
{
|
|
433
|
+
value: String,
|
|
434
|
+
category:
|
|
435
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
|
|
436
|
+
}
|
|
437
|
+
)
|
|
438
|
+
end
|
|
439
|
+
def to_hash
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
# The category of the legal identifier.
|
|
443
|
+
module Category
|
|
444
|
+
extend Increase::Internal::Type::Enum
|
|
445
|
+
|
|
446
|
+
TaggedSymbol =
|
|
447
|
+
T.type_alias do
|
|
448
|
+
T.all(
|
|
449
|
+
Symbol,
|
|
450
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category
|
|
451
|
+
)
|
|
452
|
+
end
|
|
453
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
454
|
+
|
|
455
|
+
# The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
|
|
456
|
+
US_EMPLOYER_IDENTIFICATION_NUMBER =
|
|
457
|
+
T.let(
|
|
458
|
+
:us_employer_identification_number,
|
|
459
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
|
|
460
|
+
)
|
|
461
|
+
|
|
462
|
+
# A legal identifier issued by a foreign government, like a tax identification number or registration number.
|
|
463
|
+
OTHER =
|
|
464
|
+
T.let(
|
|
465
|
+
:other,
|
|
466
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
|
|
467
|
+
)
|
|
468
|
+
|
|
469
|
+
sig do
|
|
470
|
+
override.returns(
|
|
471
|
+
T::Array[
|
|
472
|
+
Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
|
|
473
|
+
]
|
|
474
|
+
)
|
|
475
|
+
end
|
|
476
|
+
def self.values
|
|
477
|
+
end
|
|
478
|
+
end
|
|
479
|
+
end
|
|
352
480
|
end
|
|
353
481
|
|
|
354
482
|
class GovernmentAuthority < Increase::Internal::Type::BaseModel
|
|
@@ -562,22 +690,17 @@ module Increase
|
|
|
562
690
|
)
|
|
563
691
|
end
|
|
564
692
|
|
|
565
|
-
# The city of the address.
|
|
693
|
+
# The city, district, town, or village of the address.
|
|
566
694
|
sig { returns(String) }
|
|
567
695
|
attr_accessor :city
|
|
568
696
|
|
|
569
|
-
# The
|
|
697
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
570
698
|
sig { returns(String) }
|
|
571
|
-
attr_accessor :
|
|
699
|
+
attr_accessor :country
|
|
572
700
|
|
|
573
|
-
# The
|
|
574
|
-
# the address.
|
|
575
|
-
sig { returns(String) }
|
|
576
|
-
attr_accessor :state
|
|
577
|
-
|
|
578
|
-
# The ZIP code of the address.
|
|
701
|
+
# The first line of the address. This is usually the street number and street.
|
|
579
702
|
sig { returns(String) }
|
|
580
|
-
attr_accessor :
|
|
703
|
+
attr_accessor :line1
|
|
581
704
|
|
|
582
705
|
# The second line of the address. This might be the floor or room number.
|
|
583
706
|
sig { returns(T.nilable(String)) }
|
|
@@ -586,29 +709,47 @@ module Increase
|
|
|
586
709
|
sig { params(line2: String).void }
|
|
587
710
|
attr_writer :line2
|
|
588
711
|
|
|
712
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
713
|
+
# state, province, or region of the address. Required in certain countries.
|
|
714
|
+
sig { returns(T.nilable(String)) }
|
|
715
|
+
attr_reader :state
|
|
716
|
+
|
|
717
|
+
sig { params(state: String).void }
|
|
718
|
+
attr_writer :state
|
|
719
|
+
|
|
720
|
+
# The ZIP or postal code of the address. Required in certain countries.
|
|
721
|
+
sig { returns(T.nilable(String)) }
|
|
722
|
+
attr_reader :zip
|
|
723
|
+
|
|
724
|
+
sig { params(zip: String).void }
|
|
725
|
+
attr_writer :zip
|
|
726
|
+
|
|
589
727
|
# The entity's physical address. Mail receiving locations like PO Boxes and PMB's
|
|
590
728
|
# are disallowed.
|
|
591
729
|
sig do
|
|
592
730
|
params(
|
|
593
731
|
city: String,
|
|
732
|
+
country: String,
|
|
594
733
|
line1: String,
|
|
734
|
+
line2: String,
|
|
595
735
|
state: String,
|
|
596
|
-
zip: String
|
|
597
|
-
line2: String
|
|
736
|
+
zip: String
|
|
598
737
|
).returns(T.attached_class)
|
|
599
738
|
end
|
|
600
739
|
def self.new(
|
|
601
|
-
# The city of the address.
|
|
740
|
+
# The city, district, town, or village of the address.
|
|
602
741
|
city:,
|
|
742
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
743
|
+
country:,
|
|
603
744
|
# The first line of the address. This is usually the street number and street.
|
|
604
745
|
line1:,
|
|
605
|
-
# The two-letter United States Postal Service (USPS) abbreviation for the state of
|
|
606
|
-
# the address.
|
|
607
|
-
state:,
|
|
608
|
-
# The ZIP code of the address.
|
|
609
|
-
zip:,
|
|
610
746
|
# The second line of the address. This might be the floor or room number.
|
|
611
|
-
line2: nil
|
|
747
|
+
line2: nil,
|
|
748
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
749
|
+
# state, province, or region of the address. Required in certain countries.
|
|
750
|
+
state: nil,
|
|
751
|
+
# The ZIP or postal code of the address. Required in certain countries.
|
|
752
|
+
zip: nil
|
|
612
753
|
)
|
|
613
754
|
end
|
|
614
755
|
|
|
@@ -616,10 +757,11 @@ module Increase
|
|
|
616
757
|
override.returns(
|
|
617
758
|
{
|
|
618
759
|
city: String,
|
|
760
|
+
country: String,
|
|
619
761
|
line1: String,
|
|
762
|
+
line2: String,
|
|
620
763
|
state: String,
|
|
621
|
-
zip: String
|
|
622
|
-
line2: String
|
|
764
|
+
zip: String
|
|
623
765
|
}
|
|
624
766
|
)
|
|
625
767
|
end
|