increase 1.357.0 → 1.359.0

data/lib/increase/models/export.rb

@@ -257,7 +257,7 @@ module Increase
         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 @@ module Increase
         #
         #   @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 @@ module Increase
         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 @@ module Increase
         #
         #   @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 @@ module Increase
         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 @@ module Increase
         #
         #   @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 @@ module Increase
         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 @@ module Increase
         #
         #   @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
@@ -529,8 +529,8 @@ module Increase
       # @see Increase::Models::Export#fee_csv
       class FeeCsv < Increase::Internal::Type::BaseModel
         # @!attribute created_at
-        #   Filter fees by their created date. The time range must not include any fees that
-        #   are part of an open fee statement.
+        #   Filter fees by their created date. The time range must not include any fees on
+        #   an open fee statement.
         #
         #   @return [Increase::Models::Export::FeeCsv::CreatedAt, nil]
         required :created_at, -> { Increase::Export::FeeCsv::CreatedAt }, nil?: true
@@ -540,8 +540,8 @@ module Increase
         #   equal to `fee_csv`.
         #
         #   @param created_at [Increase::Models::Export::FeeCsv::CreatedAt, nil]
-        #     Filter fees by their created date. The time range must not include any fees that
-        #     are part of an open fee statement.
+        #     Filter fees by their created date. The time range must not include any fees on
+        #     an open fee statement.
 
         # @see Increase::Models::Export::FeeCsv#created_at
         class CreatedAt < Increase::Internal::Type::BaseModel
@@ -570,8 +570,8 @@ module Increase
           required :on_or_before, Time, nil?: true
 
           # @!method initialize(after:, before:, on_or_after:, on_or_before:)
-          #   Filter fees by their created date. The time range must not include any fees that
-          #   are part of an open fee statement.
+          #   Filter fees by their created date. The time range must not include any fees on
+          #   an open fee statement.
           #
           #   @param after [Time, nil] Filter fees created after this time.
           #

data/lib/increase/models/export_create_params.rb

@@ -187,10 +187,9 @@ module Increase
         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 @@ module Increase
         #     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 @@ module Increase
         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 @@ module Increase
         #
         #   @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 @@ module Increase
         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 @@ module Increase
         #     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 @@ module Increase
         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 @@ module Increase
         #
         #   @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

data/lib/increase/models/inbound_fednow_transfer.rb

@@ -84,6 +84,12 @@ module Increase
       #   @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 @@ module Increase
       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 @@ module Increase
       #   @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,6 +168,8 @@ module Increase
       #   @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.
       #
@@ -169,7 +177,8 @@ module Increase
       #     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

data/lib/increase/models/physical_card.rb

@@ -35,6 +35,20 @@ module Increase
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute expiration_month
+      #   The month printed on the Physical Card as its expiration, in M format (e.g.,
+      #   August is 8). This stays the same when the Card is renewed.
+      #
+      #   @return [Integer]
+      required :expiration_month, Integer
+
+      # @!attribute expiration_year
+      #   The year printed on the Physical Card as its expiration, in YYYY format (e.g.,
+      #   2025). This stays the same when the Card is renewed.
+      #
+      #   @return [Integer]
+      required :expiration_year, Integer
+
       # @!attribute idempotency_key
       #   The idempotency key you chose for this object. This value is unique across
       #   Increase and is used to ensure that a request is only processed once. Learn more
@@ -68,12 +82,13 @@ module Increase
       #   @return [Symbol, Increase::Models::PhysicalCard::Type]
       required :type, enum: -> { Increase::PhysicalCard::Type }
 
-      # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
+      # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, expiration_month:, expiration_year:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
       #   Custom physical Visa cards that are shipped to your customers. The artwork is
       #   configurable by a connected [Card Profile](/documentation/api#card-profiles).
       #   The same Card can be used for multiple Physical Cards. Printing cards incurs a
       #   fee. Please contact [support@increase.com](mailto:support@increase.com) for
-      #   pricing!
+      #   pricing! For more information, see our guide on
+      #   [physical card artwork](https://increase.com/documentation/card-art-physical-cards#carrier-image).
       #
       #   @param id [String] The physical card identifier.
       #
@@ -88,6 +103,14 @@ module Increase
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       #     the Physical Card was created.
       #
+      #   @param expiration_month [Integer]
+      #     The month printed on the Physical Card as its expiration, in M format (e.g.,
+      #     August is 8). This stays the same when the Card is renewed.
+      #
+      #   @param expiration_year [Integer]
+      #     The year printed on the Physical Card as its expiration, in YYYY format (e.g.,
+      #     2025). This stays the same when the Card is renewed.
+      #
       #   @param idempotency_key [String, nil]
       #     The idempotency key you chose for this object. This value is unique across
       #     Increase and is used to ensure that a request is only processed once. Learn more

