increase 1.237.0 → 1.239.0

data/lib/increase/models/entity_beneficial_owner.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::BeneficialOwners#retrieve
+    class EntityBeneficialOwner < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The identifier of this beneficial owner.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute company_title
+      #   This person's role or title within the entity.
+      #
+      #   @return [String, nil]
+      required :company_title, String, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+      #   Beneficial Owner was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute individual
+      #   Personal details for the beneficial owner.
+      #
+      #   @return [Increase::Models::EntityBeneficialOwner::Individual]
+      required :individual, -> { Increase::EntityBeneficialOwner::Individual }
+
+      # @!attribute prongs
+      #   Why this person is considered a beneficial owner of the entity.
+      #
+      #   @return [Array<Symbol, Increase::Models::EntityBeneficialOwner::Prong>]
+      required :prongs, -> { Increase::Internal::Type::ArrayOf[enum: Increase::EntityBeneficialOwner::Prong] }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `entity_beneficial_owner`.
+      #
+      #   @return [Symbol, Increase::Models::EntityBeneficialOwner::Type]
+      required :type, enum: -> { Increase::EntityBeneficialOwner::Type }
+
+      # @!method initialize(id:, company_title:, created_at:, individual:, prongs:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::EntityBeneficialOwner} for more details.
+      #
+      #   @param id [String] The identifier of this beneficial owner.
+      #
+      #   @param company_title [String, nil] This person's role or title within the entity.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Benefic
+      #
+      #   @param individual [Increase::Models::EntityBeneficialOwner::Individual] Personal details for the beneficial owner.
+      #
+      #   @param prongs [Array<Symbol, Increase::Models::EntityBeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity.
+      #
+      #   @param type [Symbol, Increase::Models::EntityBeneficialOwner::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::EntityBeneficialOwner#individual
+      class Individual < Increase::Internal::Type::BaseModel
+        # @!attribute address
+        #   The person's address.
+        #
+        #   @return [Increase::Models::EntityBeneficialOwner::Individual::Address]
+        required :address, -> { Increase::EntityBeneficialOwner::Individual::Address }
+
+        # @!attribute date_of_birth
+        #   The person's date of birth in YYYY-MM-DD format.
+        #
+        #   @return [Date]
+        required :date_of_birth, Date
+
+        # @!attribute identification
+        #   A means of verifying the person's identity.
+        #
+        #   @return [Increase::Models::EntityBeneficialOwner::Individual::Identification]
+        required :identification, -> { Increase::EntityBeneficialOwner::Individual::Identification }
+
+        # @!attribute name
+        #   The person's legal name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(address:, date_of_birth:, identification:, name:)
+        #   Personal details for the beneficial owner.
+        #
+        #   @param address [Increase::Models::EntityBeneficialOwner::Individual::Address] The person's address.
+        #
+        #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
+        #
+        #   @param identification [Increase::Models::EntityBeneficialOwner::Individual::Identification] A means of verifying the person's identity.
+        #
+        #   @param name [String] The person's legal name.
+
+        # @see Increase::Models::EntityBeneficialOwner::Individual#address
+        class Address < Increase::Internal::Type::BaseModel
+          # @!attribute city
+          #   The city, district, town, or village of the address.
+          #
+          #   @return [String, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          #   @return [String]
+          required :country, String
+
+          # @!attribute line1
+          #   The first line of the address.
+          #
+          #   @return [String]
+          required :line1, String
+
+          # @!attribute line2
+          #   The second line of the address.
+          #
+          #   @return [String, nil]
+          required :line2, String, nil?: true
+
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address.
+          #
+          #   @return [String, nil]
+          required :state, String, nil?: true
+
+          # @!attribute zip
+          #   The ZIP or postal code of the address.
+          #
+          #   @return [String, nil]
+          required :zip, String, nil?: true
+
+          # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::EntityBeneficialOwner::Individual::Address} for more details.
+          #
+          #   The person's address.
+          #
+          #   @param city [String, nil] The city, district, town, or village of the address.
+          #
+          #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          #   @param line1 [String] The first line of the address.
+          #
+          #   @param line2 [String, nil] The second line of the address.
+          #
+          #   @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
+          #
+          #   @param zip [String, nil] The ZIP or postal code of the address.
+        end
+
+        # @see Increase::Models::EntityBeneficialOwner::Individual#identification
+        class Identification < Increase::Internal::Type::BaseModel
+          # @!attribute method_
+          #   A method that can be used to verify the individual's identity.
+          #
+          #   @return [Symbol, Increase::Models::EntityBeneficialOwner::Individual::Identification::Method]
+          required :method_,
+                   enum: -> { Increase::EntityBeneficialOwner::Individual::Identification::Method },
+                   api_name: :method
+
+          # @!attribute number_last4
+          #   The last 4 digits of the identification number that can be used to verify the
+          #   individual's identity.
+          #
+          #   @return [String]
+          required :number_last4, String
+
+          # @!method initialize(method_:, number_last4:)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::EntityBeneficialOwner::Individual::Identification} for more
+          #   details.
+          #
+          #   A means of verifying the person's identity.
+          #
+          #   @param method_ [Symbol, Increase::Models::EntityBeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
+          #
+          #   @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
+
+          # A method that can be used to verify the individual's identity.
+          #
+          # @see Increase::Models::EntityBeneficialOwner::Individual::Identification#method_
+          module Method
+            extend Increase::Internal::Type::Enum
+
+            # A social security number.
+            SOCIAL_SECURITY_NUMBER = :social_security_number
+
+            # An individual taxpayer identification number (ITIN).
+            INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
+
+            # A passport number.
+            PASSPORT = :passport
+
+            # A driver's license number.
+            DRIVERS_LICENSE = :drivers_license
+
+            # Another identifying document.
+            OTHER = :other
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      module Prong
+        extend Increase::Internal::Type::Enum
+
+        # A person with 25% or greater direct or indirect ownership of the entity.
+        OWNERSHIP = :ownership
+
+        # A person who manages, directs, or has significant control of the entity.
+        CONTROL = :control
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `entity_beneficial_owner`.
+      #
+      # @see Increase::Models::EntityBeneficialOwner#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        ENTITY_BENEFICIAL_OWNER = :entity_beneficial_owner
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/real_time_decision.rb

