increase 1.238.0 → 1.239.0

data/lib/increase/resources/beneficial_owners.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class BeneficialOwners
+      # Retrieve a Beneficial Owner
+      #
+      # @overload retrieve(entity_beneficial_owner_id, request_options: {})
+      #
+      # @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to retrieve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::EntityBeneficialOwner]
+      #
+      # @see Increase::Models::BeneficialOwnerRetrieveParams
+      def retrieve(entity_beneficial_owner_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["entity_beneficial_owners/%1$s", entity_beneficial_owner_id],
+          model: Increase::EntityBeneficialOwner,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::BeneficialOwnerListParams} for more details.
+      #
+      # List Beneficial Owners
+      #
+      # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #
+      # @param entity_id [String] The identifier of the Entity to list beneficial owners for. Only `corporation` e
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::EntityBeneficialOwner>]
+      #
+      # @see Increase::Models::BeneficialOwnerListParams
+      def list(params)
+        parsed, options = Increase::BeneficialOwnerListParams.dump_request(params)
+        query = Increase::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "entity_beneficial_owners",
+          query: query,
+          page: Increase::Internal::Page,
+          model: Increase::EntityBeneficialOwner,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.238.0"
+  VERSION = "1.239.0"
 end

data/lib/increase.rb

@@ -85,6 +85,8 @@ require_relative "increase/models/ach_transfer_create_params"
 require_relative "increase/models/ach_transfer_list_params"
 require_relative "increase/models/ach_transfer_retrieve_params"
 require_relative "increase/models/balance_lookup"
+require_relative "increase/models/beneficial_owner_list_params"
+require_relative "increase/models/beneficial_owner_retrieve_params"
 require_relative "increase/models/bookkeeping_account"
 require_relative "increase/models/bookkeeping_account_balance_params"
 require_relative "increase/models/bookkeeping_account_create_params"
@@ -161,6 +163,7 @@ require_relative "increase/models/digital_wallet_token_retrieve_params"
 require_relative "increase/models/entity"
 require_relative "increase/models/entity_archive_beneficial_owner_params"
 require_relative "increase/models/entity_archive_params"
+require_relative "increase/models/entity_beneficial_owner"
 require_relative "increase/models/entity_create_beneficial_owner_params"
 require_relative "increase/models/entity_create_params"
 require_relative "increase/models/entity_list_params"
@@ -359,6 +362,7 @@ require_relative "increase/resources/account_statements"
 require_relative "increase/resources/account_transfers"
 require_relative "increase/resources/ach_prenotifications"
 require_relative "increase/resources/ach_transfers"
+require_relative "increase/resources/beneficial_owners"
 require_relative "increase/resources/bookkeeping_accounts"
 require_relative "increase/resources/bookkeeping_entries"
 require_relative "increase/resources/bookkeeping_entry_sets"

data/rbi/increase/client.rbi

@@ -124,6 +124,9 @@ module Increase
     sig { returns(Increase::Resources::Entities) }
     attr_reader :entities
 
+    sig { returns(Increase::Resources::BeneficialOwners) }
+    attr_reader :beneficial_owners
+
     sig { returns(Increase::Resources::SupplementalDocuments) }
     attr_reader :supplemental_documents
 

data/rbi/increase/models/beneficial_owner_list_params.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module Increase
+  module Models
+    class BeneficialOwnerListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::BeneficialOwnerListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Entity to list beneficial owners for. Only `corporation`
+      # entities have beneficial owners.
+      sig { returns(String) }
+      attr_accessor :entity_id
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Filter records to the one with the specified `idempotency_key` you chose for
+      # that 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_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          entity_id: String,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Entity to list beneficial owners for. Only `corporation`
+        # entities have beneficial owners.
+        entity_id:,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that 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: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_id: String,
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/beneficial_owner_retrieve_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class BeneficialOwnerRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::BeneficialOwnerRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Beneficial Owner to retrieve.
+      sig { returns(String) }
+      attr_accessor :entity_beneficial_owner_id
+
+      sig do
+        params(
+          entity_beneficial_owner_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Beneficial Owner to retrieve.
+        entity_beneficial_owner_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_beneficial_owner_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/entity.rbi

@@ -255,9 +255,7 @@ module Increase
 
         # The identifying details of anyone controlling or owning 25% or more of the
         # corporation.
-        sig do
-          returns(T::Array[Increase::Entity::Corporation::BeneficialOwner])
-        end
+        sig { returns(T::Array[Increase::EntityBeneficialOwner]) }
         attr_accessor :beneficial_owners
 
         # An email address for the business.
@@ -292,7 +290,7 @@ module Increase
           params(
             address: Increase::Entity::Corporation::Address::OrHash,
             beneficial_owners:
-              T::Array[Increase::Entity::Corporation::BeneficialOwner::OrHash],
+              T::Array[Increase::EntityBeneficialOwner::OrHash],
             email: T.nilable(String),
             incorporation_state: T.nilable(String),
             industry_code: T.nilable(String),
@@ -328,8 +326,7 @@ module Increase
           override.returns(
             {
               address: Increase::Entity::Corporation::Address,
-              beneficial_owners:
-                T::Array[Increase::Entity::Corporation::BeneficialOwner],
+              beneficial_owners: T::Array[Increase::EntityBeneficialOwner],
               email: T.nilable(String),
               incorporation_state: T.nilable(String),
               industry_code: T.nilable(String),
@@ -411,403 +408,6 @@ 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