data/lib/increase/models/transaction.rb

@@ -1666,6 +1666,9 @@ module Increase
               # The user's chargeback was submitted.
               CHARGEBACK_SUBMITTED = :chargeback_submitted
 
+              # The merchant's pre-arbitration submission was accepted by the user or not responded to in time.
+              MERCHANT_PREARBITRATION_ACCEPTED = :merchant_prearbitration_accepted
+
               # The user declined the merchant's pre-arbitration submission.
               MERCHANT_PREARBITRATION_DECLINE_SUBMITTED = :merchant_prearbitration_decline_submitted
 
@@ -1675,6 +1678,9 @@ module Increase
               # The transaction was re-presented by the merchant.
               REPRESENTED = :represented
 
+              # The user's pre-arbitration was accepted by the merchant or not responded to in time.
+              USER_PREARBITRATION_ACCEPTED = :user_prearbitration_accepted
+
               # The user's pre-arbitration was declined by the merchant.
               USER_PREARBITRATION_DECLINE_RECEIVED = :user_prearbitration_decline_received
 

data/lib/increase/models.rb

@@ -167,6 +167,8 @@ module Increase
 
   CardPushTransferRetrieveParams = Increase::Models::CardPushTransferRetrieveParams
 
+  CardRenewParams = Increase::Models::CardRenewParams
+
   CardRetrieveParams = Increase::Models::CardRetrieveParams
 
   CardToken = Increase::Models::CardToken

data/lib/increase/resources/cards.rb

@@ -5,7 +5,7 @@ module Increase
     class Cards
       # Create a Card
       #
-      # @overload create(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
+      # @overload create(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, replacement_for: nil, request_options: {})
       #
       # @param account_id [String] The Account the card should belong to.
       #
@@ -31,6 +31,10 @@ module Increase
       #   The Entity the card belongs to. You only need to supply this in rare situations
       #   when the card is not for the Account holder.
       #
+      # @param replacement_for [Increase::Models::CardCreateParams::ReplacementFor]
+      #   Details about the Card this Card replaces. Supply this when issuing a new Card
+      #   to take over from an existing one. The replaced Card is not canceled.
+      #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Increase::Models::Card]
@@ -216,6 +220,30 @@ module Increase
         )
       end
 
+      # Renew a Card in place. The Card keeps its identifier, card number, PIN, and
+      # Physical Cards, and receives a new expiration date in the current month four
+      # years from now along with a new verification code, which the Card's details will
+      # return afterwards. Physical Cards that have already shipped keep working until
+      # they are canceled.
+      #
+      # @overload renew(card_id, request_options: {})
+      #
+      # @param card_id [String] The identifier of the Card to renew.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Card]
+      #
+      # @see Increase::Models::CardRenewParams
+      def renew(card_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["cards/%1$s/renew", card_id],
+          model: Increase::Card,
+          options: params[:request_options]
+        )
+      end
+
       # Update a Card's PIN
       #
       # @overload update_pin(card_id, pin:, request_options: {})

data/lib/increase/resources/digital_card_profiles.rb

@@ -64,7 +64,7 @@ module Increase
         )
       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 @@ module Increase
         )
       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: {})
       #

data/lib/increase/resources/files.rb

@@ -38,7 +38,9 @@ module Increase
         )
       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: {})
       #

data/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 @@ module Increase
         )
       end
 
-      # Unenroll an account from IntraFi
+      # Unenroll an Account from IntraFi
       #
       # @overload unenroll(intrafi_account_enrollment_id, request_options: {})
       #

data/lib/increase/resources/physical_card_profiles.rb

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

data/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 @@ module Increase
         )
       end
 
-      # List Entity Supplemental Document Submissions
+      # List Supplemental Documents
       #
       # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
       #

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.357.0"
+  VERSION = "1.359.0"
 end

data/lib/increase.rb

@@ -118,6 +118,7 @@ require_relative "increase/models/card_push_transfer_cancel_params"
 require_relative "increase/models/card_push_transfer_create_params"
 require_relative "increase/models/card_push_transfer_list_params"
 require_relative "increase/models/card_push_transfer_retrieve_params"
+require_relative "increase/models/card_renew_params"
 require_relative "increase/models/card_retrieve_params"
 require_relative "increase/models/card_token"
 require_relative "increase/models/card_token_capabilities"

data/rbi/increase/models/account_statement.rbi

@@ -44,15 +44,17 @@ module Increase
 
       # 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.
       sig { returns(Time) }
       attr_accessor :statement_period_end
 
       # 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.
       sig { returns(Time) }
       attr_accessor :statement_period_start
 
@@ -96,13 +98,15 @@ module Increase
         starting_balance:,
         # 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.
         statement_period_end:,
         # 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.
         statement_period_start:,
         # A constant representing the object's type. For this resource it will always be
         # `account_statement`.