bely-api 2026.3.dev1__tar.gz → 2026.3.dev3__tar.gz

{bely_api-2026.3.dev1 → bely_api-2026.3.dev3}/BelyApiFactory.py

@@ -4,6 +4,7 @@
 # See LICENSE file.
 import base64
 import os
+import warnings
 
 from belyApi import Configuration, ApiClient
 from belyApi import (
@@ -37,39 +38,56 @@ class BelyApiFactory:
             api_client=self.api_client
         )
 
-        self.downloadsApi = DownloadsApi(api_client=self.api_client)
-        self.propertyValueApi = PropertyValueApi(api_client=self.api_client)
-        self.usersApi = UsersApi(api_client=self.api_client)
-        self.domainApi = DomainApi(api_client=self.api_client)
+        self.downloads_api = DownloadsApi(api_client=self.api_client)
+        self.property_value_api = PropertyValueApi(api_client=self.api_client)
+        self.users_api = UsersApi(api_client=self.api_client)
+        self.domain_api = DomainApi(api_client=self.api_client)
 
-        self.systemlogApi = SystemLogApi(api_client=self.api_client)
-        self.searchApi = SearchApi(api_client=self.api_client)
+        self.systemlog_api = SystemLogApi(api_client=self.api_client)
+        self.search_api = SearchApi(api_client=self.api_client)
+
+        # Deprecated camelCase aliases
+        self.downloadsApi = self.downloads_api
+        self.propertyValueApi = self.property_value_api
+        self.usersApi = self.users_api
+        self.domainApi = self.domain_api
+        self.systemlogApi = self.systemlog_api
+        self.searchApi = self.search_api
 
         self.auth_api = AuthenticationApi(api_client=self.api_client)
 
