feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: d691eb2845a0108278fe81faa111d29f
+openapi_spec_hash: e8136cf3fc19b9f1d4632136a98880cd
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

lib/increase/models/pending_transaction.rb

@@ -18,9 +18,9 @@ class PendingTransaction < Increase::Internal::Type::BaseModel
 
       # @!attribute amount
       #   The Pending Transaction amount in the minor unit of its currency. For dollars,
-      #   for example, this is cents. This amount does not change after the Pending
-      #   Transaction is created. If a card authorization settles for a different amount,
-      #   the settled amount is available on the resulting Transaction and on the Card
+      #   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`.
       #
       #   @return [Integer]
@@ -111,9 +111,9 @@ class PendingTransaction < Increase::Internal::Type::BaseModel
       #
       #   @param amount [Integer]
       #     The Pending Transaction amount in the minor unit of its currency. For dollars,
-      #     for example, this is cents. This amount does not change after the Pending
-      #     Transaction is created. If a card authorization settles for a different amount,
-      #     the settled amount is available on the resulting Transaction and on the Card
+      #     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`.
       #
       #   @param completed_at [Time, nil]
@@ -2811,7 +2811,7 @@ module Status
         # The Pending Transaction is still awaiting confirmation.
         PENDING = :pending
 
-        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
         COMPLETE = :complete
 
         # @!method self.values

lib/increase/models/pending_transaction_list_params.rb

@@ -217,7 +217,7 @@ module In
           # The Pending Transaction is still awaiting confirmation.
           PENDING = :pending
 
-          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
           COMPLETE = :complete
 
           # @!method self.values

rbi/increase/models/pending_transaction.rbi

@@ -17,9 +17,9 @@ module Increase
       attr_accessor :account_id
 
       # The Pending Transaction amount in the minor unit of its currency. For dollars,
-      # for example, this is cents. This amount does not change after the Pending
-      # Transaction is created. If a card authorization settles for a different amount,
-      # the settled amount is available on the resulting Transaction and on the Card
+      # 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`.
       sig { returns(Integer) }
       attr_accessor :amount
@@ -112,9 +112,9 @@ module Increase
         # The identifier for the account this Pending Transaction belongs to.
         account_id:,
         # The Pending Transaction amount in the minor unit of its currency. For dollars,
-        # for example, this is cents. This amount does not change after the Pending
-        # Transaction is created. If a card authorization settles for a different amount,
-        # the settled amount is available on the resulting Transaction and on the Card
+        # 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`.
         amount:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
@@ -5004,7 +5004,7 @@ module Increase
         PENDING =
           T.let(:pending, Increase::PendingTransaction::Status::TaggedSymbol)
 
-        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
         COMPLETE =
           T.let(:complete, Increase::PendingTransaction::Status::TaggedSymbol)
 

rbi/increase/models/pending_transaction_list_params.rbi

@@ -477,7 +477,7 @@ module Increase
               Increase::PendingTransactionListParams::Status::In::TaggedSymbol
             )
 
-          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
           COMPLETE =
             T.let(
               :complete,

sig/increase/models/pending_transaction.rbs

@@ -1834,7 +1834,7 @@ module Increase
         # The Pending Transaction is still awaiting confirmation.
         PENDING: :pending
 
-        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+        # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
         COMPLETE: :complete
 
         def self?.values: -> ::Array[Increase::Models::PendingTransaction::status]

sig/increase/models/pending_transaction_list_params.rbs

@@ -228,7 +228,7 @@ module Increase
           # The Pending Transaction is still awaiting confirmation.
           PENDING: :pending
 
-          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
+          # The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is the amount that was still held when it completed, which can differ from the amount of the associated Transaction.
           COMPLETE: :complete
 
           def self?.values: -> ::Array[Increase::Models::PendingTransactionListParams::Status::in_]