increase 1.361.0 → 1.363.0

data/rbi/increase/models/ach_transfer_create_params.rbi

@@ -11,13 +11,18 @@ module Increase
           T.any(Increase::ACHTransferCreateParams, Increase::Internal::AnyHash)
         end
 
-      # 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.
       sig { returns(String) }
       attr_accessor :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).
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -30,9 +35,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :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.
       sig { returns(T.nilable(String)) }
       attr_reader :account_number
 
@@ -60,29 +66,34 @@ module Increase
       sig { params(company_descriptive_date: String).void }
       attr_writer :company_descriptive_date
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_reader :company_discretionary_data
 
       sig { params(company_discretionary_data: String).void }
       attr_writer :company_discretionary_data
 
-      # 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`.
       sig { returns(T.nilable(String)) }
       attr_reader :company_entry_description
 
       sig { params(company_entry_description: String).void }
       attr_writer :company_entry_description
 
-      # 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`.
       sig { returns(T.nilable(String)) }
       attr_reader :company_name
 
@@ -130,16 +141,20 @@ module Increase
       end
       attr_writer :funding
 
-      # 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.
       sig { returns(T.nilable(String)) }
       attr_reader :individual_id
 
       sig { params(individual_id: String).void }
       attr_writer :individual_id
 
-      # 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`.
       sig { returns(T.nilable(String)) }
       attr_reader :individual_name
 
@@ -228,11 +243,16 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # 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
@@ -241,9 +261,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
@@ -254,19 +275,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,
@@ -277,11 +303,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/models/check_transfer.rbi

@@ -790,8 +790,13 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :note
 
+        # The payee of the check. This will be printed in the Pay to the Order Of portion
+        # of the check.
+        sig { returns(T::Array[Increase::CheckTransfer::PhysicalCheck::Payee]) }
+        attr_accessor :payee
+
         # The payer of the check. This will be printed on the top-left portion of the
-        # check and defaults to the return address if unspecified.
+        # check.
         sig { returns(T::Array[Increase::CheckTransfer::PhysicalCheck::Payer]) }
         attr_accessor :payer
 
@@ -799,24 +804,14 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :physical_check_batch_id
 
-        # The name that will be printed on the check.
-        sig { returns(String) }
-        attr_accessor :recipient_name
-
         # The return address to be printed on the check.
-        sig do
-          returns(
-            T.nilable(Increase::CheckTransfer::PhysicalCheck::ReturnAddress)
-          )
-        end
+        sig { returns(Increase::CheckTransfer::PhysicalCheck::ReturnAddress) }
         attr_reader :return_address
 
         sig do
           params(
             return_address:
-              T.nilable(
-                Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
-              )
+              Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
           ).void
         end
         attr_writer :return_address
@@ -863,14 +858,13 @@ module Increase
               Increase::CheckTransfer::PhysicalCheck::MailingAddress::OrHash,
             memo: T.nilable(String),
             note: T.nilable(String),
+            payee:
+              T::Array[Increase::CheckTransfer::PhysicalCheck::Payee::OrHash],
             payer:
               T::Array[Increase::CheckTransfer::PhysicalCheck::Payer::OrHash],
             physical_check_batch_id: T.nilable(String),
-            recipient_name: String,
             return_address:
-              T.nilable(
-                Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
-              ),
+              Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash,
             return_address_name: T.nilable(String),
             shipping_method:
               Increase::CheckTransfer::PhysicalCheck::ShippingMethod::OrSymbol,
@@ -893,13 +887,14 @@ module Increase
           memo:,
           # The descriptor that will be printed on the letter included with the check.
           note:,
+          # The payee of the check. This will be printed in the Pay to the Order Of portion
+          # of the check.
+          payee:,
           # The payer of the check. This will be printed on the top-left portion of the
-          # check and defaults to the return address if unspecified.
+          # check.
           payer:,
           # The identifier of the Physical Check Batch that this check is a part of.
           physical_check_batch_id:,
-          # The name that will be printed on the check.
-          recipient_name:,
           # The return address to be printed on the check.
           return_address:,
           # A custom name printed above the Increase-managed return address.
@@ -923,13 +918,11 @@ module Increase
                 Increase::CheckTransfer::PhysicalCheck::MailingAddress,
               memo: T.nilable(String),
               note: T.nilable(String),