+    def _deprecated(self, old_name, new_name):
+        warnings.warn(
+            f"{old_name} is deprecated, use {new_name} instead",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+
+    # -- snake_case methods (primary) --
+
     def get_lobook_api(self) -> LogbookApi:
         return self.logbook_api
 
-    def getDomainApi(self) -> DomainApi:
-        return self.domainApi
+    def get_domain_api(self) -> DomainApi:
+        return self.domain_api
 
-    def getDownloadApi(self) -> DownloadsApi:
-        return self.downloadsApi
+    def get_download_api(self) -> DownloadsApi:
+        return self.downloads_api
 
-    def getPropertyValueApi(self) -> PropertyValueApi:
-        return self.propertyValueApi
+    def get_property_value_api(self) -> PropertyValueApi:
+        return self.property_value_api
 
-    def getUsersApi(self) -> UsersApi:
-        return self.usersApi
+    def get_users_api(self) -> UsersApi:
+        return self.users_api
 
-    def getSearchApi(self) -> SearchApi:
-        return self.searchApi
+    def get_search_api(self) -> SearchApi:
+        return self.search_api
 
-    def getNotificationConfigurationApi(self):
+    def get_notification_configuration_api(self):
         return self.notification_configuration_api
 
-    def generateCDBUrlForItemId(self, itemId):
-        return self.URL_FORMAT % (self.cdbUrl, str(itemId))
+    def generate_cdb_url_for_item_id(self, item_id):
+        return self.URL_FORMAT % (self.bely_url, str(item_id))
 
     def authenticate_user(self, username, password):
         response = self.auth_api.authenticate_user_with_http_info(
@@ -82,8 +100,8 @@ class BelyApiFactory:
     def __set_authenticate_token(self, token):
         self.api_client.set_default_header(self.HEADER_TOKEN_KEY, token)
 
-    def getAuthenticateToken(self):
-        return self.apiClient.default_headers[self.HEADER_TOKEN_KEY]
+    def get_authenticate_token(self):
+        return self.api_client.default_headers[self.HEADER_TOKEN_KEY]
 
     def test_authenticated(self):
         self.auth_api.verify_authenticated()
@@ -91,6 +109,51 @@ class BelyApiFactory:
     def logout_user(self):
         self.auth_api.log_out()
 
+    def parse_api_exception(self, open_api_exception):
+        response_type = ApiExceptionMessage.__name__
+        open_api_exception.data = open_api_exception.body
+        ex_obj = self.api_client.deserialize(open_api_exception, response_type)
+        ex_obj.status = open_api_exception.status
+        return ex_obj
+
+    # -- Deprecated camelCase wrappers --
+
+    def getDomainApi(self) -> DomainApi:
+        self._deprecated("getDomainApi", "get_domain_api")
+        return self.get_domain_api()
+
+    def getDownloadApi(self) -> DownloadsApi:
+        self._deprecated("getDownloadApi", "get_download_api")
+        return self.get_download_api()
+
+    def getPropertyValueApi(self) -> PropertyValueApi:
+        self._deprecated("getPropertyValueApi", "get_property_value_api")
+        return self.get_property_value_api()
+
+    def getUsersApi(self) -> UsersApi:
+        self._deprecated("getUsersApi", "get_users_api")
+        return self.get_users_api()
+
+    def getSearchApi(self) -> SearchApi:
+        self._deprecated("getSearchApi", "get_search_api")
+        return self.get_search_api()
+
+    def getNotificationConfigurationApi(self):
+        self._deprecated("getNotificationConfigurationApi", "get_notification_configuration_api")
+        return self.get_notification_configuration_api()
+
+    def generateCDBUrlForItemId(self, itemId):
+        self._deprecated("generateCDBUrlForItemId", "generate_cdb_url_for_item_id")
+        return self.generate_cdb_url_for_item_id(itemId)
+
+    def getAuthenticateToken(self):
+        self._deprecated("getAuthenticateToken", "get_authenticate_token")
+        return self.get_authenticate_token()
+
+    def parseApiException(self, openApiException):
+        self._deprecated("parseApiException", "parse_api_exception")
+        return self.parse_api_exception(openApiException)
+
     # Restore later
     # @classmethod
     # def createFileUploadObject(cls, filePath):
@@ -100,13 +163,6 @@ class BelyApiFactory:
     # 	fileName = os.path.basename(filePath)
     # 	return FileUploadObject(file_name=fileName, base64_binary=b64String)
 
-    def parseApiException(self, openApiException):
-        responseType = ApiExceptionMessage.__name__
-        openApiException.data = openApiException.body
-        exObj = self.apiClient.deserialize(openApiException, responseType)
-        exObj.status = openApiException.status
-        return exObj
-
 
 # def run_command():
 # Example

{bely_api-2026.3.dev1 → bely_api-2026.3.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bely_api
-Version: 2026.3.dev1
+Version: 2026.3.dev3
 Summary: Python client API library used to communicate with BELY API.
 Home-page: https://git.aps.anl.gov/controls/hla/bely
 Maintainer: Dariusz Jarosz

{bely_api-2026.3.dev1 → bely_api-2026.3.dev3}/belyApi/api/authentication_api.py

@@ -367,6 +367,7 @@ class AuthenticationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -428,6 +429,7 @@ class AuthenticationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -489,6 +491,7 @@ class AuthenticationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -526,13 +529,6 @@ class AuthenticationApi:
         # process the body parameter
 
 
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    '*/*'
-                ]
-            )
 
 
         # authentication setting
@@ -606,6 +602,7 @@ class AuthenticationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bool",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -667,6 +664,7 @@ class AuthenticationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bool",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -728,6 +726,7 @@ class AuthenticationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bool",
         }
         response_data = self.api_client.call_api(
             *_param,

{bely_api-2026.3.dev1 → bely_api-2026.3.dev3}/belyApi/api/domain_api.py

@@ -94,6 +94,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[EntityType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -159,6 +160,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[EntityType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -224,6 +226,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[EntityType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -348,6 +351,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Domain",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -413,6 +417,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Domain",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -478,6 +483,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Domain",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -602,6 +608,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Domain",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -667,6 +674,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Domain",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -732,6 +740,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Domain",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -856,6 +865,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemCategory]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -921,6 +931,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemCategory]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -986,6 +997,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemCategory]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1106,6 +1118,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[Domain]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1167,6 +1180,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[Domain]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1228,6 +1242,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[Domain]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1349,6 +1364,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1414,6 +1430,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1479,6 +1496,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1603,6 +1621,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1668,6 +1687,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1733,6 +1753,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemType]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1857,6 +1878,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ItemCategory",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1922,6 +1944,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ItemCategory",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1987,6 +2010,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ItemCategory",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -2111,6 +2135,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemCategory]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -2176,6 +2201,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemCategory]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -2241,6 +2267,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[ItemCategory]",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -2365,6 +2392,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ItemType",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -2430,6 +2458,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ItemType",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -2495,6 +2524,7 @@ class DomainApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ItemType",
         }
         response_data = self.api_client.call_api(
             *_param,

{bely_api-2026.3.dev1 → bely_api-2026.3.dev3}/belyApi/api/downloads_api.py

@@ -89,6 +89,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -154,6 +155,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -219,6 +221,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -259,13 +262,6 @@ class DownloadsApi:
         # process the body parameter
 
 
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    '*/*'
-                ]
-            )
 
 
         # authentication setting
@@ -347,6 +343,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -416,6 +413,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -485,6 +483,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -528,13 +527,6 @@ class DownloadsApi:
         # process the body parameter
 
 
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    'image/png'
-                ]
-            )
 
 
         # authentication setting
@@ -612,6 +604,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -677,6 +670,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -742,6 +736,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -782,13 +777,6 @@ class DownloadsApi:
         # process the body parameter
 
 
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    'image/png'
-                ]
-            )
 
 
         # authentication setting
@@ -870,6 +858,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -939,6 +928,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1008,6 +998,7 @@ class DownloadsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -1051,13 +1042,6 @@ class DownloadsApi:
         # process the body parameter
 
 
-        # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    '*/*'
-                ]
-            )
 
 
         # authentication setting