feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 254
-openapi_spec_hash: 55fb271eb29805e8a49ed72fb5ed8843
+openapi_spec_hash: d641ea64d1228471a4e91126cebd8600
 config_hash: f0e1844d06c76a9e145f7986d993dda6

lib/increase/models/account_statement.rb

@@ -50,17 +50,19 @@ class AccountStatement < Increase::Internal::Type::BaseModel
       # @!attribute statement_period_end
       #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
       #   of the period the Account Statement covers. The statement covers all
-      #   transactions up to, but not including this timestamp. Usually, this is the
-      #   beginning of the following month.
+      #   transactions up to, but not including this timestamp. Statement periods are
+      #   measured in UTC days, so this is usually midnight UTC on the first day of the
+      #   following month.
       #
       #   @return [Time]
       required :statement_period_end, Time
 
       # @!attribute statement_period_start
       #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
       #   start of the period the Account Statement covers. This is the first moment of
-      #   the statement period and is inclusive. Usually, this is the beginning of the
-      #   month this statement covers.
+      #   the statement period and is inclusive. Statement periods are measured in UTC
+      #   days, so this is usually midnight UTC on the first day of the month this
+      #   statement covers.
       #
       #   @return [Time]
       required :statement_period_start, Time
@@ -96,14 +98,16 @@ class AccountStatement < Increase::Internal::Type::BaseModel
       #   @param statement_period_end [Time]
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
       #     of the period the Account Statement covers. The statement covers all
-      #     transactions up to, but not including this timestamp. Usually, this is the
-      #     beginning of the following month.
+      #     transactions up to, but not including this timestamp. Statement periods are
+      #     measured in UTC days, so this is usually midnight UTC on the first day of the
+      #     following month.
       #
       #   @param statement_period_start [Time]
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
       #     start of the period the Account Statement covers. This is the first moment of
-      #     the statement period and is inclusive. Usually, this is the beginning of the
-      #     month this statement covers.
+      #     the statement period and is inclusive. Statement periods are measured in UTC
+      #     days, so this is usually midnight UTC on the first day of the month this
+      #     statement covers.
       #
       #   @param type [Symbol, Increase::Models::AccountStatement::Type]
       #     A constant representing the object's type. For this resource it will always be

lib/increase/models/export.rb

@@ -257,7 +257,7 @@ class AccountStatementBai2 < Increase::Internal::Type::BaseModel
         required :account_id, String, nil?: true
 
         # @!attribute effective_date
-        #   The date for which to retrieve the balance.
+        #   The UTC date for which to retrieve the balance.
         #
         #   @return [Date, nil]
         required :effective_date, Date, nil?: true
@@ -274,7 +274,7 @@ class AccountStatementBai2 < Increase::Internal::Type::BaseModel
         #
         #   @param account_id [String, nil] Filter results by Account.
         #
-        #   @param effective_date [Date, nil] The date for which to retrieve the balance.
+        #   @param effective_date [Date, nil] The UTC date for which to retrieve the balance.
         #
         #   @param program_id [String, nil] Filter results by Program.
       end
@@ -334,7 +334,7 @@ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
         required :account_number_id, String
 
         # @!attribute balance_date
-        #   The date of the balance to include in the letter.
+        #   The UTC date of the balance to include in the letter.
         #
         #   @return [Date, nil]
         required :balance_date, Date, nil?: true
@@ -345,7 +345,7 @@ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
         #
         #   @param account_number_id [String] The Account Number to create a letter for.
         #
-        #   @param balance_date [Date, nil] The date of the balance to include in the letter.
+        #   @param balance_date [Date, nil] The UTC date of the balance to include in the letter.
       end
 
       # @see Increase::Models::Export#balance_csv
@@ -403,13 +403,13 @@ class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
         required :bookkeeping_account_id, String, nil?: true
 
         # @!attribute on_or_after_date
-        #   Filter balances to those on or after this date.
+        #   Filter balances to those on or after this UTC date.
         #
         #   @return [Date, nil]
         required :on_or_after_date, Date, nil?: true
 
         # @!attribute on_or_before_date
-        #   Filter balances to those on or before this date.
+        #   Filter balances to those on or before this UTC date.
         #
         #   @return [Date, nil]
         required :on_or_before_date, Date, nil?: true
@@ -420,9 +420,9 @@ class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
         #
         #   @param bookkeeping_account_id [String, nil] Filter results by Bookkeeping Account.
         #
-        #   @param on_or_after_date [Date, nil] Filter balances to those on or after this date.
+        #   @param on_or_after_date [Date, nil] Filter balances to those on or after this UTC date.
         #
-        #   @param on_or_before_date [Date, nil] Filter balances to those on or before this date.
+        #   @param on_or_before_date [Date, nil] Filter balances to those on or before this UTC date.
       end
 
       # The category of the Export. We may add additional possible values for this enum
