increase 1.348.0 → 1.350.0

data/rbi/increase/models/event.rbi

@@ -735,6 +735,13 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a Plaid Processor Token is created.
+        PLAID_PROCESSOR_TOKEN_CREATED =
+          T.let(
+            :"plaid_processor_token.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Checkbook is created.
         CHECKBOOK_CREATED =
           T.let(:"checkbook.created", Increase::Event::Category::TaggedSymbol)

data/rbi/increase/models/event_list_params.rbi

@@ -850,6 +850,13 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Plaid Processor Token is created.
+          PLAID_PROCESSOR_TOKEN_CREATED =
+            T.let(
+              :"plaid_processor_token.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Checkbook is created.
           CHECKBOOK_CREATED =
             T.let(

data/rbi/increase/models/event_subscription.rbi

@@ -871,6 +871,13 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Plaid Processor Token is created.
+          PLAID_PROCESSOR_TOKEN_CREATED =
+            T.let(
+              :"plaid_processor_token.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Checkbook is created.
           CHECKBOOK_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -869,6 +869,13 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Plaid Processor Token is created.
+          PLAID_PROCESSOR_TOKEN_CREATED =
+            T.let(
+              :"plaid_processor_token.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever a Checkbook is created.
           CHECKBOOK_CREATED =
             T.let(

data/rbi/increase/models/fednow_transfer.rbi

@@ -118,6 +118,12 @@ module Increase
       end
       attr_writer :rejection
 
+      # If the transfer is returned by the recipient's bank, this will contain details
+      # of each return. FedNow allows returning part of a transfer, so a transfer can be
+      # returned more than once.
+      sig { returns(T::Array[Increase::FednowTransfer::Return]) }
+      attr_accessor :returns
+
       # The destination American Bankers' Association (ABA) Routing Transit Number
       # (RTN).
       sig { returns(String) }
@@ -185,6 +191,7 @@ module Increase
           idempotency_key: T.nilable(String),
           pending_transaction_id: T.nilable(String),
           rejection: T.nilable(Increase::FednowTransfer::Rejection::OrHash),
+          returns: T::Array[Increase::FednowTransfer::Return::OrHash],
           routing_number: String,
           source_account_number_id: String,
           status: Increase::FednowTransfer::Status::OrSymbol,
@@ -236,6 +243,10 @@ module Increase
         # If the transfer is rejected by FedNow or the destination financial institution,
         # this will contain supplemental details.
         rejection:,
+        # If the transfer is returned by the recipient's bank, this will contain details
+        # of each return. FedNow allows returning part of a transfer, so a transfer can be
+        # returned more than once.
+        returns:,
         # The destination American Bankers' Association (ABA) Routing Transit Number
         # (RTN).
         routing_number:,
@@ -281,6 +292,7 @@ module Increase
             idempotency_key: T.nilable(String),
             pending_transaction_id: T.nilable(String),
             rejection: T.nilable(Increase::FednowTransfer::Rejection),
+            returns: T::Array[Increase::FednowTransfer::Return],
             routing_number: String,
             source_account_number_id: String,
             status: Increase::FednowTransfer::Status::TaggedSymbol,
@@ -877,6 +889,203 @@ module Increase
         end
       end
 
+      class Return < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::FednowTransfer::Return, Increase::Internal::AnyHash)
+          end
+
+        # The returned amount in USD cents. This is always a positive number.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # Additional information about the return provided by the recipient's bank.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :return_reason_additional_information
+
+        # The reason the transfer was returned as provided by the recipient's bank.
+        sig do
+          returns(
+            Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+          )
+        end
+        attr_accessor :return_reason_code
+
+        # The identifier of the FedNow Transfer that led to this Transaction.
+        sig { returns(String) }
+        attr_accessor :transfer_id
+
+        # A FedNow Transfer Return is created when a FedNow Transfer sent from Increase is
+        # returned by the recipient's bank.
+        sig do
+          params(
+            amount: Integer,
+            return_reason_additional_information: T.nilable(String),
+            return_reason_code:
+              Increase::FednowTransfer::Return::ReturnReasonCode::OrSymbol,
+            transfer_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The returned amount in USD cents. This is always a positive number.
+          amount:,
+          # Additional information about the return provided by the recipient's bank.
+          return_reason_additional_information:,
+          # The reason the transfer was returned as provided by the recipient's bank.
+          return_reason_code:,
+          # The identifier of the FedNow Transfer that led to this Transaction.
+          transfer_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount: Integer,
+              return_reason_additional_information: T.nilable(String),
+              return_reason_code:
+                Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol,
+              transfer_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The reason the transfer was returned as provided by the recipient's bank.
+        module ReturnReasonCode
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::FednowTransfer::Return::ReturnReasonCode)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The destination account is closed. Corresponds to the FedNow reason codes `AC04` and `AC07`.
+          ACCOUNT_CLOSED =
+            T.let(
+              :account_closed,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
+          ACCOUNT_BLOCKED =
+            T.let(
+              :account_blocked,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The recipient's bank was not a valid agent for this transfer. Corresponds to the FedNow reason codes `AC14` and `AGNT`.
+          INVALID_AGENT =
+            T.let(
+              :invalid_agent,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
+          INVALID_CREDITOR_ACCOUNT_NUMBER =
+            T.let(
+              :invalid_creditor_account_number,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The destination account number was incorrect. Corresponds to the FedNow reason code `AC01`.
+          INCORRECT_ACCOUNT_NUMBER =
+            T.let(
+              :incorrect_account_number,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
+          END_CUSTOMER_DECEASED =
+            T.let(
+              :end_customer_deceased,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer was not permitted by the recipient's bank. Corresponds to the FedNow reason code `AG01`.
+          TRANSACTION_FORBIDDEN =
+            T.let(
+              :transaction_forbidden,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer was returned for a regulatory reason at the recipient's bank. Corresponds to the FedNow reason code `RR04`.
+          REGULATORY_REASON =
+            T.let(
+              :regulatory_reason,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer was reported as fraudulent. Corresponds to the FedNow reason code `FR01`.
+          FRAUD =
+            T.let(
+              :fraud,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer duplicated another transfer. Corresponds to the FedNow reason codes `AM05` and `DUPL`.
+          DUPLICATION =
+            T.let(
+              :duplication,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer amount was incorrect. Corresponds to the FedNow reason code `AM09`.
+          WRONG_AMOUNT =
+            T.let(
+              :wrong_amount,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer was returned at the request of the recipient's customer. Corresponds to the FedNow reason code `CUST`.
+          REQUESTED_BY_CUSTOMER =
+            T.let(
+              :requested_by_customer,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The recipient's bank could not apply the funds. Corresponds to the FedNow reason code `RUTA`.
+          UNABLE_TO_APPLY =
+            T.let(
+              :unable_to_apply,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The recipient's bank did not specify a reason. Corresponds to the FedNow reason codes `MS02` and `MS03`.
+          NOT_SPECIFIED =
+            T.let(
+              :not_specified,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
+          NARRATIVE =
+            T.let(
+              :narrative,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          # The transfer was returned for some other reason.
+          OTHER =
+            T.let(
+              :other,
+              Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::FednowTransfer::Return::ReturnReasonCode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # The lifecycle status of the transfer.
       module Status
         extend Increase::Internal::Type::Enum
@@ -903,13 +1112,6 @@ module Increase
         CANCELED =
           T.let(:canceled, Increase::FednowTransfer::Status::TaggedSymbol)
 
-        # The transfer has been rejected by Increase.
-        REVIEWING_REJECTED =
-          T.let(
-            :reviewing_rejected,
-            Increase::FednowTransfer::Status::TaggedSymbol
-          )
-
         # The transfer requires attention from an Increase operator.
         REQUIRES_ATTENTION =
           T.let(
@@ -939,6 +1141,10 @@ module Increase
         REJECTED =
           T.let(:rejected, Increase::FednowTransfer::Status::TaggedSymbol)
 
+        # The transfer was returned by the recipient's bank.
+        RETURNED =
+          T.let(:returned, Increase::FednowTransfer::Status::TaggedSymbol)
+
         sig do
           override.returns(
             T::Array[Increase::FednowTransfer::Status::TaggedSymbol]

data/rbi/increase/models/fednow_transfer_list_params.rbi

@@ -280,13 +280,6 @@ module Increase
               Increase::FednowTransferListParams::Status::In::TaggedSymbol
             )
 
-          # The transfer has been rejected by Increase.
-          REVIEWING_REJECTED =
-            T.let(
-              :reviewing_rejected,
-              Increase::FednowTransferListParams::Status::In::TaggedSymbol
-            )
-
           # The transfer requires attention from an Increase operator.
           REQUIRES_ATTENTION =
             T.let(
@@ -322,6 +315,13 @@ module Increase
               Increase::FednowTransferListParams::Status::In::TaggedSymbol
             )
 
+          # The transfer was returned by the recipient's bank.
+          RETURNED =
+            T.let(
+              :returned,
+              Increase::FednowTransferListParams::Status::In::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/inbound_ach_transfer.rbi

@@ -130,7 +130,7 @@ module Increase
       sig { returns(String) }
       attr_accessor :originator_company_name
 
-      # The American Banking Association (ABA) routing number of the bank originating
+      # The American Bankers' Association (ABA) routing number of the bank originating
       # the transfer.
       sig { returns(String) }
       attr_accessor :originator_routing_number
@@ -274,7 +274,7 @@ module Increase
         originator_company_id:,
         # The name of the company that initiated the transfer.
         originator_company_name:,
-        # The American Banking Association (ABA) routing number of the bank originating
+        # The American Bankers' Association (ABA) routing number of the bank originating
         # the transfer.
         originator_routing_number:,
         # The id of the receiver of the transfer.

data/rbi/increase/models/inbound_check_deposit.rbi

@@ -47,7 +47,7 @@ module Increase
 
       # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
       # bank depositing this check. In some rare cases, this is not transmitted via
-      # Check21 and the value will be null.
+      # Check 21 and the value will be null.
       sig { returns(T.nilable(String)) }
       attr_accessor :bank_of_first_deposit_routing_number
 
@@ -172,7 +172,7 @@ module Increase
         back_image_file_id:,
         # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
         # bank depositing this check. In some rare cases, this is not transmitted via
-        # Check21 and the value will be null.
+        # Check 21 and the value will be null.
         bank_of_first_deposit_routing_number:,
         # The check number printed on the check being deposited.
         check_number:,
@@ -255,7 +255,8 @@ module Increase
         sig { returns(Time) }
         attr_accessor :adjusted_at
 
-        # The amount of the adjustment.
+        # The amount of the adjustment in USD cents. A positive amount is a credit to your
+        # account and a negative amount is a debit.
         sig { returns(Integer) }
         attr_accessor :amount
 
@@ -282,7 +283,8 @@ module Increase
         def self.new(
           # The time at which the return adjustment was received.
           adjusted_at:,
-          # The amount of the adjustment.
+          # The amount of the adjustment in USD cents. A positive amount is a credit to your
+          # account and a negative amount is a debit.
           amount:,
           # The reason for the adjustment.
           reason:,

data/rbi/increase/models/inbound_fednow_transfer.rbi

@@ -73,6 +73,10 @@ module Increase
       end
       attr_writer :decline
 
+      # A free-form reference string set by the sender, to help identify the transfer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :end_to_end_identification
+
       # The lifecycle status of the transfer.
       sig { returns(Increase::InboundFednowTransfer::Status::TaggedSymbol) }
       attr_accessor :status
@@ -82,6 +86,10 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :transaction_id
 
+      # The FedNow network identification of the transfer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :transaction_identification
+
       # A constant representing the object's type. For this resource it will always be
       # `inbound_fednow_transfer`.
       sig { returns(Increase::InboundFednowTransfer::Type::TaggedSymbol) }
@@ -114,8 +122,10 @@ module Increase
           debtor_name: String,
           debtor_routing_number: String,
           decline: T.nilable(Increase::InboundFednowTransfer::Decline::OrHash),
+          end_to_end_identification: T.nilable(String),
           status: Increase::InboundFednowTransfer::Status::OrSymbol,
           transaction_id: T.nilable(String),
+          transaction_identification: T.nilable(String),
           type: Increase::InboundFednowTransfer::Type::OrSymbol,
           unique_end_to_end_transaction_reference: T.nilable(String),
           unstructured_remittance_information: T.nilable(String)
@@ -148,11 +158,15 @@ module Increase
         debtor_routing_number:,
         # If your transfer is declined, this will contain details of the decline.
         decline:,
+        # A free-form reference string set by the sender, to help identify the transfer.
+        end_to_end_identification:,
         # The lifecycle status of the transfer.
         status:,
         # The identifier of the Transaction object created when the transfer was
         # confirmed.
         transaction_id:,
+        # The FedNow network identification of the transfer.
+        transaction_identification:,
         # A constant representing the object's type. For this resource it will always be
         # `inbound_fednow_transfer`.
         type:,
@@ -181,8 +195,10 @@ module Increase
             debtor_name: String,
             debtor_routing_number: String,
             decline: T.nilable(Increase::InboundFednowTransfer::Decline),
+            end_to_end_identification: T.nilable(String),
             status: Increase::InboundFednowTransfer::Status::TaggedSymbol,
             transaction_id: T.nilable(String),
+            transaction_identification: T.nilable(String),
             type: Increase::InboundFednowTransfer::Type::TaggedSymbol,
             unique_end_to_end_transaction_reference: T.nilable(String),
             unstructured_remittance_information: T.nilable(String)
@@ -342,6 +358,13 @@ module Increase
               Increase::InboundFednowTransfer::Decline::Reason::TaggedSymbol
             )
 
+          # The transaction is not allowed per Increase's terms.
+          TRANSACTION_NOT_ALLOWED =
+            T.let(
+              :transaction_not_allowed,
+              Increase::InboundFednowTransfer::Decline::Reason::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/inbound_mail_item.rbi

@@ -12,6 +12,12 @@ module Increase
       sig { returns(String) }
       attr_accessor :id
 
+      # The identifier for the Account that checks in this mail item are deposited into.
+      # For mail items that could not be routed to a Lockbox Recipient, this will be
+      # null.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :account_id
+
       # The checks in the mail item.
       sig { returns(T::Array[Increase::InboundMailItem::Check]) }
       attr_accessor :checks
@@ -62,6 +68,7 @@ module Increase
       sig do
         params(
           id: String,
+          account_id: T.nilable(String),
           checks: T::Array[Increase::InboundMailItem::Check::OrHash],
           created_at: Time,
           file_id: String,
@@ -77,6 +84,10 @@ module Increase
       def self.new(
         # The Inbound Mail Item identifier.
         id:,
+        # The identifier for the Account that checks in this mail item are deposited into.
+        # For mail items that could not be routed to a Lockbox Recipient, this will be
+        # null.
+        account_id:,
         # The checks in the mail item.
         checks:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
@@ -105,6 +116,7 @@ module Increase
         override.returns(
           {
             id: String,
+            account_id: T.nilable(String),
             checks: T::Array[Increase::InboundMailItem::Check],
             created_at: Time,
             file_id: String,

data/rbi/increase/models/inbound_wire_drawdown_request.rbi

@@ -15,6 +15,11 @@ module Increase
       sig { returns(String) }
       attr_accessor :id
 
+      # The Account from which the recipient of this request is being requested to send
+      # funds.
+      sig { returns(String) }
+      attr_accessor :account_id
+
       # The amount being requested in cents.
       sig { returns(Integer) }
       attr_accessor :amount
@@ -110,6 +115,7 @@ module Increase
       sig do
         params(
           id: String,
+          account_id: String,
           amount: Integer,
           created_at: Time,
           creditor_account_number: String,
@@ -135,6 +141,9 @@ module Increase
       def self.new(
         # The Wire drawdown request identifier.
         id:,
+        # The Account from which the recipient of this request is being requested to send
+        # funds.
+        account_id:,
         # The amount being requested in cents.
         amount:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -191,6 +200,7 @@ module Increase
         override.returns(
           {
             id: String,
+            account_id: String,
             amount: Integer,
             created_at: Time,
             creditor_account_number: String,

data/rbi/increase/models/inbound_wire_transfer.rbi

@@ -77,7 +77,7 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :debtor_name
 
-      # The American Banking Association (ABA) routing number of the sender.
+      # The American Bankers' Association (ABA) routing number of the sender.
       sig { returns(T.nilable(String)) }
       attr_accessor :debtor_routing_number
 
@@ -95,7 +95,7 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :input_message_accountability_data
 
-      # The American Banking Association (ABA) routing number of the bank that sent the
+      # The American Bankers' Association (ABA) routing number of the bank that sent the
       # wire.
       sig { returns(T.nilable(String)) }
       attr_accessor :instructing_agent_routing_number
@@ -209,7 +209,7 @@ module Increase
         debtor_address_line3:,
         # A name set by the sender.
         debtor_name:,
-        # The American Banking Association (ABA) routing number of the sender.
+        # The American Bankers' Association (ABA) routing number of the sender.
         debtor_routing_number:,
         # An Increase-constructed description of the transfer.
         description:,
@@ -219,7 +219,7 @@ module Increase
         # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
         # service and is helpful when debugging wires with the originating bank.
         input_message_accountability_data:,
-        # The American Banking Association (ABA) routing number of the bank that sent the
+        # The American Bankers' Association (ABA) routing number of the bank that sent the
         # wire.
         instructing_agent_routing_number:,
         # The sending bank's identifier for the wire transfer.

data/rbi/increase/models/intrafi_exclusion.rbi

@@ -25,7 +25,7 @@ module Increase
       sig { returns(String) }
       attr_accessor :entity_id
 
-      # When this was exclusion was confirmed by IntraFi.
+      # When this exclusion was confirmed by IntraFi.
       sig { returns(T.nilable(Time)) }
       attr_accessor :excluded_at
 
@@ -44,7 +44,7 @@ module Increase
       sig { returns(Increase::IntrafiExclusion::Status::TaggedSymbol) }
       attr_accessor :status
 
-      # When this was exclusion was submitted to IntraFi by Increase.
+      # When this exclusion was submitted to IntraFi by Increase.
       sig { returns(T.nilable(Time)) }
       attr_accessor :submitted_at
 
@@ -81,7 +81,7 @@ module Increase
         created_at:,
         # The entity for which this institution is excluded.
         entity_id:,
-        # When this was exclusion was confirmed by IntraFi.
+        # When this exclusion was confirmed by IntraFi.
         excluded_at:,
         # The Federal Deposit Insurance Corporation's certificate number for the
         # institution.
@@ -92,7 +92,7 @@ module Increase
         idempotency_key:,
         # The status of the exclusion request.
         status:,
-        # When this was exclusion was submitted to IntraFi by Increase.
+        # When this exclusion was submitted to IntraFi by Increase.
         submitted_at:,
         # A constant representing the object's type. For this resource it will always be
         # `intrafi_exclusion`.

data/rbi/increase/models/lockbox_recipient_create_params.rbi

@@ -30,7 +30,7 @@ module Increase
       sig { params(description: String).void }
       attr_writer :description
 
-      # The name of the Lockbox Recipient
+      # The name of the Lockbox Recipient.
       sig { returns(T.nilable(String)) }
       attr_reader :recipient_name
 
@@ -54,7 +54,7 @@ module Increase
         lockbox_address_id:,
         # The description you choose for the Lockbox Recipient.
         description: nil,
-        # The name of the Lockbox Recipient
+        # The name of the Lockbox Recipient.
         recipient_name: nil,
         request_options: {}
       )