qi-compute-api-client 0.32.0__py3-none-any.whl → 0.33.0__py3-none-any.whl

compute_api_client/api/results_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-     **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. 
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -23,12 +23,15 @@ try:
 except ImportError:
     from typing_extensions import Annotated
 
+from pydantic import Field
+from typing_extensions import Annotated
 from datetime import datetime
 
 from pydantic import StrictBool, StrictFloat, StrictInt, StrictStr
 
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, Optional, Union
 
+from compute_api_client.models.page_result import PageResult
 from compute_api_client.models.result import Result
 from compute_api_client.models.result_in import ResultIn
 
@@ -859,10 +862,6 @@ class ResultsApi:
     async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get(
         self,
         algorithm_id: StrictInt,
-        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,
         job_id: Optional[StrictInt] = None,
@@ -873,6 +872,10 @@ class ResultsApi:
         shots_done__isnull: Optional[StrictBool] = None,
         shots_done: Optional[StrictInt] = None,
         results__isnull: Optional[StrictBool] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         body: Optional[Dict[str, Any]] = None,
         _request_timeout: Union[
             None,
@@ -886,21 +889,13 @@ class ResultsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Result]:
+    ) -> PageResult:
         """Retrieve results by algorithm ID
 
         Get results by algorithm ID.
 
         :param algorithm_id: (required)
         :type algorithm_id: int
-        :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:
@@ -921,6 +916,14 @@ class ResultsApi:
         :type shots_done: int
         :param results__isnull:
         :type results__isnull: bool
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param body:
         :type body: object
         :param _request_timeout: timeout setting for this request. If one
@@ -947,10 +950,6 @@ class ResultsApi:
 
         _param = self._read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize(
             algorithm_id=algorithm_id,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             job_id=job_id,
@@ -961,6 +960,10 @@ class ResultsApi:
             shots_done__isnull=shots_done__isnull,
             shots_done=shots_done,
             results__isnull=results__isnull,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             body=body,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -969,7 +972,7 @@ class ResultsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Result]",
+            '200': "PageResult",
             '404': "HTTPNotFoundError",
             '422': "HTTPValidationError"
             
@@ -989,10 +992,6 @@ class ResultsApi:
     async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_with_http_info(
         self,
         algorithm_id: StrictInt,
-        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,
         job_id: Optional[StrictInt] = None,
@@ -1003,6 +1002,10 @@ class ResultsApi:
         shots_done__isnull: Optional[StrictBool] = None,
         shots_done: Optional[StrictInt] = None,
         results__isnull: Optional[StrictBool] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         body: Optional[Dict[str, Any]] = None,
         _request_timeout: Union[
             None,
@@ -1016,21 +1019,13 @@ class ResultsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Result]]:
+    ) -> ApiResponse[PageResult]:
         """Retrieve results by algorithm ID
 
         Get results by algorithm ID.
 
         :param algorithm_id: (required)
         :type algorithm_id: int
-        :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:
@@ -1051,6 +1046,14 @@ class ResultsApi:
         :type shots_done: int
         :param results__isnull:
         :type results__isnull: bool
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param body:
         :type body: object
         :param _request_timeout: timeout setting for this request. If one
@@ -1077,10 +1080,6 @@ class ResultsApi:
 
         _param = self._read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize(
             algorithm_id=algorithm_id,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             job_id=job_id,
@@ -1091,6 +1090,10 @@ class ResultsApi:
             shots_done__isnull=shots_done__isnull,
             shots_done=shots_done,
             results__isnull=results__isnull,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             body=body,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1099,7 +1102,7 @@ class ResultsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Result]",
+            '200': "PageResult",
             '404': "HTTPNotFoundError",
             '422': "HTTPValidationError"
             