@@ -490,13 +490,13 @@ class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
         required :account_id, String, nil?: true
 
         # @!attribute on_or_after_date
-        #   Filter balances on or after this date.
+        #   Filter balances on or after this UTC date.
         #
         #   @return [Date, nil]
         required :on_or_after_date, Date, nil?: true
 
         # @!attribute on_or_before_date
-        #   Filter balances on or before this date.
+        #   Filter balances on or before this UTC date.
         #
         #   @return [Date, nil]
         required :on_or_before_date, Date, nil?: true
@@ -507,9 +507,9 @@ class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
         #
         #   @param account_id [String, nil] Filter results by Account.
         #
-        #   @param on_or_after_date [Date, nil] Filter balances on or after this date.
+        #   @param on_or_after_date [Date, nil] Filter balances on or after this UTC date.
         #
-        #   @param on_or_before_date [Date, nil] Filter balances on or before this date.
+        #   @param on_or_before_date [Date, nil] Filter balances on or before this UTC date.
       end
 
       # @see Increase::Models::Export#dashboard_table_csv

lib/increase/models/export_create_params.rb

@@ -187,10 +187,9 @@ class AccountStatementBai2 < Increase::Internal::Type::BaseModel
         optional :account_id, String
 
         # @!attribute effective_date
-        #   The date to create a BAI2 report for. If not provided, the current date will be
-        #   used. The timezone is UTC. If the current date is used, the report will include
-        #   intraday balances, otherwise it will include end-of-day balances for the
-        #   provided date.
+        #   The UTC date to create a BAI2 report for. If not provided, the current date will
+        #   be used. If the current date is used, the report will include intraday balances,
+        #   otherwise it will include end-of-day balances for the provided date.
         #
         #   @return [Date, nil]
         optional :effective_date, Date
@@ -211,10 +210,9 @@ class AccountStatementBai2 < Increase::Internal::Type::BaseModel
         #     be included.
         #
         #   @param effective_date [Date]
-        #     The date to create a BAI2 report for. If not provided, the current date will be
-        #     used. The timezone is UTC. If the current date is used, the report will include
-        #     intraday balances, otherwise it will include end-of-day balances for the
-        #     provided date.
+        #     The UTC date to create a BAI2 report for. If not provided, the current date will
+        #     be used. If the current date is used, the report will include intraday balances,
+        #     otherwise it will include end-of-day balances for the provided date.
         #
         #   @param program_id [String]
         #     The Program to create a BAI2 report for. If not provided, all open accounts will
@@ -274,7 +272,8 @@ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
         required :account_number_id, String
 
         # @!attribute balance_date
-        #   The date of the balance to include in the letter. Defaults to the current date.
+        #   The UTC date of the balance to include in the letter. Defaults to the current
+        #   date.
         #
         #   @return [Date, nil]
         optional :balance_date, Date
@@ -285,7 +284,9 @@ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
         #
         #   @param account_number_id [String] The Account Number to create a letter for.
         #
-        #   @param balance_date [Date] The date of the balance to include in the letter. Defaults to the current date.
+        #   @param balance_date [Date]
+        #     The UTC date of the balance to include in the letter. Defaults to the current
+        #     date.
       end
 
       class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
@@ -297,13 +298,13 @@ class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
         optional :bookkeeping_account_id, String
 
         # @!attribute on_or_after_date
-        #   Filter exported Balances to those on or after this date.
+        #   Filter exported Balances to those on or after this UTC date.
         #
         #   @return [Date, nil]
         optional :on_or_after_date, Date
 
         # @!attribute on_or_before_date
-        #   Filter exported Balances to those on or before this date.
+        #   Filter exported Balances to those on or before this UTC date.
         #
         #   @return [Date, nil]
         optional :on_or_before_date, Date
@@ -316,9 +317,9 @@ class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
         #     Filter exported Bookkeeping Account Balances to the specified Bookkeeping
         #     Account.
         #
-        #   @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
+        #   @param on_or_after_date [Date] Filter exported Balances to those on or after this UTC date.
         #
-        #   @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
+        #   @param on_or_before_date [Date] Filter exported Balances to those on or before this UTC date.
       end
 
       class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
@@ -329,13 +330,13 @@ class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
         optional :account_id, String
 
         # @!attribute on_or_after_date
-        #   Filter exported Balances to those on or after this date.
+        #   Filter exported Balances to those on or after this UTC date.
         #
         #   @return [Date, nil]
         optional :on_or_after_date, Date
 
         # @!attribute on_or_before_date
-        #   Filter exported Balances to those on or before this date.
+        #   Filter exported Balances to those on or before this UTC date.
         #
         #   @return [Date, nil]
         optional :on_or_before_date, Date
