increase 1.254.0 → 1.256.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1636bd0aa7c9344a6c92012b0ff9165a3c8dc5481d18005bf4d1809c7c83e984
-  data.tar.gz: fdf74a2a3a704098357f9ff36697596e85216cc5d76beeb3d4f537916faa813b
+  metadata.gz: ad61ffa708cc356497acc0d0a9cae7721245e62553ffd4df80f25fa966e75317
+  data.tar.gz: ca76dd5b991285b0a21f821b77a90604c7039cbc9cc064b74d94581d035cd077
 SHA512:
-  metadata.gz: adfa9359b3f0fc998e2cd6bb747c485c886d56ef89a7cca991c664df49d6265385fe6518c5f6ebf3c07fbdaf93a4799a9e5763d5190c523078c219993b2483c4
-  data.tar.gz: b516fde382a7a7a1001d68c72305d0c867085079ece74e4778d0ee659e0a83c1f11b402b6dd3de036752b4b06134db0b210da98792a4502dd1b618ae2163c750
+  metadata.gz: 27498b24a428c88e91771be7f1c0fb5b29b57411210b75a0b6f487578e6fe9cd2493fe1d77b26154b4ba3dbb0870bb0ed9eea631058bd0383ea43a0107ff1dde
+  data.tar.gz: 76d960e6e27ad1208773e05bb88f88bd68a0b64858ad1d34c59be888ea86ca64a95165d51420ba03e756d54cbe3c0e7f660c171893c6cac9e8d76aaf9b03aeb7

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.256.0 (2026-03-16)
+
+Full Changelog: [v1.255.0...v1.256.0](https://github.com/Increase/increase-ruby/compare/v1.255.0...v1.256.0)
+
+### Features
+
+* **api:** api update ([bdfa9c5](https://github.com/Increase/increase-ruby/commit/bdfa9c5ba103eab87eca3e207beb057765766053))
+
+## 1.255.0 (2026-03-13)
+
+Full Changelog: [v1.254.0...v1.255.0](https://github.com/Increase/increase-ruby/compare/v1.254.0...v1.255.0)
+
+### Features
+
+* **api:** api update ([fb7738c](https://github.com/Increase/increase-ruby/commit/fb7738cf952c59634ae2c60442d3b0060d8c23b8))
+
 ## 1.254.0 (2026-03-13)
 
 Full Changelog: [v1.253.0...v1.254.0](https://github.com/Increase/increase-ruby/compare/v1.253.0...v1.254.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.254.0"
+gem "increase", "~> 1.256.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/card_push_transfer.rb

@@ -136,6 +136,12 @@ module Increase
       #   @return [String]
       required :recipient_name, String
 
+      # @!attribute route
+      #   The card network route used for the transfer.
+      #
+      #   @return [Symbol, Increase::Models::CardPushTransfer::Route]
+      required :route, enum: -> { Increase::CardPushTransfer::Route }
+
       # @!attribute sender_address_city
       #   The city of the sender.
       #
@@ -192,7 +198,7 @@ module Increase
       #   @return [Symbol, Increase::Models::CardPushTransfer::Type]
       required :type, enum: -> { Increase::CardPushTransfer::Type }
 
-      # @!method initialize(id:, acceptance:, account_id:, approval:, business_application_identifier:, cancellation:, card_token_id:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, status:, submission:, type:)
+      # @!method initialize(id:, acceptance:, account_id:, approval:, business_application_identifier:, cancellation:, card_token_id:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, route:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, status:, submission:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CardPushTransfer} for more details.
       #
@@ -236,6 +242,8 @@ module Increase
       #
       #   @param recipient_name [String] The name of the funds recipient.
       #
+      #   @param route [Symbol, Increase::Models::CardPushTransfer::Route] The card network route used for the transfer.
+      #
       #   @param sender_address_city [String] The city of the sender.
       #
       #   @param sender_address_line1 [String] The address line 1 of the sender.
@@ -1226,6 +1234,22 @@ module Increase
         end
       end
 
+      # The card network route used for the transfer.
+      #
+      # @see Increase::Models::CardPushTransfer#route
+      module Route
+        extend Increase::Internal::Type::Enum
+
+        # Visa and Interlink
+        VISA = :visa
+
+        # Mastercard and Maestro
+        MASTERCARD = :mastercard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The lifecycle status of the transfer.
       #
       # @see Increase::Models::CardPushTransfer#status

data/lib/increase/models/card_validation.rb

@@ -119,6 +119,12 @@ module Increase
       #   @return [String]
       required :merchant_state, String
 
+      # @!attribute route
+      #   The card network route used for the validation.
+      #
+      #   @return [Symbol, Increase::Models::CardValidation::Route]
+      required :route, enum: -> { Increase::CardValidation::Route }
+
       # @!attribute status
       #   The lifecycle status of the validation.
       #
@@ -139,7 +145,7 @@ module Increase
       #   @return [Symbol, Increase::Models::CardValidation::Type]
       required :type, enum: -> { Increase::CardValidation::Type }
 
-      # @!method initialize(id:, acceptance:, account_id:, card_token_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, status:, submission:, type:)
+      # @!method initialize(id:, acceptance:, account_id:, card_token_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, route:, status:, submission:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CardValidation} for more details.
       #
@@ -182,6 +188,8 @@ module Increase
       #
       #   @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
       #
+      #   @param route [Symbol, Increase::Models::CardValidation::Route] The card network route used for the validation.
+      #
       #   @param status [Symbol, Increase::Models::CardValidation::Status] The lifecycle status of the validation.
       #
       #   @param submission [Increase::Models::CardValidation::Submission, nil] After the validation is submitted to the card network, this will contain supplem
@@ -688,6 +696,22 @@ module Increase
         end
       end
 
+      # The card network route used for the validation.
+      #
+      # @see Increase::Models::CardValidation#route
+      module Route
+        extend Increase::Internal::Type::Enum
+
+        # Visa and Interlink
+        VISA = :visa
+
+        # Mastercard and Maestro
+        MASTERCARD = :mastercard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The lifecycle status of the validation.
       #
       # @see Increase::Models::CardValidation#status

data/lib/increase/models/entity.rb

@@ -121,12 +121,19 @@ module Increase
       #   @return [Symbol, Increase::Models::Entity::Type]
       required :type, enum: -> { Increase::Entity::Type }
 
-      # @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:)
+      # @!attribute validation
+      #   The validation results for the entity.
+      #
+      #   @return [Increase::Models::Entity::Validation, nil]
+      required :validation, -> { Increase::Entity::Validation }, nil?: true
+
+      # @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
       #   Some parameter documentations has been truncated, see {Increase::Models::Entity}
       #   for more details.
       #
       #   Entities are the legal entities that own accounts. They can be people,
-      #   corporations, partnerships, government authorities, or trusts.
+      #   corporations, partnerships, government authorities, or trusts. To learn more,
+      #   see [Entities](/documentation/entities).
       #
       #   @param id [String] The entity's identifier.
       #
@@ -161,6 +168,8 @@ module Increase
       #   @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`.
       #
       #   @param type [Symbol, Increase::Models::Entity::Type] A constant representing the object's type. For this resource it will always be `
+      #
+      #   @param validation [Increase::Models::Entity::Validation, nil] The validation results for the entity.
 
       # @see Increase::Models::Entity#corporation
       class Corporation < Increase::Internal::Type::BaseModel
@@ -1586,6 +1595,210 @@ module Increase
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see Increase::Models::Entity#validation
+      class Validation < Increase::Internal::Type::BaseModel
+        # @!attribute issues
+        #   The list of issues that need to be addressed.
+        #
+        #   @return [Array<Increase::Models::Entity::Validation::Issue>]
+        required :issues, -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Validation::Issue] }
+
+        # @!attribute status
+        #   The validation status for the entity. If the status is `invalid`, the `issues`
+        #   array will be populated.
+        #
+        #   @return [Symbol, Increase::Models::Entity::Validation::Status]
+        required :status, enum: -> { Increase::Entity::Validation::Status }
+
+        # @!method initialize(issues:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Entity::Validation} for more details.
+        #
+        #   The validation results for the entity.
+        #
+        #   @param issues [Array<Increase::Models::Entity::Validation::Issue>] The list of issues that need to be addressed.
+        #
+        #   @param status [Symbol, Increase::Models::Entity::Validation::Status] The validation status for the entity. If the status is `invalid`, the `issues` a
+
+        class Issue < Increase::Internal::Type::BaseModel
+          # @!attribute beneficial_owner_address
+          #   Details when the issue is with a beneficial owner's address.
+          #
+          #   @return [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil]
+          required :beneficial_owner_address,
+                   -> { Increase::Entity::Validation::Issue::BeneficialOwnerAddress },
+                   nil?: true
+
+          # @!attribute beneficial_owner_identity
+          #   Details when the issue is with a beneficial owner's identity verification.
+          #
+          #   @return [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil]
+          required :beneficial_owner_identity,
+                   -> { Increase::Entity::Validation::Issue::BeneficialOwnerIdentity },
+                   nil?: true
+
+          # @!attribute category
+          #   The type of issue. We may add additional possible values for this enum over
+          #   time; your application should be able to handle such additions gracefully.
+          #
+          #   @return [Symbol, Increase::Models::Entity::Validation::Issue::Category]
+          required :category, enum: -> { Increase::Entity::Validation::Issue::Category }
+
+          # @!attribute entity_address
+          #   Details when the issue is with the entity's address.
+          #
+          #   @return [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
+          required :entity_address, -> { Increase::Entity::Validation::Issue::EntityAddress }, nil?: true
+
+          # @!attribute entity_tax_identifier
+          #   Details when the issue is with the entity's tax ID.
+          #
+          #   @return [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
+          required :entity_tax_identifier,
+                   -> { Increase::Entity::Validation::Issue::EntityTaxIdentifier },
+                   nil?: true
+
+          # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_tax_identifier:)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::Entity::Validation::Issue} for more details.
+          #
+          #   @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil] Details when the issue is with a beneficial owner's address.
+          #
+          #   @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil] Details when the issue is with a beneficial owner's identity verification.
+          #
+          #   @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category] The type of issue. We may add additional possible values for this enum over time
+          #
+          #   @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil] Details when the issue is with the entity's address.
+          #
+          #   @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil] Details when the issue is with the entity's tax ID.
+
+          # @see Increase::Models::Entity::Validation::Issue#beneficial_owner_address
+          class BeneficialOwnerAddress < Increase::Internal::Type::BaseModel
+            # @!attribute beneficial_owner_id
+            #   The ID of the beneficial owner.
+            #
+            #   @return [String]
+            required :beneficial_owner_id, String
+
+            # @!attribute reason
+            #   The reason the address is invalid.
+            #
+            #   @return [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason]
+            required :reason, enum: -> { Increase::Entity::Validation::Issue::BeneficialOwnerAddress::Reason }
+
+            # @!method initialize(beneficial_owner_id:, reason:)
+            #   Details when the issue is with a beneficial owner's address.
+            #
+            #   @param beneficial_owner_id [String] The ID of the beneficial owner.
+            #
+            #   @param reason [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason] The reason the address is invalid.
+
+            # The reason the address is invalid.
+            #
+            # @see Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress#reason
+            module Reason
+              extend Increase::Internal::Type::Enum
+
+              # The address is a mailbox or other non-physical address.
+              MAILBOX_ADDRESS = :mailbox_address
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see Increase::Models::Entity::Validation::Issue#beneficial_owner_identity
+          class BeneficialOwnerIdentity < Increase::Internal::Type::BaseModel
+            # @!attribute beneficial_owner_id
+            #   The ID of the beneficial owner.
+            #
+            #   @return [String]
+            required :beneficial_owner_id, String
+
+            # @!method initialize(beneficial_owner_id:)
+            #   Details when the issue is with a beneficial owner's identity verification.
+            #
+            #   @param beneficial_owner_id [String] The ID of the beneficial owner.
+          end
+
+          # The type of issue. We may add additional possible values for this enum over
+          # time; your application should be able to handle such additions gracefully.
+          #
+          # @see Increase::Models::Entity::Validation::Issue#category
+          module Category
+            extend Increase::Internal::Type::Enum
+
+            # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.tax_identifier).
+            ENTITY_TAX_IDENTIFIER = :entity_tax_identifier
+
+            # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
+            ENTITY_ADDRESS = :entity_address
+
+            # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
+            BENEFICIAL_OWNER_IDENTITY = :beneficial_owner_identity
+
+            # A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
+            BENEFICIAL_OWNER_ADDRESS = :beneficial_owner_address
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Increase::Models::Entity::Validation::Issue#entity_address
+          class EntityAddress < Increase::Internal::Type::BaseModel
+            # @!attribute reason
+            #   The reason the address is invalid.
+            #
+            #   @return [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason]
+            required :reason, enum: -> { Increase::Entity::Validation::Issue::EntityAddress::Reason }
+
+            # @!method initialize(reason:)
+            #   Details when the issue is with the entity's address.
+            #
+            #   @param reason [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason] The reason the address is invalid.
+
+            # The reason the address is invalid.
+            #
+            # @see Increase::Models::Entity::Validation::Issue::EntityAddress#reason
+            module Reason
+              extend Increase::Internal::Type::Enum
+
+              # The address is a mailbox or other non-physical address.
+              MAILBOX_ADDRESS = :mailbox_address
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see Increase::Models::Entity::Validation::Issue#entity_tax_identifier
+          class EntityTaxIdentifier < Increase::Internal::Type::BaseModel
+            # @!method initialize
+            #   Details when the issue is with the entity's tax ID.
+          end
+        end
+
+        # The validation status for the entity. If the status is `invalid`, the `issues`
+        # array will be populated.
+        #
+        # @see Increase::Models::Entity::Validation#status
+        module Status
+          extend Increase::Internal::Type::Enum
+
+          # The submitted data is being validated.
+          PENDING = :pending
+
+          # The submitted data is valid.
+          VALID = :valid
+
+          # Additional information is required to validate the data.
+          INVALID = :invalid
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/increase/version.rb

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

data/rbi/increase/models/card_push_transfer.rbi

@@ -149,6 +149,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :recipient_name
 
+      # The card network route used for the transfer.
+      sig { returns(Increase::CardPushTransfer::Route::TaggedSymbol) }
+      attr_accessor :route
+
       # The city of the sender.
       sig { returns(String) }
       attr_accessor :sender_address_city
@@ -219,6 +223,7 @@ module Increase
           presentment_amount:
             Increase::CardPushTransfer::PresentmentAmount::OrHash,
           recipient_name: String,
+          route: Increase::CardPushTransfer::Route::OrSymbol,
           sender_address_city: String,
           sender_address_line1: String,
           sender_address_postal_code: String,
@@ -286,6 +291,8 @@ module Increase
         presentment_amount:,
         # The name of the funds recipient.
         recipient_name:,
+        # The card network route used for the transfer.
+        route:,
         # The city of the sender.
         sender_address_city:,
         # The address line 1 of the sender.
@@ -332,6 +339,7 @@ module Increase
             merchant_state: String,
             presentment_amount: Increase::CardPushTransfer::PresentmentAmount,
             recipient_name: String,
+            route: Increase::CardPushTransfer::Route::TaggedSymbol,
             sender_address_city: String,
             sender_address_line1: String,
             sender_address_postal_code: String,
@@ -2475,6 +2483,30 @@ module Increase
         end
       end
 
+      # The card network route used for the transfer.
+      module Route
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::CardPushTransfer::Route) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # Visa and Interlink
+        VISA = T.let(:visa, Increase::CardPushTransfer::Route::TaggedSymbol)
+
+        # Mastercard and Maestro
+        MASTERCARD =
+          T.let(:mastercard, Increase::CardPushTransfer::Route::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::CardPushTransfer::Route::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The lifecycle status of the transfer.
       module Status
         extend Increase::Internal::Type::Enum

data/rbi/increase/models/card_validation.rbi

@@ -108,6 +108,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :merchant_state
 
+      # The card network route used for the validation.
+      sig { returns(Increase::CardValidation::Route::TaggedSymbol) }
+      attr_accessor :route
+
       # The lifecycle status of the validation.
       sig { returns(Increase::CardValidation::Status::TaggedSymbol) }
       attr_accessor :status
@@ -151,6 +155,7 @@ module Increase
           merchant_name: String,
           merchant_postal_code: String,
           merchant_state: String,
+          route: Increase::CardValidation::Route::OrSymbol,
           status: Increase::CardValidation::Status::OrSymbol,
           submission: T.nilable(Increase::CardValidation::Submission::OrHash),
           type: Increase::CardValidation::Type::OrSymbol
@@ -200,6 +205,8 @@ module Increase
         merchant_postal_code:,
         # The U.S. state where the merchant (typically your business) is located.
         merchant_state:,
+        # The card network route used for the validation.
+        route:,
         # The lifecycle status of the validation.
         status:,
         # After the validation is submitted to the card network, this will contain
@@ -232,6 +239,7 @@ module Increase
             merchant_name: String,
             merchant_postal_code: String,
             merchant_state: String,
+            route: Increase::CardValidation::Route::TaggedSymbol,
             status: Increase::CardValidation::Status::TaggedSymbol,
             submission: T.nilable(Increase::CardValidation::Submission),
             type: Increase::CardValidation::Type::TaggedSymbol
@@ -1319,6 +1327,30 @@ module Increase
         end
       end
 
+      # The card network route used for the validation.
+      module Route
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::CardValidation::Route) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # Visa and Interlink
+        VISA = T.let(:visa, Increase::CardValidation::Route::TaggedSymbol)
+
+        # Mastercard and Maestro
+        MASTERCARD =
+          T.let(:mastercard, Increase::CardValidation::Route::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::CardValidation::Route::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The lifecycle status of the validation.
       module Status
         extend Increase::Internal::Type::Enum