release: 0.185.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.184.0"
+  ".": "0.185.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 201
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-b83233a82025949d61c863da86f7d5cb639e8868924719a83bda389714fbf568.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-8682653c46661e7abcd90fefb10194ac68a8caf701a5fbf7ae887fa50c12b0a6.yml

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.185.0 (2025-01-31)
+
+Full Changelog: [v0.184.0...v0.185.0](https://github.com/Increase/increase-python/compare/v0.184.0...v0.185.0)
+
+### Features
+
+* **api:** api update ([#941](https://github.com/Increase/increase-python/issues/941)) ([4c8a190](https://github.com/Increase/increase-python/commit/4c8a1903b7caee3fa8edf285415e7e95b914a4a1))
+
 ## 0.184.0 (2025-01-31)
 
 Full Changelog: [v0.183.0...v0.184.0](https://github.com/Increase/increase-python/compare/v0.183.0...v0.184.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "increase"
-version = "0.184.0"
+version = "0.185.0"
 description = "The official Python library for the increase API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/increase/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "increase"
-__version__ = "0.184.0"  # x-release-please-version
+__version__ = "0.185.0"  # x-release-please-version

src/increase/types/card_payment.py

@@ -2827,21 +2827,24 @@ class Element(BaseModel):
     """A Card Authentication object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_authentication`.
+    equal to `card_authentication`. Card Authentications are attempts to
+    authenticate a transaction or a card with 3DS.
     """
 
     card_authorization: Optional[ElementCardAuthorization] = None
     """A Card Authorization object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_authorization`.
+    equal to `card_authorization`. Card Authorizations are temporary holds placed on
+    a customers funds with the intent to later clear a transaction.
     """
 
     card_authorization_expiration: Optional[ElementCardAuthorizationExpiration] = None
     """A Card Authorization Expiration object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_authorization_expiration`.
+    equal to `card_authorization_expiration`. Card Authorization Expirations are
+    cancellations of authorizations that were never settled by the acquirer.
     """
 
     card_decline: Optional[ElementCardDecline] = None
@@ -2855,42 +2858,51 @@ class Element(BaseModel):
     """A Card Fuel Confirmation object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_fuel_confirmation`.
+    equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of
+    a Card Authorization after a fuel pump transaction is completed.
     """
 
     card_increment: Optional[ElementCardIncrement] = None
     """A Card Increment object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_increment`.
+    equal to `card_increment`. Card Increments increase the pending amount of an
+    authorized transaction.
     """
 
     card_refund: Optional[ElementCardRefund] = None
     """A Card Refund object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_refund`.
+    equal to `card_refund`. Card Refunds move money back to the cardholder. While
+    they are usually connected to a Card Settlement an acquirer can also refund
+    money directly to a card without relation to a transaction.
     """
 
     card_reversal: Optional[ElementCardReversal] = None
     """A Card Reversal object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_reversal`.
+    equal to `card_reversal`. Card Reversals cancel parts of or the entirety of an
+    existing Card Authorization.
     """
 
     card_settlement: Optional[ElementCardSettlement] = None
     """A Card Settlement object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_settlement`.
+    equal to `card_settlement`. Card Settlements are card transactions that have
+    cleared and settled. While a settlement is usually preceded by an authorization,
+    an acquirer can also directly clear a transaction without first authorizing it.
     """
 
     card_validation: Optional[ElementCardValidation] = None
     """A Card Validation object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_validation`.
+    equal to `card_validation`. Card Validations are requests from a merchant to
+    verify that a card number and optionally its address and/or Card Verification
+    Value are valid.
     """
 
     category: Literal[

src/increase/types/pending_transaction.py

@@ -604,7 +604,8 @@ class Source(BaseModel):
     """A Card Authorization object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `card_authorization`.
+    equal to `card_authorization`. Card Authorizations are temporary holds placed on
+    a customers funds with the intent to later clear a transaction.
     """
 
     category: Literal[
@@ -665,14 +666,18 @@ class Source(BaseModel):
     """An Inbound Funds Hold object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `inbound_funds_hold`.
+    equal to `inbound_funds_hold`. We hold funds for certain transaction types to
+    account for return windows where funds might still be clawed back by the sending
+    institution.
     """
 
     inbound_wire_transfer_reversal: Optional[SourceInboundWireTransferReversal] = None
     """An Inbound Wire Transfer Reversal object.
 
     This field will be present in the JSON response if and only if `category` is
-    equal to `inbound_wire_transfer_reversal`.
+    equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal is
+    created when Increase has received a wire and the User requests that it be
+    reversed.
     """
 
     other: Optional[object] = None