increase 1.361.0 → 1.363.0

data/rbi/increase/models/wire_drawdown_request.rbi

@@ -95,6 +95,18 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :idempotency_key
 
+      # If the debtor refuses the drawdown request, this will contain supplemental
+      # details.
+      sig { returns(T.nilable(Increase::WireDrawdownRequest::Refusal)) }
+      attr_reader :refusal
+
+      sig do
+        params(
+          refusal: T.nilable(Increase::WireDrawdownRequest::Refusal::OrHash)
+        ).void
+      end
+      attr_writer :refusal
+
       # The lifecycle status of the drawdown request.
       sig { returns(Increase::WireDrawdownRequest::Status::TaggedSymbol) }
       attr_accessor :status
@@ -152,6 +164,7 @@ module Increase
           end_to_end_identification: T.nilable(String),
           fulfillment_inbound_wire_transfer_id: T.nilable(String),
           idempotency_key: T.nilable(String),
+          refusal: T.nilable(Increase::WireDrawdownRequest::Refusal::OrHash),
           status: Increase::WireDrawdownRequest::Status::OrSymbol,
           submission:
             T.nilable(Increase::WireDrawdownRequest::Submission::OrHash),
@@ -201,6 +214,9 @@ module Increase
         # 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:,
+        # If the debtor refuses the drawdown request, this will contain supplemental
+        # details.
+        refusal:,
         # The lifecycle status of the drawdown request.
         status:,
         # After the drawdown request is submitted to Fedwire, this will contain
@@ -237,6 +253,7 @@ module Increase
             end_to_end_identification: T.nilable(String),
             fulfillment_inbound_wire_transfer_id: T.nilable(String),
             idempotency_key: T.nilable(String),
+            refusal: T.nilable(Increase::WireDrawdownRequest::Refusal),
             status: Increase::WireDrawdownRequest::Status::TaggedSymbol,
             submission: T.nilable(Increase::WireDrawdownRequest::Submission),
             type: Increase::WireDrawdownRequest::Type::TaggedSymbol,
@@ -408,6 +425,135 @@ module Increase
         end
       end
 
