zscaler-sdk-python 0.3.1__tar.gz → 0.4.0__tar.gz

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.3.1
+Version: 0.4.0
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -24,9 +24,9 @@ Provides-Extra: dev
 Requires-Dist: aenum ; extra == "dev"
 Requires-Dist: arrow
 Requires-Dist: black (>=24.3.0) ; extra == "dev"
-Requires-Dist: certifi
+Requires-Dist: certifi (>=2024.2.2)
 Requires-Dist: charset-normalizer
-Requires-Dist: cryptography (>=3.4,<43.0)
+Requires-Dist: cryptography (>=42.0.7)
 Requires-Dist: flake8
 Requires-Dist: flatdict
 Requires-Dist: idna
@@ -38,7 +38,7 @@ Requires-Dist: python-dateutil
 Requires-Dist: pytz
 Requires-Dist: pyyaml
 Requires-Dist: requests (>=2.32.0)
-Requires-Dist: responses
+Requires-Dist: responses (>=0.25.0)
 Requires-Dist: restfly
 Requires-Dist: six
 Requires-Dist: xmltodict

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.3.1"
+version = "0.4.0"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -30,13 +30,13 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.8,<4.0"
 arrow = "*"
-certifi = "*"
+certifi = ">=2024.2.2"
 charset-normalizer = "*"
 idna = "*"
 python-box = "^7.1.1"
 python-dateutil = "*"
 requests = ">=2.32.0"
-responses = "*"
+responses = ">=0.25.0"
 restfly = "*"
 six = "*"
 flatdict = "*"
@@ -49,12 +49,13 @@ pydash = "*"
 flake8 = "*"
 pytz = "*"
 black = ">=24.3.0"
-cryptography = ">=3.4,<43.0"
+# cryptography = ">=3.4,<43.0"
+cryptography = ">=42.0.7"
 okta = ">=2.9.7"
 
 [tool.poetry.dev-dependencies]
 black = ">=24.3.0"
-pytest = "^8.2.1"
+pytest = ">=8.2.1"
 pytest-asyncio = ">=0.23.7"
 pytest-mock = "*"
 pytest-recording = "*"

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.4.0}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.3.1"
+__version__ = "0.4.0"
 
 from zscaler.zia import ZIAClientHelper  # noqa
 from zscaler.zpa import ZPAClientHelper  # noqa

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.4.0}/zscaler/constants.py

@@ -14,7 +14,7 @@ ZPA_BASE_URLS = {
 
 DEV_AUTH_URL = "https://authn1.dev.zpath.net/authn/v1/oauth/token"
 
-RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}
+RETRYABLE_STATUS_CODES = {409, 429, 500, 502, 503, 504}
 MAX_RETRIES = 5
 BACKOFF_FACTOR = 1
 BACKOFF_BASE_DURATION = 2

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.4.0}/zscaler/zpa/__init__.py

@@ -26,6 +26,7 @@ from zscaler.utils import (
     retry_with_backoff,
     snake_to_camel,
 )
+from zscaler.zpa.authdomains import AuthDomainsAPI
 from zscaler.zpa.app_segments import ApplicationSegmentAPI
 from zscaler.zpa.app_segments_inspection import AppSegmentsInspectionAPI
 from zscaler.zpa.app_segments_pra import AppSegmentsPRAAPI
@@ -39,6 +40,7 @@ from zscaler.zpa.inspection import InspectionControllerAPI
 from zscaler.zpa.isolation import IsolationAPI
 from zscaler.zpa.lss import LSSConfigControllerAPI
 from zscaler.zpa.machine_groups import MachineGroupsAPI
+from zscaler.zpa.microtenants import MicrotenantsAPI
 from zscaler.zpa.policies import PolicySetsAPI
 from zscaler.zpa.posture_profiles import PostureProfilesAPI
 from zscaler.zpa.privileged_remote_access import PrivilegedRemoteAccessAPI
@@ -81,12 +83,12 @@ class ZPAClientHelper(ZPAClient):
         client_secret,
         customer_id,
         cloud,
