feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 255
-openapi_spec_hash: 0c2a6908b65af7107b19958604ff5cb8
+openapi_spec_hash: cdacba75b9a8527d3ebc57ceb52856b9
 config_hash: de151ebd21a0bd391662389b310a8f49

src/increase/types/card.py

@@ -282,7 +282,8 @@ class DigitalWallet(BaseModel):
     phone: Optional[str] = None
     """
     A phone number that can be used to verify the cardholder via one-time passcode
-    over SMS.
+    over SMS. Returned in [E.164](https://en.wikipedia.org/wiki/E.164) format, for
+    example `+14155550123`.
     """
 
 
@@ -331,7 +332,7 @@ class ReplacementFor(BaseModel):
 class Card(BaseModel):
     """Cards may operate on credit, debit, or prepaid BINs.
 
-    They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
+    They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement. For more information, see our guide on [managing cards](https://increase.com/documentation/managing-cards).
     """
 
     id: str

src/increase/types/card_create_params.py

@@ -325,7 +325,8 @@ class DigitalWallet(TypedDict, total=False):
     phone: str
     """
     A phone number that can be used to contact and verify the cardholder via
-    one-time passcode over SMS.
+    one-time passcode over SMS. Accepts formats like `+14155550123`, `4155550123`,
+    `415-555-0123`, or `(415) 555-0123`.
     """
 
 

src/increase/types/card_dispute.py

@@ -2655,7 +2655,7 @@ class Withdrawal(BaseModel):
 
 class CardDispute(BaseModel):
     """
-    If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.
+    If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate. For more information, see our guide on [card disputes](https://increase.com/documentation/card-disputes).
     """
 
     id: str

src/increase/types/card_payment.py

@@ -8539,7 +8539,7 @@ class State(BaseModel):
 
 class CardPayment(BaseModel):
     """
-    Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
+    Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement. For more information, see our guide on the [Card Payment lifecycle](https://increase.com/documentation/card-payment-lifecycle).
     """
 
     id: str

src/increase/types/card_push_transfer.py

@@ -337,6 +337,7 @@ class PresentmentAmount(BaseModel):
         "DZD",
         "USD",
         "AOA",
+        "XCD",
         "ARS",
         "AMD",
         "AWG",
@@ -348,6 +349,7 @@ class PresentmentAmount(BaseModel):
         "BBD",
         "BYN",
         "BZD",
+        "XOF",
         "BMD",
         "INR",
         "BTN",
@@ -358,10 +360,10 @@ class PresentmentAmount(BaseModel):
         "NOK",
         "BRL",
         "BND",
-        "BGN",
         "BIF",
         "CVE",
         "KHR",
+        "XAF",
         "CAD",
         "KYD",
         "CLP",
@@ -374,6 +376,7 @@ class PresentmentAmount(BaseModel):
         "NZD",
         "CRC",
         "CUP",
+        "XCG",
         "CZK",
         "DKK",
         "DJF",
@@ -385,6 +388,7 @@ class PresentmentAmount(BaseModel):
         "ETB",
         "FKP",
         "FJD",
+        "XPF",
         "GMD",
         "GEL",
         "GHS",
@@ -491,6 +495,7 @@ class PresentmentAmount(BaseModel):
         "YER",
         "ZMW",
         "ZWG",
+        "BGN",
     ]
     """The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
 
@@ -500,6 +505,7 @@ class PresentmentAmount(BaseModel):
     - `DZD` - DZD
     - `USD` - USD
     - `AOA` - AOA
+    - `XCD` - XCD
     - `ARS` - ARS
     - `AMD` - AMD
     - `AWG` - AWG
@@ -511,6 +517,7 @@ class PresentmentAmount(BaseModel):
     - `BBD` - BBD
     - `BYN` - BYN
     - `BZD` - BZD
+    - `XOF` - XOF
     - `BMD` - BMD
     - `INR` - INR
     - `BTN` - BTN
@@ -521,10 +528,10 @@ class PresentmentAmount(BaseModel):
     - `NOK` - NOK
     - `BRL` - BRL
     - `BND` - BND
-    - `BGN` - BGN
     - `BIF` - BIF
     - `CVE` - CVE
     - `KHR` - KHR
+    - `XAF` - XAF
     - `CAD` - CAD
     - `KYD` - KYD
     - `CLP` - CLP
@@ -537,6 +544,7 @@ class PresentmentAmount(BaseModel):
     - `NZD` - NZD
     - `CRC` - CRC
     - `CUP` - CUP
+    - `XCG` - XCG
     - `CZK` - CZK
     - `DKK` - DKK
     - `DJF` - DJF
@@ -548,6 +556,7 @@ class PresentmentAmount(BaseModel):
     - `ETB` - ETB
     - `FKP` - FKP
     - `FJD` - FJD
+    - `XPF` - XPF
     - `GMD` - GMD
     - `GEL` - GEL
     - `GHS` - GHS
@@ -654,6 +663,7 @@ class PresentmentAmount(BaseModel):
     - `YER` - YER
     - `ZMW` - ZMW
     - `ZWG` - ZWG
+    - `BGN` - BGN
     """
 
     value: str

src/increase/types/card_push_transfer_create_params.py

