@planqk/planqk-api-sdk 1.1.0 → 1.3.0

package/planqk/api/sdk/__init__.py

@@ -2,14 +2,34 @@
 
 # isort: skip_file
 
-from .types import DataPoolDto, DataPoolDtoCurrentUserPermission, DataPoolFileDto, OauthScope
+from .types import (
+    AccessToken,
+    DataPoolDto,
+    DataPoolDtoCurrentUserPermission,
+    DataPoolFileDto,
+    OauthScope,
+    OrganizationMembership,
+    OrganizationMembershipAccountType,
+    OrganizationMembershipRole,
+    PersonalAccessTokenPrincipal,
+    PersonalAccessTokenPrincipalAccountType,
+    ServiceExecution,
+    ServiceExecutionStatus,
+    ServiceExecutionTokenPrincipal,
+    UserContext,
+    UserContextAccountType,
+    UserContextContextType,
+)
 from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFoundError, UnauthorizedError
-from . import data_pools
+from . import authentication, data_pools
+from .authentication import AuthorizeResponse
 from .client import AsyncPlanqkApi, PlanqkApi
 from .environment import PlanqkApiEnvironment
 
 __all__ = [
+    "AccessToken",
     "AsyncPlanqkApi",
+    "AuthorizeResponse",
     "BadRequestError",
     "DataPoolDto",
     "DataPoolDtoCurrentUserPermission",
@@ -18,8 +38,20 @@ __all__ = [
     "InternalServerError",
     "NotFoundError",
     "OauthScope",
+    "OrganizationMembership",
+    "OrganizationMembershipAccountType",
+    "OrganizationMembershipRole",
+    "PersonalAccessTokenPrincipal",
+    "PersonalAccessTokenPrincipalAccountType",
     "PlanqkApi",
     "PlanqkApiEnvironment",
+    "ServiceExecution",
+    "ServiceExecutionStatus",
+    "ServiceExecutionTokenPrincipal",
     "UnauthorizedError",
+    "UserContext",
+    "UserContextAccountType",
+    "UserContextContextType",
+    "authentication",
     "data_pools",
 ]

package/planqk/api/sdk/authentication/__init__.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import AuthorizeResponse
+
+__all__ = ["AuthorizeResponse"]

package/planqk/api/sdk/authentication/client.py

@@ -0,0 +1,102 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawAuthenticationClient, RawAuthenticationClient
+from .types.authorize_response import AuthorizeResponse
+
+
+class AuthenticationClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAuthenticationClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAuthenticationClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAuthenticationClient
+        """
+        return self._raw_client
+
+    def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthorizeResponse:
+        """
+        Get the authenticated principal based on the provided token.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AuthorizeResponse
+            The scopes of the provided token.
+
+        Examples
+        --------
+        from planqk import PlanqkApi
+
+        client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            api_key="YOUR_API_KEY",
+        )
+        client.authentication.authorize()
+        """
+        _response = self._raw_client.authorize(request_options=request_options)
+        return _response.data
+
+
+class AsyncAuthenticationClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAuthenticationClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAuthenticationClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAuthenticationClient
+        """
+        return self._raw_client
+
+    async def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthorizeResponse:
+        """
+        Get the authenticated principal based on the provided token.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AuthorizeResponse
+            The scopes of the provided token.
+
+        Examples
+        --------
+        import asyncio
+
+        from planqk import AsyncPlanqkApi
+
+        client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.authentication.authorize()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.authorize(request_options=request_options)
+        return _response.data

package/planqk/api/sdk/authentication/raw_client.py

@@ -0,0 +1,183 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.forbidden_error import ForbiddenError
+from ..errors.internal_server_error import InternalServerError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unauthorized_error import UnauthorizedError
+from .types.authorize_response import AuthorizeResponse
+
+
+class RawAuthenticationClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def authorize(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[AuthorizeResponse]:
+        """
+        Get the authenticated principal based on the provided token.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[AuthorizeResponse]
+            The scopes of the provided token.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "authorize",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    AuthorizeResponse,
+                    parse_obj_as(
+                        type_=AuthorizeResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawAuthenticationClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def authorize(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[AuthorizeResponse]:
+        """
+        Get the authenticated principal based on the provided token.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[AuthorizeResponse]
+            The scopes of the provided token.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "authorize",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    AuthorizeResponse,
+                    parse_obj_as(
+                        type_=AuthorizeResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

package/planqk/api/sdk/authentication/types/__init__.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .authorize_response import AuthorizeResponse
+
+__all__ = ["AuthorizeResponse"]

package/planqk/api/sdk/authentication/types/authorize_response.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...types.personal_access_token_principal import PersonalAccessTokenPrincipal
+from ...types.service_execution_token_principal import ServiceExecutionTokenPrincipal
+
+AuthorizeResponse = typing.Union[PersonalAccessTokenPrincipal, ServiceExecutionTokenPrincipal]

package/planqk/api/sdk/client.py

@@ -3,6 +3,7 @@
 import typing
 
 import httpx
+from .authentication.client import AsyncAuthenticationClient, AuthenticationClient
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .data_pools.client import AsyncDataPoolsClient, DataPoolsClient
 from .environment import PlanqkApiEnvironment
@@ -26,6 +27,7 @@ class PlanqkApi:
 
 
 
+    organization_id : typing.Optional[str]
     api_key : str
     headers : typing.Optional[typing.Dict[str, str]]
         Additional headers to send with every request.
@@ -44,6 +46,7 @@ class PlanqkApi:
     from planqk import PlanqkApi
 
     client = PlanqkApi(
+        organization_id="YOUR_ORGANIZATION_ID",
         api_key="YOUR_API_KEY",
     )
     """
@@ -53,6 +56,7 @@ class PlanqkApi:
         *,
         base_url: typing.Optional[str] = None,
         environment: PlanqkApiEnvironment = PlanqkApiEnvironment.DEFAULT,
+        organization_id: typing.Optional[str] = None,
         api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
@@ -64,6 +68,7 @@ class PlanqkApi:
         )
         self._client_wrapper = SyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
+            organization_id=organization_id,
             api_key=api_key,
             headers=headers,
             httpx_client=httpx_client
@@ -74,6 +79,7 @@ class PlanqkApi:
             timeout=_defaulted_timeout,
         )
         self.data_pools = DataPoolsClient(client_wrapper=self._client_wrapper)