+        microtenant_id=None,
         timeout=240,
         cache=None,
         fail_safe=False,
     ):
         # Initialize rate limiter
-        # You may want to adjust these parameters as per your rate limit configuration
         self.rate_limiter = RateLimiter(
             get_limit=20,  # Adjusted to allow 20 GET requests per 10 seconds
             post_put_delete_limit=10,  # Adjusted to allow 10 POST/PUT/DELETE requests per 10 seconds
@@ -94,7 +96,6 @@ class ZPAClientHelper(ZPAClient):
             post_put_delete_freq=10,  # Adjust frequency to 10 seconds
         )
 
-        # Validate cloud value
         if cloud not in ZPA_BASE_URLS:
             valid_clouds = ", ".join(ZPA_BASE_URLS.keys())
             raise ValueError(
@@ -102,15 +103,13 @@ class ZPAClientHelper(ZPAClient):
                 f"Please use one of the following supported values: {valid_clouds}"
             )
 
-        # Continue with existing initialization...
-        # Select the appropriate URL
         self.baseurl = ZPA_BASE_URLS.get(cloud, ZPA_BASE_URLS["PRODUCTION"])
-
         self.timeout = timeout
         self.client_id = client_id
         self.client_secret = client_secret
         self.customer_id = customer_id
         self.cloud = cloud
+        self.microtenant_id = microtenant_id or os.getenv("ZPA_MICROTENANT_ID")
         self.url = f"{self.baseurl}/mgmtconfig/v1/admin/customers/{customer_id}"
         self.user_config_url = f"{self.baseurl}/userconfig/v1/customers/{customer_id}"
         self.v2_url = f"{self.baseurl}/mgmtconfig/v2/admin/customers/{customer_id}"
@@ -118,7 +117,6 @@ class ZPAClientHelper(ZPAClient):
         self.cbi_url = f"{self.baseurl}/cbiconfig/cbi/api/customers/{customer_id}"
         self.fail_safe = fail_safe
 
-        # Cache setup
         cache_enabled = os.environ.get("ZSCALER_CLIENT_CACHE_ENABLED", "true").lower() == "true"
         if cache is None:
             if cache_enabled:
@@ -130,7 +128,6 @@ class ZPAClientHelper(ZPAClient):
         else:
             self.cache = cache
 
-        # Initialize user-agent
         ua = UserAgent()
         self.user_agent = ua.get_user_agent_string()
         self.access_token = None
@@ -184,20 +181,34 @@ class ZPAClientHelper(ZPAClient):
         elif api_version == "cbiconfig_v1":
             api = self.cbi_url
 
+        if params is None:
+            params = {}
+
+        if json and "microtenant_id" in json:
+            microtenant_id = json.pop("microtenant_id")
+        else:
+            microtenant_id = self.microtenant_id
+
+        if microtenant_id:
+            params["microtenantId"] = microtenant_id
+
         url = f"{api}/{path.lstrip('/')}"
+        if params:
+            url = f"{url}?{urllib.parse.urlencode(params)}"
+
         start_time = time.time()
         headers_with_user_agent = self.headers.copy()
         headers_with_user_agent["User-Agent"] = self.user_agent
         request_uuid = uuid.uuid4()
