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

{bely_api-2026.3.dev0 → 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,53 +38,70 @@ 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(
             username=username, password=password
         )
 
-        token = response[-1][self.HEADER_TOKEN_KEY]
+        token = response.headers[self.HEADER_TOKEN_KEY]
         self.__set_authenticate_token(token)
 
     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.dev0 → bely_api-2026.3.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bely_api
-Version: 2026.3.dev0
+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.dev3/belyApi/__init__.py

@@ -0,0 +1,173 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    BELY API
+
+    The API that provides access to BELY data.
+
+    The version of the OpenAPI document: 2024.5
+    Contact: djarosz@anl.gov
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "AuthenticationApi",
+    "DownloadsApi",
+    "LogbookApi",
+    "NotificationConfigurationApi",
+    "PropertyValueApi",
+    "SearchApi",
+    "SystemLogApi",
+    "TestApi",
+    "UsersApi",
+    "DomainApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AllowedPropertyValue",
+    "ApiExceptionMessage",
+    "ApiExceptionMessageException",
+    "ApiExceptionMessageExceptionCause",
+    "ApiExceptionMessageExceptionCauseStackTraceInner",
+    "ApiExceptionMessageExceptionCauseSuppressedInner",
+    "Connector",
+    "ConnectorType",
+    "Domain",
+    "EntityInfo",
+    "EntityType",
+    "Item",
+    "ItemCategory",
+    "ItemConnector",
+    "ItemDomainLogbook",
+    "ItemElement",
+    "ItemElementHistory",
+    "ItemElementRelationship",
+    "ItemElementRelationshipHistory",
+    "ItemProject",
+    "ItemResource",
+    "ItemSource",
+    "ItemType",
+    "ListTbl",
+    "Log",
+    "LogDocumentOptions",
+    "LogDocumentSection",
+    "LogEntry",
+    "LogReaction",
+    "LogbookSearchResults",
+    "NotificationConfiguration",
+    "NotificationConfigurationHandlerSetting",
+    "NotificationConfigurationSetting",
+    "NotificationHandlerConfigKey",
+    "NotificationProvider",
+    "NotificationProviderConfigKey",
+    "PropertyMetadata",
+    "PropertyType",
+    "PropertyValue",
+    "PropertyValueHistory",
+    "Reaction",
+    "RelationshipType",
+    "RelationshipTypeHandler",
+    "ResourceType",
+    "ResourceTypeCategory",
+    "RoleType",
+    "SearchEntitiesOptions",
+    "SearchEntitiesResults",
+    "SearchResult",
+    "Source",
+    "UserGroup",
+    "UserInfo",
+    "UserRole",
+]
+
+# import apis into sdk package
+from belyApi.api.authentication_api import AuthenticationApi as AuthenticationApi
+from belyApi.api.downloads_api import DownloadsApi as DownloadsApi
+from belyApi.api.logbook_api import LogbookApi as LogbookApi
+from belyApi.api.notification_configuration_api import NotificationConfigurationApi as NotificationConfigurationApi
+from belyApi.api.property_value_api import PropertyValueApi as PropertyValueApi
+from belyApi.api.search_api import SearchApi as SearchApi
+from belyApi.api.system_log_api import SystemLogApi as SystemLogApi
+from belyApi.api.test_api import TestApi as TestApi
+from belyApi.api.users_api import UsersApi as UsersApi
+from belyApi.api.domain_api import DomainApi as DomainApi
+
+# import ApiClient
+from belyApi.api_response import ApiResponse as ApiResponse
+from belyApi.api_client import ApiClient as ApiClient
+from belyApi.configuration import Configuration as Configuration
+from belyApi.exceptions import OpenApiException as OpenApiException
+from belyApi.exceptions import ApiTypeError as ApiTypeError
+from belyApi.exceptions import ApiValueError as ApiValueError
+from belyApi.exceptions import ApiKeyError as ApiKeyError
+from belyApi.exceptions import ApiAttributeError as ApiAttributeError
+from belyApi.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from belyApi.models.allowed_property_value import AllowedPropertyValue as AllowedPropertyValue
+from belyApi.models.api_exception_message import ApiExceptionMessage as ApiExceptionMessage
+from belyApi.models.api_exception_message_exception import ApiExceptionMessageException as ApiExceptionMessageException
+from belyApi.models.api_exception_message_exception_cause import ApiExceptionMessageExceptionCause as ApiExceptionMessageExceptionCause
+from belyApi.models.api_exception_message_exception_cause_stack_trace_inner import ApiExceptionMessageExceptionCauseStackTraceInner as ApiExceptionMessageExceptionCauseStackTraceInner
+from belyApi.models.api_exception_message_exception_cause_suppressed_inner import ApiExceptionMessageExceptionCauseSuppressedInner as ApiExceptionMessageExceptionCauseSuppressedInner
+from belyApi.models.connector import Connector as Connector
+from belyApi.models.connector_type import ConnectorType as ConnectorType
+from belyApi.models.domain import Domain as Domain
+from belyApi.models.entity_info import EntityInfo as EntityInfo
+from belyApi.models.entity_type import EntityType as EntityType
+from belyApi.models.item import Item as Item
+from belyApi.models.item_category import ItemCategory as ItemCategory
+from belyApi.models.item_connector import ItemConnector as ItemConnector
+from belyApi.models.item_domain_logbook import ItemDomainLogbook as ItemDomainLogbook
+from belyApi.models.item_element import ItemElement as ItemElement
+from belyApi.models.item_element_history import ItemElementHistory as ItemElementHistory
+from belyApi.models.item_element_relationship import ItemElementRelationship as ItemElementRelationship
+from belyApi.models.item_element_relationship_history import ItemElementRelationshipHistory as ItemElementRelationshipHistory
+from belyApi.models.item_project import ItemProject as ItemProject
+from belyApi.models.item_resource import ItemResource as ItemResource
+from belyApi.models.item_source import ItemSource as ItemSource
+from belyApi.models.item_type import ItemType as ItemType
+from belyApi.models.list_tbl import ListTbl as ListTbl
+from belyApi.models.log import Log as Log
+from belyApi.models.log_document_options import LogDocumentOptions as LogDocumentOptions
+from belyApi.models.log_document_section import LogDocumentSection as LogDocumentSection
+from belyApi.models.log_entry import LogEntry as LogEntry
+from belyApi.models.log_reaction import LogReaction as LogReaction
+from belyApi.models.logbook_search_results import LogbookSearchResults as LogbookSearchResults
+from belyApi.models.notification_configuration import NotificationConfiguration as NotificationConfiguration
+from belyApi.models.notification_configuration_handler_setting import NotificationConfigurationHandlerSetting as NotificationConfigurationHandlerSetting
+from belyApi.models.notification_configuration_setting import NotificationConfigurationSetting as NotificationConfigurationSetting
+from belyApi.models.notification_handler_config_key import NotificationHandlerConfigKey as NotificationHandlerConfigKey
+from belyApi.models.notification_provider import NotificationProvider as NotificationProvider
+from belyApi.models.notification_provider_config_key import NotificationProviderConfigKey as NotificationProviderConfigKey
+from belyApi.models.property_metadata import PropertyMetadata as PropertyMetadata
+from belyApi.models.property_type import PropertyType as PropertyType
+from belyApi.models.property_value import PropertyValue as PropertyValue
+from belyApi.models.property_value_history import PropertyValueHistory as PropertyValueHistory
+from belyApi.models.reaction import Reaction as Reaction
+from belyApi.models.relationship_type import RelationshipType as RelationshipType
+from belyApi.models.relationship_type_handler import RelationshipTypeHandler as RelationshipTypeHandler
+from belyApi.models.resource_type import ResourceType as ResourceType
+from belyApi.models.resource_type_category import ResourceTypeCategory as ResourceTypeCategory
+from belyApi.models.role_type import RoleType as RoleType
+from belyApi.models.search_entities_options import SearchEntitiesOptions as SearchEntitiesOptions
+from belyApi.models.search_entities_results import SearchEntitiesResults as SearchEntitiesResults
+from belyApi.models.search_result import SearchResult as SearchResult
+from belyApi.models.source import Source as Source
+from belyApi.models.user_group import UserGroup as UserGroup
+from belyApi.models.user_info import UserInfo as UserInfo
+from belyApi.models.user_role import UserRole as UserRole
+

{bely_api-2026.3.dev0 → bely_api-2026.3.dev3}/belyApi/api/__init__.py

@@ -1,5 +1,3 @@
-from __future__ import absolute_import
-
 # flake8: noqa
 
 # import apis into api package
@@ -13,3 +11,4 @@ from belyApi.api.system_log_api import SystemLogApi
 from belyApi.api.test_api import TestApi
 from belyApi.api.users_api import UsersApi
 from belyApi.api.domain_api import DomainApi
+