@@ -1119,10 +1122,6 @@ class ResultsApi:
     async def read_results_by_algorithm_id_results_algorithm_algorithm_id_get_without_preload_content(
         self,
         algorithm_id: StrictInt,
-        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,
         job_id: Optional[StrictInt] = None,
@@ -1133,6 +1132,10 @@ class ResultsApi:
         shots_done__isnull: Optional[StrictBool] = None,
         shots_done: Optional[StrictInt] = None,
         results__isnull: Optional[StrictBool] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         body: Optional[Dict[str, Any]] = None,
         _request_timeout: Union[
             None,
@@ -1153,14 +1156,6 @@ class ResultsApi:
 
         :param algorithm_id: (required)
         :type algorithm_id: int
-        :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:
@@ -1181,6 +1176,14 @@ class ResultsApi:
         :type shots_done: int
         :param results__isnull:
         :type results__isnull: bool
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param body:
         :type body: object
         :param _request_timeout: timeout setting for this request. If one
@@ -1207,10 +1210,6 @@ class ResultsApi:
 
         _param = self._read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize(
             algorithm_id=algorithm_id,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             job_id=job_id,
@@ -1221,6 +1220,10 @@ class ResultsApi:
             shots_done__isnull=shots_done__isnull,
             shots_done=shots_done,
             results__isnull=results__isnull,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             body=body,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -1229,7 +1232,7 @@ class ResultsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Result]",
+            '200': "PageResult",
             '404': "HTTPNotFoundError",
             '422': "HTTPValidationError"
             
@@ -1244,10 +1247,6 @@ class ResultsApi:
     def _read_results_by_algorithm_id_results_algorithm_algorithm_id_get_serialize(
         self,
         algorithm_id,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         created_on,
         job_id,
@@ -1258,6 +1257,10 @@ class ResultsApi:
         shots_done__isnull,
         shots_done,
         results__isnull,
+        sort_by,
+        latest,
+        page,
+        size,
         body,
         _request_auth,
         _content_type,
@@ -1282,22 +1285,6 @@ class ResultsApi:
         if algorithm_id is not None:
             _path_params['algorithm_id'] = algorithm_id
         # process the query parameters
-        if latest is not None:
-            
-            _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))
@@ -1347,6 +1334,22 @@ class ResultsApi:
             
             _query_params.append(('results__isnull', results__isnull))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if latest is not None:
+            
+            _query_params.append(('latest', latest))
+            
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if size is not None:
+            
+            _query_params.append(('size', size))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1402,6 +1405,10 @@ class ResultsApi:
     async def read_results_by_job_id_results_job_job_id_get(
         self,
         job_id: StrictInt,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
+        sort_by: Optional[StrictStr] = None,
+        latest: Optional[StrictBool] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1414,13 +1421,21 @@ class ResultsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Result]:
+    ) -> PageResult:
         """Retrieve results by job ID
 
         Get results by job ID.
 
         :param job_id: (required)
         :type job_id: int
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
+        :param sort_by:
+        :type sort_by: str
+        :param latest:
+        :type latest: bool
         :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
@@ -1445,6 +1460,10 @@ class ResultsApi:
 
         _param = self._read_results_by_job_id_results_job_job_id_get_serialize(
             job_id=job_id,
+            page=page,
+            size=size,
+            sort_by=sort_by,
+            latest=latest,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1452,7 +1471,7 @@ class ResultsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Result]",
+            '200': "PageResult",
             '404': "HTTPNotFoundError",
             '422': "HTTPValidationError"
             
@@ -1472,6 +1491,10 @@ class ResultsApi:
     async def read_results_by_job_id_results_job_job_id_get_with_http_info(
         self,
         job_id: StrictInt,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
+        sort_by: Optional[StrictStr] = None,
+        latest: Optional[StrictBool] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1484,13 +1507,21 @@ class ResultsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Result]]:
+    ) -> ApiResponse[PageResult]:
         """Retrieve results by job ID
 
         Get results by job ID.
 
         :param job_id: (required)
         :type job_id: int
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
+        :param sort_by:
+        :type sort_by: str
+        :param latest:
+        :type latest: bool
         :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
@@ -1515,6 +1546,10 @@ class ResultsApi:
 
         _param = self._read_results_by_job_id_results_job_job_id_get_serialize(
             job_id=job_id,
+            page=page,
+            size=size,
+            sort_by=sort_by,
+            latest=latest,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1522,7 +1557,7 @@ class ResultsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Result]",
+            '200': "PageResult",
             '404': "HTTPNotFoundError",
             '422': "HTTPValidationError"
             
@@ -1542,6 +1577,10 @@ class ResultsApi:
     async def read_results_by_job_id_results_job_job_id_get_without_preload_content(
         self,
         job_id: StrictInt,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
+        sort_by: Optional[StrictStr] = None,
+        latest: Optional[StrictBool] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1561,6 +1600,14 @@ class ResultsApi:
 
         :param job_id: (required)
         :type job_id: int
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
+        :param sort_by:
+        :type sort_by: str
+        :param latest:
+        :type latest: bool
         :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
@@ -1585,6 +1632,10 @@ class ResultsApi:
 
         _param = self._read_results_by_job_id_results_job_job_id_get_serialize(
             job_id=job_id,
+            page=page,
+            size=size,
+            sort_by=sort_by,
+            latest=latest,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1592,7 +1643,7 @@ class ResultsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Result]",
+            '200': "PageResult",
             '404': "HTTPNotFoundError",
             '422': "HTTPValidationError"
             
@@ -1607,6 +1658,10 @@ class ResultsApi:
     def _read_results_by_job_id_results_job_job_id_get_serialize(
         self,
         job_id,
+        page,
+        size,
+        sort_by,
+        latest,
         _request_auth,
         _content_type,
         _headers,
@@ -1630,6 +1685,22 @@ class ResultsApi:
         if job_id is not None:
             _path_params['job_id'] = job_id
         # process the query parameters
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if size is not None:
+            
+            _query_params.append(('size', size))
+            
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if latest is not None:
+            
+            _query_params.append(('latest', latest))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter