increase 1.249.0 → 1.251.0

data/rbi/increase/models/card_push_transfer.rbi

@@ -63,6 +63,10 @@ module Increase
       end
       attr_writer :cancellation
 
+      # The ID of the Card Token that was used to validate the card.
+      sig { returns(String) }
+      attr_accessor :card_token_id
+
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       # the transfer was created.
       sig { returns(Time) }
@@ -201,6 +205,7 @@ module Increase
             Increase::CardPushTransfer::BusinessApplicationIdentifier::OrSymbol,
           cancellation:
             T.nilable(Increase::CardPushTransfer::Cancellation::OrHash),
+          card_token_id: String,
           created_at: Time,
           created_by: T.nilable(Increase::CardPushTransfer::CreatedBy::OrHash),
           decline: T.nilable(Increase::CardPushTransfer::Decline::OrHash),
@@ -243,6 +248,8 @@ module Increase
         # If your account requires approvals for transfers and the transfer was not
         # approved, this will contain details of the cancellation.
         cancellation:,
+        # The ID of the Card Token that was used to validate the card.
+        card_token_id:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         # the transfer was created.
         created_at:,
@@ -312,6 +319,7 @@ module Increase
             business_application_identifier:
               Increase::CardPushTransfer::BusinessApplicationIdentifier::TaggedSymbol,
             cancellation: T.nilable(Increase::CardPushTransfer::Cancellation),
+            card_token_id: String,
             created_at: Time,
             created_by: T.nilable(Increase::CardPushTransfer::CreatedBy),
             decline: T.nilable(Increase::CardPushTransfer::Decline),

data/rbi/increase/models/entity.rbi

@@ -255,7 +255,9 @@ module Increase
 
         # The identifying details of anyone controlling or owning 25% or more of the
         # corporation.
-        sig { returns(T::Array[Increase::EntityBeneficialOwner]) }
+        sig do
+          returns(T::Array[Increase::Entity::Corporation::BeneficialOwner])
+        end
         attr_accessor :beneficial_owners
 
         # An email address for the business.
@@ -290,7 +292,7 @@ module Increase
           params(
             address: Increase::Entity::Corporation::Address::OrHash,
             beneficial_owners:
-              T::Array[Increase::EntityBeneficialOwner::OrHash],
+              T::Array[Increase::Entity::Corporation::BeneficialOwner::OrHash],
             email: T.nilable(String),
             incorporation_state: T.nilable(String),
             industry_code: T.nilable(String),
@@ -326,7 +328,8 @@ module Increase
           override.returns(
             {
               address: Increase::Entity::Corporation::Address,
-              beneficial_owners: T::Array[Increase::EntityBeneficialOwner],
+              beneficial_owners:
+                T::Array[Increase::Entity::Corporation::BeneficialOwner],
               email: T.nilable(String),
               incorporation_state: T.nilable(String),
               industry_code: T.nilable(String),
@@ -408,6 +411,403 @@ module Increase
           def to_hash
           end
         end
+
+        class BeneficialOwner < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::Entity::Corporation::BeneficialOwner,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The identifier of this beneficial owner.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # This person's role or title within the entity.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :company_title
+
+          # Personal details for the beneficial owner.
+          sig do
+            returns(Increase::Entity::Corporation::BeneficialOwner::Individual)
+          end
+          attr_reader :individual
+
+          sig do
+            params(
+              individual:
+                Increase::Entity::Corporation::BeneficialOwner::Individual::OrHash
+            ).void
+          end
+          attr_writer :individual
+
+          # Why this person is considered a beneficial owner of the entity.
+          sig do
+            returns(
+              T::Array[
+                Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
+              ]
+            )
+          end
+          attr_accessor :prongs
+
+          sig do
+            params(
+              id: String,
+              company_title: T.nilable(String),
+              individual:
+                Increase::Entity::Corporation::BeneficialOwner::Individual::OrHash,
+              prongs:
+                T::Array[
+                  Increase::Entity::Corporation::BeneficialOwner::Prong::OrSymbol
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The identifier of this beneficial owner.
+            id:,
+            # This person's role or title within the entity.
+            company_title:,
+            # Personal details for the beneficial owner.
+            individual:,
+            # Why this person is considered a beneficial owner of the entity.
+            prongs:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                company_title: T.nilable(String),
+                individual:
+                  Increase::Entity::Corporation::BeneficialOwner::Individual,
+                prongs:
+                  T::Array[
+                    Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Individual < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::Entity::Corporation::BeneficialOwner::Individual,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # The person's address.
+            sig do
+              returns(
+                Increase::Entity::Corporation::BeneficialOwner::Individual::Address
+              )
+            end
+            attr_reader :address
+
+            sig do
+              params(
+                address:
+                  Increase::Entity::Corporation::BeneficialOwner::Individual::Address::OrHash
+              ).void
+            end
+            attr_writer :address
+
+            # The person's date of birth in YYYY-MM-DD format.
+            sig { returns(Date) }
+            attr_accessor :date_of_birth
+
+            # A means of verifying the person's identity.
+            sig do
+              returns(
+                Increase::Entity::Corporation::BeneficialOwner::Individual::Identification
+              )
+            end
+            attr_reader :identification
+
+            sig do
+              params(
+                identification:
+                  Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::OrHash
+              ).void
+            end
+            attr_writer :identification
+
+            # The person's legal name.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # Personal details for the beneficial owner.
+            sig do
+              params(
+                address:
+                  Increase::Entity::Corporation::BeneficialOwner::Individual::Address::OrHash,
+                date_of_birth: Date,
+                identification:
+                  Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::OrHash,
+                name: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The person's address.
+              address:,
+              # The person's date of birth in YYYY-MM-DD format.
+              date_of_birth:,
+              # A means of verifying the person's identity.
+              identification:,
+              # The person's legal name.
+              name:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  address:
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Address,
+                  date_of_birth: Date,
+                  identification:
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification,
+                  name: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Address < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Address,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The city, district, town, or village of the address.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :city
+
+              # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+              sig { returns(String) }
+              attr_accessor :country
+
+              # The first line of the address.
+              sig { returns(String) }
+              attr_accessor :line1
+
+              # The second line of the address.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :line2
+
+              # The two-letter United States Postal Service (USPS) abbreviation for the US
+              # state, province, or region of the address.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :state
+
+              # The ZIP or postal code of the address.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :zip
+
+              # The person's address.
+              sig do
+                params(
+                  city: T.nilable(String),
+                  country: String,
+                  line1: String,
+                  line2: T.nilable(String),
+                  state: T.nilable(String),
+                  zip: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The city, district, town, or village of the address.
+                city:,
+                # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+                country:,
+                # The first line of the address.
+                line1:,
+                # The second line of the address.
+                line2:,
+                # The two-letter United States Postal Service (USPS) abbreviation for the US
+                # state, province, or region of the address.
+                state:,
+                # The ZIP or postal code of the address.
+                zip:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    city: T.nilable(String),
+                    country: String,
+                    line1: String,
+                    line2: T.nilable(String),
+                    state: T.nilable(String),
+                    zip: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            class Identification < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # A method that can be used to verify the individual's identity.
+              sig do
+                returns(
+                  Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                )
+              end
+              attr_accessor :method_
+
+              # The last 4 digits of the identification number that can be used to verify the
+              # individual's identity.
+              sig { returns(String) }
+              attr_accessor :number_last4
+
+              # A means of verifying the person's identity.
+              sig do
+                params(
+                  method_:
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::OrSymbol,
+                  number_last4: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # A method that can be used to verify the individual's identity.
+                method_:,
+                # The last 4 digits of the identification number that can be used to verify the
+                # individual's identity.
+                number_last4:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    method_:
+                      Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol,
+                    number_last4: String
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # A method that can be used to verify the individual's identity.
+              module Method
+                extend Increase::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                # A social security number.
+                SOCIAL_SECURITY_NUMBER =
+                  T.let(
+                    :social_security_number,
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
+                # An individual taxpayer identification number (ITIN).
+                INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
+                  T.let(
+                    :individual_taxpayer_identification_number,
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
+                # A passport number.
+                PASSPORT =
+                  T.let(
+                    :passport,
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
+                # A driver's license number.
+                DRIVERS_LICENSE =
+                  T.let(
+                    :drivers_license,
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
+                # Another identifying document.
+                OTHER =
+                  T.let(
+                    :other,
+                    Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Increase::Entity::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+
+          module Prong
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::Entity::Corporation::BeneficialOwner::Prong
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # A person with 25% or greater direct or indirect ownership of the entity.
+            OWNERSHIP =
+              T.let(
+                :ownership,
+                Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
+              )
+
+            # A person who manages, directs, or has significant control of the entity.
+            CONTROL =
+              T.let(
+                :control,
+                Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::Entity::Corporation::BeneficialOwner::Prong::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       class GovernmentAuthority < Increase::Internal::Type::BaseModel

data/rbi/increase/models/entity_beneficial_owner.rbi

@@ -21,6 +21,16 @@ module Increase
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # The identifier of the Entity to which this beneficial owner belongs.
+      sig { returns(String) }
+      attr_accessor :entity_id
+
+      # The idempotency key you chose for this object. This value is unique across
+      # Increase and is used to ensure that a request is only processed once. Learn more
+      # about [idempotency](https://increase.com/documentation/idempotency-keys).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :idempotency_key
+
       # Personal details for the beneficial owner.
       sig { returns(Increase::EntityBeneficialOwner::Individual) }
       attr_reader :individual
@@ -53,6 +63,8 @@ module Increase
           id: String,
           company_title: T.nilable(String),
           created_at: Time,
+          entity_id: String,
+          idempotency_key: T.nilable(String),
           individual: Increase::EntityBeneficialOwner::Individual::OrHash,
           prongs: T::Array[Increase::EntityBeneficialOwner::Prong::OrSymbol],
           type: Increase::EntityBeneficialOwner::Type::OrSymbol
@@ -66,6 +78,12 @@ module Increase
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
         # Beneficial Owner was created.
         created_at:,
+        # The identifier of the Entity to which this beneficial owner belongs.
+        entity_id:,
+        # The idempotency key you chose for this object. This value is unique across
+        # Increase and is used to ensure that a request is only processed once. Learn more
+        # about [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key:,
         # Personal details for the beneficial owner.
         individual:,
         # Why this person is considered a beneficial owner of the entity.
@@ -82,6 +100,8 @@ module Increase
             id: String,
             company_title: T.nilable(String),
             created_at: Time,
+            entity_id: String,
+            idempotency_key: T.nilable(String),
             individual: Increase::EntityBeneficialOwner::Individual,
             prongs:
               T::Array[Increase::EntityBeneficialOwner::Prong::TaggedSymbol],

data/rbi/increase/models.rbi

@@ -71,6 +71,8 @@ module Increase
 
   BeneficialOwnerArchiveParams = Increase::Models::BeneficialOwnerArchiveParams
 
+  BeneficialOwnerCreateParams = Increase::Models::BeneficialOwnerCreateParams
+
   BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
 
   BeneficialOwnerRetrieveParams =
@@ -251,9 +253,6 @@ module Increase
 
   EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
 
-  EntityCreateBeneficialOwnerParams =
-    Increase::Models::EntityCreateBeneficialOwnerParams
-
   EntityCreateParams = Increase::Models::EntityCreateParams
 
   EntityListParams = Increase::Models::EntityListParams

data/rbi/increase/resources/beneficial_owners.rbi

@@ -3,6 +3,32 @@
 module Increase
   module Resources
     class BeneficialOwners
+      # Create a beneficial owner
+      sig do
+        params(
+          entity_id: String,
+          individual: Increase::BeneficialOwnerCreateParams::Individual::OrHash,
+          prongs:
+            T::Array[Increase::BeneficialOwnerCreateParams::Prong::OrSymbol],
+          company_title: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityBeneficialOwner)
+      end
+      def create(
+        # The identifier of the Entity to associate with the new Beneficial Owner.
+        entity_id:,
+        # Personal details for the beneficial owner.
+        individual:,
+        # Why this person is considered a beneficial owner of the entity. At least one
+        # option is required, if a person is both a control person and owner, submit an
+        # array containing both.
+        prongs:,
+        # This person's role or title within the entity.
+        company_title: nil,
+        request_options: {}
+      )
+      end
+
       # Retrieve a Beneficial Owner
       sig do
         params(

data/rbi/increase/resources/entities.rbi

@@ -167,25 +167,6 @@ module Increase
       )
       end
 
-      # Create a beneficial owner for a corporate Entity
-      sig do
-        params(
-          entity_id: String,
-          beneficial_owner:
-            Increase::EntityCreateBeneficialOwnerParams::BeneficialOwner::OrHash,
-          request_options: Increase::RequestOptions::OrHash
-        ).returns(Increase::Entity)
-      end
-      def create_beneficial_owner(
-        # The identifier of the Entity to associate with the new Beneficial Owner.
-        entity_id,
-        # The identifying details of anyone controlling or owning 25% or more of the
-        # corporation.
-        beneficial_owner:,
-        request_options: {}
-      )
-      end
-
       # @api private
       sig { params(client: Increase::Client).returns(T.attached_class) }
       def self.new(client:)