increase 1.356.0 → 1.358.0

data/rbi/increase/models/event.rbi

@@ -341,6 +341,13 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a Digital Wallet Token Request is created.
+        DIGITAL_WALLET_TOKEN_REQUEST_CREATED =
+          T.let(
+            :"digital_wallet_token_request.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever an Entity is created.
         ENTITY_CREATED =
           T.let(:"entity.created", Increase::Event::Category::TaggedSymbol)

data/rbi/increase/models/event_list_params.rbi

@@ -39,8 +39,8 @@ module Increase
       sig { params(cursor: String).void }
       attr_writer :cursor
 
-      # Limit the size of the list that is returned. The default (and maximum) is 100
-      # objects.
+      # Limit the size of the list that is returned. The default is 100 objects and the
+      # maximum is 1,000.
       #
       # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
@@ -73,8 +73,8 @@ module Increase
         created_at: nil,
         # Return the page of entries after this one.
         cursor: nil,
-        # Limit the size of the list that is returned. The default (and maximum) is 100
-        # objects.
+        # Limit the size of the list that is returned. The default is 100 objects and the
+        # maximum is 1,000.
         #
         # Defaults to `100`.
         limit: nil,
@@ -423,6 +423,13 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Digital Wallet Token Request is created.
+          DIGITAL_WALLET_TOKEN_REQUEST_CREATED =
+            T.let(
+              :"digital_wallet_token_request.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever an Entity is created.
           ENTITY_CREATED =
             T.let(

data/rbi/increase/models/event_subscription.rbi

@@ -444,6 +444,13 @@ module Increase
               Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Digital Wallet Token Request is created.
+          DIGITAL_WALLET_TOKEN_REQUEST_CREATED =
+            T.let(
+              :"digital_wallet_token_request.created",
+              Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an Entity is created.
           ENTITY_CREATED =
             T.let(

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -442,6 +442,13 @@ module Increase
               Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
             )
 
+          # Occurs whenever a Digital Wallet Token Request is created.
+          DIGITAL_WALLET_TOKEN_REQUEST_CREATED =
+            T.let(
+              :"digital_wallet_token_request.created",
+              Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
+            )
+
           # Occurs whenever an Entity is created.
           ENTITY_CREATED =
             T.let(

data/rbi/increase/models/export.rbi

@@ -377,7 +377,7 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :account_id
 
-        # The date for which to retrieve the balance.
+        # The UTC date for which to retrieve the balance.
         sig { returns(T.nilable(Date)) }
         attr_accessor :effective_date
 
@@ -397,7 +397,7 @@ module Increase
         def self.new(
           # Filter results by Account.
           account_id:,
-          # The date for which to retrieve the balance.
+          # The UTC date for which to retrieve the balance.
           effective_date:,
           # Filter results by Program.
           program_id:
@@ -532,7 +532,7 @@ module Increase
         sig { returns(String) }
         attr_accessor :account_number_id
 
-        # The date of the balance to include in the letter.
+        # The UTC date of the balance to include in the letter.
         sig { returns(T.nilable(Date)) }
         attr_accessor :balance_date
 
@@ -547,7 +547,7 @@ module Increase
         def self.new(
           # The Account Number to create a letter for.
           account_number_id:,
-          # The date of the balance to include in the letter.
+          # The UTC date of the balance to include in the letter.
           balance_date:
         )
         end
@@ -665,11 +665,11 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :bookkeeping_account_id
 
-        # Filter balances to those on or after this date.
+        # Filter balances to those on or after this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_accessor :on_or_after_date
 
-        # Filter balances to those on or before this date.
+        # Filter balances to those on or before this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_accessor :on_or_before_date
 
@@ -685,9 +685,9 @@ module Increase
         def self.new(
           # Filter results by Bookkeeping Account.
           bookkeeping_account_id:,
-          # Filter balances to those on or after this date.
+          # Filter balances to those on or after this UTC date.
           on_or_after_date:,
-          # Filter balances to those on or before this date.
+          # Filter balances to those on or before this UTC date.
           on_or_before_date:
         )
         end
@@ -808,11 +808,11 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :account_id
 
-        # Filter balances on or after this date.
+        # Filter balances on or after this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_accessor :on_or_after_date
 
-        # Filter balances on or before this date.
+        # Filter balances on or before this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_accessor :on_or_before_date
 
@@ -828,9 +828,9 @@ module Increase
         def self.new(
           # Filter results by Account.
           account_id:,
-          # Filter balances on or after this date.
+          # Filter balances on or after this UTC date.
           on_or_after_date:,
-          # Filter balances on or before this date.
+          # Filter balances on or before this UTC date.
           on_or_before_date:
         )
         end

data/rbi/increase/models/export_create_params.rbi

@@ -361,10 +361,9 @@ module Increase
         sig { params(account_id: String).void }
         attr_writer :account_id
 
-        # 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.
         sig { returns(T.nilable(Date)) }
         attr_reader :effective_date
 
@@ -392,10 +391,9 @@ module Increase
           # The Account to create a BAI2 report for. If not provided, all open accounts will
           # be included.
           account_id: nil,
-          # 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.
           effective_date: nil,
           # The Program to create a BAI2 report for. If not provided, all open accounts will
           # be included.
@@ -526,7 +524,8 @@ module Increase
         sig { returns(String) }
         attr_accessor :account_number_id
 
-        # 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.
         sig { returns(T.nilable(Date)) }
         attr_reader :balance_date
 
@@ -543,7 +542,8 @@ module Increase
         def self.new(
           # The Account Number to create a letter for.
           account_number_id:,
-          # 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.
           balance_date: nil
         )
         end
@@ -572,14 +572,14 @@ module Increase
         sig { params(bookkeeping_account_id: String).void }
         attr_writer :bookkeeping_account_id
 
-        # Filter exported Balances to those on or after this date.
+        # Filter exported Balances to those on or after this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_reader :on_or_after_date
 
         sig { params(on_or_after_date: Date).void }
         attr_writer :on_or_after_date
 
-        # Filter exported Balances to those on or before this date.
+        # Filter exported Balances to those on or before this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_reader :on_or_before_date
 
@@ -599,9 +599,9 @@ module Increase
           # Filter exported Bookkeeping Account Balances to the specified Bookkeeping
           # Account.
           bookkeeping_account_id: nil,
-          # Filter exported Balances to those on or after this date.
+          # Filter exported Balances to those on or after this UTC date.
           on_or_after_date: nil,
-          # Filter exported Balances to those on or before this date.
+          # Filter exported Balances to those on or before this UTC date.
           on_or_before_date: nil
         )
         end
@@ -635,14 +635,14 @@ module Increase
         sig { params(account_id: String).void }
         attr_writer :account_id
 
-        # Filter exported Balances to those on or after this date.
+        # Filter exported Balances to those on or after this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_reader :on_or_after_date
 
         sig { params(on_or_after_date: Date).void }
         attr_writer :on_or_after_date
 
-        # Filter exported Balances to those on or before this date.
+        # Filter exported Balances to those on or before this UTC date.
         sig { returns(T.nilable(Date)) }
         attr_reader :on_or_before_date
 
@@ -661,9 +661,9 @@ module Increase
         def self.new(
           # Filter exported Balances to the specified Account.
           account_id: nil,
-          # Filter exported Balances to those on or after this date.
+          # Filter exported Balances to those on or after this UTC date.
           on_or_after_date: nil,
-          # Filter exported Balances to those on or before this date.
+          # Filter exported Balances to those on or before this UTC date.
           on_or_before_date: nil
         )
         end

data/rbi/increase/models/file.rbi

@@ -225,7 +225,7 @@ module Increase
             Increase::File::Purpose::TaggedSymbol
           )
 
-        # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
+        # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG with the Visa Brand Mark sized and placed as in the digital card template.
         DIGITAL_WALLET_ARTWORK =
           T.let(:digital_wallet_artwork, Increase::File::Purpose::TaggedSymbol)
 

data/rbi/increase/models/file_create_params.rbi

@@ -153,7 +153,7 @@ module Increase
             Increase::FileCreateParams::Purpose::TaggedSymbol
           )
 
-        # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
+        # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG with the Visa Brand Mark sized and placed as in the digital card template.
         DIGITAL_WALLET_ARTWORK =
           T.let(
             :digital_wallet_artwork,

data/rbi/increase/models/file_list_params.rbi

@@ -347,7 +347,7 @@ module Increase
               Increase::FileListParams::Purpose::In::TaggedSymbol
             )
 
-          # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
+          # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG with the Visa Brand Mark sized and placed as in the digital card template.
           DIGITAL_WALLET_ARTWORK =
             T.let(
               :digital_wallet_artwork,

data/rbi/increase/models/inbound_check_deposit.rbi

@@ -42,7 +42,7 @@ module Increase
       attr_accessor :automatically_resolves_at
 
       # The ID for the File containing the image of the back of the check.
-      sig { returns(T.nilable(String)) }
+      sig { returns(String) }
       attr_accessor :back_image_file_id
 
       # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
@@ -94,7 +94,7 @@ module Increase
       attr_writer :deposit_return
 
       # The ID for the File containing the image of the front of the check.
-      sig { returns(T.nilable(String)) }
+      sig { returns(String) }
       attr_accessor :front_image_file_id
 
       # Whether the details on the check match the recipient name of the check transfer.
@@ -130,7 +130,7 @@ module Increase
             T::Array[Increase::InboundCheckDeposit::Adjustment::OrHash],
           amount: Integer,
           automatically_resolves_at: Time,
-          back_image_file_id: T.nilable(String),
+          back_image_file_id: String,
           bank_of_first_deposit_routing_number: T.nilable(String),
           check_number: T.nilable(String),
           check_transfer_id: T.nilable(String),
@@ -140,7 +140,7 @@ module Increase
           declined_transaction_id: T.nilable(String),
           deposit_return:
             T.nilable(Increase::InboundCheckDeposit::DepositReturn::OrHash),
-          front_image_file_id: T.nilable(String),
+          front_image_file_id: String,
           payee_name_analysis:
             Increase::InboundCheckDeposit::PayeeNameAnalysis::OrSymbol,
           status: Increase::InboundCheckDeposit::Status::OrSymbol,
@@ -220,7 +220,7 @@ module Increase
             adjustments: T::Array[Increase::InboundCheckDeposit::Adjustment],
             amount: Integer,
             automatically_resolves_at: Time,
-            back_image_file_id: T.nilable(String),
+            back_image_file_id: String,
             bank_of_first_deposit_routing_number: T.nilable(String),
             check_number: T.nilable(String),
             check_transfer_id: T.nilable(String),
@@ -230,7 +230,7 @@ module Increase
             declined_transaction_id: T.nilable(String),
             deposit_return:
               T.nilable(Increase::InboundCheckDeposit::DepositReturn),
-            front_image_file_id: T.nilable(String),
+            front_image_file_id: String,
             payee_name_analysis:
               Increase::InboundCheckDeposit::PayeeNameAnalysis::TaggedSymbol,
             status: Increase::InboundCheckDeposit::Status::TaggedSymbol,
@@ -331,6 +331,13 @@ module Increase
               Increase::InboundCheckDeposit::Adjustment::Reason::TaggedSymbol
             )
 
+          # A previous adjustment for the check was applied twice and the duplicate has been reversed.
+          DUPLICATE_ENTRY =
+            T.let(
+              :duplicate_entry,
+              Increase::InboundCheckDeposit::Adjustment::Reason::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/inbound_fednow_transfer.rbi

@@ -77,6 +77,10 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :end_to_end_identification
 
+      # The FedNow network identification of the transfer.
+      sig { returns(String) }
+      attr_accessor :message_identification
+
       # The lifecycle status of the transfer.
       sig { returns(Increase::InboundFednowTransfer::Status::TaggedSymbol) }
       attr_accessor :status
@@ -86,7 +90,7 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :transaction_id
 
-      # The FedNow network identification of the transfer.
+      # An optional identifier for the transfer set by the sending bank.
       sig { returns(T.nilable(String)) }
       attr_accessor :transaction_identification
 
@@ -123,6 +127,7 @@ module Increase
           debtor_routing_number: String,
           decline: T.nilable(Increase::InboundFednowTransfer::Decline::OrHash),
           end_to_end_identification: T.nilable(String),
+          message_identification: String,
           status: Increase::InboundFednowTransfer::Status::OrSymbol,
           transaction_id: T.nilable(String),
           transaction_identification: T.nilable(String),
@@ -160,12 +165,14 @@ module Increase
         decline:,
         # A free-form reference string set by the sender, to help identify the transfer.
         end_to_end_identification:,
+        # The FedNow network identification of the transfer.
+        message_identification:,
         # The lifecycle status of the transfer.
         status:,
         # The identifier of the Transaction object created when the transfer was
         # confirmed.
         transaction_id:,
-        # The FedNow network identification of the transfer.
+        # An optional identifier for the transfer set by the sending bank.
         transaction_identification:,
         # A constant representing the object's type. For this resource it will always be
         # `inbound_fednow_transfer`.
@@ -196,6 +203,7 @@ module Increase
             debtor_routing_number: String,
             decline: T.nilable(Increase::InboundFednowTransfer::Decline),
             end_to_end_identification: T.nilable(String),
+            message_identification: String,
             status: Increase::InboundFednowTransfer::Status::TaggedSymbol,
             transaction_id: T.nilable(String),
             transaction_identification: T.nilable(String),

data/rbi/increase/models/pending_transaction.rbi

@@ -18,9 +18,9 @@ module Increase
 
       # The Pending Transaction amount in the minor unit of its currency. For dollars,
       # for example, this is cents. For a card authorization this is the amount still
-      # held: it decreases when the merchant reverses part of the authorization. The
-      # amount that settled is available on the resulting Transaction and on the Card
-      # Payment's `state.settled_amount`.
+      # held: it decreases when the merchant reverses or partially settles the
+      # authorization. The amount that settled is available on the resulting Transaction
+      # and on the Card Payment's `state.settled_amount`.
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -113,9 +113,9 @@ module Increase
         account_id:,
         # The Pending Transaction amount in the minor unit of its currency. For dollars,
         # for example, this is cents. For a card authorization this is the amount still
-        # held: it decreases when the merchant reverses part of the authorization. The
-        # amount that settled is available on the resulting Transaction and on the Card
-        # Payment's `state.settled_amount`.
+        # held: it decreases when the merchant reverses or partially settles the
+        # authorization. The amount that settled is available on the resulting Transaction
+        # and on the Card Payment's `state.settled_amount`.
         amount:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
         # Transaction was completed.
@@ -3948,6 +3948,13 @@ module Increase
                   Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
                 )
 
+              # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
+              PULSE_TOKENIZATION_FEE =
+                T.let(
+                  :pulse_tokenization_fee,
+                  Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
+                )
+
               sig do
                 override.returns(
                   T::Array[

data/rbi/increase/models/physical_card.rbi

@@ -34,6 +34,16 @@ module Increase
       sig { returns(Time) }
       attr_accessor :created_at
 
+      # 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.
+      sig { returns(Integer) }
+      attr_accessor :expiration_month
+
+      # 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.
+      sig { returns(Integer) }
+      attr_accessor :expiration_year
+
       # 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
       # about [idempotency](https://increase.com/documentation/idempotency-keys).
@@ -72,6 +82,8 @@ module Increase
           card_id: String,
           cardholder: Increase::PhysicalCard::Cardholder::OrHash,
           created_at: Time,
+          expiration_month: Integer,
+          expiration_year: Integer,
           idempotency_key: T.nilable(String),
           physical_card_profile_id: T.nilable(String),
           shipment: Increase::PhysicalCard::Shipment::OrHash,
@@ -91,6 +103,12 @@ module Increase
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
         # the Physical Card was created.
         created_at:,
+        # 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.
+        expiration_month:,
+        # 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.
+        expiration_year:,
         # 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
         # about [idempotency](https://increase.com/documentation/idempotency-keys).
@@ -115,6 +133,8 @@ module Increase
             card_id: String,
             cardholder: Increase::PhysicalCard::Cardholder,
             created_at: Time,
+            expiration_month: Integer,
+            expiration_year: Integer,
             idempotency_key: T.nilable(String),
             physical_card_profile_id: T.nilable(String),
             shipment: Increase::PhysicalCard::Shipment,
@@ -286,6 +306,10 @@ module Increase
           sig { returns(String) }
           attr_accessor :name
 
+          # The phone number of the recipient.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :phone_number
+
           # The postal code of the shipping address.
           sig { returns(String) }
           attr_accessor :postal_code
@@ -303,6 +327,7 @@ module Increase
               line2: T.nilable(String),
               line3: T.nilable(String),
               name: String,
+              phone_number: T.nilable(String),
               postal_code: String,
               state: String
             ).returns(T.attached_class)
@@ -320,6 +345,8 @@ module Increase
             line3:,
             # The name of the recipient.
             name:,
+            # The phone number of the recipient.
+            phone_number:,
             # The postal code of the shipping address.
             postal_code:,
             # The state of the shipping address.
@@ -336,6 +363,7 @@ module Increase
                 line2: T.nilable(String),
                 line3: T.nilable(String),
                 name: String,
+                phone_number: T.nilable(String),
                 postal_code: String,
                 state: String
               }

data/rbi/increase/models/simulations/check_deposit_adjustment_params.rbi

@@ -138,6 +138,13 @@ module Increase
               Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
             )
 
+          # A previous adjustment for the check was applied twice and the duplicate has been reversed.
+          DUPLICATE_ENTRY =
+            T.let(
+              :duplicate_entry,
+              Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi

@@ -113,6 +113,13 @@ module Increase
               Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
             )
 
+          # A previous adjustment for the check was applied twice and the duplicate has been reversed.
+          DUPLICATE_ENTRY =
+            T.let(
+              :duplicate_entry,
+              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[