Deprecate webhooks module and base::get_credit_balance function (#755)

Author: iliascholl-up42

CHANGELOG.md

@@ -30,6 +30,10 @@ You can check your current version with the following command:
 
 For more information, see [UP42 Python package description](https://pypi.org/project/up42-py/).
 
+### 2.4.0a3
+**July 15, 2025**
+- Deprecated the `webhooks` module and the `base::get_credits_balance` function
+
 ### 2.4.0a2
 **July 07, 2025**
 - Added `provider_properties` data field to `glossary::Scene` active record class.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "up42-py"
-version = "2.4.0a2"
+version = "2.4.0a3"
 description = "Python SDK for UP42, the geospatial marketplace and developer platform."
 authors = ["UP42 GmbH <[email protected]>"]
 license = "https://github.com/up42/up42-py/blob/master/LICENSE"

up42/base.py

@@ -67,6 +67,7 @@ def authenticate(
         self._id = user_info["sub"]
         self._auth = up42_client.auth
 
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def get_credits_balance(self) -> dict:
         """
         Display the overall credits available in your account.

up42/webhooks.py

@@ -27,6 +27,7 @@ class Webhook:
     Also see the [full webhook documentation](https://docs.up42.com/account/webhooks).
     """
 
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def save(self):
         payload = {
             "name": self.name,
@@ -49,6 +50,7 @@ def save(self):
             logger.info("Created webhook %s", self)
 
     @staticmethod
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def from_metadata(metadata: dict) -> "Webhook":
         return Webhook(
             id=metadata["id"],
@@ -62,11 +64,13 @@ def from_metadata(metadata: dict) -> "Webhook":
         )
 
     @classmethod
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def get(cls, webhook_id: str) -> "Webhook":
         url = host.endpoint(f"/workspaces/{cls.workspace_id}/webhooks/{webhook_id}")
         metadata = cls.session.get(url).json()["data"]
         return cls.from_metadata(metadata)
 
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def trigger_test_events(self) -> dict:
         """
         Triggers webhook test event to test your receiving side. The UP42 server will send test
@@ -78,6 +82,7 @@ def trigger_test_events(self) -> dict:
         url = host.endpoint(f"/workspaces/{self.workspace_id}/webhooks/{self.id}/tests")
         return self.session.post(url=url).json()["data"]
 
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def delete(self) -> None:
         """
         Deletes a registered webhook.
@@ -87,6 +92,7 @@ def delete(self) -> None:
         logger.info("Successfully deleted Webhook: %s", self.id)
 
     @classmethod
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def get_webhook_events(cls) -> list[dict]:
         """
         Gets all available webhook events.
@@ -98,6 +104,7 @@ def get_webhook_events(cls) -> list[dict]:
         return cls.session.get(url=url).json()["data"]
 
     @classmethod
+    @utils.deprecation(replacement_name=None, version="3.0.0")
     def all(cls) -> List["Webhook"]:
         """
         Gets all registered webhooks for this workspace.