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

compute_api_client/api/jobs_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,17 +23,20 @@ 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, StrictInt, StrictStr
 
-from typing import List, Optional
+from typing import Optional
 
 from compute_api_client.models.algorithm_type import AlgorithmType
 from compute_api_client.models.job import Job
 from compute_api_client.models.job_in import JobIn
 from compute_api_client.models.job_patch import JobPatch
 from compute_api_client.models.job_status import JobStatus
+from compute_api_client.models.page_job import PageJob
 
 from compute_api_client.api_client import ApiClient
 from compute_api_client.api_response import ApiResponse
@@ -862,10 +865,6 @@ class JobsApi:
     @validate_call
     async def read_jobs_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,
         file_id: Optional[StrictInt] = None,
@@ -878,6 +877,10 @@ class JobsApi:
         finished_at: Optional[datetime] = None,
         number_of_shots__isnull: Optional[StrictBool] = None,
         number_of_shots: Optional[StrictInt] = 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,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -890,19 +893,11 @@ class JobsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Job]:
+    ) -> PageJob:
         """List jobs
 
         List jobs.
 
-        :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:
@@ -927,6 +922,14 @@ class JobsApi:
         :type number_of_shots__isnull: bool
         :param number_of_shots:
         :type number_of_shots: int
+        :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 _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
@@ -950,10 +953,6 @@ class JobsApi:
         """ # noqa: E501
 
         _param = self._read_jobs_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,
             file_id=file_id,
@@ -966,6 +965,10 @@ class JobsApi:
             finished_at=finished_at,
             number_of_shots__isnull=number_of_shots__isnull,
             number_of_shots=number_of_shots,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -973,7 +976,7 @@ class JobsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Job]",
+            '200': "PageJob",
             '422': "HTTPValidationError"
             
         }
@@ -991,10 +994,6 @@ class JobsApi:
     @validate_call
     async def read_jobs_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,
         file_id: Optional[StrictInt] = None,
@@ -1007,6 +1006,10 @@ class JobsApi:
         finished_at: Optional[datetime] = None,
         number_of_shots__isnull: Optional[StrictBool] = None,
         number_of_shots: Optional[StrictInt] = 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,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1019,19 +1022,11 @@ class JobsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Job]]:
+    ) -> ApiResponse[PageJob]:
         """List jobs
 
         List jobs.
 
-        :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:
@@ -1056,6 +1051,14 @@ class JobsApi:
         :type number_of_shots__isnull: bool
         :param number_of_shots:
         :type number_of_shots: int
+        :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 _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
@@ -1079,10 +1082,6 @@ class JobsApi:
         """ # noqa: E501
 
         _param = self._read_jobs_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,
             file_id=file_id,
@@ -1095,6 +1094,10 @@ class JobsApi:
             finished_at=finished_at,
             number_of_shots__isnull=number_of_shots__isnull,
             number_of_shots=number_of_shots,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1102,7 +1105,7 @@ class JobsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Job]",
+            '200': "PageJob",
             '422': "HTTPValidationError"
             
         }
@@ -1120,10 +1123,6 @@ class JobsApi:
     @validate_call
     async def read_jobs_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,
         file_id: Optional[StrictInt] = None,
@@ -1136,6 +1135,10 @@ class JobsApi:
         finished_at: Optional[datetime] = None,
         number_of_shots__isnull: Optional[StrictBool] = None,
         number_of_shots: Optional[StrictInt] = 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,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1153,14 +1156,6 @@ class JobsApi:
 
         List jobs.
 
-        :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:
@@ -1185,6 +1180,14 @@ class JobsApi:
         :type number_of_shots__isnull: bool
         :param number_of_shots:
         :type number_of_shots: int
