increase 1.362.0 → 1.364.0

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

data/rbi/increase/resources/entities.rbi

@@ -8,12 +8,10 @@ module Increase
         params(
           structure: Increase::EntityCreateParams::Structure::OrSymbol,
           corporation: Increase::EntityCreateParams::Corporation::OrHash,
-          description: String,
           government_authority:
             Increase::EntityCreateParams::GovernmentAuthority::OrHash,
           joint: Increase::EntityCreateParams::Joint::OrHash,
           natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
-          risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
           sole_proprietorship:
             Increase::EntityCreateParams::SoleProprietorship::OrHash,
           supplemental_documents:
@@ -34,8 +32,6 @@ module Increase
         # Details of the corporation entity to create. Required if `structure` is equal to
         # `corporation`.
         corporation: nil,
-        # The description you choose to give the entity.
-        description: nil,
         # Details of the Government Authority entity to create. Required if `structure` is
         # equal to `government_authority`.
         government_authority: nil,
@@ -47,9 +43,6 @@ module Increase
         # `social_security_number` or `individual_taxpayer_identification_number`
         # identification methods.
         natural_person: nil,
-        # An assessment of the entity's potential risk of involvement in financial crimes,
-        # such as money laundering.
-        risk_rating: nil,
         # Details of the sole proprietorship entity to create. Required if `structure` is
         # equal to `sole_proprietorship`.
         sole_proprietorship: nil,
@@ -92,7 +85,6 @@ module Increase
           government_authority:
             Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
           natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
-          risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
           sole_proprietorship:
             Increase::EntityUpdateParams::SoleProprietorship::OrHash,
           terms_agreements:
@@ -119,9 +111,6 @@ module Increase
         # Details of the natural person entity to update. If you specify this parameter
         # and the entity is not a natural person, the request will fail.
         natural_person: nil,
-        # An assessment of the entity’s potential risk of involvement in financial crimes,
-        # such as money laundering.
-        risk_rating: nil,
         # Details of the sole proprietorship entity to update. If you specify this
         # parameter and the entity is not a sole proprietorship, the request will fail.
         sole_proprietorship: nil,

data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi

@@ -50,6 +50,25 @@ module Increase
       )
       end
 