-        dump_request(logger, url, method, json, params, headers_with_user_agent, request_uuid)
-        cache_key = self.cache.create_key(url, params)
+        dump_request(logger, url, method, json, None, headers_with_user_agent, request_uuid)
+        cache_key = self.cache.create_key(url, None)
         if method == "GET" and self.cache.contains(cache_key):
             resp = self.cache.get(cache_key)
             dump_response(
                 logger=logger,
                 url=url,
                 method=method,
-                params=params,
+                params=None,
                 resp=resp,
                 request_uuid=request_uuid,
                 start_time=start_time,
@@ -217,13 +228,14 @@ class ZPAClientHelper(ZPAClient):
                     method,
                     url,
                     json=json,
+                    params=None,
                     headers=headers_with_user_agent,
                     timeout=self.timeout,
                 )
                 dump_response(
                     logger=logger,
                     url=url,
-                    params=params,
+                    params=None,
                     method=method,
                     resp=resp,
                     request_uuid=request_uuid,
@@ -366,6 +378,7 @@ class ZPAClientHelper(ZPAClient):
         search_field="name",
         max_pages=None,
         max_items=None,
+        all_entries=False,  # Return all SCIM groups including the deleted ones if set to true
         sort_order=None,
         sort_by=None,
         sort_dir=None,
@@ -373,8 +386,10 @@ class ZPAClientHelper(ZPAClient):
         end_time=None,
         idp_group_id=None,
         scim_user_id=None,
+        scim_username=None,
         page=None,
-        pagesize=20,
+        pagesize=None,
+        microtenant_id=None,
     ):
         """
         Fetches paginated data from the ZPA API based on specified parameters and handles various types of API pagination.
@@ -417,15 +432,19 @@ class ZPAClientHelper(ZPAClient):
         if params is None:
             params = {}
 
-        if (page is not None or pagesize != 20) and (max_pages is not None or max_items is not None):
+        if (page is not None or pagesize is not None) and (max_pages is not None or max_items is not None):
             raise ValueError(
                 "Do not mix 'page' or 'pagesize' with 'max_pages' or 'max_items'. Choose either set of parameters."
             )
 
-        params["pagesize"] = min(pagesize, 500)  # Apply maximum constraint and handle default
+        params["page"] = page if page is not None else 1  # Default to page 1 if not specified
+        params["pagesize"] = min(pagesize if pagesize is not None else 20, 500)  # Apply maximum constraint and handle default
 
-        if page:
-            params["page"] = page
+        # Check for microtenantId in function arguments first, then environment variable
+        if microtenant_id:
+            params["microtenantId"] = microtenant_id
+        elif self.microtenant_id and "microtenantId" not in params:
+            params["microtenantId"] = self.microtenant_id
 
         if search:
             api_search_field = snake_to_camel(search_field)
@@ -443,6 +462,10 @@ class ZPAClientHelper(ZPAClient):
             params["idpGroupId"] = idp_group_id
         if scim_user_id:
             params["scimUserId"] = scim_user_id
+        if scim_username:
+            params["scimUserName"] = scim_username
+        if all_entries:
+            params["allEntries"] = all_entries
 
         total_collected = 0
         ret_data = []
@@ -456,17 +479,18 @@ class ZPAClientHelper(ZPAClient):
                 if should_wait:
                     time.sleep(delay)
 
-                url = f"{path}?{urllib.parse.urlencode(params)}"
-                response = self.send("GET", url, api_version=api_version)
+                response = self.send("GET", path=path, params=params, api_version=api_version)
 
                 if response.status_code != expected_status_code:
-                    error_msg = ERROR_MESSAGES["UNEXPECTED_STATUS"].format(status_code=response.status_code, page=page)
+                    error_msg = ERROR_MESSAGES["UNEXPECTED_STATUS"].format(
+                        status_code=response.status_code, page=params["page"]
+                    )
                     logger.error(error_msg)
                     return BoxList([]), error_msg
 
                 response_data = response.json()
                 data = response_data.get("list", [])
-                if not data and (page is None or page == 1):
+                if not data and (params["page"] == 1):
                     error_msg = ERROR_MESSAGES["EMPTY_RESULTS"]
                     logger.warn(error_msg)
                     return BoxList([]), error_msg
@@ -478,12 +502,11 @@ class ZPAClientHelper(ZPAClient):
                 if max_items is not None and total_collected >= max_items:
                     break
 
-                nextPage = response_data.get("nextPage")
-                if not nextPage or (max_pages is not None and page >= max_pages):
+                next_page = response_data.get("nextPage")
+                if not next_page or (max_pages is not None and params["page"] >= max_pages):
                     break
 
-                page = nextPage if page is None else page + 1
-                params["page"] = page
+                params["page"] = next_page if params["page"] is None else params["page"] + 1
 
         finally:
             time.sleep(2)  # Ensure a delay between requests regardless of outcome
@@ -495,6 +518,14 @@ class ZPAClientHelper(ZPAClient):
 
         return BoxList(ret_data), None
 
+    @property
+    def authdomains(self):
+        """
+        The interface object for the :ref:`ZPA Auth Domains interface <zpa-authdomains>`.
+
+        """
+        return AuthDomainsAPI(self)
+
     @property
     def app_segments(self):
         """
