qi-compute-api-client 0.17.0__py3-none-any.whl → 0.27.0__py3-none-any.whl

compute_api_client/api/batch_jobs_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -25,7 +25,7 @@ except ImportError:
 
 from datetime import datetime
 
-from pydantic import StrictBool, StrictInt
+from pydantic import StrictBool, StrictInt, StrictStr
 
 from typing import List, Optional
 
@@ -309,6 +309,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -577,6 +578,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -845,6 +847,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -1164,7 +1167,7 @@ class BatchJobsApi:
     ) -> BatchJob:
         """Take batch job
 
-        Claim batch job by ID.
+        Claim batch job.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1229,7 +1232,7 @@ class BatchJobsApi:
     ) -> ApiResponse[BatchJob]:
         """Take batch job
 
-        Claim batch job by ID.
+        Claim batch job.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1294,7 +1297,7 @@ class BatchJobsApi:
     ) -> RESTResponseType:
         """Take batch job
 
-        Claim batch job by ID.
+        Claim batch job.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1400,6 +1403,9 @@ class BatchJobsApi:
     async def read_batch_jobs_batch_jobs_get(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         status: Optional[BatchJobStatus] = None,
@@ -1433,6 +1439,12 @@ class BatchJobsApi:
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param created_on:
@@ -1485,6 +1497,9 @@ class BatchJobsApi:
 
         _param = self._read_batch_jobs_batch_jobs_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             status=status,
@@ -1525,6 +1540,9 @@ class BatchJobsApi:
     async def read_batch_jobs_batch_jobs_get_with_http_info(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         status: Optional[BatchJobStatus] = None,
@@ -1558,6 +1576,12 @@ class BatchJobsApi:
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param created_on:
@@ -1610,6 +1634,9 @@ class BatchJobsApi:
 
         _param = self._read_batch_jobs_batch_jobs_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             status=status,
@@ -1650,6 +1677,9 @@ class BatchJobsApi:
     async def read_batch_jobs_batch_jobs_get_without_preload_content(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         status: Optional[BatchJobStatus] = None,
@@ -1683,6 +1713,12 @@ class BatchJobsApi:
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param created_on:
@@ -1735,6 +1771,9 @@ class BatchJobsApi:
 
         _param = self._read_batch_jobs_batch_jobs_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             status=status,
@@ -1770,6 +1809,9 @@ class BatchJobsApi:
     def _read_batch_jobs_batch_jobs_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         created_on,
         status,
@@ -1809,6 +1851,18 @@ class BatchJobsApi:
             
             _query_params.append(('latest', latest))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if page_number is not None:
+            
+            _query_params.append(('page_number', page_number))
+            
+        if items_per_page is not None:
+            
+            _query_params.append(('items_per_page', items_per_page))
+            
         if id is not None:
             
             _query_params.append(('id', id))
@@ -1916,6 +1970,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1935,3 +1990,253 @@ class BatchJobsApi:
         )
 
 
+
+
+    @validate_call
+    async def unpop_batch_job_batch_jobs_unpop_patch(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> BatchJob:
+        """Take batch job
+
+        Unclaim batch job.
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._unpop_batch_job_batch_jobs_unpop_patch_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BatchJob",
+            '404': "HTTPNotFoundError"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def unpop_batch_job_batch_jobs_unpop_patch_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[BatchJob]:
+        """Take batch job
+
+        Unclaim batch job.
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._unpop_batch_job_batch_jobs_unpop_patch_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BatchJob",
+            '404': "HTTPNotFoundError"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def unpop_batch_job_batch_jobs_unpop_patch_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Take batch job
+
+        Unclaim batch job.
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._unpop_batch_job_batch_jobs_unpop_patch_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BatchJob",
+            '404': "HTTPNotFoundError"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _unpop_batch_job_batch_jobs_unpop_patch_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'backend'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/batch_jobs/unpop',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

compute_api_client/api/commits_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -307,6 +307,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -566,6 +567,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -834,6 +836,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -860,6 +863,9 @@ class CommitsApi:
     async def read_commits_commits_get(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         hash: Optional[StrictStr] = None,
@@ -884,6 +890,12 @@ class CommitsApi:
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param created_on:
@@ -918,6 +930,9 @@ class CommitsApi:
 
         _param = self._read_commits_commits_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             hash=hash,
@@ -949,6 +964,9 @@ class CommitsApi:
     async def read_commits_commits_get_with_http_info(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         hash: Optional[StrictStr] = None,
@@ -973,6 +991,12 @@ class CommitsApi:
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param created_on:
@@ -1007,6 +1031,9 @@ class CommitsApi:
 
         _param = self._read_commits_commits_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             hash=hash,
@@ -1038,6 +1065,9 @@ class CommitsApi:
     async def read_commits_commits_get_without_preload_content(
         self,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         hash: Optional[StrictStr] = None,
@@ -1062,6 +1092,12 @@ class CommitsApi:
 
         :param latest:
         :type latest: bool
+        :param sort_by:
+        :type sort_by: str
+        :param page_number:
+        :type page_number: int
+        :param items_per_page:
+        :type items_per_page: int
         :param id:
         :type id: int
         :param created_on:
@@ -1096,6 +1132,9 @@ class CommitsApi:
 
         _param = self._read_commits_commits_get_serialize(
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             hash=hash,
@@ -1122,6 +1161,9 @@ class CommitsApi:
     def _read_commits_commits_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         created_on,
         hash,
@@ -1152,6 +1194,18 @@ class CommitsApi:
             
             _query_params.append(('latest', latest))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if page_number is not None:
+            
+            _query_params.append(('page_number', page_number))
+            
+        if items_per_page is not None:
+            
+            _query_params.append(('items_per_page', items_per_page))
+            
         if id is not None:
             
             _query_params.append(('id', id))
@@ -1196,6 +1250,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]