feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 255
-openapi_spec_hash: 31dbb51b621eeb3886e4e430fe825146
+openapi_spec_hash: 4e105ef004f4e45b77ab69e64165b710
 config_hash: de151ebd21a0bd391662389b310a8f49

lib/increase/models/ach_transfer.rb

@@ -59,25 +59,34 @@ class ACHTransfer < Increase::Internal::Type::BaseModel
       required :cancellation, -> { Increase::ACHTransfer::Cancellation }, nil?: true
 
       # @!attribute company_descriptive_date
-      #   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.
       #
       #   @return [String, nil]
       required :company_descriptive_date, String, nil?: true
 
       # @!attribute company_discretionary_data
-      #   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.
       #
       #   @return [String, nil]
       required :company_discretionary_data, String, nil?: true
 
       # @!attribute company_entry_description
-      #   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.
       #
       #   @return [String, nil]
       required :company_entry_description, String, nil?: true
 
       # @!attribute company_id
-      #   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.
       #
       #   @return [String]
       required :company_id, String
@@ -179,10 +188,8 @@ class ACHTransfer < Increase::Internal::Type::BaseModel
       required :pending_transaction_id, String, nil?: true
 
       # @!attribute preferred_effective_date
-      #   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.
       #
       #   @return [Increase::Models::ACHTransfer::PreferredEffectiveDate]
       required :preferred_effective_date, -> { Increase::ACHTransfer::PreferredEffectiveDate }
@@ -218,8 +225,8 @@ class ACHTransfer < Increase::Internal::Type::BaseModel
       # @!attribute statement_descriptor
       #   The descriptor that will show on the recipient's bank statement.
       #
-      #   @return [String]
-      required :statement_descriptor, String
+      #   @return [String, nil]
+      required :statement_descriptor, String, nil?: true
 
       # @!attribute status
       #   The lifecycle status of the transfer.
@@ -281,14 +288,26 @@ class ACHTransfer < Increase::Internal::Type::BaseModel
       #     If your account requires approvals for transfers and the transfer was not
       #     approved, this will contain details of the cancellation.
       #
-      #   @param company_descriptive_date [String, nil] The description of the date of the transfer.
+      #   @param company_descriptive_date [String, nil]
+      #     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.
       #
-      #   @param company_discretionary_data [String, nil] The data you chose to associate with the transfer.
+      #   @param company_discretionary_data [String, nil]
+      #     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.
       #
       #   @param company_entry_description [String, nil]
-      #     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.
       #
-      #   @param company_id [String] The company ID associated with the transfer.
+      #   @param company_id [String]
+      #     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.
       #
       #   @param company_name [String, nil] The name by which the recipient knows you.
       #
@@ -341,10 +360,8 @@ class ACHTransfer < Increase::Internal::Type::BaseModel
       #     by someone else in your organization.
       #
       #   @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate]
-      #     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.
       #
       #   @param return_ [Increase::Models::ACHTransfer::Return, nil]
       #     If your transfer is returned, this will contain details of the return.
@@ -362,7 +379,7 @@ class ACHTransfer < Increase::Internal::Type::BaseModel
       #     [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
       #     to use for the transfer.
       #
-      #   @param statement_descriptor [String] The descriptor that will show on the recipient's bank statement.
+      #   @param statement_descriptor [String, nil] The descriptor that will show on the recipient's bank statement.
       #
       #   @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
       #
@@ -1069,10 +1086,8 @@ class PreferredEffectiveDate < Increase::Internal::Type::BaseModel
                  nil?: true
 
         # @!method initialize(date:, 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.
         #
         #   @param date [Date, nil]
         #     A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to

lib/increase/models/transaction.rb

@@ -1129,8 +1129,8 @@ class ACHTransferIntention < Increase::Internal::Type::BaseModel
           # @!attribute statement_descriptor
           #   A description set when the ACH Transfer was created.
           #
-          #   @return [String]
-          required :statement_descriptor, String
+          #   @return [String, nil]
+          required :statement_descriptor, String, nil?: true
 
           # @!attribute transfer_id
           #   The identifier of the ACH Transfer that led to this Transaction.
@@ -1154,7 +1154,7 @@ class ACHTransferIntention < Increase::Internal::Type::BaseModel
           #     The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
           #     destination account.
           #
-          #   @param statement_descriptor [String] A description set when the ACH Transfer was created.
+          #   @param statement_descriptor [String, nil] A description set when the ACH Transfer was created.
           #
           #   @param transfer_id [String] The identifier of the ACH Transfer that led to this Transaction.
         end

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),

rbi/increase/models/transaction.rbi

@@ -2010,7 +2010,7 @@ module Increase
           attr_accessor :routing_number
 
           # A description set when the ACH Transfer was created.
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :statement_descriptor
 
           # The identifier of the ACH Transfer that led to this Transaction.
@@ -2026,7 +2026,7 @@ module Increase
               account_number: String,
               amount: Integer,
               routing_number: String,
-              statement_descriptor: String,
+              statement_descriptor: T.nilable(String),
               transfer_id: String
             ).returns(T.attached_class)
           end
@@ -2052,7 +2052,7 @@ module Increase
                 account_number: String,
                 amount: Integer,
                 routing_number: String,
-                statement_descriptor: String,
+                statement_descriptor: T.nilable(String),
                 transfer_id: String
               }
             )

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?,

sig/increase/models/transaction.rbs

@@ -567,7 +567,7 @@ module Increase
             account_number: String,
             amount: Integer,
             routing_number: String,
-            statement_descriptor: String,
+            statement_descriptor: String?,
             transfer_id: String
           }
 
@@ -578,23 +578,23 @@ module Increase
 
           attr_accessor routing_number: String
 
-          attr_accessor statement_descriptor: String
+          attr_accessor statement_descriptor: String?
 
           attr_accessor transfer_id: String
 
           def initialize: (
             account_number: String,
             amount: Integer,
             routing_number: String,
-            statement_descriptor: String,
+            statement_descriptor: String?,
             transfer_id: String
           ) -> void
 
           def to_hash: -> {
             account_number: String,
             amount: Integer,
             routing_number: String,
-            statement_descriptor: String,
+            statement_descriptor: String?,
             transfer_id: String
           }
         end