+        self.authentication = AuthenticationClient(client_wrapper=self._client_wrapper)
 
 
 class AsyncPlanqkApi:
@@ -94,6 +100,7 @@ class AsyncPlanqkApi:
 
 
 
+    organization_id : typing.Optional[str]
     api_key : str
     headers : typing.Optional[typing.Dict[str, str]]
         Additional headers to send with every request.
@@ -112,6 +119,7 @@ class AsyncPlanqkApi:
     from planqk import AsyncPlanqkApi
 
     client = AsyncPlanqkApi(
+        organization_id="YOUR_ORGANIZATION_ID",
         api_key="YOUR_API_KEY",
     )
     """
@@ -121,6 +129,7 @@ class AsyncPlanqkApi:
         *,
         base_url: typing.Optional[str] = None,
         environment: PlanqkApiEnvironment = PlanqkApiEnvironment.DEFAULT,
+        organization_id: typing.Optional[str] = None,
         api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
@@ -132,6 +141,7 @@ class AsyncPlanqkApi:
         )
         self._client_wrapper = AsyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
+            organization_id=organization_id,
             api_key=api_key,
             headers=headers,
             httpx_client=httpx_client
@@ -142,6 +152,7 @@ class AsyncPlanqkApi:
             timeout=_defaulted_timeout,
         )
         self.data_pools = AsyncDataPoolsClient(client_wrapper=self._client_wrapper)
+        self.authentication = AsyncAuthenticationClient(client_wrapper=self._client_wrapper)
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: PlanqkApiEnvironment) -> str:

package/planqk/api/sdk/core/client_wrapper.py

@@ -10,11 +10,13 @@ class BaseClientWrapper:
     def __init__(
         self,
         *,
+        organization_id: typing.Optional[str] = None,
         api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
     ):
+        self._organization_id = organization_id
         self.api_key = api_key
         self._headers = headers
         self._base_url = base_url
@@ -25,6 +27,8 @@ class BaseClientWrapper:
             "X-Fern-Language": "Python",
             **(self.get_custom_headers() or {}),
         }
+        if self._organization_id is not None:
+            headers["X-OrganizationId"] = self._organization_id
         headers["X-Auth-Token"] = self.api_key
         return headers
 
@@ -42,13 +46,16 @@ class SyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
+        organization_id: typing.Optional[str] = None,
         api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.Client,
     ):
-        super().__init__(api_key=api_key, headers=headers, base_url=base_url, timeout=timeout)
+        super().__init__(
+            organization_id=organization_id, api_key=api_key, headers=headers, base_url=base_url, timeout=timeout
+        )
         self.httpx_client = HttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,
@@ -61,13 +68,16 @@ class AsyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
+        organization_id: typing.Optional[str] = None,
         api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.AsyncClient,
     ):
-        super().__init__(api_key=api_key, headers=headers, base_url=base_url, timeout=timeout)
+        super().__init__(
+            organization_id=organization_id, api_key=api_key, headers=headers, base_url=base_url, timeout=timeout
+        )
         self.httpx_client = AsyncHttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,

package/planqk/api/sdk/data_pools/client.py

@@ -49,6 +49,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.get_data_pool(
@@ -93,6 +94,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.update_data_pool(
@@ -124,6 +126,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.delete_data_pool(
@@ -152,6 +155,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.get_data_pools()
@@ -182,6 +186,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.create_data_pool()
@@ -212,6 +217,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.get_data_pool_files(
@@ -254,6 +260,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.add_data_pool_file(
@@ -312,6 +319,7 @@ class DataPoolsClient:
         from planqk import PlanqkApi
 
         client = PlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
         client.data_pools.delete_data_pool_file(
@@ -361,6 +369,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -413,6 +422,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -452,6 +462,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -490,6 +501,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -528,6 +540,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -566,6 +579,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -616,6 +630,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 
@@ -683,6 +698,7 @@ class AsyncDataPoolsClient:
         from planqk import AsyncPlanqkApi
 
         client = AsyncPlanqkApi(
+            organization_id="YOUR_ORGANIZATION_ID",
             api_key="YOUR_API_KEY",
         )
 

package/planqk/api/sdk/environment.py

@@ -4,4 +4,4 @@ import enum
 
 
 class PlanqkApiEnvironment(enum.Enum):
-    DEFAULT = "https://34.90.225.20.nip.io/qc-catalog"
+    DEFAULT = "https://platform.planqk.de/qc-catalog"

package/planqk/api/sdk/types/__init__.py

@@ -2,9 +2,38 @@
 
 # isort: skip_file
 
+from .access_token import AccessToken
 from .data_pool_dto import DataPoolDto
 from .data_pool_dto_current_user_permission import DataPoolDtoCurrentUserPermission
 from .data_pool_file_dto import DataPoolFileDto
 from .oauth_scope import OauthScope
+from .organization_membership import OrganizationMembership
+from .organization_membership_account_type import OrganizationMembershipAccountType
+from .organization_membership_role import OrganizationMembershipRole
+from .personal_access_token_principal import PersonalAccessTokenPrincipal
+from .personal_access_token_principal_account_type import PersonalAccessTokenPrincipalAccountType
+from .service_execution import ServiceExecution
+from .service_execution_status import ServiceExecutionStatus
+from .service_execution_token_principal import ServiceExecutionTokenPrincipal
+from .user_context import UserContext
+from .user_context_account_type import UserContextAccountType
+from .user_context_context_type import UserContextContextType
 
-__all__ = ["DataPoolDto", "DataPoolDtoCurrentUserPermission", "DataPoolFileDto", "OauthScope"]
+__all__ = [
+    "AccessToken",
+    "DataPoolDto",
+    "DataPoolDtoCurrentUserPermission",
+    "DataPoolFileDto",
+    "OauthScope",
+    "OrganizationMembership",
+    "OrganizationMembershipAccountType",
+    "OrganizationMembershipRole",
+    "PersonalAccessTokenPrincipal",
+    "PersonalAccessTokenPrincipalAccountType",
+    "ServiceExecution",
+    "ServiceExecutionStatus",
+    "ServiceExecutionTokenPrincipal",
+    "UserContext",
+    "UserContextAccountType",
+    "UserContextContextType",
+]