@@ -591,6 +622,14 @@ class ZPAClientHelper(ZPAClient):
         """
         return MachineGroupsAPI(self)
 
+    @property
+    def microtenants(self):
+        """
+        The interface object for the :ref:`ZPA Microtenants interface <zpa-microtenants>`.
+
+        """
+        return MicrotenantsAPI(self)
+
     @property
     def policies(self):
         """

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.4.0}/zscaler/zpa/app_segments.py

@@ -62,7 +62,7 @@ class ApplicationSegmentAPI:
         list, _ = self.rest.get_paginated_data(path="/application", **kwargs, api_version="v1")
         return list
 
-    def get_segment(self, segment_id: str) -> Box:
+    def get_segment(self, segment_id: str, **kwargs) -> Box:
         """
         Get information for an application segment.
 
@@ -77,15 +77,30 @@ class ApplicationSegmentAPI:
             >>> app_segment = zpa.app_segments.details('99999')
 
         """
-        response = self.rest.get("/application/%s" % (segment_id))
-        if isinstance(response, Response):
-            status_code = response.status_code
-            if status_code != 200:
-                return None
-        return response
+        params = {}
+        if "microtenant_id" in kwargs:
+            params["microtenantId"] = kwargs.pop("microtenant_id")
+        return self.rest.get(f"application/{segment_id}", params=params)
+
+    def get_segment_by_name(self, name: str, **kwargs):
+        """
+        Returns information on the application segment with the specified name.
+
+        Args:
+            name (str): The name of the application segment.
 
-    def get_segment_by_name(self, name):
-        apps = self.list_segments()
+        Returns:
+            :obj:`Box` or None: The resource record for the application segment  if found, otherwise None.
+
+        Examples:
+            >>> appsegment = zpa.app_segments.get_segment_by_name('example_name')
+            >>> if appsegment:
+            ...     pprint(appsegment)
+            ... else:
+            ...     print("Application segment not found")
+
+        """
+        apps = self.list_segments(**kwargs)
         for app in apps:
             if app.get("name") == name:
                 return app
@@ -117,44 +132,14 @@ class ApplicationSegmentAPI:
             >>> app_segments = zpa.app_segments.get_segments_by_type(app_type, expand_all, search=search)
         """
         params = {"applicationType": application_type, "expandAll": "true" if expand_all else "false"}
-        # Include additional search parameters if specified
         if "search" in kwargs:
             params["search"] = kwargs["search"]
 
         result, error = self.rest.get_paginated_data(path="/application/getAppsByType", params=params, **kwargs)
         if error:
-            return BoxList([])  # Return an empty BoxList on failure due to the error
+            return BoxList([])
         return result
 
-    def delete_segment(self, segment_id: str, force_delete: bool = False) -> int:
-        """
-        Delete an application segment.
-
-        Args:
-            force_delete (bool):
-                Setting this field to true deletes the mapping between Application Segment and Segment Group.
-            segment_id (str):
-                The unique identifier for the application segment.
-
-        Returns:
-            :obj:`int`: The operation response code.
-
-        Examples:
-            Delete an Application Segment with an id of 99999.
-
-            >>> zpa.app_segments.delete('99999')
-
-            Force deletion of an Application Segment with an id of 88888.
-
-            >>> zpa.app_segments.delete('88888', force_delete=True)
-
-        """
-        query = ""
-        if force_delete:
-            query = "forceDelete=true"
-        response = self.rest.delete("/application/%s?%s" % (segment_id, query))
-        return response.status_code
-
     def add_segment(
         self,
         name: str,
@@ -204,7 +189,6 @@ class ApplicationSegmentAPI:
             ...    tcp_port_ranges=['8080', '8085'],
             ...    server_group_ids=['99999', '88888'])
         """
