autoassembler 0.3.1__py3-none-any.whl

autoassembler/alpha/jobs/client.py

@@ -0,0 +1,338 @@
+# 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 ...types.job import Job
+from .raw_client import AsyncRawJobsClient, RawJobsClient
+from .types.cancel_job_jobs_response import CancelJobJobsResponse
+from .types.list_jobs_jobs_response import ListJobsJobsResponse
+from .types.retry_job_jobs_response import RetryJobJobsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class JobsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawJobsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawJobsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawJobsClient
+        """
+        return self._raw_client
+
+    def list_jobs(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListJobsJobsResponse:
+        """
+        Returns jobs visible to the current user. Admin users see all jobs; non-admin users see their own jobs.
+
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number for pagination.
+
+        limit : typing.Optional[int]
+            Number of jobs per page. 0 returns all jobs.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListJobsJobsResponse
+            List of jobs
+
+        Examples
+        --------
+        from autoassembler import AutoAssembler
+
+        client = AutoAssembler(
+            token="YOUR_TOKEN",
+        )
+        client.alpha.jobs.list_jobs()
+        """
+        _response = self._raw_client.list_jobs(page=page, limit=limit, request_options=request_options)
+        return _response.data
+
+    def get_job(self, key: str, *, request_options: typing.Optional[RequestOptions] = None) -> Job:
+        """
+        Parameters
+        ----------
+        key : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Job
+            Job
+
+        Examples
+        --------
+        from autoassembler import AutoAssembler
+
+        client = AutoAssembler(
+            token="YOUR_TOKEN",
+        )
+        client.alpha.jobs.get_job(
+            key="key",
+        )
+        """
+        _response = self._raw_client.get_job(key, request_options=request_options)
+        return _response.data
+
+    def cancel_job(self, *, key: str, request_options: typing.Optional[RequestOptions] = None) -> CancelJobJobsResponse:
+        """
+        Marks the specified job as cancelled and broadcasts a cancellation request.
+
+        Parameters
+        ----------
+        key : str
+            Unique key of the job to cancel.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CancelJobJobsResponse
+            Job cancelled successfully
+
+        Examples
+        --------
+        from autoassembler import AutoAssembler
+
+        client = AutoAssembler(
+            token="YOUR_TOKEN",
+        )
+        client.alpha.jobs.cancel_job(
+            key="key",
+        )
+        """
+        _response = self._raw_client.cancel_job(key=key, request_options=request_options)
+        return _response.data
+
+    def retry_job(self, *, key: str, request_options: typing.Optional[RequestOptions] = None) -> RetryJobJobsResponse:
+        """
+        Re-enqueues a previously failed, cancelled, or aborted job as a new job.
+
+        Parameters
+        ----------
+        key : str
+            Unique key of the original job to retry.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RetryJobJobsResponse
+            Job re-enqueued successfully
+
+        Examples
+        --------
+        from autoassembler import AutoAssembler
+
+        client = AutoAssembler(
+            token="YOUR_TOKEN",
+        )
+        client.alpha.jobs.retry_job(
+            key="key",
+        )
+        """
+        _response = self._raw_client.retry_job(key=key, request_options=request_options)
+        return _response.data
+
+
+class AsyncJobsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawJobsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawJobsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawJobsClient
+        """
+        return self._raw_client
+
+    async def list_jobs(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListJobsJobsResponse:
+        """
+        Returns jobs visible to the current user. Admin users see all jobs; non-admin users see their own jobs.
+
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number for pagination.
+
+        limit : typing.Optional[int]
+            Number of jobs per page. 0 returns all jobs.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListJobsJobsResponse
+            List of jobs
+
+        Examples
+        --------
+        import asyncio
+
+        from autoassembler import AsyncAutoAssembler
+
+        client = AsyncAutoAssembler(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.alpha.jobs.list_jobs()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_jobs(page=page, limit=limit, request_options=request_options)
+        return _response.data
+
+    async def get_job(self, key: str, *, request_options: typing.Optional[RequestOptions] = None) -> Job:
+        """
+        Parameters
+        ----------
+        key : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Job
+            Job
+
+        Examples
+        --------
+        import asyncio
+
+        from autoassembler import AsyncAutoAssembler
+
+        client = AsyncAutoAssembler(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.alpha.jobs.get_job(
+                key="key",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_job(key, request_options=request_options)
+        return _response.data
+
+    async def cancel_job(
+        self, *, key: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> CancelJobJobsResponse:
+        """
+        Marks the specified job as cancelled and broadcasts a cancellation request.
+
+        Parameters
+        ----------
+        key : str
+            Unique key of the job to cancel.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CancelJobJobsResponse
+            Job cancelled successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from autoassembler import AsyncAutoAssembler
+
+        client = AsyncAutoAssembler(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.alpha.jobs.cancel_job(
+                key="key",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_job(key=key, request_options=request_options)
+        return _response.data
+
+    async def retry_job(
+        self, *, key: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> RetryJobJobsResponse:
+        """
+        Re-enqueues a previously failed, cancelled, or aborted job as a new job.
+
+        Parameters
+        ----------
+        key : str
+            Unique key of the original job to retry.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RetryJobJobsResponse
+            Job re-enqueued successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from autoassembler import AsyncAutoAssembler
+
+        client = AsyncAutoAssembler(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.alpha.jobs.retry_job(
+                key="key",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.retry_job(key=key, request_options=request_options)
+        return _response.data