increase 1.362.0 → 1.364.0

data/rbi/increase/models/checkbook_check_list_params.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookCheckListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookCheckListParams, Increase::Internal::AnyHash)
+        end
+
+      # Filter Checkbook Checks to those drawn on the specified Account Number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_number_id
+
+      sig { params(account_number_id: String).void }
+      attr_writer :account_number_id
+
+      # Filter Checkbook Checks to the one with the specified check number.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :check_number
+
+      sig { params(check_number: Integer).void }
+      attr_writer :check_number
+
+      # Filter Checkbook Checks to those belonging to the specified Checkbook.
+      sig { returns(T.nilable(String)) }
+      attr_reader :checkbook_id
+
+      sig { params(checkbook_id: String).void }
+      attr_writer :checkbook_id
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      #
+      # Defaults to `100`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          account_number_id: String,
+          check_number: Integer,
+          checkbook_id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            account_number_id: String,
+            check_number: Integer,
+            checkbook_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/{oauth_connection_retrieve_params.rbi → checkbook_check_retrieve_params.rbi}

@@ -2,31 +2,31 @@
 
 module Increase
   module Models
-    class OAuthConnectionRetrieveParams < Increase::Internal::Type::BaseModel
+    class CheckbookCheckRetrieveParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Increase::OAuthConnectionRetrieveParams,
+            Increase::CheckbookCheckRetrieveParams,
             Increase::Internal::AnyHash
           )
         end
 
-      # The identifier of the OAuth Connection.
+      # The identifier of the Checkbook Check.
       sig { returns(String) }
-      attr_accessor :oauth_connection_id
+      attr_accessor :checkbook_check_id
 
       sig do
         params(
-          oauth_connection_id: String,
+          checkbook_check_id: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The identifier of the OAuth Connection.
-        oauth_connection_id:,
+        # The identifier of the Checkbook Check.
+        checkbook_check_id:,
         request_options: {}
       )
       end
@@ -34,7 +34,7 @@ module Increase
       sig do
         override.returns(
           {
-            oauth_connection_id: String,
+            checkbook_check_id: String,
             request_options: Increase::RequestOptions
           }
         )

data/rbi/increase/models/{oauth_application_retrieve_params.rbi → checkbook_check_stop_params.rbi}

@@ -2,31 +2,28 @@
 
 module Increase
   module Models
-    class OAuthApplicationRetrieveParams < Increase::Internal::Type::BaseModel
+    class CheckbookCheckStopParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
-          T.any(
-            Increase::OAuthApplicationRetrieveParams,
-            Increase::Internal::AnyHash
-          )
+          T.any(Increase::CheckbookCheckStopParams, Increase::Internal::AnyHash)
         end
 
-      # The identifier of the OAuth Application.
+      # The identifier of the Checkbook Check to stop.
       sig { returns(String) }
-      attr_accessor :oauth_application_id
+      attr_accessor :checkbook_check_id
 
       sig do
         params(
-          oauth_application_id: String,
+          checkbook_check_id: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The identifier of the OAuth Application.
-        oauth_application_id:,
+        # The identifier of the Checkbook Check to stop.
+        checkbook_check_id:,
         request_options: {}
       )
       end
@@ -34,7 +31,7 @@ module Increase
       sig do
         override.returns(
           {
-            oauth_application_id: String,
+            checkbook_check_id: String,
             request_options: Increase::RequestOptions
           }
         )