-        # Initialise payload
         payload = {
             "name": name,
             "domainNames": domain_names,
@@ -213,33 +197,26 @@ class ApplicationSegmentAPI:
             "segmentGroupId": segment_group_id,
             "serverGroups": [{"id": group_id} for group_id in server_group_ids],
         }
-
-        # Handle clientless_app_ids separately
         if "clientless_app_ids" in kwargs:
             clientless_apps = kwargs.pop("clientless_app_ids")
             payload["clientlessApps"] = transform_clientless_apps(clientless_apps)
 
-        # add_id_groups(self.reformat_params, kwargs, payload)
-
-        # # Add optional parameters to payload
-        # for key, value in kwargs.items():
-        #     payload[snake_to_camel(key)] = value
         add_id_groups(self.reformat_params, kwargs, payload)
         for key, value in kwargs.items():
             if value is not None:
                 payload[snake_to_camel(key)] = value
 
-        # Convert the entire payload's keys to camelCase before sending
         camel_payload = recursive_snake_to_camel(payload)
         for key, value in kwargs.items():
             if value is not None:
                 camel_payload[snake_to_camel(key)] = value
 
-        response = self.rest.post("application", json=payload)
+        microtenant_id = kwargs.pop("microtenant_id", None)
+        params = {"microtenantId": microtenant_id} if microtenant_id else {}
+
+        response = self.rest.post("application", json=payload, params=params)
         if isinstance(response, Response):
-            # this is only true when the creation failed (status code is not 2xx)
             status_code = response.status_code
-            # Handle error response
             raise Exception(f"API call failed with status {status_code}: {response.json()}")
         return response
 