@@ -346,9 +347,9 @@ class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
         #
         #   @param account_id [String] Filter exported Balances to the specified Account.
         #
-        #   @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
+        #   @param on_or_after_date [Date] Filter exported Balances to those on or after this UTC date.
         #
-        #   @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
+        #   @param on_or_before_date [Date] Filter exported Balances to those on or before this UTC date.
       end
 
       class EntityCsv < Increase::Internal::Type::BaseModel

lib/increase/models/inbound_fednow_transfer.rb

@@ -84,6 +84,12 @@ class InboundFednowTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :end_to_end_identification, String, nil?: true
 
+      # @!attribute message_identification
+      #   The FedNow network identification of the transfer.
+      #
+      #   @return [String]
+      required :message_identification, String
+
       # @!attribute status
       #   The lifecycle status of the transfer.
       #
@@ -98,7 +104,7 @@ class InboundFednowTransfer < Increase::Internal::Type::BaseModel
       required :transaction_id, String, nil?: true
 
       # @!attribute transaction_identification
-      #   The FedNow network identification of the transfer.
+      #   An optional identifier for the transfer set by the sending bank.
       #
       #   @return [String, nil]
       required :transaction_identification, String, nil?: true
@@ -124,7 +130,7 @@ class InboundFednowTransfer < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       required :unstructured_remittance_information, String, nil?: true
 
-      # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
+      # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, message_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
       #   An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
       #   your account.
       #
@@ -162,14 +168,17 @@ class InboundFednowTransfer < Increase::Internal::Type::BaseModel
       #   @param end_to_end_identification [String, nil]
       #     A free-form reference string set by the sender, to help identify the transfer.
       #
+      #   @param message_identification [String] The FedNow network identification of the transfer.
+      #
       #   @param status [Symbol, Increase::Models::InboundFednowTransfer::Status]
       #     The lifecycle status of the transfer.
       #
       #   @param transaction_id [String, nil]
       #     The identifier of the Transaction object created when the transfer was
       #     confirmed.
       #
-      #   @param transaction_identification [String, nil] The FedNow network identification of the transfer.
+      #   @param transaction_identification [String, nil]
+      #     An optional identifier for the transfer set by the sending bank.
       #
       #   @param type [Symbol, Increase::Models::InboundFednowTransfer::Type]
       #     A constant representing the object's type. For this resource it will always be

lib/increase/resources/digital_card_profiles.rb

@@ -64,7 +64,7 @@ def retrieve(digital_card_profile_id, params = {})
         )
       end
 
-      # List Card Profiles
+      # List Digital Card Profiles
       #
       # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
       #
@@ -122,7 +122,7 @@ def archive(digital_card_profile_id, params = {})
         )
       end
 
-      # Clones a Digital Card Profile
+      # Clone a Digital Card Profile
       #
       # @overload clone_(digital_card_profile_id, app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_name: nil, contact_phone: nil, contact_website: nil, description: nil, text_color: nil, request_options: {})
       #

lib/increase/resources/files.rb

@@ -38,7 +38,9 @@ def create(params)
         )
       end
 
-      # Retrieve a File
+      # Fetch metadata about a File, like its `purpose` and MIME type. To access the
+      # content, use the [Get File contents](/documentation/api/files#get-file-contents)
+      # API.
       #
       # @overload retrieve(file_id, request_options: {})
       #

lib/increase/resources/intrafi_account_enrollments.rb

@@ -3,7 +3,7 @@
 module Increase
   module Resources
     class IntrafiAccountEnrollments
-      # Enroll an account in the IntraFi deposit sweep network
+      # Enroll an Account in the IntraFi deposit sweep network
       #
       # @overload create(account_id:, email_address:, request_options: {})
       #
@@ -88,7 +88,7 @@ def list(params = {})
         )
       end
 
-      # Unenroll an account from IntraFi
+      # Unenroll an Account from IntraFi
       #
       # @overload unenroll(intrafi_account_enrollment_id, request_options: {})
       #

lib/increase/resources/physical_card_profiles.rb

@@ -43,7 +43,7 @@ def create(params)
         )
       end
 
-      # Retrieve a Card Profile
+      # Retrieve a Physical Card Profile
       #
       # @overload retrieve(physical_card_profile_id, request_options: {})
       #

lib/increase/resources/supplemental_documents.rb

@@ -3,7 +3,7 @@
 module Increase
   module Resources
     class SupplementalDocuments
-      # Create a supplemental document for an Entity
+      # Create a Supplemental Document
       #
       # @overload create(entity_id:, file_id:, request_options: {})
       #
@@ -27,7 +27,7 @@ def create(params)
         )
       end
 
-      # List Entity Supplemental Document Submissions
+      # List Supplemental Documents
       #
       # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
       #