wandelbots-api-client 25.8.0.dev55__py3-none-any.whl → 25.8.0.dev56__py3-none-any.whl

wandelbots_api_client/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "25.8.0.dev55"
+__version__ = "25.8.0.dev56"
 
 from . import models
 from . import api

wandelbots_api_client/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Wandelbots-Nova-API-Python-Client/25.8.0.dev55'
+        self.user_agent = 'Wandelbots-Nova-API-Python-Client/25.8.0.dev56'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

wandelbots_api_client/authorization.py

@@ -0,0 +1,244 @@
+from typing import Optional
+
+import asyncio
+import aiohttp
+import pydantic
+
+class Auth0Config(pydantic.BaseModel):
+    """Configuration for Auth0 authentication"""
+
+    domain: Optional[str] = None
+    client_id: Optional[str] = None
+    audience: Optional[str] = None
+
+    @classmethod
+    def default(cls) -> "Auth0Config":
+        """Create Auth0Config from environment variables"""
+        return cls(
+            domain="auth.portal.wandelbots.io",
+            client_id="J7WJUi38xVQdJAEBNRT9Xw1b0fXDb4J2",
+            audience="nova-api",
+        )
+
+    def is_complete(self) -> bool:
+        """Check if all required fields are set and not None"""
+        return bool(self.domain and self.client_id and self.audience)
+
+    def get_validated_config(self) -> tuple[str, str, str]:
+        """Get validated config values, ensuring they are not None"""
+        if not self.is_complete():
+            raise ValueError("Auth0 configuration is incomplete")
+        return self.domain, self.client_id, self.audience
+
+
+class Auth0DeviceCodeInfo(pydantic.BaseModel):
+    """
+    Model to store device code information.
+
+    Attributes:
+        device_code (str): The device code.
+        user_code (str): The user code.
+        verification_uri (str): The verification URI.
+        expires_in (int): The expiration time in seconds.
+        interval (int): The interval time in seconds (default is 5).
+    """
+
+    device_code: str
+    user_code: str
+    verification_uri: str
+    expires_in: int
+    interval: int = pydantic.Field(default=5)
+
+
+class Auth0TokenInfo(pydantic.BaseModel):
+    """
+    Model to store token information.
+
+    Attributes:
+        access_token (str): The access token.
+        refresh_token (str, optional): The refresh token.
+    """
+
+    access_token: str
+    refresh_token: Optional[str] = None
+
+
+class Auth0DeviceAuthorization:
+    """
+    Class to handle Auth0 device authorization.
+
+    Methods:
+        __init__(auth0_config: Auth0Config | None = None):
+            Initializes the Auth0DeviceAuthorization instance with the given parameters.
+        request_device_code():
+            Requests a device code from Auth0.
+        display_user_instructions():
+            Displays instructions for the user to authenticate.
+        poll_token_endpoint():
+            Polls the token endpoint to obtain an access token.
+        refresh_access_token(refresh_token: str):
+            Refreshes the access token using the refresh token.
+    """
+
+    def __init__(self, auth0_config: Optional[Auth0Config] = None):
+        """
+        Initialize with Auth0Config from env vars or passed config.
+
+        Args:
+            auth0_config: Optional Auth0Config object. If not provided,
+                         will be created using default configuration.
+        """
+        try:
+            self.params = auth0_config or Auth0Config.default()
+            if not self.params.is_complete():
+                raise ValueError("Auth0 configuration is incomplete")
+
+            domain, client_id, audience = self.params.get_validated_config()
+            self.auth0_domain = domain
+            self.auth0_client_id = client_id
+            self.auth0_audience = audience
+
+        except ValueError as e:
+            raise ValueError(f"Error: Auth0 configuration is invalid: {e}")
+
+        self.headers = {"content-type": "application/x-www-form-urlencoded"}
+        self.device_code_info: Optional[Auth0DeviceCodeInfo] = None
+        self.refresh_token: Optional[str] = None
+        self.interval = 5
+        self.attempts = 10
+
+    async def request_device_code(self) -> Auth0DeviceCodeInfo:
+        """
+        Requests a device code from Auth0.
+
+        Returns:
+            Auth0DeviceCodeInfo: The device code information.
+
+        Raises:
+            Exception: If there is an error requesting the device code.
+        """
+        device_code_url = f"https://{self.auth0_domain}/oauth/device/code"
+        data = {
+            "client_id": self.auth0_client_id,
+            "scope": "openid profile email",
+            "audience": self.auth0_audience,
+        }
+
+        async with aiohttp.ClientSession() as session:
+            async with session.post(device_code_url, headers=self.headers, data=data) as response:
+                if response.status == 200:
+                    response_data = await response.json()
+                    self.device_code_info = Auth0DeviceCodeInfo(**response_data)
+                    self.interval = self.device_code_info.interval
+                    return self.device_code_info
+                else:
+                    error_data = await response.json()
+                    raise Exception("Error requesting device code:", error_data)
+
+    def get_device_code_info(self) -> Optional[Auth0DeviceCodeInfo]:
+        """
+        Returns the device code information.
+
+        Returns:
+            Optional[Auth0DeviceCodeInfo]: The device code information.
+        """
+        return self.device_code_info
+
+    def display_user_instructions(self) -> None:
+        """
+        Displays instructions for the user to authenticate.
+
+        Raises:
+            Exception: If device code information is not available.
+        """
+        if self.device_code_info:
+            verification_uri = f"{self.device_code_info.verification_uri}?user_code={self.device_code_info.user_code}"
+            user_code = self.device_code_info.user_code
+            print(
+                f"Please visit {verification_uri} and validate the code {user_code} to authenticate."
+            )
+        else:
+            raise Exception("Device code information is not available.")
+
+    async def poll_token_endpoint(self):
+        """
+        Polls the token endpoint to obtain an access token.
+
+        Returns:
+            str: The access token.
+
+        Raises:
+            Exception: If there is an error polling the token endpoint.
+        """
+        if not self.device_code_info:
+            raise Exception("Device code information is not available.")
+
+        token_url = f"https://{self.auth0_domain}/oauth/token"
+        token_data = {
+            "grant_type": "urn:ietf:params:oauth:grant-type:device_code",
+            "device_code": self.device_code_info.device_code,
+            "client_id": self.auth0_client_id,
+        }
+
+        async with aiohttp.ClientSession() as session:
+            while self.attempts > 0:
+                self.attempts = self.attempts - 1
+                async with session.post(token_url, headers=self.headers, data=token_data) as token_response:
+                    if token_response.status == 200:
+                        # If the response status is 200, it means the access token is successfully obtained.
+                        response_data = await token_response.json()
+                        token_info = Auth0TokenInfo(**response_data)
+                        self.refresh_token = token_info.refresh_token
+                        return token_info.access_token
+                    elif token_response.status == 400:
+                        # If the response status is 400, check the error type.
+                        error_data = await token_response.json()
+                        error = error_data.get("error")
+                        if error == "authorization_pending":
+                            # If the error is 'authorization_pending', it means the user has not yet authorized.
+                            await asyncio.sleep(self.interval)
+                        elif error == "slow_down":
+                            # If the error is 'slow_down', it means the server requests to slow down polling.
+                            self.interval += 5
+                            await asyncio.sleep(self.interval)
+                    elif token_response.status == 403:
+                        # If the response status is 403, it means the request is forbidden, wait and retry.
+                        await asyncio.sleep(self.interval)
+                    else:
+                        # For other status codes, raise an exception with the error details.
+                        error_data = await token_response.json()
+                        raise Exception("Error:", token_response.status, error_data)
+        raise Exception("Error: It was not able to authenticate. Please try again.")
+
+    async def refresh_access_token(self, refresh_token: str):
+        """
+        Refreshes the access token using the refresh token.
+
+        Args:
+            refresh_token (str): The refresh token.
+
+        Returns:
+            str: The new access token.
+
+        Raises:
+            Exception: If there is an error refreshing the access token.
+        """
+        if not refresh_token:
+            raise Exception("Refresh token is not available.")
+
+        token_url = f"https://{self.auth0_domain}/oauth/token"
+        token_data = {
+            "grant_type": "refresh_token",
+            "client_id": self.auth0_client_id,
+            "refresh_token": refresh_token,
+        }
+
+        async with aiohttp.ClientSession() as session:
+            async with session.post(token_url, headers=self.headers, data=token_data) as response:
+                if response.status == 200:
+                    response_data = await response.json()
+                    token_info = Auth0TokenInfo(**response_data)
+                    return token_info.access_token
+                else:
+                    error_data = await response.json()
+                    raise Exception("Error refreshing access token:", error_data)

wandelbots_api_client/configuration.py

@@ -524,7 +524,7 @@ conf = wandelbots_api_client.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 25.8.0.dev55".\
+               "SDK Package Version: 25.8.0.dev56".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

wandelbots_api_client/v2/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "25.8.0.dev55"
+__version__ = "25.8.0.dev56"
 
 from . import models
 from . import api

wandelbots_api_client/v2/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Wandelbots-Nova-API-Python-Client/25.8.0.dev55'
+        self.user_agent = 'Wandelbots-Nova-API-Python-Client/25.8.0.dev56'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

wandelbots_api_client/v2/configuration.py

@@ -524,7 +524,7 @@ conf = wandelbots_api_client.v2.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0 beta\n"\
-               "SDK Package Version: 25.8.0.dev55".\
+               "SDK Package Version: 25.8.0.dev56".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{wandelbots_api_client-25.8.0.dev55.dist-info → wandelbots_api_client-25.8.0.dev56.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wandelbots_api_client
-Version: 25.8.0.dev55
+Version: 25.8.0.dev56
 Summary: Wandelbots Python Client: Interact with robots in an easy and intuitive way. 
 Home-page: 
 Author: Copyright (c) 2025 Wandelbots GmbH
@@ -34,7 +34,7 @@ Dynamic: license-file
 Interact with robots in an easy and intuitive way.
 
 - Compatible API version: 1.0.0 (can be found at the home screen of your instance -> API)
