increase 1.362.0 → 1.364.0

data/rbi/increase/models/ach_transfer.rbi

@@ -73,19 +73,28 @@ module Increase
       end
       attr_writer :cancellation
 
-      # The description of the date of the transfer.
+      # A description of the transfer date (typically `YYMMDD`), sent in the company
+      # batch header. This value is informational and does not affect funds movement,
+      # settlement timing, or returns.
       sig { returns(T.nilable(String)) }
       attr_accessor :company_descriptive_date
 
-      # The data you chose to associate with the transfer.
+      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :company_discretionary_data
 
-      # The description of the transfer you set to be shown to the recipient.
+      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :company_entry_description
 
-      # The company ID associated with the transfer.
+      # The Company ID sent in the batch header, which identifies the originator to the
+      # receiving bank. Businesses use this value to allowlist the companies permitted
+      # to debit their accounts. This value is configured by Increase and will be the
+      # same for all your transfers.
       sig { returns(String) }
       attr_accessor :company_id
 
@@ -173,10 +182,8 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :pending_transaction_id
 
-      # 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
-      # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
-      # must be set.
+      # Configuration for how the effective date of the transfer was set. This
+      # determines same-day vs future-dated settlement timing.
       sig { returns(Increase::ACHTransfer::PreferredEffectiveDate) }
       attr_reader :preferred_effective_date
 
@@ -223,7 +230,7 @@ module Increase
       attr_accessor :standard_entry_class_code
 
       # The descriptor that will show on the recipient's bank statement.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :statement_descriptor
 
       # The lifecycle status of the transfer.
@@ -295,7 +302,7 @@ module Increase
           settlement: T.nilable(Increase::ACHTransfer::Settlement::OrHash),
           standard_entry_class_code:
             Increase::ACHTransfer::StandardEntryClassCode::OrSymbol,
-          statement_descriptor: String,
+          statement_descriptor: T.nilable(String),
           status: Increase::ACHTransfer::Status::OrSymbol,
           submission: T.nilable(Increase::ACHTransfer::Submission::OrHash),
           transaction_id: T.nilable(String),
@@ -325,13 +332,22 @@ module Increase
         # If your account requires approvals for transfers and the transfer was not
         # approved, this will contain details of the cancellation.
         cancellation:,
-        # The description of the date of the transfer.
+        # A description of the transfer date (typically `YYMMDD`), sent in the company
+        # batch header. This value is informational and does not affect funds movement,
+        # settlement timing, or returns.
         company_descriptive_date:,
-        # The data you chose to associate with the transfer.
+        # 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.
         company_discretionary_data:,
-        # The description of the transfer you set to be shown to the recipient.
+        # 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.
         company_entry_description:,
-        # The company ID associated with the transfer.
+        # The Company ID sent in the batch header, which identifies the originator to the
+        # receiving bank. Businesses use this value to allowlist the companies permitted
+        # to debit their accounts. This value is configured by Increase and will be the
+        # same for all your transfers.
         company_id:,
         # The name by which the recipient knows you.
         company_name:,
@@ -372,10 +388,8 @@ module Increase
         # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
         # by someone else in your organization.
         pending_transaction_id:,
-        # 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
-        # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
-        # must be set.
+        # Configuration for how the effective date of the transfer was set. This
+        # determines same-day vs future-dated settlement timing.
         preferred_effective_date:,
         # If your transfer is returned, this will contain details of the return.
         return_:,
@@ -446,7 +460,7 @@ module Increase
             settlement: T.nilable(Increase::ACHTransfer::Settlement),
             standard_entry_class_code:
               Increase::ACHTransfer::StandardEntryClassCode::TaggedSymbol,
-            statement_descriptor: String,
+            statement_descriptor: T.nilable(String),
             status: Increase::ACHTransfer::Status::TaggedSymbol,
             submission: T.nilable(Increase::ACHTransfer::Submission),
             transaction_id: T.nilable(String),
@@ -1730,10 +1744,8 @@ module Increase
         end
         attr_accessor :settlement_schedule
 
-        # 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
-        # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
-        # must be set.
+        # Configuration for how the effective date of the transfer was set. This
+        # determines same-day vs future-dated settlement timing.
         sig do
           params(
             date: T.nilable(Date),

data/rbi/increase/models/card_payment.rbi

@@ -18362,6 +18362,13 @@ module Increase
                     Increase::CardPayment::Element::CardRefund::PurchaseDetails::Fleet::FuelType::TaggedSymbol
                   )
 
+                # Diesel 1 off-road non-taxable
+                DIESEL_1_OFF_ROAD_NON_TAXABLE =
+                  T.let(
+                    :diesel_1_off_road_non_taxable,
+                    Increase::CardPayment::Element::CardRefund::PurchaseDetails::Fleet::FuelType::TaggedSymbol
+                  )
+
                 # Renewable diesel R95 or greater off-road non-taxable
                 RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
                   T.let(
@@ -23209,6 +23216,13 @@ module Increase
                     Increase::CardPayment::Element::CardSettlement::PurchaseDetails::Fleet::FuelType::TaggedSymbol
                   )
 
+                # Diesel 1 off-road non-taxable
+                DIESEL_1_OFF_ROAD_NON_TAXABLE =
+                  T.let(
+                    :diesel_1_off_road_non_taxable,
+                    Increase::CardPayment::Element::CardSettlement::PurchaseDetails::Fleet::FuelType::TaggedSymbol
+                  )
+
                 # Renewable diesel R95 or greater off-road non-taxable
                 RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
                   T.let(

data/rbi/increase/models/card_update_params.rbi

@@ -1282,21 +1282,17 @@ module Increase
         attr_writer :digital_card_profile_id
 
         # An email address that can be used to verify the cardholder via one-time passcode
-        # over email.
+        # over email. Send `null` to clear the email address. Omit this field to leave it
+        # unchanged.
         sig { returns(T.nilable(String)) }
-        attr_reader :email
-
-        sig { params(email: String).void }
-        attr_writer :email
+        attr_accessor :email
 
         # A phone number that can be used to verify the cardholder via one-time passcode
         # over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
-        # `(415) 555-0123`.
+        # `(415) 555-0123`. Send `null` to clear the phone number. Omit this field to
+        # leave it unchanged.
         sig { returns(T.nilable(String)) }
-        attr_reader :phone
-
-        sig { params(phone: String).void }
-        attr_writer :phone
+        attr_accessor :phone
 
         # The contact information used in the two-factor steps for digital wallet card
         # creation. At least one field must be present to complete the digital wallet
@@ -1304,26 +1300,32 @@ module Increase
         sig do
           params(
             digital_card_profile_id: String,
-            email: String,
-            phone: String
+            email: T.nilable(String),
+            phone: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
           # The digital card profile assigned to this digital card.
           digital_card_profile_id: nil,
           # An email address that can be used to verify the cardholder via one-time passcode
-          # over email.
+          # over email. Send `null` to clear the email address. Omit this field to leave it
+          # unchanged.
           email: nil,
           # A phone number that can be used to verify the cardholder via one-time passcode
           # over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
-          # `(415) 555-0123`.
+          # `(415) 555-0123`. Send `null` to clear the phone number. Omit this field to
+          # leave it unchanged.
           phone: nil
         )
         end
 
         sig do
           override.returns(
-            { digital_card_profile_id: String, email: String, phone: String }
+            {
+              digital_card_profile_id: String,
+              email: T.nilable(String),
+              phone: T.nilable(String)
+            }
           )
         end
         def to_hash

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