@@ -159,6 +159,7 @@ class PresentmentAmount(TypedDict, total=False):
             "DZD",
             "USD",
             "AOA",
+            "XCD",
             "ARS",
             "AMD",
             "AWG",
@@ -170,6 +171,7 @@ class PresentmentAmount(TypedDict, total=False):
             "BBD",
             "BYN",
             "BZD",
+            "XOF",
             "BMD",
             "INR",
             "BTN",
@@ -180,10 +182,10 @@ class PresentmentAmount(TypedDict, total=False):
             "NOK",
             "BRL",
             "BND",
-            "BGN",
             "BIF",
             "CVE",
             "KHR",
+            "XAF",
             "CAD",
             "KYD",
             "CLP",
@@ -196,6 +198,7 @@ class PresentmentAmount(TypedDict, total=False):
             "NZD",
             "CRC",
             "CUP",
+            "XCG",
             "CZK",
             "DKK",
             "DJF",
@@ -207,6 +210,7 @@ class PresentmentAmount(TypedDict, total=False):
             "ETB",
             "FKP",
             "FJD",
+            "XPF",
             "GMD",
             "GEL",
             "GHS",
@@ -313,6 +317,7 @@ class PresentmentAmount(TypedDict, total=False):
             "YER",
             "ZMW",
             "ZWG",
+            "BGN",
         ]
     ]
     """The ISO 4217 currency code representing the currency of the amount.
@@ -323,6 +328,7 @@ class PresentmentAmount(TypedDict, total=False):
     - `DZD` - DZD
     - `USD` - USD
     - `AOA` - AOA
+    - `XCD` - XCD
     - `ARS` - ARS
     - `AMD` - AMD
     - `AWG` - AWG
@@ -334,6 +340,7 @@ class PresentmentAmount(TypedDict, total=False):
     - `BBD` - BBD
     - `BYN` - BYN
     - `BZD` - BZD
+    - `XOF` - XOF
     - `BMD` - BMD
     - `INR` - INR
     - `BTN` - BTN
@@ -344,10 +351,10 @@ class PresentmentAmount(TypedDict, total=False):
     - `NOK` - NOK
     - `BRL` - BRL
     - `BND` - BND
-    - `BGN` - BGN
     - `BIF` - BIF
     - `CVE` - CVE
     - `KHR` - KHR
+    - `XAF` - XAF
     - `CAD` - CAD
     - `KYD` - KYD
     - `CLP` - CLP
@@ -360,6 +367,7 @@ class PresentmentAmount(TypedDict, total=False):
     - `NZD` - NZD
     - `CRC` - CRC
     - `CUP` - CUP
+    - `XCG` - XCG
     - `CZK` - CZK
     - `DKK` - DKK
     - `DJF` - DJF
@@ -371,6 +379,7 @@ class PresentmentAmount(TypedDict, total=False):
     - `ETB` - ETB
     - `FKP` - FKP
     - `FJD` - FJD
+    - `XPF` - XPF
     - `GMD` - GMD
     - `GEL` - GEL
     - `GHS` - GHS
@@ -477,6 +486,7 @@ class PresentmentAmount(TypedDict, total=False):
     - `YER` - YER
     - `ZMW` - ZMW
     - `ZWG` - ZWG
+    - `BGN` - BGN
     """
 
     value: Required[str]

src/increase/types/card_update_params.py

@@ -296,5 +296,6 @@ class DigitalWallet(TypedDict, total=False):
     phone: str
     """
     A phone number that can be used to verify the cardholder via one-time passcode
-    over SMS.
+    over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
+    `(415) 555-0123`.
     """

src/increase/types/export.py

@@ -162,7 +162,7 @@ class EntityCsv(BaseModel):
 class FeeCsvCreatedAt(BaseModel):
     """Filter fees by their created date.
 
-    The time range must not include any fees that are part of an open fee statement.
+    The time range must not include any fees on an open fee statement.
     """
 
     after: Optional[datetime] = None
@@ -187,9 +187,21 @@ class FeeCsv(BaseModel):
     created_at: Optional[FeeCsvCreatedAt] = None
     """Filter fees by their created date.
 
-    The time range must not include any fees that are part of an open fee statement.
+    The time range must not include any fees on an open fee statement.
     """
 
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
+
 
 class Form1099Int(BaseModel):
     """Details of the Form 1099-INT export.

src/increase/types/export_create_params.py

@@ -270,7 +270,7 @@ class FeeCsvCreatedAt(TypedDict, total=False):
     """
 
 
-class FeeCsv(TypedDict, total=False):
+class FeeCsv(TypedDict, total=False, extra_items=object):  # type: ignore[call-arg]
     """Options for the created export. Required if `category` is equal to `fee_csv`."""
 
     created_at: FeeCsvCreatedAt

src/increase/types/physical_card.py

@@ -179,7 +179,7 @@ class Shipment(BaseModel):
 class PhysicalCard(BaseModel):
     """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 [[email protected]](mailto:[email protected]) for pricing!
+    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 [[email protected]](mailto:[email protected]) for pricing! For more information, see our guide on [physical card artwork](https://increase.com/documentation/card-art-physical-cards#carrier-image).
     """
 
     id: str