data/rbi/increase/models/checkbook_create_params.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookCreateParams, Increase::Internal::AnyHash)
+        end
+
+      # The identifier of the Account Number that the checks will draw from. The Account
+      # Number must be active.
+      sig { returns(String) }
+      attr_accessor :account_number_id
+
+      # The destination address that the Checkbook will be mailed to.
+      sig { returns(Increase::CheckbookCreateParams::MailingAddress) }
+      attr_reader :mailing_address
+
+      sig do
+        params(
+          mailing_address:
+            Increase::CheckbookCreateParams::MailingAddress::OrHash
+        ).void
+      end
+      attr_writer :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.
+      sig { returns(T::Array[Increase::CheckbookCreateParams::Payer]) }
+      attr_accessor :payer
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            account_number_id: String,
+            mailing_address: Increase::CheckbookCreateParams::MailingAddress,
+            payer: T::Array[Increase::CheckbookCreateParams::Payer],
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class MailingAddress < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CheckbookCreateParams::MailingAddress,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The city of the destination address.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # The first line of the destination address.
+        sig { returns(String) }
+        attr_accessor :line1
+
+        # The recipient at the destination address.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The postal code of the destination address.
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        # The US state of the destination address.
+        sig { returns(String) }
+        attr_accessor :state
+
+        # The second line of the destination address.
+        sig { returns(T.nilable(String)) }
+        attr_reader :line2
+
+        sig { params(line2: String).void }
+        attr_writer :line2
+
+        # The destination address that the Checkbook will be mailed to.
+        sig do
+          params(
+            city: String,
+            line1: String,
+            name: String,
+            postal_code: String,
+            state: String,
+            line2: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city of the destination address.
+          city:,
+          # The first line of the destination address.
+          line1:,
+          # The recipient at the destination address.
+          name:,
+          # The postal code of the destination address.
+          postal_code:,
+          # The US state of the destination address.
+          state:,
+          # The second line of the destination address.
+          line2: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              city: String,
+              line1: String,
+              name: String,
+              postal_code: String,
+              state: String,
+              line2: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Payer < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CheckbookCreateParams::Payer,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The contents of the line.
+        sig { returns(String) }
+        attr_accessor :contents
+
+        sig { params(contents: String).returns(T.attached_class) }
+        def self.new(
+          # The contents of the line.
+          contents:
+        )
+        end
+
+        sig { override.returns({ contents: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/checkbook_list_params.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookListParams, Increase::Internal::AnyHash)
+        end
+
+      # Filter Checkbooks to those attached to the specified Account Number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_number_id
+
+      sig { params(account_number_id: String).void }
+      attr_writer :account_number_id
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # 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).
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      #
+      # Defaults to `100`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig { returns(T.nilable(Increase::CheckbookListParams::Status)) }
+      attr_reader :status
+
+      sig { params(status: Increase::CheckbookListParams::Status::OrHash).void }
+      attr_writer :status
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            account_number_id: String,
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            status: Increase::CheckbookListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CheckbookListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Checkbooks for those with the specified status or statuses. For GET
+        # requests, this should be encoded as a comma-delimited string, such as
+        # `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Increase::CheckbookListParams::Status::In::OrSymbol]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_: T::Array[Increase::CheckbookListParams::Status::In::OrSymbol]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_: T::Array[Increase::CheckbookListParams::Status::In::OrSymbol]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Checkbooks for those with the specified status or statuses. For GET
+          # requests, this should be encoded as a comma-delimited string, such as
+          # `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_: T::Array[Increase::CheckbookListParams::Status::In::OrSymbol]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::CheckbookListParams::Status::In)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The Checkbook is pending submission to the printer.
+          PENDING_SUBMISSION =
+            T.let(
+              :pending_submission,
+              Increase::CheckbookListParams::Status::In::TaggedSymbol
+            )
+
+          # The Checkbook has been submitted to the printer and is pending mailing.
+          PENDING_MAILING =
+            T.let(
+              :pending_mailing,
+              Increase::CheckbookListParams::Status::In::TaggedSymbol
+            )
+
+          # The Checkbook has been mailed.
+          MAILED =
+            T.let(
+              :mailed,
+              Increase::CheckbookListParams::Status::In::TaggedSymbol
+            )
+
+          # The Checkbook has been stopped and its checks can no longer be deposited.
+          STOPPED =
+            T.let(
+              :stopped,
+              Increase::CheckbookListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Increase::CheckbookListParams::Status::In::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/checkbook_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookRetrieveParams, Increase::Internal::AnyHash)
+        end
+
+      # The identifier of the Checkbook.
+      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.
+        checkbook_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { checkbook_id: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/checkbook_stop_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CheckbookStopParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CheckbookStopParams, Increase::Internal::AnyHash)
+        end
+
+      # The identifier of the Checkbook to stop.
+      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 to stop.
+        checkbook_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { checkbook_id: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/declined_transaction.rbi

@@ -3962,6 +3962,10 @@ module Increase
           sig { returns(T.nilable(String)) }
           attr_accessor :check_transfer_id
 
+          # The identifier of the Checkbook Check object associated with this decline.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :checkbook_check_id
+
           # The identifier of the API File object containing an image of the front of the
           # declined check.
           sig { returns(T.nilable(String)) }
@@ -3987,6 +3991,7 @@ module Increase
               auxiliary_on_us: T.nilable(String),
               back_image_file_id: T.nilable(String),
               check_transfer_id: T.nilable(String),
+              checkbook_check_id: T.nilable(String),
               front_image_file_id: T.nilable(String),
               inbound_check_deposit_id: T.nilable(String),
               reason:
@@ -4005,6 +4010,8 @@ module Increase
             back_image_file_id:,
             # The identifier of the Check Transfer object associated with this decline.
             check_transfer_id:,
+            # The identifier of the Checkbook Check object associated with this decline.
+            checkbook_check_id:,
             # The identifier of the API File object containing an image of the front of the
             # declined check.
             front_image_file_id:,
@@ -4022,6 +4029,7 @@ module Increase
                 auxiliary_on_us: T.nilable(String),
                 back_image_file_id: T.nilable(String),
                 check_transfer_id: T.nilable(String),
+                checkbook_check_id: T.nilable(String),
                 front_image_file_id: T.nilable(String),
                 inbound_check_deposit_id: T.nilable(String),
                 reason: