npm - @planqk/planqk-api-sdk - Versions diffs - 1.3.0 → 1.3.4 - Mend

@planqk/planqk-api-sdk 1.3.0 → 1.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

package/.fossa.yml +8 -0
package/.gitlab-ci.yml +34 -5
package/apps/README.md +24 -0
package/apps/python-test-app/main.py +3 -3
package/apps/test-file.txt +1 -0
package/apps/ts-test-app/index.ts +8 -8
package/apps/ts-test-app/package-lock.json +8 -6
package/apps/ts-test-app/package.json +5 -9
package/notebooks/python-sdk.ipynb +2 -1
package/package.json +1 -1
package/planqk/api/_version.py +1 -1
package/planqk/api/client.py +5 -2
package/planqk/api/sdk/__init__.py +2 -34
package/planqk/api/sdk/client.py +0 -3
package/planqk/api/sdk/types/__init__.py +1 -30
package/pyproject.toml +3 -1
package/uv.lock +642 -331
package/apps/python-test-app/my_file.txt +0 -1
package/apps/ts-test-app/test-file.txt +0 -1
package/planqk/api/sdk/authentication/__init__.py +0 -7
package/planqk/api/sdk/authentication/client.py +0 -102
package/planqk/api/sdk/authentication/raw_client.py +0 -183
package/planqk/api/sdk/authentication/types/__init__.py +0 -7
package/planqk/api/sdk/authentication/types/authorize_response.py +0 -8
package/planqk/api/sdk/types/access_token.py +0 -26
package/planqk/api/sdk/types/organization_membership.py +0 -27
package/planqk/api/sdk/types/organization_membership_account_type.py +0 -5
package/planqk/api/sdk/types/organization_membership_role.py +0 -5
package/planqk/api/sdk/types/personal_access_token_principal.py +0 -31
package/planqk/api/sdk/types/personal_access_token_principal_account_type.py +0 -5
package/planqk/api/sdk/types/service_execution.py +0 -27
package/planqk/api/sdk/types/service_execution_status.py +0 -7
package/planqk/api/sdk/types/service_execution_token_principal.py +0 -34
package/planqk/api/sdk/types/user_context.py +0 -35
package/planqk/api/sdk/types/user_context_account_type.py +0 -5
package/planqk/api/sdk/types/user_context_context_type.py +0 -5

package/apps/python-test-app/my_file.txt DELETED Viewed

	@@ -1 +0,0 @@
1	- Hello World

package/apps/ts-test-app/test-file.txt DELETED Viewed

	@@ -1 +0,0 @@
1	- This is a test file for the PlanQK API SDK.

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

@@ -1,7 +0,0 @@
-# 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 DELETED Viewed

@@ -1,102 +0,0 @@
-# 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 DELETED Viewed

@@ -1,183 +0,0 @@
-# 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 DELETED Viewed

@@ -1,7 +0,0 @@
-# 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 DELETED Viewed

@@ -1,8 +0,0 @@
-# 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/types/access_token.py DELETED Viewed

@@ -1,26 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import datetime as dt
-import typing
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-class AccessToken(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    name: typing.Optional[str] = None
-    created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
-    used_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="usedAt")] = None
-    expires_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="expiresAt")] = None
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/organization_membership.py DELETED Viewed