@@ -306,7 +283,6 @@ class ApplicationSegmentAPI:
             ...    name='new_app_name',
 
         """
-        # Set payload to value of existing record and convert nested dict keys.
         payload = convert_keys(self.get_segment(segment_id))
 
         if kwargs.get("tcp_port_ranges"):
@@ -315,38 +291,143 @@ class ApplicationSegmentAPI:
         if kwargs.get("udp_port_ranges"):
             payload["udpPortRange"] = [{"from": ports[0], "to": ports[1]} for ports in kwargs.pop("udp_port_ranges")]
 
-        # Handle the clientless_app_ids directly within this function without a separate helper
         if kwargs.get("clientless_app_ids"):
-            # Here you would implement any necessary formatting directly
             formatted_clientless_apps = [{"id": app.get("id")} for app in kwargs.pop("clientless_app_ids")]
-            payload["clientlessApps"] = formatted_clientless_apps  # use the correct key expected by your API
+            payload["clientlessApps"] = formatted_clientless_apps
 
-        # Convert other keys in payload
         add_id_groups(self.reformat_params, kwargs, payload)
 
-        # Add remaining optional parameters to payload
         for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
-        resp = self.rest.put(f"application/{segment_id}", json=payload).status_code
+        microtenant_id = kwargs.pop("microtenant_id", None)
+        params = {"microtenantId": microtenant_id} if microtenant_id else {}
 
-        # Return the object if it was updated successfully
+        resp = self.rest.put(f"application/{segment_id}", json=payload, params=params).status_code
         if not isinstance(resp, Response):
             return self.get_segment(segment_id)
 
-    def detach_from_segment_group(self, app_id, seg_group_id):
-        seg_group = self.rest.get("/segmentGroup/%s" % (seg_group_id))
-        if isinstance(seg_group, Response):
-            status_code = seg_group.status_code
-            if status_code > 299:
-                return None
-        apps = seg_group.get("applications", [])
-        addaptedApps = []
-        for app in apps:
-            if app.get("id") != app_id:
-                addaptedApps.append(app)
-        seg_group["applications"] = addaptedApps
-        self.rest.put(
-            "/segmentGroup/%s" % (seg_group_id),
-            json=seg_group,
-        )
+    def delete_segment(self, segment_id: str, force_delete: bool = False, **kwargs) -> int:
+        """
+        Delete an application segment.
+
+        Args:
+            force_delete (bool):
+                Setting this field to true deletes the mapping between Application Segment and Segment Group.
+            segment_id (str):
+                The unique identifier for the application segment.
+
+        Returns:
+            :obj:`int`: The operation response code.
+
+        Examples:
+            Delete an Application Segment with an id of 99999.
+
+            >>> zpa.app_segments.delete('99999')
+
+            Force deletion of an Application Segment with an id of 88888.
+
+            >>> zpa.app_segments.delete_segment('88888', force_delete=True)
+
+        """
+        params = {}
+        if "microtenant_id" in kwargs:
+            params["microtenantId"] = kwargs.pop("microtenant_id")
+        query = "forceDelete=true" if force_delete else ""
+        response = self.rest.delete(f"/application/{segment_id}?{query}", params=params)
+        return response.status_code
+
+    def app_segment_move(self, application_id: str, **kwargs) -> Box:
+        """
+        Moves application segments from one microtenant to another
+        Note: Application segments can only be moved from a Default Microtenant microtenant_id as 0 to a child tenant
+
+        Args:
+            application_id (str):
+                The unique identifier of the Application Segment.
+            target_segment_group_id (str):
+                The unique identifier of the target segment group that the application segment is being moved to.
+            target_server_group_id (str):
+                The unique identifier of the target server group that the application segment is being moved to.
+            target_microtenant_id (str):
+                The unique identifier of the Microtenant that the application segment is being moved to.
+
+        Keyword Args:
+            ...
+
+        Returns:
+            :obj:`Box`: The resource record for the moved application segment.
+
+        Examples:
+            Moving an application segment to another microtenant:
+
+            >>> zpa.app_segments.app_segment_move(
+            ...    application_id='216199618143373016',
+            ...    target_segment_group_id='216199618143373010',
+            ...    target_server_group_id='216199618143373012',
+            ...    target_microtenant_id='216199618143372994'
+            ... )
+
+        """
+        payload = {
+            "targetSegmentGroupId": kwargs.pop("target_segment_group_id", None),
+            "targetMicrotenantId": kwargs.pop("target_microtenant_id", None),
+            "targetServerGroupId": kwargs.pop("target_server_group_id", None),
+        }
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        microtenant_id = kwargs.pop("microtenant_id", None)
+        params = {"microtenantId": microtenant_id} if microtenant_id else {}
+
+        response = self.rest.post(f"application/{application_id}/move", json=payload, params=params)
+        if response.status_code == 204:
+            return Box({})
+        elif isinstance(response, Response):
+            status_code = response.status_code
+            raise Exception(f"API call failed with status {status_code}: {response.json()}")
+        return response
+
+    def app_segment_share(self, application_id: str, **kwargs) -> Box:
+        """
+        Moves application segments from one microtenant to another
+        Note: Application segments can only be shared between child tenants.
+
+        Args:
+            application_id (str):
+                The unique identifier of the Application Segment.
+            share_to_microtenants (:obj:`list` of :obj:`str`):
+                The unique identifier of the Microtenant that the application segment is being shared to.
+                This field is required if you want to share an application segment.
+                To remove the share send the attribute as an empty list.
+        Keyword Args:
+            ...
+
+        Returns:
+            :obj:`Box`: An empty Box object if the operation is successful.
+
+        Examples:
+            Moving an application segment to another microtenant:
+
+            >>> zpa.app_segments.app_segment_share(
+            ...    application_id='216199618143373016',
+            ...    share_to_microtenants=['216199618143373010']
+            ... )
+
+        """
+        payload = {
+            "shareToMicrotenants": kwargs.pop("share_to_microtenants", None),
+        }
+        for key, value in kwargs.items():
+            payload[snake_to_camel(key)] = value
+
+        microtenant_id = kwargs.pop("microtenant_id", None)
+        params = {"microtenantId": microtenant_id} if microtenant_id else {}
+
+        response = self.rest.put(f"application/{application_id}/share", json=payload, params=params)
+        if response.status_code == 204:
+            return Box({})
+        elif isinstance(response, Response):
+            status_code = response.status_code
+            raise Exception(f"API call failed with status {status_code}: {response.json()}")
+        return response