increase 1.86.0 → 1.88.0

data/rbi/increase/models/declined_transaction.rbi

@@ -1534,7 +1534,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1550,7 +1552,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1572,7 +1576,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1588,7 +1594,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1610,7 +1618,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1626,7 +1636,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1648,7 +1660,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1664,7 +1678,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1686,7 +1702,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1702,7 +1720,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1724,7 +1744,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1740,7 +1762,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1762,7 +1786,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1778,7 +1804,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1800,7 +1828,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1816,7 +1846,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1838,7 +1870,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1854,7 +1888,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.

data/rbi/increase/models/pending_transaction.rbi

@@ -1629,7 +1629,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1645,7 +1647,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1667,7 +1671,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1683,7 +1689,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1705,7 +1713,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1721,7 +1731,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1743,7 +1755,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1759,7 +1773,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1781,7 +1797,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1797,7 +1815,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1819,7 +1839,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1835,7 +1857,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1857,7 +1881,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1873,7 +1899,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1895,7 +1923,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1911,7 +1941,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.
@@ -1933,7 +1965,9 @@ module Increase
                   )
                 end
 
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               sig { returns(Integer) }
               attr_accessor :amount
 
@@ -1949,7 +1983,9 @@ module Increase
                 )
               end
               def self.new(
-                # The amount in minor units of the `currency` field.
+                # The amount in minor units of the `currency` field. The amount is positive if it
+                # is added to the amount (such as an ATM surcharge fee) and negative if it is
+                # subtracted from the amount (such as a discount).
                 amount:,
                 # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
                 # amount's currency.

data/rbi/increase/models/real_time_decision.rbi

@@ -1127,7 +1127,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1143,7 +1145,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1165,7 +1169,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1181,7 +1187,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1203,7 +1211,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1219,7 +1229,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1241,7 +1253,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1257,7 +1271,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1279,7 +1295,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1295,7 +1313,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1317,7 +1337,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1333,7 +1355,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1355,7 +1379,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1371,7 +1397,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1393,7 +1421,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1409,7 +1439,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.
@@ -1431,7 +1463,9 @@ module Increase
                 )
               end
 
-            # The amount in minor units of the `currency` field.
+            # The amount in minor units of the `currency` field. The amount is positive if it
+            # is added to the amount (such as an ATM surcharge fee) and negative if it is
+            # subtracted from the amount (such as a discount).
             sig { returns(Integer) }
             attr_accessor :amount
 
@@ -1447,7 +1481,9 @@ module Increase
               )
             end
             def self.new(
-              # The amount in minor units of the `currency` field.
+              # The amount in minor units of the `currency` field. The amount is positive if it
+              # is added to the amount (such as an ATM surcharge fee) and negative if it is
+              # subtracted from the amount (such as a discount).
               amount:,
               # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
               # amount's currency.

data/rbi/increase/resources/account_transfers.rbi

@@ -15,16 +15,19 @@ module Increase
         ).returns(Increase::AccountTransfer)
       end
       def create(
-        # The identifier for the account that will send the transfer.
+        # The identifier for the originating Account that will send the transfer.
         account_id:,
         # The transfer amount in the minor unit of the account currency. For dollars, for
         # example, this is cents.
         amount:,
-        # The description you choose to give the transfer.
+        # An internal-facing description for the transfer for display in the API and
+        # dashboard. This will also show in the description of the created Transactions.
         description:,
-        # The identifier for the account that will receive the transfer.
+        # The identifier for the destination Account that will receive the transfer.
         destination_account_id:,
-        # Whether the transfer requires explicit approval via the dashboard or API.
+        # Whether the transfer should require explicit approval via the dashboard or API.
+        # For more information, see
+        # [Transfer Approvals](/documentation/transfer-approvals).
         require_approval: nil,
         request_options: {}
       )
@@ -73,7 +76,7 @@ module Increase
       )
       end
 
-      # Approve an Account Transfer
+      # Approves an Account Transfer in status `pending_approval`.
       sig do
         params(
           account_transfer_id: String,
@@ -87,7 +90,7 @@ module Increase
       )
       end
 
-      # Cancel an Account Transfer
+      # Cancels an Account Transfer in status `pending_approval`.
       sig do
         params(
           account_transfer_id: String,