@planqk/planqk-service-sdk 2.2.1 → 2.4.0

package/planqk/service/sdk/service_api/client.py

@@ -1,21 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from ..core.client_wrapper import SyncClientWrapper
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
-from .types.health_check_response import HealthCheckResponse
-from ..core.pydantic_utilities import parse_obj_as
-from json.decoder import JSONDecodeError
-from ..core.api_error import ApiError
 from ..types.service_execution import ServiceExecution
-from ..errors.bad_request_error import BadRequestError
-from ..errors.unauthorized_error import UnauthorizedError
-from ..errors.forbidden_error import ForbiddenError
-from ..errors.not_found_error import NotFoundError
-from ..errors.internal_server_error import InternalServerError
-from ..core.jsonable_encoder import jsonable_encoder
+from .raw_client import AsyncRawServiceApiClient, RawServiceApiClient
 from .types.get_result_response import GetResultResponse
-from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -23,13 +14,25 @@ OMIT = typing.cast(typing.Any, ...)
 
 class ServiceApiClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = RawServiceApiClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawServiceApiClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawServiceApiClient
+        """
+        return self._raw_client
 
-    def health_check(
+    def get_service_executions(
         self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HealthCheckResponse:
+    ) -> typing.List[ServiceExecution]:
         """
-        This method checks the health of the service.
+        Retrieves a list of all service executions.
+        The response includes links to each service execution, allowing for further queries on their status and results.
 
         Parameters
         ----------
@@ -38,8 +41,8 @@ class ServiceApiClient:
 
         Returns
         -------
-        HealthCheckResponse
-            OK
+        typing.List[ServiceExecution]
+            List of service executions
 
         Examples
         --------
@@ -48,39 +51,24 @@ class ServiceApiClient:
         client = PlanqkServiceApi(
             token="YOUR_TOKEN",
         )
-        client.service_api.health_check()
+        client.service_api.get_service_executions()
         """
-        _response = self._client_wrapper.httpx_client.request(
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    HealthCheckResponse,
-                    parse_obj_as(
-                        type_=HealthCheckResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    def execute(
+        _response = self._raw_client.get_service_executions(request_options=request_options)
+        return _response.data
+
+    def start_execution(
         self,
         *,
-        request: typing.Dict[str, typing.Dict[str, typing.Optional[typing.Any]]],
+        request: typing.Dict[str, typing.Optional[typing.Any]],
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ServiceExecution:
         """
-        This method starts a service execution, which in turn is processed asynchronously by PLANQK.
+        Starts a service execution, which in turn is processed asynchronously.
         The location header of the response contains the URL which can be used to query the status and the result of the service execution.
 
         Parameters
         ----------