@@ -198,12 +198,6 @@ module Increase
         #   @return [String, nil]
         required :cardholder_name, String, nil?: true
 
-        # @!attribute category
-        #   The category of the card authentication attempt.
-        #
-        #   @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil]
-        required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::Category }, nil?: true
-
         # @!attribute decision
         #   Whether or not the authentication attempt was approved.
         #
@@ -249,6 +243,12 @@ module Increase
         #   @return [String, nil]
         required :merchant_name, String, nil?: true
 
+        # @!attribute message_category
+        #   The message category of the card authentication attempt.
+        #
+        #   @return [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory]
+        required :message_category, -> { Increase::RealTimeDecision::CardAuthentication::MessageCategory }
+
         # @!attribute prior_authenticated_card_payment_id
         #   The ID of a prior Card Authentication that the requestor used to authenticate
         #   this cardholder for a previous transaction.
@@ -256,26 +256,6 @@ module Increase
         #   @return [String, nil]
         required :prior_authenticated_card_payment_id, String, nil?: true
 
-        # @!attribute purchase_amount
-        #   The purchase amount in minor units.
-        #
-        #   @return [Integer, nil]
-        required :purchase_amount, Integer, nil?: true
-
-        # @!attribute purchase_amount_cardholder_estimated
-        #   The purchase amount in the cardholder's currency (i.e., USD) estimated using
-        #   daily conversion rates from the card network.
-        #
-        #   @return [Integer, nil]
-        required :purchase_amount_cardholder_estimated, Integer, nil?: true
-
-        # @!attribute purchase_currency
-        #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-        #   authentication attempt's purchase currency.
-        #
-        #   @return [String, nil]
-        required :purchase_currency, String, nil?: true
-
         # @!attribute requestor_authentication_indicator
         #   The 3DS requestor authentication indicator describes why the authentication
         #   attempt is performed, such as for a recurring transaction.
@@ -356,14 +336,6 @@ module Increase
         #   @return [String]
         required :three_d_secure_server_transaction_id, String
 