@@ -1,27 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-from .organization_membership_account_type import OrganizationMembershipAccountType
-from .organization_membership_role import OrganizationMembershipRole
-class OrganizationMembership(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    account_type: typing_extensions.Annotated[
-        typing.Optional[OrganizationMembershipAccountType], FieldMetadata(alias="accountType")
-    ] = None
-    role: typing.Optional[OrganizationMembershipRole] = None
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/organization_membership_account_type.py DELETED Viewed

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-OrganizationMembershipAccountType = typing.Union[typing.Literal["BASIC", "PRO", "BUSINESS"], typing.Any]

package/planqk/api/sdk/types/organization_membership_role.py DELETED Viewed

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-OrganizationMembershipRole = typing.Union[typing.Literal["VIEWER", "MAINTAINER", "OWNER"], typing.Any]

package/planqk/api/sdk/types/personal_access_token_principal.py DELETED Viewed

@@ -1,31 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-from .access_token import AccessToken
-from .organization_membership import OrganizationMembership
-from .personal_access_token_principal_account_type import PersonalAccessTokenPrincipalAccountType
-class PersonalAccessTokenPrincipal(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    access_token: typing_extensions.Annotated[typing.Optional[AccessToken], FieldMetadata(alias="accessToken")] = None
-    account_type: typing_extensions.Annotated[
-        typing.Optional[PersonalAccessTokenPrincipalAccountType], FieldMetadata(alias="accountType")
-    ] = None
-    organization_memberships: typing_extensions.Annotated[
-        typing.Optional[typing.List[OrganizationMembership]], FieldMetadata(alias="organizationMemberships")
-    ] = None
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/personal_access_token_principal_account_type.py DELETED Viewed

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-PersonalAccessTokenPrincipalAccountType = typing.Union[typing.Literal["BASIC", "PRO", "BUSINESS"], typing.Any]

package/planqk/api/sdk/types/service_execution.py DELETED Viewed

@@ -1,27 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import datetime as dt
-import typing
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ..core.serialization import FieldMetadata
-from .service_execution_status import ServiceExecutionStatus
-class ServiceExecution(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    created_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdAt")] = None
-    started_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="startedAt")] = None
-    ended_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="endedAt")] = None
-    status: typing.Optional[ServiceExecutionStatus] = None
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow

package/planqk/api/sdk/types/service_execution_status.py DELETED Viewed

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-ServiceExecutionStatus = typing.Union[
-    typing.Literal["UNKNOWN", "PENDING", "RUNNING", "SUCCEEDED", "FAILED"], typing.Any
-]

package/planqk/api/sdk/types/service_execution_token_principal.py DELETED Viewed

@@ -1,34 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-from __future__ import annotations
-import typing
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
-from ..core.serialization import FieldMetadata
-from .service_execution import ServiceExecution
-class ServiceExecutionTokenPrincipal(UniversalBaseModel):
-    service_execution: typing_extensions.Annotated[
-        typing.Optional[ServiceExecution], FieldMetadata(alias="serviceExecution")
-    ] = None
-    service_provider: typing_extensions.Annotated[
-        typing.Optional["UserContext"], FieldMetadata(alias="serviceProvider")
-    ] = None
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow
-from .user_context import UserContext  # noqa: E402, F401, I001
-update_forward_refs(ServiceExecutionTokenPrincipal)

package/planqk/api/sdk/types/user_context.py DELETED Viewed

@@ -1,35 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-from __future__ import annotations
-import typing
-import pydantic
-import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel, update_forward_refs
-from ..core.serialization import FieldMetadata
-from .user_context_account_type import UserContextAccountType
-from .user_context_context_type import UserContextContextType
-class UserContext(UniversalBaseModel):
-    id: typing.Optional[str] = None
-    context_type: typing_extensions.Annotated[
-        typing.Optional[UserContextContextType], FieldMetadata(alias="contextType")
-    ] = None
-    account_type: typing_extensions.Annotated[
-        typing.Optional[UserContextAccountType], FieldMetadata(alias="accountType")
-    ] = None
-    parent: typing.Optional["UserContext"] = None
-    if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
-    else:
-        class Config:
-            frozen = True
-            smart_union = True
-            extra = pydantic.Extra.allow
-update_forward_refs(UserContext)

package/planqk/api/sdk/types/user_context_account_type.py DELETED Viewed

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-UserContextAccountType = typing.Union[typing.Literal["BASIC", "PRO", "BUSINESS"], typing.Any]

package/planqk/api/sdk/types/user_context_context_type.py DELETED Viewed

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-import typing
-UserContextContextType = typing.Union[typing.Literal["USER", "ORGANIZATION", "SERVICE_EXECUTION"], typing.Any]