-        request : typing.Dict[str, typing.Dict[str, typing.Optional[typing.Any]]]
+        request : typing.Dict[str, typing.Optional[typing.Any]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -88,7 +76,7 @@ class ServiceApiClient:
         Returns
         -------
         ServiceExecution
-            Service execution successfully submitted
+            Service execution is submitted
 
         Examples
         --------
@@ -97,85 +85,17 @@ class ServiceApiClient:
         client = PlanqkServiceApi(
             token="YOUR_TOKEN",
         )
-        client.service_api.execute(
-            request={"key": {"key": "value"}},
+        client.service_api.start_execution(
+            request={"key": "value"},
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            method="POST",
-            json=request,
-            request_options=request_options,
-            omit=OMIT,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    ServiceExecution,
-                    parse_obj_as(
-                        type_=ServiceExecution,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    def get_status(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> ServiceExecution:
+        _response = self._raw_client.start_execution(request=request, request_options=request_options)
+        return _response.data
+
+    def get_status(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ServiceExecution:
         """
-        This method checks the status of a service execution.
+        Retrieves the status of a service execution.
+        The status can be one of the following: UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED.
 
         Parameters
         ----------
@@ -188,7 +108,7 @@ class ServiceApiClient:
         Returns
         -------
         ServiceExecution
-            Ok
+            A service execution
 
         Examples
         --------
@@ -201,70 +121,14 @@ class ServiceApiClient:
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}",
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    ServiceExecution,
-                    parse_obj_as(
-                        type_=ServiceExecution,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    def get_result(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> GetResultResponse:
+        _response = self._raw_client.get_status(id, request_options=request_options)
+        return _response.data
+
+    def get_result(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetResultResponse:
         """
-        This method retrieves the result of a service execution.
+        Retrieves the result of a service execution.
+        The result is returned as a JSON object containing the status and any additional data.
+        The result may include links to download specific result files.
 
         Parameters
         ----------
@@ -277,7 +141,7 @@ class ServiceApiClient:
         Returns
         -------
         GetResultResponse
-            Ok
+            The service execution result
 
         Examples
         --------
@@ -290,74 +154,16 @@ class ServiceApiClient:
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}/result",
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    GetResultResponse,
-                    parse_obj_as(
-                        type_=GetResultResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = self._raw_client.get_result(id, request_options=request_options)
+        return _response.data
 
     def get_result_file(
-        self,
-        id: str,
-        file: str,
-        *,
-        request_options: typing.Optional[RequestOptions] = None,
+        self, id: str, file: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.Iterator[bytes]:
         """
-        This method downloads a result file of a service execution.
+        Retrieves a specific result file of a service execution.
+        The file name is provided in the path parameter.
+        The result file is returned as a binary stream.
 
         Parameters
         ----------
@@ -370,77 +176,17 @@ class ServiceApiClient:
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
-        Yields
-        ------
+        Returns
+        -------
         typing.Iterator[bytes]
-            Ok
+            The content of a result file
         """
-        with self._client_wrapper.httpx_client.stream(
-            f"{jsonable_encoder(id)}/result/{jsonable_encoder(file)}",
-            method="GET",
-            request_options=request_options,
-        ) as _response:
-            try:
-                if 200 <= _response.status_code < 300:
-                    _chunk_size = (
-                        request_options.get("chunk_size", None)
-                        if request_options is not None
-                        else None
-                    )
-                    for _chunk in _response.iter_bytes(chunk_size=_chunk_size):
-                        yield _chunk
-                    return
-                _response.read()
-                if _response.status_code == 401:
-                    raise UnauthorizedError(
-                        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(
-                        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(
-                        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(
-                        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, body=_response.text)
-            raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    def get_logs(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[str]:
+        with self._raw_client.get_result_file(id, file, request_options=request_options) as r:
+            yield from r.data
+
+    def get_logs(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[str]:
         """
-        This method retrieves the log output of a service execution.
+        Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
 
         Parameters
         ----------
@@ -453,7 +199,7 @@ class ServiceApiClient:
         Returns
         -------
         typing.List[str]
-            Ok
+            List of log entries
 
         Examples
         --------
@@ -466,70 +212,12 @@ class ServiceApiClient:
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}/log",
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    typing.List[str],
-                    parse_obj_as(
-                        type_=typing.List[str],  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    def cancel(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> ServiceExecution:
+        _response = self._raw_client.get_logs(id, request_options=request_options)
+        return _response.data
+
+    def cancel_execution(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ServiceExecution:
         """
-        This method cancels a service execution.
+        Cancel a pending or running service execution.
 
         Parameters
         ----------
@@ -542,7 +230,7 @@ class ServiceApiClient:
         Returns
         -------
         ServiceExecution
-            Ok
+            Service execution is cancelled
 
         Examples
         --------
@@ -551,79 +239,35 @@ class ServiceApiClient:
         client = PlanqkServiceApi(
             token="YOUR_TOKEN",
         )
-        client.service_api.cancel(
+        client.service_api.cancel_execution(
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}/cancel",
-            method="PUT",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    ServiceExecution,
-                    parse_obj_as(
-                        type_=ServiceExecution,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = self._raw_client.cancel_execution(id, request_options=request_options)
+        return _response.data
 
 
 class AsyncServiceApiClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = AsyncRawServiceApiClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawServiceApiClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawServiceApiClient
+        """
+        return self._raw_client
 
-    async def health_check(
+    async def get_service_executions(
         self, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HealthCheckResponse:
+    ) -> typing.List[ServiceExecution]:
         """
-        This method checks the health of the service.
+        Retrieves a list of all service executions.
+        The response includes links to each service execution, allowing for further queries on their status and results.
 
         Parameters
         ----------
@@ -632,8 +276,8 @@ class AsyncServiceApiClient:
 
         Returns
         -------
-        HealthCheckResponse
-            OK
+        typing.List[ServiceExecution]
+            List of service executions
 
         Examples
         --------
@@ -647,42 +291,27 @@ class AsyncServiceApiClient:
 
 
         async def main() -> None:
-            await client.service_api.health_check()
+            await client.service_api.get_service_executions()
 
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    HealthCheckResponse,
-                    parse_obj_as(
-                        type_=HealthCheckResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def execute(
+        _response = await self._raw_client.get_service_executions(request_options=request_options)
+        return _response.data
+
+    async def start_execution(
         self,
         *,
-        request: typing.Dict[str, typing.Dict[str, typing.Optional[typing.Any]]],
+        request: typing.Dict[str, typing.Optional[typing.Any]],
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ServiceExecution:
         """
-        This method starts a service execution, which in turn is processed asynchronously by PLANQK.
+        Starts a service execution, which in turn is processed asynchronously.
         The location header of the response contains the URL which can be used to query the status and the result of the service execution.
 
         Parameters
         ----------
-        request : typing.Dict[str, typing.Dict[str, typing.Optional[typing.Any]]]
+        request : typing.Dict[str, typing.Optional[typing.Any]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -690,7 +319,7 @@ class AsyncServiceApiClient:
         Returns
         -------
         ServiceExecution
-            Service execution successfully submitted
+            Service execution is submitted
 
         Examples
         --------
@@ -704,88 +333,20 @@ class AsyncServiceApiClient:
 
 
         async def main() -> None:
-            await client.service_api.execute(
-                request={"key": {"key": "value"}},
+            await client.service_api.start_execution(
+                request={"key": "value"},
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            method="POST",
-            json=request,
-            request_options=request_options,
-            omit=OMIT,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    ServiceExecution,
-                    parse_obj_as(
-                        type_=ServiceExecution,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def get_status(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> ServiceExecution:
+        _response = await self._raw_client.start_execution(request=request, request_options=request_options)
+        return _response.data
+
+    async def get_status(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ServiceExecution:
         """
-        This method checks the status of a service execution.
+        Retrieves the status of a service execution.
+        The status can be one of the following: UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED.
 
         Parameters
         ----------
@@ -798,7 +359,7 @@ class AsyncServiceApiClient:
         Returns
         -------
         ServiceExecution
-            Ok
+            A service execution
 
         Examples
         --------
@@ -819,70 +380,16 @@ class AsyncServiceApiClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}",
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    ServiceExecution,
-                    parse_obj_as(
-                        type_=ServiceExecution,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = await self._raw_client.get_status(id, request_options=request_options)
+        return _response.data
 
     async def get_result(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> GetResultResponse:
         """
-        This method retrieves the result of a service execution.
+        Retrieves the result of a service execution.
+        The result is returned as a JSON object containing the status and any additional data.
+        The result may include links to download specific result files.
 
         Parameters
         ----------
@@ -895,7 +402,7 @@ class AsyncServiceApiClient:
         Returns
         -------
         GetResultResponse
-            Ok
+            The service execution result
 
         Examples
         --------
@@ -916,74 +423,16 @@ class AsyncServiceApiClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}/result",
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    GetResultResponse,
-                    parse_obj_as(
-                        type_=GetResultResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = await self._raw_client.get_result(id, request_options=request_options)
+        return _response.data
 
     async def get_result_file(
-        self,
-        id: str,
-        file: str,
-        *,
-        request_options: typing.Optional[RequestOptions] = None,
+        self, id: str, file: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.AsyncIterator[bytes]:
         """
-        This method downloads a result file of a service execution.
+        Retrieves a specific result file of a service execution.
+        The file name is provided in the path parameter.
+        The result file is returned as a binary stream.
 
         Parameters
         ----------
@@ -996,77 +445,18 @@ class AsyncServiceApiClient:
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
-        Yields
-        ------
+        Returns
+        -------
         typing.AsyncIterator[bytes]
-            Ok
+            The content of a result file
         """
-        async with self._client_wrapper.httpx_client.stream(
-            f"{jsonable_encoder(id)}/result/{jsonable_encoder(file)}",
-            method="GET",
-            request_options=request_options,
-        ) as _response:
-            try:
-                if 200 <= _response.status_code < 300:
-                    _chunk_size = (
-                        request_options.get("chunk_size", None)
-                        if request_options is not None
-                        else None
-                    )
-                    async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size):
-                        yield _chunk
-                    return
-                await _response.aread()
-                if _response.status_code == 401:
-                    raise UnauthorizedError(
-                        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(
-                        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(
-                        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(
-                        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, body=_response.text)
-            raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def get_logs(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[str]:
+        async with self._raw_client.get_result_file(id, file, request_options=request_options) as r:
+            async for _chunk in r.data:
+                yield _chunk
+
+    async def get_logs(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[str]:
         """
-        This method retrieves the log output of a service execution.
+        Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
 
         Parameters
         ----------
@@ -1079,7 +469,7 @@ class AsyncServiceApiClient:
         Returns
         -------
         typing.List[str]
-            Ok
+            List of log entries
 
         Examples
         --------
@@ -1100,70 +490,14 @@ class AsyncServiceApiClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}/log",
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    typing.List[str],
-                    parse_obj_as(
-                        type_=typing.List[str],  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def cancel(
+        _response = await self._raw_client.get_logs(id, request_options=request_options)
+        return _response.data
+
+    async def cancel_execution(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> ServiceExecution:
         """
-        This method cancels a service execution.
+        Cancel a pending or running service execution.
 
         Parameters
         ----------
@@ -1176,7 +510,7 @@ class AsyncServiceApiClient:
         Returns
         -------
         ServiceExecution
-            Ok
+            Service execution is cancelled
 
         Examples
         --------
@@ -1190,68 +524,12 @@ class AsyncServiceApiClient:
 
 
         async def main() -> None:
-            await client.service_api.cancel(
+            await client.service_api.cancel_execution(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            f"{jsonable_encoder(id)}/cancel",
-            method="PUT",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    ServiceExecution,
-                    parse_obj_as(
-                        type_=ServiceExecution,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 401:
-                raise UnauthorizedError(
-                    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(
-                    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(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = await self._raw_client.cancel_execution(id, request_options=request_options)
+        return _response.data