-        # @!attribute transaction_type
-        #   The type of transaction being authenticated.
-        #
-        #   @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil]
-        required :transaction_type,
-                 enum: -> { Increase::RealTimeDecision::CardAuthentication::TransactionType },
-                 nil?: true
-
         # @!attribute upcoming_card_payment_id
         #   The identifier of the Card Payment this authentication attempt will belong to.
         #   Available in the API once the card authentication has completed.
@@ -371,7 +343,7 @@ module Increase
         #   @return [String]
         required :upcoming_card_payment_id, String
 
-        # @!method initialize(access_control_server_transaction_id:, account_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, cardholder_email:, cardholder_name:, category:, decision:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, prior_authenticated_card_payment_id:, purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, three_d_secure_server_transaction_id:, transaction_type:, upcoming_card_payment_id:)
+        # @!method initialize(access_control_server_transaction_id:, account_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, cardholder_email:, cardholder_name:, decision:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, message_category:, prior_authenticated_card_payment_id:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, three_d_secure_server_transaction_id:, upcoming_card_payment_id:)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::RealTimeDecision::CardAuthentication} for more details.
         #
@@ -401,8 +373,6 @@ module Increase
         #
         #   @param cardholder_name [String, nil] The name of the cardholder.
         #
-        #   @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil] The category of the card authentication attempt.
-        #
         #   @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] Whether or not the authentication attempt was approved.
         #
         #   @param device_channel [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel] The device channel of the card authentication attempt.
@@ -417,13 +387,9 @@ module Increase
         #
         #   @param merchant_name [String, nil] The name of the merchant.
         #
-        #   @param prior_authenticated_card_payment_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
+        #   @param message_category [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory] The message category of the card authentication attempt.
         #
-        #   @param purchase_amount [Integer, nil] The purchase amount in minor units.
-        #
-        #   @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
-        #
-        #   @param purchase_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
+        #   @param prior_authenticated_card_payment_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
         #
         #   @param requestor_authentication_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil] The 3DS requestor authentication indicator describes why the authentication atte
         #
@@ -449,26 +415,8 @@ module Increase
         #
         #   @param three_d_secure_server_transaction_id [String] A unique identifier assigned by the 3DS Server initiating the authentication att
         #
-        #   @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil] The type of transaction being authenticated.
-        #
         #   @param upcoming_card_payment_id [String] The identifier of the Card Payment this authentication attempt will belong to. A
 
-        # The category of the card authentication attempt.
-        #
-        # @see Increase::Models::RealTimeDecision::CardAuthentication#category
-        module Category
-          extend Increase::Internal::Type::Enum
-
-          # The authentication attempt is for a payment.
-          PAYMENT_AUTHENTICATION = :payment_authentication
-
-          # The authentication attempt is not for a payment.
-          NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # Whether or not the authentication attempt was approved.
         #
         # @see Increase::Models::RealTimeDecision::CardAuthentication#decision
@@ -689,6 +637,135 @@ module Increase
           end
         end
 
