increase 1.237.0 → 1.239.0

data/rbi/increase/models/real_time_decision.rbi

@@ -276,16 +276,6 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :cardholder_name
 
-        # The category of the card authentication attempt.
-        sig do
-          returns(
-            T.nilable(
-              Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
-            )
-          )
-        end
-        attr_accessor :category
-
         # Whether or not the authentication attempt was approved.
         sig do
           returns(
@@ -333,25 +323,27 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :merchant_name
 
+        # The message category of the card authentication attempt.
+        sig do
+          returns(
+            Increase::RealTimeDecision::CardAuthentication::MessageCategory
+          )
+        end
+        attr_reader :message_category
+
+        sig do
+          params(
+            message_category:
+              Increase::RealTimeDecision::CardAuthentication::MessageCategory::OrHash
+          ).void
+        end
+        attr_writer :message_category
+
         # The ID of a prior Card Authentication that the requestor used to authenticate
         # this cardholder for a previous transaction.
         sig { returns(T.nilable(String)) }
         attr_accessor :prior_authenticated_card_payment_id
 
-        # The purchase amount in minor units.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :purchase_amount
-
-        # The purchase amount in the cardholder's currency (i.e., USD) estimated using
-        # daily conversion rates from the card network.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :purchase_amount_cardholder_estimated
-
-        # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-        # authentication attempt's purchase currency.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :purchase_currency
-
         # The 3DS requestor authentication indicator describes why the authentication
         # attempt is performed, such as for a recurring transaction.
         sig do
@@ -414,16 +406,6 @@ module Increase
         sig { returns(String) }
         attr_accessor :three_d_secure_server_transaction_id
 
-        # The type of transaction being authenticated.
-        sig do
-          returns(
-            T.nilable(
-              Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-            )
-          )
-        end
-        attr_accessor :transaction_type
-
         # The identifier of the Card Payment this authentication attempt will belong to.
         # Available in the API once the card authentication has completed.
         sig { returns(String) }
@@ -444,10 +426,6 @@ module Increase
             card_id: String,
             cardholder_email: T.nilable(String),
             cardholder_name: T.nilable(String),
-            category:
-              T.nilable(
-                Increase::RealTimeDecision::CardAuthentication::Category::OrSymbol
-              ),
             decision:
               T.nilable(
                 Increase::RealTimeDecision::CardAuthentication::Decision::OrSymbol
@@ -459,10 +437,9 @@ module Increase
             merchant_category_code: T.nilable(String),
             merchant_country: T.nilable(String),
             merchant_name: T.nilable(String),
+            message_category:
+              Increase::RealTimeDecision::CardAuthentication::MessageCategory::OrHash,
             prior_authenticated_card_payment_id: T.nilable(String),
-            purchase_amount: T.nilable(Integer),
-            purchase_amount_cardholder_estimated: T.nilable(Integer),
-            purchase_currency: T.nilable(String),
             requestor_authentication_indicator:
               T.nilable(
                 Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::OrSymbol
@@ -481,10 +458,6 @@ module Increase
             shipping_address_postal_code: T.nilable(String),
             shipping_address_state: T.nilable(String),
             three_d_secure_server_transaction_id: String,
-            transaction_type:
-              T.nilable(
-                Increase::RealTimeDecision::CardAuthentication::TransactionType::OrSymbol
-              ),
             upcoming_card_payment_id: String
           ).returns(T.attached_class)
         end
@@ -521,8 +494,6 @@ module Increase
           cardholder_email:,
           # The name of the cardholder.
           cardholder_name:,
-          # The category of the card authentication attempt.
-          category:,
           # Whether or not the authentication attempt was approved.
           decision:,
           # The device channel of the card authentication attempt.
@@ -540,17 +511,11 @@ module Increase
           merchant_country:,
           # The name of the merchant.
           merchant_name:,
+          # The message category of the card authentication attempt.
+          message_category:,
           # The ID of a prior Card Authentication that the requestor used to authenticate
           # this cardholder for a previous transaction.
           prior_authenticated_card_payment_id:,
-          # The purchase amount in minor units.
-          purchase_amount:,
-          # The purchase amount in the cardholder's currency (i.e., USD) estimated using
-          # daily conversion rates from the card network.
-          purchase_amount_cardholder_estimated:,
-          # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-          # authentication attempt's purchase currency.
-          purchase_currency:,
           # The 3DS requestor authentication indicator describes why the authentication
           # attempt is performed, such as for a recurring transaction.
           requestor_authentication_indicator:,
@@ -577,8 +542,6 @@ module Increase
           # A unique identifier assigned by the 3DS Server initiating the authentication
           # attempt for this transaction.
           three_d_secure_server_transaction_id:,
-          # The type of transaction being authenticated.
-          transaction_type:,
           # The identifier of the Card Payment this authentication attempt will belong to.
           # Available in the API once the card authentication has completed.
           upcoming_card_payment_id:
@@ -600,10 +563,6 @@ module Increase
               card_id: String,
               cardholder_email: T.nilable(String),
               cardholder_name: T.nilable(String),
-              category:
-                T.nilable(
-                  Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
-                ),
               decision:
                 T.nilable(
                   Increase::RealTimeDecision::CardAuthentication::Decision::TaggedSymbol
@@ -615,10 +574,9 @@ module Increase
               merchant_category_code: T.nilable(String),
               merchant_country: T.nilable(String),
               merchant_name: T.nilable(String),
+              message_category:
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory,
               prior_authenticated_card_payment_id: T.nilable(String),
-              purchase_amount: T.nilable(Integer),
-              purchase_amount_cardholder_estimated: T.nilable(Integer),
-              purchase_currency: T.nilable(String),
               requestor_authentication_indicator:
                 T.nilable(
                   Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
@@ -637,10 +595,6 @@ module Increase
               shipping_address_postal_code: T.nilable(String),
               shipping_address_state: T.nilable(String),
               three_d_secure_server_transaction_id: String,
-              transaction_type:
-                T.nilable(
-                  Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-                ),
               upcoming_card_payment_id: String
             }
           )
@@ -648,44 +602,6 @@ module Increase
         def to_hash
         end
 
-        # The category of the card authentication attempt.
-        module Category
-          extend Increase::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Increase::RealTimeDecision::CardAuthentication::Category
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          # The authentication attempt is for a payment.
-          PAYMENT_AUTHENTICATION =
-            T.let(
-              :payment_authentication,
-              Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
-            )
-
-          # The authentication attempt is not for a payment.
-          NON_PAYMENT_AUTHENTICATION =
-            T.let(
-              :non_payment_authentication,
-              Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         # Whether or not the authentication attempt was approved.
         module Decision
           extend Increase::Internal::Type::Enum
@@ -1195,6 +1111,300 @@ module Increase
           end
         end
 
+        class MessageCategory < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The category of the card authentication attempt.
+          sig do
+            returns(
+              Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category::TaggedSymbol
+            )
+          end
+          attr_accessor :category
+
+          # Fields specific to non-payment authentication attempts.
+          sig do
+            returns(
+              T.nilable(
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment
+              )
+            )
+          end
+          attr_reader :non_payment
+
+          sig do
+            params(
+              non_payment:
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment::OrHash
+                )
+            ).void
+          end
+          attr_writer :non_payment
+
+          # Fields specific to payment authentication attempts.
+          sig do
+            returns(
+              T.nilable(
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment
+              )
+            )
+          end
+          attr_reader :payment
+
+          sig do
+            params(
+              payment:
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::OrHash
+                )
+            ).void
+          end
+          attr_writer :payment
+
+          # The message category of the card authentication attempt.
+          sig do
+            params(
+              category:
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category::OrSymbol,
+              non_payment:
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment::OrHash
+                ),
+              payment:
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The category of the card authentication attempt.
+            category:,
+            # Fields specific to non-payment authentication attempts.
+            non_payment:,
+            # Fields specific to payment authentication attempts.
+            payment:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                category:
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category::TaggedSymbol,
+                non_payment:
+                  T.nilable(
+                    Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment
+                  ),
+                payment:
+                  T.nilable(
+                    Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The category of the card authentication attempt.
+          module Category
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # The authentication attempt is for a payment.
+            PAYMENT_AUTHENTICATION =
+              T.let(
+                :payment_authentication,
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category::TaggedSymbol
+              )
+
+            # The authentication attempt is not for a payment.
+            NON_PAYMENT_AUTHENTICATION =
+              T.let(
+                :non_payment_authentication,
+                Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Category::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class NonPayment < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # Fields specific to non-payment authentication attempts.
+            sig { returns(T.attached_class) }
+            def self.new
+            end
+
+            sig { override.returns({}) }
+            def to_hash
+            end
+          end
+
+          class Payment < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # The purchase amount in minor units.
+            sig { returns(Integer) }
+            attr_accessor :purchase_amount
+
+            # The purchase amount in the cardholder's currency (i.e., USD) estimated using
+            # daily conversion rates from the card network.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :purchase_amount_cardholder_estimated
+
+            # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+            # authentication attempt's purchase currency.
+            sig { returns(String) }
+            attr_accessor :purchase_currency
+
+            # The type of transaction being authenticated.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                )
+              )
+            end
+            attr_accessor :transaction_type
+
+            # Fields specific to payment authentication attempts.
+            sig do
+              params(
+                purchase_amount: Integer,
+                purchase_amount_cardholder_estimated: T.nilable(Integer),
+                purchase_currency: String,
+                transaction_type:
+                  T.nilable(
+                    Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::OrSymbol
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The purchase amount in minor units.
+              purchase_amount:,
+              # The purchase amount in the cardholder's currency (i.e., USD) estimated using
+              # daily conversion rates from the card network.
+              purchase_amount_cardholder_estimated:,
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+              # authentication attempt's purchase currency.
+              purchase_currency:,
+              # The type of transaction being authenticated.
+              transaction_type:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  purchase_amount: Integer,
+                  purchase_amount_cardholder_estimated: T.nilable(Integer),
+                  purchase_currency: String,
+                  transaction_type:
+                    T.nilable(
+                      Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                    )
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The type of transaction being authenticated.
+            module TransactionType
+              extend Increase::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              # Purchase of goods or services.
+              GOODS_SERVICE_PURCHASE =
+                T.let(
+                  :goods_service_purchase,
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                )
+
+              # Check acceptance.
+              CHECK_ACCEPTANCE =
+                T.let(
+                  :check_acceptance,
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                )
+
+              # Account funding.
+              ACCOUNT_FUNDING =
+                T.let(
+                  :account_funding,
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                )
+
+              # Quasi-cash transaction.
+              QUASI_CASH_TRANSACTION =
+                T.let(
+                  :quasi_cash_transaction,
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                )
+
+              # Prepaid activation and load.
+              PREPAID_ACTIVATION_AND_LOAD =
+                T.let(
+                  :prepaid_activation_and_load,
+                  Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Increase::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+
         # The 3DS requestor authentication indicator describes why the authentication
         # attempt is performed, such as for a recurring transaction.
         module RequestorAuthenticationIndicator
@@ -1355,65 +1565,6 @@ module Increase
           def self.values
           end
         end
-
-        # The type of transaction being authenticated.
-        module TransactionType
-          extend Increase::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Increase::RealTimeDecision::CardAuthentication::TransactionType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          # Purchase of goods or services.
-          GOODS_SERVICE_PURCHASE =
-            T.let(
-              :goods_service_purchase,
-              Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-            )
-
-          # Check acceptance.
-          CHECK_ACCEPTANCE =
-            T.let(
-              :check_acceptance,
-              Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-            )
-
-          # Account funding.
-          ACCOUNT_FUNDING =
-            T.let(
-              :account_funding,
-              Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-            )
-
-          # Quasi-cash transaction.
-          QUASI_CASH_TRANSACTION =
-            T.let(
-              :quasi_cash_transaction,
-              Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-            )
-
-          # Prepaid activation and load.
-          PREPAID_ACTIVATION_AND_LOAD =
-            T.let(
-              :prepaid_activation_and_load,
-              Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
       end
 
       class CardAuthenticationChallenge < Increase::Internal::Type::BaseModel

data/rbi/increase/models.rbi

@@ -69,6 +69,11 @@ module Increase
 
   BalanceLookup = Increase::Models::BalanceLookup
 
+  BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
+
+  BeneficialOwnerRetrieveParams =
+    Increase::Models::BeneficialOwnerRetrieveParams
+
   BookkeepingAccount = Increase::Models::BookkeepingAccount
 
   BookkeepingAccountBalanceParams =
@@ -243,6 +248,8 @@ module Increase
 
   EntityArchiveParams = Increase::Models::EntityArchiveParams
 
+  EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
+
   EntityCreateBeneficialOwnerParams =
     Increase::Models::EntityCreateBeneficialOwnerParams
 

data/rbi/increase/resources/beneficial_owners.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class BeneficialOwners
+      # Retrieve a Beneficial Owner
+      sig do
+        params(
+          entity_beneficial_owner_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::EntityBeneficialOwner)
+      end
+      def retrieve(
+        # The identifier of the Beneficial Owner to retrieve.
+        entity_beneficial_owner_id,
+        request_options: {}
+      )
+      end
+
+      # List Beneficial Owners
+      sig do
+        params(
+          entity_id: String,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::EntityBeneficialOwner])
+      end
+      def list(
+        # 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
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/increase/client.rbs

@@ -83,6 +83,8 @@ module Increase
 
     attr_reader entities: Increase::Resources::Entities
 
+    attr_reader beneficial_owners: Increase::Resources::BeneficialOwners
+
     attr_reader supplemental_documents: Increase::Resources::SupplementalDocuments
 
     attr_reader programs: Increase::Resources::Programs