increase 1.250.0 → 1.252.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.
@@ -255,7 +255,9 @@ module Increase
255
255
 
256
256
  # The identifying details of anyone controlling or owning 25% or more of the
257
257
  # corporation.
258
- sig { returns(T::Array[Increase::EntityBeneficialOwner]) }
258
+ sig do
259
+ returns(T::Array[Increase::Entity::Corporation::BeneficialOwner])
260
+ end
259
261
  attr_accessor :beneficial_owners
260
262
 
261
263
  # An email address for the business.
@@ -290,7 +292,7 @@ module Increase
290
292
  params(
291
293
  address: Increase::Entity::Corporation::Address::OrHash,
292
294
  beneficial_owners:
293
- T::Array[Increase::EntityBeneficialOwner::OrHash],
295
+ T::Array[Increase::Entity::Corporation::BeneficialOwner::OrHash],
294
296
  email: T.nilable(String),
295
297
  incorporation_state: T.nilable(String),
296
298
  industry_code: T.nilable(String),
@@ -326,7 +328,8 @@ module Increase
326
328
  override.returns(
327
329
  {
328
330
  address: Increase::Entity::Corporation::Address,
329
- beneficial_owners: T::Array[Increase::EntityBeneficialOwner],
331
+ beneficial_owners:
332
+ T::Array[Increase::Entity::Corporation::BeneficialOwner],
330
333
  email: T.nilable(String),
331
334
  incorporation_state: T.nilable(String),
332
335
  industry_code: T.nilable(String),
@@ -408,6 +411,403 @@ module Increase
408
411
  def to_hash
409
412
  end
410
413
  end
414
+
415
+ class BeneficialOwner < Increase::Internal::Type::BaseModel
416
+ OrHash =
417
+ T.type_alias do
418
+ T.any(
419
+ Increase::Entity::Corporation::BeneficialOwner,
420
+ Increase::Internal::AnyHash
421
+ )
422
+ end
423
+
424
+ # The identifier of this beneficial owner.
425
+ sig { returns(String) }
426
+ attr_accessor :id
427
+
428
+ # This person's role or title within the entity.
429
+ sig { returns(T.nilable(String)) }
430
+ attr_accessor :company_title
431
+
432
+ # Personal details for the beneficial owner.
433
+ sig do
434
+ returns(Increase::Entity::Corporation::BeneficialOwner::Individual)
435
+ end
436
+ attr_reader :individual
437
+
438
+ sig do
439
+ params(
440
+ individual:
441
+ Increase::Entity::Corporation::BeneficialOwner::Individual::OrHash
442
+ ).void
443
+ end
444
+ attr_writer :individual
445
+
446
+ # Why this person is considered a beneficial owner of the entity.
447
+ sig do
448
+ returns(
449
+ T::Array[
450
+ Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
451
+ ]
452
+ )
453
+ end
454
+ attr_accessor :prongs
455
+
456
+ sig do
457
+ params(
458
+ id: String,
459
+ company_title: T.nilable(String),
460
+ individual:
461
+ Increase::Entity::Corporation::BeneficialOwner::Individual::OrHash,
462
+ prongs:
463
+ T::Array[
464
+ Increase::Entity::Corporation::BeneficialOwner::Prong::OrSymbol
465
+ ]
466
+ ).returns(T.attached_class)
467
+ end
468
+ def self.new(
469
+ # The identifier of this beneficial owner.
470
+ id:,
471
+ # This person's role or title within the entity.
472
+ company_title:,
473
+ # Personal details for the beneficial owner.
474
+ individual:,
475
+ # Why this person is considered a beneficial owner of the entity.
476
+ prongs:
477
+ )
478
+ end
479
+
480
+ sig do
481
+ override.returns(
482
+ {
483
+ id: String,
484
+ company_title: T.nilable(String),
485
+ individual:
486
+ Increase::Entity::Corporation::BeneficialOwner::Individual,
487
+ prongs:
488
+ T::Array[
489
+ Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
490
+ ]
491
+ }
492
+ )
493
+ end
494
+ def to_hash
495
+ end
496
+
497
+ class Individual < Increase::Internal::Type::BaseModel
498
+ OrHash =
499
+ T.type_alias do
500
+ T.any(
501
+ Increase::Entity::Corporation::BeneficialOwner::Individual,
502
+ Increase::Internal::AnyHash
503
+ )
504
+ end
505
+
506
+ # The person's address.
507
+ sig do
508
+ returns(
509
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Address
510
+ )
511
+ end
512
+ attr_reader :address
513
+
514
+ sig do
515
+ params(
516
+ address:
517
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Address::OrHash
518
+ ).void
519
+ end
520
+ attr_writer :address
521
+
522
+ # The person's date of birth in YYYY-MM-DD format.
523
+ sig { returns(Date) }
524
+ attr_accessor :date_of_birth
525
+
526
+ # A means of verifying the person's identity.
527
+ sig do
528
+ returns(
529
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification
530
+ )
531
+ end
532
+ attr_reader :identification
533
+
534
+ sig do
535
+ params(
536
+ identification:
537
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::OrHash
538
+ ).void
539
+ end
540
+ attr_writer :identification
541
+
542
+ # The person's legal name.
543
+ sig { returns(String) }
544
+ attr_accessor :name
545
+
546
+ # Personal details for the beneficial owner.
547
+ sig do
548
+ params(
549
+ address:
550
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Address::OrHash,
551
+ date_of_birth: Date,
552
+ identification:
553
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::OrHash,
554
+ name: String
555
+ ).returns(T.attached_class)
556
+ end
557
+ def self.new(
558
+ # The person's address.
559
+ address:,
560
+ # The person's date of birth in YYYY-MM-DD format.
561
+ date_of_birth:,
562
+ # A means of verifying the person's identity.
563
+ identification:,
564
+ # The person's legal name.
565
+ name:
566
+ )
567
+ end
568
+
569
+ sig do
570
+ override.returns(
571
+ {
572
+ address:
573
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Address,
574
+ date_of_birth: Date,
575
+ identification:
576
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification,
577
+ name: String
578
+ }
579
+ )
580
+ end
581
+ def to_hash
582
+ end
583
+
584
+ class Address < Increase::Internal::Type::BaseModel
585
+ OrHash =
586
+ T.type_alias do
587
+ T.any(
588
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Address,
589
+ Increase::Internal::AnyHash
590
+ )
591
+ end
592
+
593
+ # The city, district, town, or village of the address.
594
+ sig { returns(T.nilable(String)) }
595
+ attr_accessor :city
596
+
597
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
598
+ sig { returns(String) }
599
+ attr_accessor :country
600
+
601
+ # The first line of the address.
602
+ sig { returns(String) }
603
+ attr_accessor :line1
604
+
605
+ # The second line of the address.
606
+ sig { returns(T.nilable(String)) }
607
+ attr_accessor :line2
608
+
609
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
610
+ # state, province, or region of the address.
611
+ sig { returns(T.nilable(String)) }
612
+ attr_accessor :state
613
+
614
+ # The ZIP or postal code of the address.
615
+ sig { returns(T.nilable(String)) }
616
+ attr_accessor :zip
617
+
618
+ # The person's address.
619
+ sig do
620
+ params(
621
+ city: T.nilable(String),
622
+ country: String,
623
+ line1: String,
624
+ line2: T.nilable(String),
625
+ state: T.nilable(String),
626
+ zip: T.nilable(String)
627
+ ).returns(T.attached_class)
628
+ end
629
+ def self.new(
630
+ # The city, district, town, or village of the address.
631
+ city:,
632
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
633
+ country:,
634
+ # The first line of the address.
635
+ line1:,
636
+ # The second line of the address.
637
+ line2:,
638
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
639
+ # state, province, or region of the address.
640
+ state:,
641
+ # The ZIP or postal code of the address.
642
+ zip:
643
+ )
644
+ end
645
+
646
+ sig do
647
+ override.returns(
648
+ {
649
+ city: T.nilable(String),
650
+ country: String,
651
+ line1: String,
652
+ line2: T.nilable(String),
653
+ state: T.nilable(String),
654
+ zip: T.nilable(String)
655
+ }
656
+ )
657
+ end
658
+ def to_hash
659
+ end
660
+ end
661
+
662
+ class Identification < Increase::Internal::Type::BaseModel
663
+ OrHash =
664
+ T.type_alias do
665
+ T.any(
666
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification,
667
+ Increase::Internal::AnyHash
668
+ )
669
+ end
670
+
671
+ # A method that can be used to verify the individual's identity.
672
+ sig do
673
+ returns(
674
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
675
+ )
676
+ end
677
+ attr_accessor :method_
678
+
679
+ # The last 4 digits of the identification number that can be used to verify the
680
+ # individual's identity.
681
+ sig { returns(String) }
682
+ attr_accessor :number_last4
683
+
684
+ # A means of verifying the person's identity.
685
+ sig do
686
+ params(
687
+ method_:
688
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::OrSymbol,
689
+ number_last4: String
690
+ ).returns(T.attached_class)
691
+ end
692
+ def self.new(
693
+ # A method that can be used to verify the individual's identity.
694
+ method_:,
695
+ # The last 4 digits of the identification number that can be used to verify the
696
+ # individual's identity.
697
+ number_last4:
698
+ )
699
+ end
700
+
701
+ sig do
702
+ override.returns(
703
+ {
704
+ method_:
705
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol,
706
+ number_last4: String
707
+ }
708
+ )
709
+ end
710
+ def to_hash
711
+ end
712
+
713
+ # A method that can be used to verify the individual's identity.
714
+ module Method
715
+ extend Increase::Internal::Type::Enum
716
+
717
+ TaggedSymbol =
718
+ T.type_alias do
719
+ T.all(
720
+ Symbol,
721
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method
722
+ )
723
+ end
724
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
725
+
726
+ # A social security number.
727
+ SOCIAL_SECURITY_NUMBER =
728
+ T.let(
729
+ :social_security_number,
730
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
731
+ )
732
+
733
+ # An individual taxpayer identification number (ITIN).
734
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
735
+ T.let(
736
+ :individual_taxpayer_identification_number,
737
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
738
+ )
739
+
740
+ # A passport number.
741
+ PASSPORT =
742
+ T.let(
743
+ :passport,
744
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
745
+ )
746
+
747
+ # A driver's license number.
748
+ DRIVERS_LICENSE =
749
+ T.let(
750
+ :drivers_license,
751
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
752
+ )
753
+
754
+ # Another identifying document.
755
+ OTHER =
756
+ T.let(
757
+ :other,
758
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
759
+ )
760
+
761
+ sig do
762
+ override.returns(
763
+ T::Array[
764
+ Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
765
+ ]
766
+ )
767
+ end
768
+ def self.values
769
+ end
770
+ end
771
+ end
772
+ end
773
+
774
+ module Prong
775
+ extend Increase::Internal::Type::Enum
776
+
777
+ TaggedSymbol =
778
+ T.type_alias do
779
+ T.all(
780
+ Symbol,
781
+ Increase::Entity::Corporation::BeneficialOwner::Prong
782
+ )
783
+ end
784
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
785
+
786
+ # A person with 25% or greater direct or indirect ownership of the entity.
787
+ OWNERSHIP =
788
+ T.let(
789
+ :ownership,
790
+ Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
791
+ )
792
+
793
+ # A person who manages, directs, or has significant control of the entity.
794
+ CONTROL =
795
+ T.let(
796
+ :control,
797
+ Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
798
+ )
799
+
800
+ sig do
801
+ override.returns(
802
+ T::Array[
803
+ Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
804
+ ]
805
+ )
806
+ end
807
+ def self.values
808
+ end
809
+ end
810
+ end
411
811
  end
412
812
 
413
813
  class GovernmentAuthority < Increase::Internal::Type::BaseModel
@@ -21,6 +21,10 @@ module Increase
21
21
  sig { returns(Time) }
22
22
  attr_accessor :created_at
23
23
 
24
+ # The identifier of the Entity to which this beneficial owner belongs.
25
+ sig { returns(String) }
26
+ attr_accessor :entity_id
27
+
24
28
  # The idempotency key you chose for this object. This value is unique across
25
29
  # Increase and is used to ensure that a request is only processed once. Learn more
26
30
  # about [idempotency](https://increase.com/documentation/idempotency-keys).
@@ -59,6 +63,7 @@ module Increase
59
63
  id: String,
60
64
  company_title: T.nilable(String),
61
65
  created_at: Time,
66
+ entity_id: String,
62
67
  idempotency_key: T.nilable(String),
63
68
  individual: Increase::EntityBeneficialOwner::Individual::OrHash,
64
69
  prongs: T::Array[Increase::EntityBeneficialOwner::Prong::OrSymbol],
@@ -73,6 +78,8 @@ module Increase
73
78
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
74
79
  # Beneficial Owner was created.
75
80
  created_at:,
81
+ # The identifier of the Entity to which this beneficial owner belongs.
82
+ entity_id:,
76
83
  # The idempotency key you chose for this object. This value is unique across
77
84
  # Increase and is used to ensure that a request is only processed once. Learn more
78
85
  # about [idempotency](https://increase.com/documentation/idempotency-keys).
@@ -93,6 +100,7 @@ module Increase
93
100
  id: String,
94
101
  company_title: T.nilable(String),
95
102
  created_at: Time,
103
+ entity_id: String,
96
104
  idempotency_key: T.nilable(String),
97
105
  individual: Increase::EntityBeneficialOwner::Individual,
98
106
  prongs:
@@ -253,9 +253,6 @@ module Increase
253
253
 
254
254
  EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
255
255
 
256
- EntityCreateBeneficialOwnerParams =
257
- Increase::Models::EntityCreateBeneficialOwnerParams
258
-
259
256
  EntityCreateParams = Increase::Models::EntityCreateParams
260
257
 
261
258
  EntityListParams = Increase::Models::EntityListParams
@@ -167,25 +167,6 @@ module Increase
167
167
  )
168
168
  end
169
169
 
170
- # Create a beneficial owner for a corporate Entity
171
- sig do
172
- params(
173
- entity_id: String,
174
- beneficial_owner:
175
- Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::OrHash,
176
- request_options: Increase::RequestOptions::OrHash
177
- ).returns(Increase::Entity)
178
- end
179
- def create_beneficial_owner(
180
- # The identifier of the Entity to associate with the new Beneficial Owner.
181
- entity_id,
182
- # The identifying details of anyone controlling or owning 25% or more of the
183
- # corporation.
184
- beneficial_owner:,
185
- request_options: {}
186
- )
187
- end
188
-
189
170
  # @api private
190
171
  sig { params(client: Increase::Client).returns(T.attached_class) }
191
172
  def self.new(client:)
@@ -8,6 +8,7 @@ module Increase
8
8
  approval: Increase::CardPushTransfer::Approval?,
9
9
  business_application_identifier: Increase::Models::CardPushTransfer::business_application_identifier,
10
10
  cancellation: Increase::CardPushTransfer::Cancellation?,
11
+ card_token_id: String,
11
12
  created_at: Time,
12
13
  created_by: Increase::CardPushTransfer::CreatedBy?,
13
14
  decline: Increase::CardPushTransfer::Decline?,
@@ -44,6 +45,8 @@ module Increase
44
45
 
45
46
  attr_accessor cancellation: Increase::CardPushTransfer::Cancellation?
46
47
 
48
+ attr_accessor card_token_id: String
49
+
47
50
  attr_accessor created_at: Time
48
51
 
49
52
  attr_accessor created_by: Increase::CardPushTransfer::CreatedBy?
@@ -93,6 +96,7 @@ module Increase
93
96
  approval: Increase::CardPushTransfer::Approval?,
94
97
  business_application_identifier: Increase::Models::CardPushTransfer::business_application_identifier,
95
98
  cancellation: Increase::CardPushTransfer::Cancellation?,
99
+ card_token_id: String,
96
100
  created_at: Time,
97
101
  created_by: Increase::CardPushTransfer::CreatedBy?,
98
102
  decline: Increase::CardPushTransfer::Decline?,
@@ -123,6 +127,7 @@ module Increase
123
127
  approval: Increase::CardPushTransfer::Approval?,
124
128
  business_application_identifier: Increase::Models::CardPushTransfer::business_application_identifier,
125
129
  cancellation: Increase::CardPushTransfer::Cancellation?,
130
+ card_token_id: String,
126
131
  created_at: Time,
127
132
  created_by: Increase::CardPushTransfer::CreatedBy?,
128
133
  decline: Increase::CardPushTransfer::Decline?,