increase 1.363.0 → 1.365.0

data/rbi/increase/models/real_time_decision.rbi

@@ -7302,23 +7302,154 @@ module Increase
               )
             end
 
+          # Device type.
+          sig do
+            returns(
+              T.nilable(
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :device_type
+
           # ID assigned to the device by the digital wallet provider.
           sig { returns(T.nilable(String)) }
           attr_accessor :identifier
 
+          # IP address of the device.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :ip_address
+
+          # Name of the device, for example "My Work Phone".
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
           # Device that is being used to provision the digital wallet token.
           sig do
-            params(identifier: T.nilable(String)).returns(T.attached_class)
+            params(
+              device_type:
+                T.nilable(
+                  Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::OrSymbol
+                ),
+              identifier: T.nilable(String),
+              ip_address: T.nilable(String),
+              name: T.nilable(String)
+            ).returns(T.attached_class)
           end
           def self.new(
+            # Device type.
+            device_type:,
             # ID assigned to the device by the digital wallet provider.
-            identifier:
+            identifier:,
+            # IP address of the device.
+            ip_address:,
+            # Name of the device, for example "My Work Phone".
+            name:
           )
           end
 
-          sig { override.returns({ identifier: T.nilable(String) }) }
+          sig do
+            override.returns(
+              {
+                device_type:
+                  T.nilable(
+                    Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+                  ),
+                identifier: T.nilable(String),
+                ip_address: T.nilable(String),
+                name: T.nilable(String)
+              }
+            )
+          end
           def to_hash
           end
+
+          # Device type.
+          module DeviceType
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # Unknown
+            UNKNOWN =
+              T.let(
+                :unknown,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Mobile Phone
+            MOBILE_PHONE =
+              T.let(
+                :mobile_phone,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Tablet
+            TABLET =
+              T.let(
+                :tablet,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Watch
+            WATCH =
+              T.let(
+                :watch,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Mobile Phone or Tablet
+            MOBILEPHONE_OR_TABLET =
+              T.let(
+                :mobilephone_or_tablet,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # PC
+            PC =
+              T.let(
+                :pc,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Household Device
+            HOUSEHOLD_DEVICE =
+              T.let(
+                :household_device,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Wearable Device
+            WEARABLE_DEVICE =
+              T.let(
+                :wearable_device,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            # Automobile Device
+            AUTOMOBILE_DEVICE =
+              T.let(
+                :automobile_device,
+                Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         # The digital wallet app being used.

data/rbi/increase/models/simulations/checkbook_mail_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class CheckbookMailParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::CheckbookMailParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Checkbook you wish to mail.
+        sig { returns(String) }
+        attr_accessor :checkbook_id
+
+        sig do
+          params(
+            checkbook_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Checkbook you wish to mail.
+          checkbook_id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { checkbook_id: String, request_options: Increase::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/transaction.rbi

@@ -8070,6 +8070,13 @@ module Increase
                     Increase::Transaction::Source::CardRefund::PurchaseDetails::Fleet::FuelType::TaggedSymbol
                   )
 
+                # Diesel 1 off-road non-taxable
+                DIESEL_1_OFF_ROAD_NON_TAXABLE =
+                  T.let(
+                    :diesel_1_off_road_non_taxable,
+                    Increase::Transaction::Source::CardRefund::PurchaseDetails::Fleet::FuelType::TaggedSymbol
+                  )
+
                 # Renewable diesel R95 or greater off-road non-taxable
                 RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
                   T.let(
@@ -12159,6 +12166,13 @@ module Increase
                     Increase::Transaction::Source::CardSettlement::PurchaseDetails::Fleet::FuelType::TaggedSymbol
                   )
 
+                # Diesel 1 off-road non-taxable
+                DIESEL_1_OFF_ROAD_NON_TAXABLE =
+                  T.let(
+                    :diesel_1_off_road_non_taxable,
+                    Increase::Transaction::Source::CardSettlement::PurchaseDetails::Fleet::FuelType::TaggedSymbol
+                  )
+
                 # Renewable diesel R95 or greater off-road non-taxable
                 RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
                   T.let(
@@ -14713,6 +14727,10 @@ module Increase
           sig { returns(T.nilable(String)) }
           attr_accessor :bank_of_first_deposit_routing_number
 
+          # The identifier of the Checkbook Check object that was deposited.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :checkbook_check_id
+
           # When the check was deposited.
           sig { returns(Time) }
           attr_accessor :deposited_at
@@ -14752,6 +14770,7 @@ module Increase
             params(
               back_image_file_id: T.nilable(String),
               bank_of_first_deposit_routing_number: T.nilable(String),
+              checkbook_check_id: T.nilable(String),
               deposited_at: Time,
               front_image_file_id: T.nilable(String),
               inbound_check_deposit_id: T.nilable(String),
@@ -14769,6 +14788,8 @@ module Increase
             # bank depositing this check. In some rare cases, this is not transmitted via
             # Check 21 and the value will be null.
             bank_of_first_deposit_routing_number:,
+            # The identifier of the Checkbook Check object that was deposited.
+            checkbook_check_id:,
             # When the check was deposited.
             deposited_at:,
             # The identifier of the API File object containing an image of the front of the
@@ -14792,6 +14813,7 @@ module Increase
               {
                 back_image_file_id: T.nilable(String),
                 bank_of_first_deposit_routing_number: T.nilable(String),
+                checkbook_check_id: T.nilable(String),
                 deposited_at: Time,
                 front_image_file_id: T.nilable(String),
                 inbound_check_deposit_id: T.nilable(String),
@@ -15680,6 +15702,10 @@ module Increase
               )
             end
 
+          # The identifier of the Checkbook Check object that was deposited.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :checkbook_check_id
+
           # The ID of the Inbound Check Deposit that is being returned.
           sig { returns(String) }
           attr_accessor :inbound_check_deposit_id
@@ -15695,11 +15721,14 @@ module Increase
           # requests that it be returned.
           sig do
             params(
+              checkbook_check_id: T.nilable(String),
               inbound_check_deposit_id: String,
               transfer_id: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
+            # The identifier of the Checkbook Check object that was deposited.
+            checkbook_check_id:,
             # The ID of the Inbound Check Deposit that is being returned.
             inbound_check_deposit_id:,
             # The identifier of the Check Transfer object that was deposited.
@@ -15710,6 +15739,7 @@ module Increase
           sig do
             override.returns(
               {
+                checkbook_check_id: T.nilable(String),
                 inbound_check_deposit_id: String,
                 transfer_id: T.nilable(String)
               }

data/rbi/increase/models.rbi

@@ -166,6 +166,24 @@ module Increase
 
   CardValidationRetrieveParams = Increase::Models::CardValidationRetrieveParams
 
+  Checkbook = Increase::Models::Checkbook
+
+  CheckbookCheck = Increase::Models::CheckbookCheck
+
+  CheckbookCheckListParams = Increase::Models::CheckbookCheckListParams
+
+  CheckbookCheckRetrieveParams = Increase::Models::CheckbookCheckRetrieveParams
+
+  CheckbookCheckStopParams = Increase::Models::CheckbookCheckStopParams
+
+  CheckbookCreateParams = Increase::Models::CheckbookCreateParams
+
+  CheckbookListParams = Increase::Models::CheckbookListParams
+
+  CheckbookRetrieveParams = Increase::Models::CheckbookRetrieveParams
+
+  CheckbookStopParams = Increase::Models::CheckbookStopParams
+
   CheckDeposit = Increase::Models::CheckDeposit
 
   CheckDepositCreateParams = Increase::Models::CheckDepositCreateParams

data/rbi/increase/resources/account_numbers.rbi

@@ -8,9 +8,10 @@ module Increase
         params(
           account_id: String,
           name: String,
-          inbound_ach: Increase::AccountNumberCreateParams::InboundACH::OrHash,
-          inbound_checks:
-            Increase::AccountNumberCreateParams::InboundChecks::OrHash,
+          inbound_ach_debits:
+            Increase::AccountNumberCreateParams::InboundACHDebits::OrSymbol,
+          unregistered_inbound_checks:
+            Increase::AccountNumberCreateParams::UnregisteredInboundChecks::OrSymbol,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::AccountNumber)
       end
@@ -19,11 +20,13 @@ module Increase
         account_id:,
         # The name you choose for the Account Number.
         name:,
-        # Options related to how this Account Number should handle inbound ACH transfers.
-        inbound_ach: nil,
-        # Options related to how this Account Number should handle inbound check
-        # withdrawals.
-        inbound_checks: nil,
+        # Whether inbound ACH debits are allowed against this Account Number. Note that
+        # ACH debits will be declined if this is `allowed` but the Account Number is not
+        # active. If you do not specify this field, the default is `allowed`.
+        inbound_ach_debits: nil,
+        # Whether unregistered inbound checks for this Account Number can be deposited. If
+        # you do not specify this field, the default is `blocked`.
+        unregistered_inbound_checks: nil,
         request_options: {}
       )
       end
@@ -46,26 +49,28 @@ module Increase
       sig do
         params(
           account_number_id: String,
-          inbound_ach: Increase::AccountNumberUpdateParams::InboundACH::OrHash,
-          inbound_checks:
-            Increase::AccountNumberUpdateParams::InboundChecks::OrHash,
+          inbound_ach_debits:
+            Increase::AccountNumberUpdateParams::InboundACHDebits::OrSymbol,
           name: String,
           status: Increase::AccountNumberUpdateParams::Status::OrSymbol,
+          unregistered_inbound_checks:
+            Increase::AccountNumberUpdateParams::UnregisteredInboundChecks::OrSymbol,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::AccountNumber)
       end
       def update(
         # The identifier of the Account Number.
         account_number_id,
-        # Options related to how this Account Number handles inbound ACH transfers.
-        inbound_ach: nil,
-        # Options related to how this Account Number should handle inbound check
-        # withdrawals.
-        inbound_checks: nil,
+        # Whether inbound ACH debits are allowed against this Account Number. Note that
+        # ACH debits will be declined if this is `allowed` but the Account Number is not
+        # active.
+        inbound_ach_debits: nil,
         # The name you choose for the Account Number.
         name: nil,
         # This indicates if transfers can be made to the Account Number.
         status: nil,
+        # Whether unregistered inbound checks for this Account Number can be deposited.
+        unregistered_inbound_checks: nil,
         request_options: {}
       )
       end
@@ -74,11 +79,11 @@ module Increase
       sig do
         params(
           account_id: String,
-          ach_debit_status:
-            Increase::AccountNumberListParams::ACHDebitStatus::OrHash,
           created_at: Increase::AccountNumberListParams::CreatedAt::OrHash,
           cursor: String,
           idempotency_key: String,
+          inbound_ach_debits:
+            Increase::AccountNumberListParams::InboundACHDebits::OrHash,
           limit: Integer,
           status: Increase::AccountNumberListParams::Status::OrHash,
           request_options: Increase::RequestOptions::OrHash
@@ -87,7 +92,6 @@ module Increase
       def list(
         # Filter Account Numbers to those belonging to the specified Account.
         account_id: nil,
-        ach_debit_status: nil,
         created_at: nil,
         # Return the page of entries after this one.
         cursor: nil,
@@ -96,6 +100,7 @@ module Increase
         # request is only processed once. Learn more about
         # [idempotency](https://increase.com/documentation/idempotency-keys).
         idempotency_key: nil,
+        inbound_ach_debits: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
         #

data/rbi/increase/resources/ach_transfers.rbi

@@ -13,19 +13,18 @@ module Increase
         params(
           account_id: String,
           amount: Integer,
-          statement_descriptor: String,
+          company_name: String,
+          individual_name: String,
           account_number: String,
           addenda: Increase::ACHTransferCreateParams::Addenda::OrHash,
           company_descriptive_date: String,
           company_discretionary_data: String,
           company_entry_description: String,
-          company_name: String,
           destination_account_holder:
             Increase::ACHTransferCreateParams::DestinationAccountHolder::OrSymbol,
           external_account_id: String,
           funding: Increase::ACHTransferCreateParams::Funding::OrSymbol,
           individual_id: String,
-          individual_name: String,
           preferred_effective_date:
             Increase::ACHTransferCreateParams::PreferredEffectiveDate::OrHash,
           require_approval: T::Boolean,
@@ -47,13 +46,18 @@ module Increase
         # into Increase. Debit transfers
         # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
         amount:,
-        # A description you choose to give the transfer. This will be saved with the
-        # transfer details, displayed in the dashboard, and returned by the API. If
-        # `individual_name` and `company_name` are not explicitly set by this API, the
-        # `statement_descriptor` will be sent in those fields to the receiving bank to
-        # help the customer recognize the transfer. You are highly encouraged to pass
-        # `individual_name` and `company_name` instead of relying on this fallback.
-        statement_descriptor:,
+        # The name by which the recipient knows the counterparty of this transaction. If
+        # you're processing payments on behalf of another party, use their name, not your
+        # own, so that it's more likely the recipient understands the context of the
+        # payment. This value is usually displayed to the recipient on their bank
+        # statement. We recommend setting this on every transfer; if you do not, we fall
+        # back to the `statement_descriptor`.
+        company_name:,
+        # The name of the transfer recipient. This value is informational and generally
+        # not verified by the recipient's bank. This value is usually displayed to the
+        # recipient on their bank statement. We recommend setting this on every transfer;
+        # if you do not, we fall back to the `statement_descriptor`.
+        individual_name:,
         # The receiver's account number. For credit transfers (transfers with a positive
         # `amount`), this is the account that funds will be sent to. For debit transfers
         # (transfers with a negative `amount`), this is the account that funds will be
@@ -80,13 +84,6 @@ module Increase
         # code and use case. For example, some use cases require constants like
         # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
         company_entry_description: nil,
-        # The name by which the recipient knows the counterparty of this transaction. If
-        # you're processing payments on behalf of another party, use their name, not your
-        # own, so that it's more likely the recipient understands the context of the
-        # payment. This value is usually displayed to the recipient on their bank
-        # statement. We recommend setting this on every transfer; if you do not, we fall
-        # back to the `statement_descriptor`.
-        company_name: nil,
         # The type of entity that owns the receiver's account.
         destination_account_holder: nil,
         # The ID of an External Account to initiate a transfer to. If this parameter is
@@ -101,11 +98,6 @@ module Increase
         # unset. For the specific case of person-to-person credits with the WEB standard
         # entry class code, this must include the name of the payer.
         individual_id: nil,
-        # The name of the transfer recipient. This value is informational and generally
-        # not verified by the recipient's bank. This value is usually displayed to the
-        # recipient on their bank statement. We recommend setting this on every transfer;
-        # if you do not, we fall back to the `statement_descriptor`.
-        individual_name: nil,
         # Configuration for how the effective date of the transfer will be set. This
         # determines same-day vs future-dated settlement timing. If not set, defaults to a
         # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes

data/rbi/increase/resources/cards.rbi

@@ -23,7 +23,9 @@ module Increase
         account_id:,
         # Controls that restrict how this card can be used.
         authorization_controls: nil,
-        # The card's billing address.
+        # The card's billing address. This is used in card authorizations to
+        # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+        # If not provided, the address associated with the account's entity will be used.
         billing_address: nil,
         # The name of the cardholder. Used to respond to Account Name Inquiry requests
         # from acquirers in Card Validations.
@@ -79,7 +81,9 @@ module Increase
         card_id,
         # Controls that restrict how this card can be used.
         authorization_controls: nil,
-        # The card's updated billing address.
+        # The card's billing address. This is used in card authorizations to
+        # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+        # If not provided, the address associated with the account's entity will be used.
         billing_address: nil,
         # The description you choose to give the card.
         description: nil,

data/rbi/increase/resources/checkbook_checks.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class CheckbookChecks
+      # Retrieve a Checkbook Check
+      sig do
+        params(
+          checkbook_check_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CheckbookCheck)
+      end
+      def retrieve(
+        # The identifier of the Checkbook Check.
+        checkbook_check_id,
+        request_options: {}
+      )
+      end
+
+      # List Checkbook Checks
+      sig do
+        params(
+          account_number_id: String,
+          check_number: Integer,
+          checkbook_id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::CheckbookCheck])
+      end
+      def list(
+        # Filter Checkbook Checks to those drawn on the specified Account Number.
+        account_number_id: nil,
+        # Filter Checkbook Checks to the one with the specified check number.
+        check_number: nil,
+        # Filter Checkbook Checks to those belonging to the specified Checkbook.
+        checkbook_id: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        #
+        # Defaults to `100`.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Stop a Checkbook Check. A stopped check cannot be deposited.
+      sig do
+        params(
+          checkbook_check_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CheckbookCheck)
+      end
+      def stop(
+        # The identifier of the Checkbook Check to stop.
+        checkbook_check_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/checkbooks.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Checkbooks
+      # Create a Checkbook
+      sig do
+        params(
+          account_number_id: String,
+          mailing_address:
+            Increase::CheckbookCreateParams::MailingAddress::OrHash,
+          payer: T::Array[Increase::CheckbookCreateParams::Payer::OrHash],
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Checkbook)
+      end
+      def create(
+        # The identifier of the Account Number that the checks will draw from. The Account
+        # Number must be active.
+        account_number_id:,
+        # The destination address that the Checkbook will be mailed to.
+        mailing_address:,
+        # The payer of the checks. This will be printed on the top-left corner of each
+        # check. This should be an array of up to 4 elements, each of which represents a
+        # line of the payer.
+        payer:,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Checkbook
+      sig do
+        params(
+          checkbook_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Checkbook)
+      end
+      def retrieve(
+        # The identifier of the Checkbook.
+        checkbook_id,
+        request_options: {}
+      )
+      end
+
+      # List Checkbooks
+      sig do
+        params(
+          account_number_id: String,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::CheckbookListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::Checkbook])
+      end
+      def list(
+        # Filter Checkbooks to those attached to the specified Account Number.
+        account_number_id: nil,
+        # 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.
+        #
+        # Defaults to `100`.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Stop a Checkbook. Stopping a Checkbook stops all of its checks that have not yet
+      # been deposited.
+      sig do
+        params(
+          checkbook_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Checkbook)
+      end
+      def stop(
+        # The identifier of the Checkbook to stop.
+        checkbook_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end