+        :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 _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
@@ -1208,10 +1211,6 @@ class JobsApi:
         """ # noqa: E501
 
         _param = self._read_jobs_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,
             file_id=file_id,
@@ -1224,6 +1223,10 @@ class JobsApi:
             finished_at=finished_at,
             number_of_shots__isnull=number_of_shots__isnull,
             number_of_shots=number_of_shots,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1231,7 +1234,7 @@ class JobsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Job]",
+            '200': "PageJob",
             '422': "HTTPValidationError"
             
         }
@@ -1244,10 +1247,6 @@ class JobsApi:
 
     def _read_jobs_jobs_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         created_on,
         file_id,
@@ -1260,6 +1259,10 @@ class JobsApi:
         finished_at,
         number_of_shots__isnull,
         number_of_shots,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -1281,22 +1284,6 @@ class JobsApi:
 
         # process the path parameters
         # 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))
@@ -1372,6 +1359,22 @@ class JobsApi:
             
             _query_params.append(('number_of_shots', number_of_shots))
             
+        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

compute_api_client/api/languages_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,11 +23,14 @@ try:
 except ImportError:
     from typing_extensions import Annotated
 
+from pydantic import Field
+from typing_extensions import Annotated
 from pydantic import StrictBool, StrictInt, StrictStr
 
-from typing import List, Optional
+from typing import Optional
 
 from compute_api_client.models.language import Language
+from compute_api_client.models.page_language import PageLanguage
 
 from compute_api_client.api_client import ApiClient
 from compute_api_client.api_response import ApiResponse
@@ -319,13 +322,13 @@ class LanguagesApi:
     async def read_languages_languages_get(
         self,
         q: Optional[StrictStr] = None,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
         version: Optional[StrictStr] = 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,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -338,27 +341,27 @@ class LanguagesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Language]:
+    ) -> PageLanguage:
         """List languages
 
         List languages.
 
         :param q:
         :type q: str
-        :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 name:
         :type name: str
         :param version:
         :type version: str
+        :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 _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
@@ -383,13 +386,13 @@ class LanguagesApi:
 
         _param = self._read_languages_languages_get_serialize(
             q=q,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             version=version,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -397,7 +400,7 @@ class LanguagesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Language]",
+            '200': "PageLanguage",
             '422': "HTTPValidationError"
             
         }
@@ -416,13 +419,13 @@ class LanguagesApi:
     async def read_languages_languages_get_with_http_info(
         self,
         q: Optional[StrictStr] = None,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
         version: Optional[StrictStr] = 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,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -435,27 +438,27 @@ class LanguagesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Language]]:
+    ) -> ApiResponse[PageLanguage]:
         """List languages
 
         List languages.
 
         :param q:
         :type q: str
-        :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 name:
         :type name: str
         :param version:
         :type version: str
+        :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 _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
@@ -480,13 +483,13 @@ class LanguagesApi:
 
         _param = self._read_languages_languages_get_serialize(
             q=q,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             version=version,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -494,7 +497,7 @@ class LanguagesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Language]",
+            '200': "PageLanguage",
             '422': "HTTPValidationError"
             
         }
@@ -513,13 +516,13 @@ class LanguagesApi:
     async def read_languages_languages_get_without_preload_content(
         self,
         q: Optional[StrictStr] = None,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
         version: Optional[StrictStr] = 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,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -539,20 +542,20 @@ class LanguagesApi:
 
         :param q:
         :type q: str
-        :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 name:
         :type name: str
         :param version:
         :type version: str
+        :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 _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
@@ -577,13 +580,13 @@ class LanguagesApi:
 
         _param = self._read_languages_languages_get_serialize(
             q=q,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             version=version,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -591,7 +594,7 @@ class LanguagesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Language]",
+            '200': "PageLanguage",
             '422': "HTTPValidationError"
             
         }
@@ -605,13 +608,13 @@ class LanguagesApi:
     def _read_languages_languages_get_serialize(
         self,
         q,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         name,
         version,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -637,33 +640,33 @@ class LanguagesApi:
             
             _query_params.append(('q', q))
             
-        if latest is not None:
+        if id is not None:
             
-            _query_params.append(('latest', latest))
+            _query_params.append(('id', id))
             
-        if sort_by is not None:
+        if name is not None:
             
-            _query_params.append(('sort_by', sort_by))
+            _query_params.append(('name', name))
             
-        if page_number is not None:
+        if version is not None:
             
-            _query_params.append(('page_number', page_number))
+            _query_params.append(('version', version))
             
-        if items_per_page is not None:
+        if sort_by is not None:
             
-            _query_params.append(('items_per_page', items_per_page))
+            _query_params.append(('sort_by', sort_by))
             
-        if id is not None:
+        if latest is not None:
             
-            _query_params.append(('id', id))
+            _query_params.append(('latest', latest))
             
-        if name is not None:
+        if page is not None:
             
-            _query_params.append(('name', name))
+            _query_params.append(('page', page))
             
-        if version is not None:
+        if size is not None:
             
-            _query_params.append(('version', version))
+            _query_params.append(('size', size))
             
         # process the header parameters
         # process the form parameters