+      # Return an Inbound Real-Time Payments Transfer
+      sig do
+        params(
+          inbound_real_time_payments_transfer_id: String,
+          amount: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsTransfer)
+      end
+      def return_(
+        # The identifier of the Inbound Real-Time Payments Transfer to return to its
+        # sender.
+        inbound_real_time_payments_transfer_id,
+        # The amount to return, in USD cents. Defaults to the full amount of the Inbound
+        # Real-Time Payments Transfer, and can't be higher than it.
+        amount: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Increase::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/increase/resources/simulations/checkbooks.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class Checkbooks
+        # Simulates the mailing of a [Checkbook](#checkbooks), which happens periodically
+        # throughout the day in production but can be sped up in sandbox. This Checkbook
+        # must have a `status` of `pending_submission` or `pending_mailing`.
+        sig do
+          params(
+            checkbook_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::Checkbook)
+        end
+        def mail(
+          # The identifier of the Checkbook you wish to mail.
+          checkbook_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations.rbi

@@ -78,6 +78,9 @@ module Increase
       sig { returns(Increase::Resources::Simulations::CheckTransfers) }
       attr_reader :check_transfers
 
+      sig { returns(Increase::Resources::Simulations::Checkbooks) }
+      attr_reader :checkbooks
+
       sig { returns(Increase::Resources::Simulations::InboundCheckDeposits) }
       attr_reader :inbound_check_deposits
 

data/sig/increase/client.rbs

@@ -63,6 +63,10 @@ module Increase
 
     attr_reader check_transfers: Increase::Resources::CheckTransfers
 
+    attr_reader checkbooks: Increase::Resources::Checkbooks
+
+    attr_reader checkbook_checks: Increase::Resources::CheckbookChecks
+
     attr_reader inbound_check_deposits: Increase::Resources::InboundCheckDeposits
 
     attr_reader real_time_payments_transfers: Increase::Resources::RealTimePaymentsTransfers
@@ -115,14 +119,6 @@ module Increase
 
     attr_reader real_time_decisions: Increase::Resources::RealTimeDecisions
 
-    attr_reader groups: Increase::Resources::Groups
-
-    attr_reader oauth_applications: Increase::Resources::OAuthApplications
-
-    attr_reader oauth_connections: Increase::Resources::OAuthConnections
-
-    attr_reader oauth_tokens: Increase::Resources::OAuthTokens
-
     attr_reader intrafi_account_enrollments: Increase::Resources::IntrafiAccountEnrollments
 
     attr_reader intrafi_balances: Increase::Resources::IntrafiBalances

data/sig/increase/models/account_number.rbs

@@ -7,12 +7,12 @@ module Increase
         account_number: String,
         created_at: Time,
         idempotency_key: String?,
-        inbound_ach: Increase::AccountNumber::InboundACH,
-        inbound_checks: Increase::AccountNumber::InboundChecks,
+        inbound_ach_debits: Increase::Models::AccountNumber::inbound_ach_debits,
         name: String,
         routing_number: String,
         status: Increase::Models::AccountNumber::status,
-        type: Increase::Models::AccountNumber::type_
+        type: Increase::Models::AccountNumber::type_,
+        unregistered_inbound_checks: Increase::Models::AccountNumber::unregistered_inbound_checks
       }
 
     class AccountNumber < Increase::Internal::Type::BaseModel
@@ -26,9 +26,7 @@ module Increase
 
       attr_accessor idempotency_key: String?
 
-      attr_accessor inbound_ach: Increase::AccountNumber::InboundACH
-
-      attr_accessor inbound_checks: Increase::AccountNumber::InboundChecks
+      attr_accessor inbound_ach_debits: Increase::Models::AccountNumber::inbound_ach_debits
 
       attr_accessor name: String
 
@@ -38,18 +36,20 @@ module Increase
 
       attr_accessor type: Increase::Models::AccountNumber::type_
 
+      attr_accessor unregistered_inbound_checks: Increase::Models::AccountNumber::unregistered_inbound_checks
+
       def initialize: (
         id: String,
         account_id: String,
         account_number: String,
         created_at: Time,
         idempotency_key: String?,
-        inbound_ach: Increase::AccountNumber::InboundACH,
-        inbound_checks: Increase::AccountNumber::InboundChecks,
+        inbound_ach_debits: Increase::Models::AccountNumber::inbound_ach_debits,
         name: String,
         routing_number: String,
         status: Increase::Models::AccountNumber::status,
-        type: Increase::Models::AccountNumber::type_
+        type: Increase::Models::AccountNumber::type_,
+        unregistered_inbound_checks: Increase::Models::AccountNumber::unregistered_inbound_checks
       ) -> void
 
       def to_hash: -> {
@@ -58,72 +58,26 @@ module Increase
         account_number: String,
         created_at: Time,
         idempotency_key: String?,
-        inbound_ach: Increase::AccountNumber::InboundACH,
-        inbound_checks: Increase::AccountNumber::InboundChecks,
+        inbound_ach_debits: Increase::Models::AccountNumber::inbound_ach_debits,
         name: String,
         routing_number: String,
         status: Increase::Models::AccountNumber::status,
-        type: Increase::Models::AccountNumber::type_
+        type: Increase::Models::AccountNumber::type_,
+        unregistered_inbound_checks: Increase::Models::AccountNumber::unregistered_inbound_checks
       }
 
-      type inbound_ach =
-        {
-          debit_status: Increase::Models::AccountNumber::InboundACH::debit_status
-        }
-
-      class InboundACH < Increase::Internal::Type::BaseModel
-        attr_accessor debit_status: Increase::Models::AccountNumber::InboundACH::debit_status
-
-        def initialize: (
-          debit_status: Increase::Models::AccountNumber::InboundACH::debit_status
-        ) -> void
-
-        def to_hash: -> {
-          debit_status: Increase::Models::AccountNumber::InboundACH::debit_status
-        }
-
-        type debit_status = :allowed | :blocked
-
-        module DebitStatus
-          extend Increase::Internal::Type::Enum
-
-          # ACH Debits are allowed.
-          ALLOWED: :allowed
-
-          # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
-          BLOCKED: :blocked
-
-          def self?.values: -> ::Array[Increase::Models::AccountNumber::InboundACH::debit_status]
-        end
-      end
-
-      type inbound_checks =
-        { status: Increase::Models::AccountNumber::InboundChecks::status }
+      type inbound_ach_debits = :allowed | :blocked
 
-      class InboundChecks < Increase::Internal::Type::BaseModel
-        attr_accessor status: Increase::Models::AccountNumber::InboundChecks::status
-
-        def initialize: (
-          status: Increase::Models::AccountNumber::InboundChecks::status
-        ) -> void
-
-        def to_hash: -> {
-          status: Increase::Models::AccountNumber::InboundChecks::status
-        }
-
-        type status = :allowed | :check_transfers_only
-
-        module Status
-          extend Increase::Internal::Type::Enum
+      module InboundACHDebits
+        extend Increase::Internal::Type::Enum
 
-          # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
-          ALLOWED: :allowed
+        # ACH Debits are allowed.
+        ALLOWED: :allowed
 
-          # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
-          CHECK_TRANSFERS_ONLY: :check_transfers_only
+        # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
+        BLOCKED: :blocked
 
-          def self?.values: -> ::Array[Increase::Models::AccountNumber::InboundChecks::status]
-        end
+        def self?.values: -> ::Array[Increase::Models::AccountNumber::inbound_ach_debits]
       end
 
       type status = :active | :disabled | :canceled
@@ -152,6 +106,20 @@ module Increase
 
         def self?.values: -> ::Array[Increase::Models::AccountNumber::type_]
       end
+
+      type unregistered_inbound_checks = :allowed | :blocked
+
+      module UnregisteredInboundChecks
+        extend Increase::Internal::Type::Enum
+
+        # Accept all Inbound Check Deposits, even if they are not associated with a Check Transfer or Checkbook Check.
+        ALLOWED: :allowed
+
+        # Only accept Inbound Check Deposits if they can be matched to a Check Transfer or Checkbook Check.
+        BLOCKED: :blocked
+
+        def self?.values: -> ::Array[Increase::Models::AccountNumber::unregistered_inbound_checks]
+      end
     end
   end
 end

data/sig/increase/models/account_number_create_params.rbs

@@ -4,8 +4,8 @@ module Increase
       {
         account_id: String,
         name: String,
-        inbound_ach: Increase::AccountNumberCreateParams::InboundACH,
-        inbound_checks: Increase::AccountNumberCreateParams::InboundChecks
+        inbound_ach_debits: Increase::Models::AccountNumberCreateParams::inbound_ach_debits,
+        unregistered_inbound_checks: Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks
       }
       & Increase::Internal::Type::request_parameters
 
@@ -17,94 +17,60 @@ module Increase
 
       attr_accessor name: String
 
-      attr_reader inbound_ach: Increase::AccountNumberCreateParams::InboundACH?
+      attr_reader inbound_ach_debits: Increase::Models::AccountNumberCreateParams::inbound_ach_debits?
 
-      def inbound_ach=: (
-        Increase::AccountNumberCreateParams::InboundACH
-      ) -> Increase::AccountNumberCreateParams::InboundACH
+      def inbound_ach_debits=: (
+        Increase::Models::AccountNumberCreateParams::inbound_ach_debits
+      ) -> Increase::Models::AccountNumberCreateParams::inbound_ach_debits
 
-      attr_reader inbound_checks: Increase::AccountNumberCreateParams::InboundChecks?
+      attr_reader unregistered_inbound_checks: Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks?
 
-      def inbound_checks=: (
-        Increase::AccountNumberCreateParams::InboundChecks
-      ) -> Increase::AccountNumberCreateParams::InboundChecks
+      def unregistered_inbound_checks=: (
+        Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks
+      ) -> Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks
 
       def initialize: (
         account_id: String,
         name: String,
-        ?inbound_ach: Increase::AccountNumberCreateParams::InboundACH,
-        ?inbound_checks: Increase::AccountNumberCreateParams::InboundChecks,
+        ?inbound_ach_debits: Increase::Models::AccountNumberCreateParams::inbound_ach_debits,
+        ?unregistered_inbound_checks: Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks,
         ?request_options: Increase::request_opts
       ) -> void
 
       def to_hash: -> {
         account_id: String,
         name: String,
-        inbound_ach: Increase::AccountNumberCreateParams::InboundACH,
-        inbound_checks: Increase::AccountNumberCreateParams::InboundChecks,
+        inbound_ach_debits: Increase::Models::AccountNumberCreateParams::inbound_ach_debits,
+        unregistered_inbound_checks: Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks,
         request_options: Increase::RequestOptions
       }
 
-      type inbound_ach =
-        {
-          debit_status: Increase::Models::AccountNumberCreateParams::InboundACH::debit_status
-        }
+      type inbound_ach_debits = :allowed | :blocked
 
-      class InboundACH < Increase::Internal::Type::BaseModel
-        attr_accessor debit_status: Increase::Models::AccountNumberCreateParams::InboundACH::debit_status
+      module InboundACHDebits
+        extend Increase::Internal::Type::Enum
 
-        def initialize: (
-          debit_status: Increase::Models::AccountNumberCreateParams::InboundACH::debit_status
-        ) -> void
+        # ACH Debits are allowed.
+        ALLOWED: :allowed
 
-        def to_hash: -> {
-          debit_status: Increase::Models::AccountNumberCreateParams::InboundACH::debit_status
-        }
+        # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
+        BLOCKED: :blocked
 
-        type debit_status = :allowed | :blocked
-
-        module DebitStatus
-          extend Increase::Internal::Type::Enum
-
-          # ACH Debits are allowed.
-          ALLOWED: :allowed
-
-          # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
-          BLOCKED: :blocked
-
-          def self?.values: -> ::Array[Increase::Models::AccountNumberCreateParams::InboundACH::debit_status]
-        end
+        def self?.values: -> ::Array[Increase::Models::AccountNumberCreateParams::inbound_ach_debits]
       end
 
-      type inbound_checks =
-        {
-          status: Increase::Models::AccountNumberCreateParams::InboundChecks::status
-        }
-
-      class InboundChecks < Increase::Internal::Type::BaseModel
-        attr_accessor status: Increase::Models::AccountNumberCreateParams::InboundChecks::status
-
-        def initialize: (
-          status: Increase::Models::AccountNumberCreateParams::InboundChecks::status
-        ) -> void
-
-        def to_hash: -> {
-          status: Increase::Models::AccountNumberCreateParams::InboundChecks::status
-        }
-
-        type status = :allowed | :check_transfers_only
+      type unregistered_inbound_checks = :allowed | :blocked
 
-        module Status
-          extend Increase::Internal::Type::Enum
+      module UnregisteredInboundChecks
+        extend Increase::Internal::Type::Enum
 
-          # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
-          ALLOWED: :allowed
+        # Accept all Inbound Check Deposits, even if they are not associated with a Check Transfer or Checkbook Check.
+        ALLOWED: :allowed
 
-          # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
-          CHECK_TRANSFERS_ONLY: :check_transfers_only
+        # Only accept Inbound Check Deposits if they can be matched to a Check Transfer or Checkbook Check.
+        BLOCKED: :blocked
 
-          def self?.values: -> ::Array[Increase::Models::AccountNumberCreateParams::InboundChecks::status]
-        end
+        def self?.values: -> ::Array[Increase::Models::AccountNumberCreateParams::unregistered_inbound_checks]
       end
     end
   end