+              payee: T::Array[Increase::CheckTransfer::PhysicalCheck::Payee],
               payer: T::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
               physical_check_batch_id: T.nilable(String),
-              recipient_name: String,
               return_address:
-                T.nilable(
-                  Increase::CheckTransfer::PhysicalCheck::ReturnAddress
-                ),
+                Increase::CheckTransfer::PhysicalCheck::ReturnAddress,
               return_address_name: T.nilable(String),
               shipping_method:
                 Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol,
@@ -952,11 +945,11 @@ module Increase
             end
 
           # The city of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :city
 
           # The street address of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :line1
 
           # The second line of the address of the check's destination.
@@ -964,7 +957,7 @@ module Increase
           attr_accessor :line2
 
           # The name component of the check's mailing address.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :name
 
           # The phone number to be used in case of delivery issues at the check's mailing
@@ -973,23 +966,23 @@ module Increase
           attr_accessor :phone
 
           # The postal code of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :postal_code
 
           # The state of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :state
 
           # Details for where Increase will mail the check.
           sig do
             params(
-              city: T.nilable(String),
-              line1: T.nilable(String),
+              city: String,
+              line1: String,
               line2: T.nilable(String),
-              name: T.nilable(String),
+              name: String,
               phone: T.nilable(String),
-              postal_code: T.nilable(String),
-              state: T.nilable(String)
+              postal_code: String,
+              state: String
             ).returns(T.attached_class)
           end
           def self.new(
@@ -1014,13 +1007,13 @@ module Increase
           sig do
             override.returns(
               {
-                city: T.nilable(String),
-                line1: T.nilable(String),
+                city: String,
+                line1: String,
                 line2: T.nilable(String),
-                name: T.nilable(String),
+                name: String,
                 phone: T.nilable(String),
-                postal_code: T.nilable(String),
-                state: T.nilable(String)
+                postal_code: String,
+                state: String
               }
             )
           end
@@ -1028,6 +1021,31 @@ module Increase
           end
         end
 
+        class Payee < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::CheckTransfer::PhysicalCheck::Payee,
+                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
+
         class Payer < Increase::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -1063,11 +1081,11 @@ module Increase
             end
 
           # The city of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :city
 
           # The street address of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :line1
 
           # The second line of the address of the check's destination.
@@ -1075,7 +1093,7 @@ module Increase
           attr_accessor :line2
 
           # The name component of the check's return address.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :name
 
           # The shipper's phone number to be used in case of delivery issues. Only used for
@@ -1084,23 +1102,23 @@ module Increase
           attr_accessor :phone
 
           # The postal code of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :postal_code
 
           # The state of the check's destination.
-          sig { returns(T.nilable(String)) }
+          sig { returns(String) }
           attr_accessor :state
 
           # The return address to be printed on the check.
           sig do
             params(
-              city: T.nilable(String),
-              line1: T.nilable(String),
+              city: String,
+              line1: String,
               line2: T.nilable(String),
-              name: T.nilable(String),
+              name: String,
               phone: T.nilable(String),
-              postal_code: T.nilable(String),
-              state: T.nilable(String)
+              postal_code: String,
+              state: String
             ).returns(T.attached_class)
           end
           def self.new(
@@ -1125,13 +1143,13 @@ module Increase
           sig do
             override.returns(
               {
-                city: T.nilable(String),
-                line1: T.nilable(String),
+                city: String,
+                line1: String,
                 line2: T.nilable(String),
-                name: T.nilable(String),
+                name: String,
                 phone: T.nilable(String),
-                postal_code: T.nilable(String),
-                state: T.nilable(String)
+                postal_code: String,
+                state: String
               }
             )
           end

data/rbi/increase/models/check_transfer_create_params.rbi

@@ -289,6 +289,16 @@ module Increase
         sig { returns(String) }
         attr_accessor :memo
 
+        # The payee of the check. This will be printed in the Pay to the Order Of portion
+        # of the check. This should be an array of up to 4 elements, each of which
+        # represents a line of the payee.
+        sig do
+          returns(
+            T::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payee]
+          )
+        end
+        attr_accessor :payee
+
         # The payer of the check. This will be printed on the top-left portion of the
         # check. This should be an array of up to 4 elements, each of which represents a
         # line of the payer.
@@ -299,10 +309,6 @@ module Increase
         end
         attr_accessor :payer
 
-        # The name that will be printed on the check in the 'To:' field.
-        sig { returns(String) }
-        attr_accessor :recipient_name
-
         # The ID of a File to be attached to the check. This must have
         # `purpose: check_attachment`. For details on pricing and restrictions, see
         # https://increase.com/documentation/originating-checks#printing-checks .
@@ -412,11 +418,14 @@ module Increase
             mailing_address:
               Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress::OrHash,
             memo: String,
+            payee:
+              T::Array[
+                Increase::CheckTransferCreateParams::PhysicalCheck::Payee::OrHash
+              ],
             payer:
               T::Array[
                 Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
               ],
-            recipient_name: String,
             attachment_file_id: String,
             check_voucher_image_file_id: String,
             note: String,
@@ -436,12 +445,14 @@ module Increase
           mailing_address:,
           # The descriptor that will be printed on the memo field on the check.
           memo:,
+          # The payee of the check. This will be printed in the Pay to the Order Of portion
+          # of the check. This should be an array of up to 4 elements, each of which
+          # represents a line of the payee.
+          payee:,
           # The payer of the check. This will be printed on the top-left portion of the
           # check. This should be an array of up to 4 elements, each of which represents a
           # line of the payer.
           payer:,
-          # The name that will be printed on the check in the 'To:' field.
-          recipient_name:,
           # The ID of a File to be attached to the check. This must have
           # `purpose: check_attachment`. For details on pricing and restrictions, see
           # https://increase.com/documentation/originating-checks#printing-checks .
@@ -479,11 +490,14 @@ module Increase
               mailing_address:
                 Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
               memo: String,
+              payee:
+                T::Array[
+                  Increase::CheckTransferCreateParams::PhysicalCheck::Payee
+                ],
               payer:
                 T::Array[
                   Increase::CheckTransferCreateParams::PhysicalCheck::Payer
                 ],
-              recipient_name: String,
               attachment_file_id: String,
               check_voucher_image_file_id: String,
               note: String,
@@ -518,6 +532,10 @@ module Increase
           sig { returns(String) }
           attr_accessor :line1
 
+          # The name component of the check's destination address.
+          sig { returns(String) }
+          attr_accessor :name
+
           # The postal code component of the check's destination address.
           sig { returns(String) }
           attr_accessor :postal_code
@@ -533,14 +551,6 @@ module Increase
           sig { params(line2: String).void }
           attr_writer :line2
 
-          # The name component of the check's destination address. Defaults to the provided
-          # `recipient_name` parameter if `name` is not provided.
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
           # The phone number to associate with the check's destination address. The phone
           # number is only used when `shipping_method` is `fedex_overnight` and will be
           # supplied to FedEx to be used in case of delivery issues.
@@ -556,10 +566,10 @@ module Increase
             params(
               city: String,
               line1: String,
+              name: String,
               postal_code: String,
               state: String,
               line2: String,
-              name: String,
               phone: String
             ).returns(T.attached_class)
           end
@@ -568,15 +578,14 @@ module Increase
             city:,
             # The first line of the address component of the check's destination address.
             line1:,
+            # The name component of the check's destination address.
+            name:,
             # The postal code component of the check's destination address.
             postal_code:,
             # The US state component of the check's destination address.
             state:,
             # The second line of the address component of the check's destination address.
             line2: nil,
-            # The name component of the check's destination address. Defaults to the provided
-            # `recipient_name` parameter if `name` is not provided.
-            name: nil,
             # The phone number to associate with the check's destination address. The phone
             # number is only used when `shipping_method` is `fedex_overnight` and will be
             # supplied to FedEx to be used in case of delivery issues.
@@ -589,10 +598,10 @@ module Increase
               {
                 city: String,
                 line1: String,
+                name: String,
                 postal_code: String,
                 state: String,
                 line2: String,
-                name: String,
                 phone: String
               }
             )
@@ -601,6 +610,31 @@ module Increase
           end
         end
 
+        class Payee < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::CheckTransferCreateParams::PhysicalCheck::Payee,
+                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
+
         class Payer < Increase::Internal::Type::BaseModel
           OrHash =
             T.type_alias do