Make extra API schema fields accessible through Pydantic `model_extra…

…` attribute

CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog], and this project adheres to
 
 ## Unreleased
 
+### Changed
+- Make extra API schema fields accessible through Pydantic `model_extra` attribute.
+
 ### Fixed
 - Never expect undocumented API fields to be present.
 

src/pymonzo/accounts/schemas.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from typing import List, Optional, Union
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from pymonzo.accounts.enums import MonzoAccountCurrency, MonzoAccountType
 
@@ -37,6 +37,8 @@ class MonzoAccountOwner(BaseModel):
         preferred_first_name: First name preferred by the user.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     # Undocumented in API docs
     user_id: Optional[str] = None
     preferred_name: Optional[str] = None
@@ -65,6 +67,8 @@ class MonzoAccount(BaseModel):
         payment_details: Account payment details.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     id: str
     description: str
     created: datetime

src/pymonzo/attachments/schemas.py

@@ -2,7 +2,7 @@
 
 from datetime import datetime
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 
 class MonzoAttachment(BaseModel):
@@ -20,6 +20,8 @@ class MonzoAttachment(BaseModel):
         created: The timestamp in UTC when the attachment was created.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     id: str
     user_id: str
     external_id: str
@@ -39,5 +41,7 @@ class MonzoAttachmentResponse(BaseModel):
         upload_url: The URL to `POST` the file to when uploading.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     file_url: str
     upload_url: str

src/pymonzo/balance/schemas.py

@@ -2,7 +2,7 @@
 
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 # Optional `rich` support
 try:
@@ -41,6 +41,8 @@ class MonzoBalance(BaseModel):
         local_spend: Local spend.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     balance: int
     total_balance: int
     currency: str

src/pymonzo/feed/schemas.py

@@ -2,7 +2,7 @@
 
 from typing import Optional
 
-from pydantic import BaseModel, HttpUrl
+from pydantic import BaseModel, ConfigDict, HttpUrl
 
 
 class MonzoBasicFeedItem(BaseModel):
@@ -24,6 +24,8 @@ class MonzoBasicFeedItem(BaseModel):
             Defaults to standard app colours.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     title: str
     image_url: HttpUrl
     body: str

src/pymonzo/pots/schemas.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 # Optional `rich` support
 try:
@@ -53,6 +53,8 @@ class MonzoPot(BaseModel):
         has_virtual_cards: Whether the pot has linked virtual cards.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     id: str
     name: str
     style: str

src/pymonzo/transactions/schemas.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from typing import Dict, Optional, Union
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from pymonzo.transactions.enums import (
     MonzoTransactionCategory,
@@ -82,6 +82,8 @@ class MonzoTransactionMerchant(BaseModel):
         created: Merchant creation date.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     id: str
     group_id: str
     name: str
@@ -197,6 +199,8 @@ class MonzoTransaction(BaseModel):
         decline_reason: This is only present on declined transactions.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     amount: int
     created: datetime
     currency: str

src/pymonzo/webhooks/schemas.py

@@ -1,6 +1,6 @@
 """Monzo API 'webhooks' related schemas."""
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 from pymonzo.transactions import MonzoTransactionMerchant
 
@@ -17,6 +17,8 @@ class MonzoWebhook(BaseModel):
         url: The URL we will send notifications to.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     id: str
     account_id: str
     url: str
@@ -50,6 +52,8 @@ class MonzoWebhookTransactionEvent(BaseModel):
         merchant: Merchant information.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     account_id: str
     amount: int
     created: str
@@ -73,5 +77,7 @@ class MonzoWebhookEvent(BaseModel):
         data: Webhook event data.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     type: str
     data: MonzoWebhookTransactionEvent

src/pymonzo/whoami/schemas.py

@@ -1,6 +1,6 @@
 """Monzo API 'whoami' related schemas."""
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 # Optional `rich` support
 try:
@@ -23,6 +23,8 @@ class MonzoWhoAmI(BaseModel):
         user_id: User ID.
     """
 
+    model_config = ConfigDict(extra="allow")
+
     authenticated: bool
     client_id: str
     user_id: str