+      class Refusal < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::WireDrawdownRequest::Refusal,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Additional information about the refusal provided by the debtor bank. This is
+        # typically present when the `refusal_reason_code` is `narrative`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :refusal_reason_additional_information
+
+        # The reason the wire drawdown request was refused as provided by the debtor bank.
+        sig do
+          returns(
+            Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+          )
+        end
+        attr_accessor :refusal_reason_code
+
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the wire drawdown request was refused.
+        sig { returns(Time) }
+        attr_accessor :refused_at
+
+        # If the debtor refuses the drawdown request, this will contain supplemental
+        # details.
+        sig do
+          params(
+            refusal_reason_additional_information: T.nilable(String),
+            refusal_reason_code:
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::OrSymbol,
+            refused_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Additional information about the refusal provided by the debtor bank. This is
+          # typically present when the `refusal_reason_code` is `narrative`.
+          refusal_reason_additional_information:,
+          # The reason the wire drawdown request was refused as provided by the debtor bank.
+          refusal_reason_code:,
+          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+          # the wire drawdown request was refused.
+          refused_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              refusal_reason_additional_information: T.nilable(String),
+              refusal_reason_code:
+                Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol,
+              refused_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The reason the wire drawdown request was refused as provided by the debtor bank.
+        module RefusalReasonCode
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::WireDrawdownRequest::Refusal::RefusalReasonCode
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The debtor's account number is invalid or missing. Corresponds to the Fedwire reason code `AC02`.
+          INVALID_DEBTOR_ACCOUNT_NUMBER =
+            T.let(
+              :invalid_debtor_account_number,
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+            )
+
+          # The debtor account does not allow drawdown requests. Corresponds to the Fedwire reason code `AG01`.
+          TRANSACTION_FORBIDDEN =
+            T.let(
+              :transaction_forbidden,
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+            )
+
+          # The debtor account cannot be debited for a generic reason. Corresponds to the Fedwire reason code `AG07`.
+          UNSUCCESSFUL_DIRECT_DEBIT =
+            T.let(
+              :unsuccessful_direct_debit,
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+            )
+
+          # The debtor's identification is inconsistent with the debtor account number. Corresponds to the Fedwire reason code `BE01`.
+          INCONSISTENT_WITH_END_CUSTOMER =
+            T.let(
+              :inconsistent_with_end_customer,
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+            )
+
+          # The reason is provided as narrative information in the additional information field. Corresponds to the Fedwire reason code `NARR`.
+          NARRATIVE =
+            T.let(
+              :narrative,
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+            )
+
+          # Some other error or issue has occurred.
+          OTHER =
+            T.let(
+              :other,
+              Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::WireDrawdownRequest::Refusal::RefusalReasonCode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # The lifecycle status of the drawdown request.
       module Status
         extend Increase::Internal::Type::Enum

data/rbi/increase/models.rbi

@@ -327,10 +327,6 @@ module Increase
 
   FileRetrieveParams = Increase::Models::FileRetrieveParams
 
-  Group = Increase::Models::Group
-
-  GroupRetrieveParams = Increase::Models::GroupRetrieveParams
-
   InboundACHTransfer = Increase::Models::InboundACHTransfer
 
   InboundACHTransferCreateNotificationOfChangeParams =
@@ -396,6 +392,9 @@ module Increase
   InboundRealTimePaymentsTransferRetrieveParams =
     Increase::Models::InboundRealTimePaymentsTransferRetrieveParams
 
+  InboundRealTimePaymentsTransferReturnParams =
+    Increase::Models::InboundRealTimePaymentsTransferReturnParams
+
   InboundWireDrawdownRequest = Increase::Models::InboundWireDrawdownRequest
 
   InboundWireDrawdownRequestListParams =
@@ -467,24 +466,6 @@ module Increase
 
   LockboxRecipientUpdateParams = Increase::Models::LockboxRecipientUpdateParams
 
-  OAuthApplication = Increase::Models::OAuthApplication
-
-  OAuthApplicationListParams = Increase::Models::OAuthApplicationListParams
-
-  OAuthApplicationRetrieveParams =
-    Increase::Models::OAuthApplicationRetrieveParams
-
-  OAuthConnection = Increase::Models::OAuthConnection
-
-  OAuthConnectionListParams = Increase::Models::OAuthConnectionListParams
-
-  OAuthConnectionRetrieveParams =
-    Increase::Models::OAuthConnectionRetrieveParams
-
-  OAuthToken = Increase::Models::OAuthToken
-
-  OAuthTokenCreateParams = Increase::Models::OAuthTokenCreateParams
-
   PendingTransaction = Increase::Models::PendingTransaction
 
   PendingTransactionCreateParams =

data/rbi/increase/resources/ach_transfers.rbi

@@ -3,7 +3,12 @@
 module Increase
   module Resources
     class ACHTransfers
-      # Create an ACH Transfer
+      # An ACH Transfer has two primary descriptive fields:
+      # [`company_name`](/documentation/api/ach-transfers#create-an-ach-transfer.company_name)
+      # and
+      # [`individual_name`](/documentation/api/ach-transfers#create-an-ach-transfer.individual_name).
+      # You should set both of these, in addition to the required amount and account
+      # fields.
       sig do
         params(
           account_id: String,
@@ -31,11 +36,16 @@ module Increase
         ).returns(Increase::ACHTransfer)
       end
       def create(
-        # The Increase identifier for the account that will send the transfer.
+        # The Increase identifier for the account that will originate the transfer. For
+        # credit transfers (transfers with a positive `amount`), this is the account that
+        # funds will be sent from. For debit transfers (transfers with a negative
+        # `amount`), this is the account that funds will be pulled into.
         account_id:,
         # The transfer amount in USD cents. A positive amount originates a credit transfer
-        # pushing funds to the receiving account. A negative amount originates a debit
-        # transfer pulling funds from the receiving account.
+        # pushing funds from Increase to the account at the other bank. A negative amount
+        # originates a debit transfer pulling funds from the account at the other bank
+        # 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
@@ -44,9 +54,10 @@ module Increase
         # 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 receiver's account number. For credit transfers (positive `amount`) this is
-        # the account that funds will be sent to. For debit transfers (negative `amount`)
-        # this is the account that funds will be pulled from.
+        # 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
+        # pulled from.
         account_number: nil,
         # Additional information passed through to the receiving bank with the transfer.
         # Most ACH transfers do not need this. Only set this if your recipient has asked
@@ -57,19 +68,24 @@ module Increase
         # batch header. This value is informational and does not affect funds movement,
         # settlement timing, or returns. Only set this if your recipient has asked for it.
         company_descriptive_date: nil,
-        # Custom data sent in the company batch header. This value is informational and
-        # does not affect funds movement, settlement timing, or returns. Most ACH
-        # transfers do not need this. Only set this if your recipient has asked for it.
+        # Custom data sent in the company batch header, meant as metadata for the
+        # originator. This value is informational and does not affect funds movement,
+        # settlement timing, or returns. Most ACH transfers do not need this; we recommend
+        # storing metadata in your own application instead.
         company_discretionary_data: nil,
-        # A short description sent in the company batch header. Most receivers do not
-        # surface this. Only set this if your recipient has asked for a specific value or
-        # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
-        # example, Prearranged Payment and Deposit (PPD) payroll credits must use
-        # `PAYROLL`, and reversals must use `REVERSAL`.
+        # A short description sent in the company batch header, meant to provide the
+        # receiver with a reason for the transfer. Many receivers do not surface this data
+        # on the receiver's bank statement. Only set this if your recipient has asked for
+        # a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
+        # 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 you, sent in the company batch header. We
-        # recommend setting this on every transfer; if you do not, we fall back to the
-        # `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: nil,
         # The type of entity that owns the receiver's account.
         destination_account_holder: nil,
@@ -80,11 +96,15 @@ module Increase
         #
         # Defaults to `checking`.
         funding: nil,
-        # Your internal identifier for the transfer recipient. This value is informational
-        # and not verified by the recipient's bank. Most callers can leave this unset.
+        # Your internal identifier for the recipient. This value is informational and
+        # generally not verified by the recipient's bank. Most callers can leave this
+        # 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 not verified
-        # by the recipient's bank.
+        # 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

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/wire_drawdown_requests.rbi

@@ -8,12 +8,21 @@ module Increase
         sig do
           params(
             wire_drawdown_request_id: String,
+            refusal_reason_additional_information: String,
+            refusal_reason_code:
+              Increase::Simulations::WireDrawdownRequestRefuseParams::RefusalReasonCode::OrSymbol,
             request_options: Increase::RequestOptions::OrHash
           ).returns(Increase::WireDrawdownRequest)
         end
         def refuse(
           # The identifier of the Wire Drawdown Request you wish to refuse.
           wire_drawdown_request_id,
+          # Additional information about the refusal that the simulated refusal will have.
+          refusal_reason_additional_information: nil,
+          # The reason code that the simulated refusal will have.
+          #
+          # Defaults to `other`.
+          refusal_reason_code: nil,
           request_options: {}
         )
         end

data/sig/increase/client.rbs

@@ -115,14 +115,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/internal/util.rbs

@@ -137,7 +137,7 @@ module Increase
 
       def self?.encode_multipart_streaming: (
         top body
-      ) -> [String, Enumerable[String]]
+      ) -> [String, (^-> Enumerable[String])]
 
       def self?.encode_content: (
         ::Hash[String, String] headers,

data/sig/increase/models/ach_transfer.rbs

@@ -33,7 +33,7 @@ module Increase
         routing_number: String,
         settlement: Increase::ACHTransfer::Settlement?,
         standard_entry_class_code: Increase::Models::ACHTransfer::standard_entry_class_code,
-        statement_descriptor: String,
+        statement_descriptor: String?,
         status: Increase::Models::ACHTransfer::status,
         submission: Increase::ACHTransfer::Submission?,
         transaction_id: String?,
@@ -103,7 +103,7 @@ module Increase
 
       attr_accessor standard_entry_class_code: Increase::Models::ACHTransfer::standard_entry_class_code
 
-      attr_accessor statement_descriptor: String
+      attr_accessor statement_descriptor: String?
 
       attr_accessor status: Increase::Models::ACHTransfer::status
 
@@ -145,7 +145,7 @@ module Increase
         routing_number: String,
         settlement: Increase::ACHTransfer::Settlement?,
         standard_entry_class_code: Increase::Models::ACHTransfer::standard_entry_class_code,
-        statement_descriptor: String,
+        statement_descriptor: String?,
         status: Increase::Models::ACHTransfer::status,
         submission: Increase::ACHTransfer::Submission?,
         transaction_id: String?,
@@ -184,7 +184,7 @@ module Increase
         routing_number: String,
         settlement: Increase::ACHTransfer::Settlement?,
         standard_entry_class_code: Increase::Models::ACHTransfer::standard_entry_class_code,
-        statement_descriptor: String,
+        statement_descriptor: String?,
         status: Increase::Models::ACHTransfer::status,
         submission: Increase::ACHTransfer::Submission?,
         transaction_id: String?,

data/sig/increase/models/check_transfer.rbs

@@ -295,10 +295,10 @@ module Increase
           mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress,
           memo: String?,
           note: String?,
+          payee: ::Array[Increase::CheckTransfer::PhysicalCheck::Payee],
           payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
           physical_check_batch_id: String?,
-          recipient_name: String,
-          return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?,
+          return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress,
           return_address_name: String?,
           shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransfer::PhysicalCheck::Signature,
@@ -316,13 +316,13 @@ module Increase
 
         attr_accessor note: String?
 
+        attr_accessor payee: ::Array[Increase::CheckTransfer::PhysicalCheck::Payee]
+
         attr_accessor payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer]
 
         attr_accessor physical_check_batch_id: String?
 
-        attr_accessor recipient_name: String
-
-        attr_accessor return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?
+        attr_accessor return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress
 
         attr_accessor return_address_name: String?
 
@@ -338,10 +338,10 @@ module Increase
           mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress,
           memo: String?,
           note: String?,
+          payee: ::Array[Increase::CheckTransfer::PhysicalCheck::Payee],
           payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
           physical_check_batch_id: String?,
-          recipient_name: String,
-          return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?,
+          return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress,
           return_address_name: String?,
           shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransfer::PhysicalCheck::Signature,
@@ -354,10 +354,10 @@ module Increase
           mailing_address: Increase::CheckTransfer::PhysicalCheck::MailingAddress,
           memo: String?,
           note: String?,
+          payee: ::Array[Increase::CheckTransfer::PhysicalCheck::Payee],
           payer: ::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
           physical_check_batch_id: String?,
-          recipient_name: String,
-          return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress?,
+          return_address: Increase::CheckTransfer::PhysicalCheck::ReturnAddress,
           return_address_name: String?,
           shipping_method: Increase::Models::CheckTransfer::PhysicalCheck::shipping_method,
           signature: Increase::CheckTransfer::PhysicalCheck::Signature,
@@ -366,51 +366,61 @@ module Increase
 
         type mailing_address =
           {
-            city: String?,
-            :line1 => String?,
+            city: String,
+            :line1 => String,
             :line2 => String?,
-            name: String?,
+            name: String,
             phone: String?,
-            postal_code: String?,
-            state: String?
+            postal_code: String,
+            state: String
           }
 
         class MailingAddress < Increase::Internal::Type::BaseModel
-          attr_accessor city: String?
+          attr_accessor city: String
 
-          attr_accessor line1: String?
+          attr_accessor line1: String
 
           attr_accessor line2: String?
 
-          attr_accessor name: String?
+          attr_accessor name: String
 
           attr_accessor phone: String?
 
-          attr_accessor postal_code: String?
+          attr_accessor postal_code: String
 
-          attr_accessor state: String?
+          attr_accessor state: String
 
           def initialize: (
-            city: String?,
-            line1: String?,
+            city: String,
+            line1: String,
             line2: String?,
-            name: String?,
+            name: String,
             phone: String?,
-            postal_code: String?,
-            state: String?
+            postal_code: String,
+            state: String
           ) -> void
 
           def to_hash: -> {
-            city: String?,
-            :line1 => String?,
+            city: String,
+            :line1 => String,
             :line2 => String?,
-            name: String?,
+            name: String,
             phone: String?,
-            postal_code: String?,
-            state: String?
+            postal_code: String,
+            state: String
           }
         end
 
+        type payee = { contents: String }
+
+        class Payee < Increase::Internal::Type::BaseModel
+          attr_accessor contents: String
+
+          def initialize: (contents: String) -> void
+
+          def to_hash: -> { contents: String }
+        end
+
         type payer = { contents: String }
 
         class Payer < Increase::Internal::Type::BaseModel
@@ -423,48 +433,48 @@ module Increase
 
         type return_address =
           {
-            city: String?,
-            :line1 => String?,
+            city: String,
+            :line1 => String,
             :line2 => String?,
-            name: String?,
+            name: String,
             phone: String?,
-            postal_code: String?,
-            state: String?
+            postal_code: String,
+            state: String
           }
 
         class ReturnAddress < Increase::Internal::Type::BaseModel
-          attr_accessor city: String?
+          attr_accessor city: String
 
-          attr_accessor line1: String?
+          attr_accessor line1: String
 
           attr_accessor line2: String?
 
-          attr_accessor name: String?
+          attr_accessor name: String
 
           attr_accessor phone: String?
 
-          attr_accessor postal_code: String?
+          attr_accessor postal_code: String
 
-          attr_accessor state: String?
+          attr_accessor state: String
 
           def initialize: (
-            city: String?,
-            line1: String?,
+            city: String,
+            line1: String,
             line2: String?,
-            name: String?,
+            name: String,
             phone: String?,
-            postal_code: String?,
-            state: String?
+            postal_code: String,
+            state: String
           ) -> void
 
           def to_hash: -> {
-            city: String?,
-            :line1 => String?,
+            city: String,
+            :line1 => String,
             :line2 => String?,
-            name: String?,
+            name: String,
             phone: String?,
-            postal_code: String?,
-            state: String?
+            postal_code: String,
+            state: String
           }
         end