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

compute_api_client/api/backend_types_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 pydantic import StrictBool, StrictInt, StrictStr
 
-from typing import List, Optional
+from typing import Optional
 
 from compute_api_client.models.backend_status import BackendStatus
 from compute_api_client.models.backend_type import BackendType
+from compute_api_client.models.page_backend_type import PageBackendType
 
 from compute_api_client.api_client import ApiClient
 from compute_api_client.api_response import ApiResponse
@@ -319,19 +322,20 @@ class BackendTypesApi:
     @validate_call
     async def read_backend_types_backend_types_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,
         name: Optional[StrictStr] = None,
         infrastructure: Optional[StrictStr] = None,
         description: Optional[StrictStr] = None,
         image_id: Optional[StrictStr] = None,
         is_hardware: Optional[StrictBool] = None,
+        nqubits: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         default_number_of_shots: Optional[StrictInt] = None,
         max_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)],
@@ -344,19 +348,11 @@ class BackendTypesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[BackendType]:
+    ) -> PageBackendType:
         """List backend types
 
         Read backend types.
 
-        :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:
@@ -369,12 +365,22 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :param nqubits:
+        :type nqubits: int
         :param status:
         :type status: BackendStatus
         :param default_number_of_shots:
         :type default_number_of_shots: int
         :param max_number_of_shots:
         :type max_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
@@ -398,19 +404,20 @@ class BackendTypesApi:
         """ # noqa: E501
 
         _param = self._read_backend_types_backend_types_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             infrastructure=infrastructure,
             description=description,
             image_id=image_id,
             is_hardware=is_hardware,
+            nqubits=nqubits,
             status=status,
             default_number_of_shots=default_number_of_shots,
             max_number_of_shots=max_number_of_shots,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -418,7 +425,7 @@ class BackendTypesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[BackendType]",
+            '200': "PageBackendType",
             '422': "HTTPValidationError"
             
         }
@@ -436,19 +443,20 @@ class BackendTypesApi:
     @validate_call
     async def read_backend_types_backend_types_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,
         name: Optional[StrictStr] = None,
         infrastructure: Optional[StrictStr] = None,
         description: Optional[StrictStr] = None,
         image_id: Optional[StrictStr] = None,
         is_hardware: Optional[StrictBool] = None,
+        nqubits: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         default_number_of_shots: Optional[StrictInt] = None,
         max_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)],
@@ -461,19 +469,11 @@ class BackendTypesApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[BackendType]]:
+    ) -> ApiResponse[PageBackendType]:
         """List backend types
 
         Read backend types.
 
-        :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:
@@ -486,12 +486,22 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :param nqubits:
+        :type nqubits: int
         :param status:
         :type status: BackendStatus
         :param default_number_of_shots:
         :type default_number_of_shots: int
         :param max_number_of_shots:
         :type max_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
@@ -515,19 +525,20 @@ class BackendTypesApi:
         """ # noqa: E501
 
         _param = self._read_backend_types_backend_types_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             infrastructure=infrastructure,
             description=description,
             image_id=image_id,
             is_hardware=is_hardware,
+            nqubits=nqubits,
             status=status,
             default_number_of_shots=default_number_of_shots,
             max_number_of_shots=max_number_of_shots,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -535,7 +546,7 @@ class BackendTypesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[BackendType]",
+            '200': "PageBackendType",
             '422': "HTTPValidationError"
             
         }
@@ -553,19 +564,20 @@ class BackendTypesApi:
     @validate_call
     async def read_backend_types_backend_types_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,
         name: Optional[StrictStr] = None,
         infrastructure: Optional[StrictStr] = None,
         description: Optional[StrictStr] = None,
         image_id: Optional[StrictStr] = None,
         is_hardware: Optional[StrictBool] = None,
+        nqubits: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         default_number_of_shots: Optional[StrictInt] = None,
         max_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)],
@@ -583,14 +595,6 @@ class BackendTypesApi:
 
         Read backend types.
 
-        :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:
@@ -603,12 +607,22 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :param nqubits:
+        :type nqubits: int
         :param status:
         :type status: BackendStatus
         :param default_number_of_shots:
         :type default_number_of_shots: int
         :param max_number_of_shots:
         :type max_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
@@ -632,19 +646,20 @@ class BackendTypesApi:
         """ # noqa: E501
 
         _param = self._read_backend_types_backend_types_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             infrastructure=infrastructure,
             description=description,
             image_id=image_id,
             is_hardware=is_hardware,
+            nqubits=nqubits,
             status=status,
             default_number_of_shots=default_number_of_shots,
             max_number_of_shots=max_number_of_shots,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -652,7 +667,7 @@ class BackendTypesApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[BackendType]",
+            '200': "PageBackendType",
             '422': "HTTPValidationError"
             
         }
@@ -665,19 +680,20 @@ class BackendTypesApi:
 
     def _read_backend_types_backend_types_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         name,
         infrastructure,
         description,
         image_id,
         is_hardware,
+        nqubits,
         status,
         default_number_of_shots,
         max_number_of_shots,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -699,22 +715,6 @@ class BackendTypesApi:
 
         # 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))
@@ -739,6 +739,10 @@ class BackendTypesApi:
             
             _query_params.append(('is_hardware', is_hardware))
             
+        if nqubits is not None:
+            
+            _query_params.append(('nqubits', nqubits))
+            
         if status is not None:
             
             _query_params.append(('status', status.value))
@@ -751,6 +755,22 @@ class BackendTypesApi:
             
             _query_params.append(('max_number_of_shots', max_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