+        # @see Increase::Models::RealTimeDecision::CardAuthentication#message_category
+        class MessageCategory < Increase::Internal::Type::BaseModel
+          # @!attribute category
+          #   The category of the card authentication attempt.
+          #
+          #   @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Category]
+          required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category }
+
+          # @!attribute non_payment
+          #   Fields specific to non-payment authentication attempts.
+          #
+          #   @return [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment, nil]
+          required :non_payment,
+                   -> { Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment },
+                   nil?: true
+
+          # @!attribute payment
+          #   Fields specific to payment authentication attempts.
+          #
+          #   @return [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment, nil]
+          required :payment,
+                   -> { Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment },
+                   nil?: true
+
+          # @!method initialize(category:, non_payment:, payment:)
+          #   The message category of the card authentication attempt.
+          #
+          #   @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Category] The category of the card authentication attempt.
+          #
+          #   @param non_payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment, nil] Fields specific to non-payment authentication attempts.
+          #
+          #   @param payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment, nil] Fields specific to payment authentication attempts.
+
+          # The category of the card authentication attempt.
+          #
+          # @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory#category
+          module Category
+            extend Increase::Internal::Type::Enum
+
+            # The authentication attempt is for a payment.
+            PAYMENT_AUTHENTICATION = :payment_authentication
+
+            # The authentication attempt is not for a payment.
+            NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory#non_payment
+          class NonPayment < Increase::Internal::Type::BaseModel
+            # @!method initialize
+            #   Fields specific to non-payment authentication attempts.
+          end
+
+          # @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory#payment
+          class Payment < Increase::Internal::Type::BaseModel
+            # @!attribute purchase_amount
+            #   The purchase amount in minor units.
+            #
+            #   @return [Integer]
+            required :purchase_amount, Integer
+
+            # @!attribute purchase_amount_cardholder_estimated
+            #   The purchase amount in the cardholder's currency (i.e., USD) estimated using
+            #   daily conversion rates from the card network.
+            #
+            #   @return [Integer, nil]
+            required :purchase_amount_cardholder_estimated, Integer, nil?: true
+
+            # @!attribute purchase_currency
+            #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+            #   authentication attempt's purchase currency.
+            #
+            #   @return [String]
+            required :purchase_currency, String
+
+            # @!attribute transaction_type
+            #   The type of transaction being authenticated.
+            #
+            #   @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType, nil]
+            required :transaction_type,
+                     enum: -> {
+                       Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType
+                     },
+                     nil?: true
+
+            # @!method initialize(purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, transaction_type:)
+            #   Some parameter documentations has been truncated, see
+            #   {Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment}
+            #   for more details.
+            #
+            #   Fields specific to payment authentication attempts.
+            #
+            #   @param purchase_amount [Integer] The purchase amount in minor units.
+            #
+            #   @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
+            #
+            #   @param purchase_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
+            #
+            #   @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType, nil] The type of transaction being authenticated.
+
+            # The type of transaction being authenticated.
+            #
+            # @see Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment#transaction_type
+            module TransactionType
+              extend Increase::Internal::Type::Enum
+
+              # Purchase of goods or services.
+              GOODS_SERVICE_PURCHASE = :goods_service_purchase
+
+              # Check acceptance.
+              CHECK_ACCEPTANCE = :check_acceptance
+
+              # Account funding.
+              ACCOUNT_FUNDING = :account_funding
+
+              # Quasi-cash transaction.
+              QUASI_CASH_TRANSACTION = :quasi_cash_transaction
+
+              # Prepaid activation and load.
+              PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
         # The 3DS requestor authentication indicator describes why the authentication
         # attempt is performed, such as for a recurring transaction.
         #
@@ -761,31 +838,6 @@ module Increase
           # @!method self.values
           #   @return [Array<Symbol>]
         end
-
-        # The type of transaction being authenticated.
-        #
-        # @see Increase::Models::RealTimeDecision::CardAuthentication#transaction_type
-        module TransactionType
-          extend Increase::Internal::Type::Enum
-
-          # Purchase of goods or services.
-          GOODS_SERVICE_PURCHASE = :goods_service_purchase
-
-          # Check acceptance.
-          CHECK_ACCEPTANCE = :check_acceptance
-
-          # Account funding.
-          ACCOUNT_FUNDING = :account_funding
-
-          # Quasi-cash transaction.
-          QUASI_CASH_TRANSACTION = :quasi_cash_transaction
-
-          # Prepaid activation and load.
-          PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
 
       # @see Increase::Models::RealTimeDecision#card_authentication_challenge

data/lib/increase/models.rb

@@ -103,6 +103,10 @@ module Increase
 
   BalanceLookup = Increase::Models::BalanceLookup
 
+  BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
+
+  BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams
+
   BookkeepingAccount = Increase::Models::BookkeepingAccount
 
   BookkeepingAccountBalanceParams = Increase::Models::BookkeepingAccountBalanceParams
@@ -255,6 +259,8 @@ module Increase
 
   EntityArchiveParams = Increase::Models::EntityArchiveParams
 
+  EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
+
   EntityCreateBeneficialOwnerParams = Increase::Models::EntityCreateBeneficialOwnerParams
 
   EntityCreateParams = Increase::Models::EntityCreateParams

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.237.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