-- Package version: 25.8.0.dev55
+- Package version: 25.8.0.dev56
 
 Sign up for our [Wandelbots Developers Beta program](https://www.wandelbots.com/developers-beta) to get access to the Wandelbots API.
 

{wandelbots_api_client-25.8.0.dev55.dist-info → wandelbots_api_client-25.8.0.dev56.dist-info}/RECORD

@@ -1,7 +1,8 @@
-wandelbots_api_client/__init__.py,sha256=jDP-Ahgj1sy-yMa2IXSEqfr3A5s6YmXFckGtQtDghVM,1023
-wandelbots_api_client/api_client.py,sha256=Ql23JZ5Fnw5J5HEc8QbZaIJ4cl6BiTKRWTcrTCmg8vs,27596
+wandelbots_api_client/__init__.py,sha256=MnULAzt4nTj0m4gteIHwBz9xgmoB5eoZspyKQ1aC7FM,1023
+wandelbots_api_client/api_client.py,sha256=MKIGav9zGRDyy-GFRynt35iYw2kdEqeIvLp6_OgUCO0,27596
 wandelbots_api_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-wandelbots_api_client/configuration.py,sha256=5MGgTKpCl29gUKj19-E_2aRor3s03HMFTUrzKm3I30A,18313
+wandelbots_api_client/authorization.py,sha256=DyGsVHmD-1D4C9rMEEtQLi5YvbxPxgt7MqKVlwQgC3o,9499
+wandelbots_api_client/configuration.py,sha256=2LzyoZdVxLtxLEPcXgoA5Mv0wPhUr9EDb_IMDkEjuE8,18313
 wandelbots_api_client/exceptions.py,sha256=4ukZiylEwTUCen4G_zzHViQOC0Desk52mRekPGrRcKQ,6428
 wandelbots_api_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wandelbots_api_client/rest.py,sha256=_X74qGWiiOLYoP_QpNiI9u8kABK4reJYHznf01UKER4,7208
@@ -325,10 +326,10 @@ wandelbots_api_client/models/virtual_controller.py,sha256=yHZFsjkHsXhMvTyGP3wjQV
 wandelbots_api_client/models/virtual_controller_types.py,sha256=4rWSHD3DZj-UypBooESzcB83YmGyQx4fLu8Y5SRgSUQ,5944
 wandelbots_api_client/models/virtual_robot_configuration.py,sha256=KcgjymCdWxcHEXkPpLMkg_Mq7TSiLTM6r2VdPmeW5nc,2952
 wandelbots_api_client/models/yaskawa_controller.py,sha256=_DkR9wvTKrGqMZGIcg0d3cu0G45YSf9iekykTyBKrbE,3203
-wandelbots_api_client/v2/__init__.py,sha256=k0gZtBiMT44R42zdRI0Y7xIVytFrNUkCHaB_t7141O0,1111
-wandelbots_api_client/v2/api_client.py,sha256=EypoRpdWa0VLMBpr5_aUQABBItBHXIDxlhE8HKp1SHo,27702
+wandelbots_api_client/v2/__init__.py,sha256=51ZzI0yjjJO5dN4UMwm1YdX7DvenPcpL5GDzOtXbr1w,1111
+wandelbots_api_client/v2/api_client.py,sha256=gm-R8kbnKsnG2ayyKN88qoOcnTANsgqVcRctHJUTxHg,27702
 wandelbots_api_client/v2/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-wandelbots_api_client/v2/configuration.py,sha256=3j2NMKtU5cIsYn7QZ5uzRULhrGgCj5iSE8SROqDupVY,18412
+wandelbots_api_client/v2/configuration.py,sha256=aDI_VZYybRzzndGGFRDtylCbKK2_p1odPj8VtAFiX-8,18412
 wandelbots_api_client/v2/exceptions.py,sha256=dAl-6ZWR0W3REJYdNiRpXHF9yH_6QNlr6dWAaUUMM3E,6516
 wandelbots_api_client/v2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wandelbots_api_client/v2/rest.py,sha256=6a7yb-r1BWnJgC8_9PgI_k_RRX29eJQvltiKCUU5XW0,7299
@@ -589,8 +590,8 @@ wandelbots_api_client/v2/models/virtual_controller_types.py,sha256=iQ869lF-WLChF
 wandelbots_api_client/v2/models/virtual_robot_configuration.py,sha256=VXH1GwZWpysReIBDBFr-ObsEBU8WTl_7r6-POl42opE,3040
 wandelbots_api_client/v2/models/wait_for_io_event_request.py,sha256=fN26w26nC0u7ubmt-TPs2QC0UhA9859P-yheeNvFwuc,3293
 wandelbots_api_client/v2/models/yaskawa_controller.py,sha256=25SUJjdLyy3ZGHsGLhPYQpyGO9Bp2nGT9luk2B7_dA0,3257
-wandelbots_api_client-25.8.0.dev55.dist-info/licenses/LICENSE,sha256=PJyUaZgTVC0_nJmhRpcbnOcXvmTqJGE6axeSifngIGY,11344
-wandelbots_api_client-25.8.0.dev55.dist-info/METADATA,sha256=69NeL0Ac1mXrZuEOO8xsmPzoGsG9JqHHncZljDAHIpA,1818
-wandelbots_api_client-25.8.0.dev55.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-wandelbots_api_client-25.8.0.dev55.dist-info/top_level.txt,sha256=eCDsV95XWqVBSMDe4MRzyOj53-TK-o5WU1Qv_yv493M,22
-wandelbots_api_client-25.8.0.dev55.dist-info/RECORD,,
+wandelbots_api_client-25.8.0.dev56.dist-info/licenses/LICENSE,sha256=PJyUaZgTVC0_nJmhRpcbnOcXvmTqJGE6axeSifngIGY,11344
+wandelbots_api_client-25.8.0.dev56.dist-info/METADATA,sha256=H4xaS23X_Kh_rKAH6SnqhMJq6KCEcvg0ASeWXlNnA2o,1818
+wandelbots_api_client-25.8.0.dev56.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wandelbots_api_client-25.8.0.dev56.dist-info/top_level.txt,sha256=eCDsV95XWqVBSMDe4MRzyOj53-TK-o5WU1Qv_yv493M,22
+wandelbots_api_client-25.8.0.dev56.dist-info/RECORD,,