feat(api): add 'pin status' and 'pending_commands' to Card model (#548)

Author: stainless-app[bot]

src/lithic/resources/cards/cards.py

@@ -301,6 +301,7 @@ def update(
         digital_card_art_token: str | NotGiven = NOT_GIVEN,
         memo: str | NotGiven = NOT_GIVEN,
         pin: str | NotGiven = NOT_GIVEN,
+        pin_status: Literal["OK"] | NotGiven = NOT_GIVEN,
         spend_limit: int | NotGiven = NOT_GIVEN,
         spend_limit_duration: SpendLimitDuration | NotGiven = NOT_GIVEN,
         state: Literal["CLOSED", "OPEN", "PAUSED"] | NotGiven = NOT_GIVEN,
@@ -329,8 +330,11 @@ def update(
               store JSON data as it can cause unexpected behavior.
 
           pin: Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
-              `VIRTUAL`. See
-              [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block-enterprise).
+              `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
+              [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
+
+          pin_status: Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+              attempts). Can only be set to `OK` to unblock a card.
 
           spend_limit: Amount (in cents) to limit approved authorizations. Transaction requests above
               the spend limit will be declined. Note that a spend limit of 0 is effectively no
@@ -379,6 +383,7 @@ def update(
                     "digital_card_art_token": digital_card_art_token,
                     "memo": memo,
                     "pin": pin,
+                    "pin_status": pin_status,
                     "spend_limit": spend_limit,
                     "spend_limit_duration": spend_limit_duration,
                     "state": state,
@@ -1172,6 +1177,7 @@ async def update(
         digital_card_art_token: str | NotGiven = NOT_GIVEN,
         memo: str | NotGiven = NOT_GIVEN,
         pin: str | NotGiven = NOT_GIVEN,
+        pin_status: Literal["OK"] | NotGiven = NOT_GIVEN,
         spend_limit: int | NotGiven = NOT_GIVEN,
         spend_limit_duration: SpendLimitDuration | NotGiven = NOT_GIVEN,
         state: Literal["CLOSED", "OPEN", "PAUSED"] | NotGiven = NOT_GIVEN,
@@ -1200,8 +1206,11 @@ async def update(
               store JSON data as it can cause unexpected behavior.
 
           pin: Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
-              `VIRTUAL`. See
-              [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block-enterprise).
+              `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
+              [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
+
+          pin_status: Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+              attempts). Can only be set to `OK` to unblock a card.
 
           spend_limit: Amount (in cents) to limit approved authorizations. Transaction requests above
               the spend limit will be declined. Note that a spend limit of 0 is effectively no
@@ -1250,6 +1259,7 @@ async def update(
                     "digital_card_art_token": digital_card_art_token,
                     "memo": memo,
                     "pin": pin,
+                    "pin_status": pin_status,
                     "spend_limit": spend_limit,
                     "spend_limit_duration": spend_limit_duration,
                     "state": state,

src/lithic/types/card.py

@@ -71,6 +71,12 @@ class Card(BaseModel):
     last_four: str
     """Last four digits of the card number."""
 
+    pin_status: Literal["OK", "BLOCKED", "NOT_SET"]
+    """Indicates if a card is blocked due a PIN status issue (e.g.
+
+    excessive incorrect attempts).
+    """
+
     spend_limit: int
     """Amount (in cents) to limit approved authorizations.
 
@@ -176,6 +182,13 @@ class Card(BaseModel):
     [support@lithic.com](mailto:support@lithic.com) for questions.
     """
 
+    pending_commands: Optional[List[str]] = None
+    """
+    Indicates if there are offline PIN changes pending card interaction with an
+    offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
+    only to cards issued in markets supporting offline PINs.
+    """
+
     product_id: Optional[str] = None
     """Only applicable to cards of type `PHYSICAL`.
 

src/lithic/types/card_update_params.py

@@ -28,8 +28,15 @@ class CardUpdateParams(TypedDict, total=False):
     pin: str
     """Encrypted PIN block (in base64).
 
-    Only applies to cards of type `PHYSICAL` and `VIRTUAL`. See
-    [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block-enterprise).
+    Only applies to cards of type `PHYSICAL` and `VIRTUAL`. Changing PIN also resets
+    PIN status to `OK`. See
+    [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
+    """
+
+    pin_status: Literal["OK"]
+    """Indicates if a card is blocked due a PIN status issue (e.g.
+
+    excessive incorrect attempts). Can only be set to `OK` to unblock a card.
     """
 
     spend_limit: int

tests/api_resources/test_cards.py

@@ -140,6 +140,7 @@ def test_method_update_with_all_params(self, client: Lithic) -> None:
             digital_card_art_token="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             memo="Updated Name",
             pin="pin",
+            pin_status="OK",
             spend_limit=100,
             spend_limit_duration="ANNUALLY",
             state="CLOSED",
@@ -662,6 +663,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncLithic) ->
             digital_card_art_token="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             memo="Updated Name",
             pin="pin",
+            pin_status="OK",
             spend_limit=100,
             spend_limit_duration="ANNUALLY",
             state="CLOSED",