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

compute_api_client/api/backend_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.backend import Backend
 from compute_api_client.models.backend_in import BackendIn
 from compute_api_client.models.backend_patch import BackendPatch
 from compute_api_client.models.backend_status import BackendStatus
 from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
+from compute_api_client.models.page_backend import PageBackend
 
 from compute_api_client.api_client import ApiClient
 from compute_api_client.api_response import ApiResponse
@@ -849,16 +852,16 @@ class BackendApi:
     @validate_call
     async def read_backends_backends_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,
         location: Optional[StrictStr] = None,
         backend_type_id: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         last_heartbeat: Optional[datetime] = 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)],
@@ -871,19 +874,11 @@ class BackendApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Backend]:
+    ) -> PageBackend:
         """List backends
 
         Read backends.
 
-        :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:
@@ -896,6 +891,14 @@ class BackendApi:
         :type status: BackendStatus
         :param last_heartbeat:
         :type last_heartbeat: datetime
+        :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
@@ -919,16 +922,16 @@ class BackendApi:
         """ # noqa: E501
 
         _param = self._read_backends_backends_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             location=location,
             backend_type_id=backend_type_id,
             status=status,
             last_heartbeat=last_heartbeat,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -936,7 +939,7 @@ class BackendApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Backend]",
+            '200': "PageBackend",
             '422': "HTTPValidationError"
             
         }
@@ -954,16 +957,16 @@ class BackendApi:
     @validate_call
     async def read_backends_backends_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,
         location: Optional[StrictStr] = None,
         backend_type_id: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         last_heartbeat: Optional[datetime] = 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)],
@@ -976,19 +979,11 @@ class BackendApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Backend]]:
+    ) -> ApiResponse[PageBackend]:
         """List backends
 
         Read backends.
 
-        :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:
@@ -1001,6 +996,14 @@ class BackendApi:
         :type status: BackendStatus
         :param last_heartbeat:
         :type last_heartbeat: datetime
+        :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
@@ -1024,16 +1027,16 @@ class BackendApi:
         """ # noqa: E501
 
         _param = self._read_backends_backends_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             location=location,
             backend_type_id=backend_type_id,
             status=status,
             last_heartbeat=last_heartbeat,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1041,7 +1044,7 @@ class BackendApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Backend]",
+            '200': "PageBackend",
             '422': "HTTPValidationError"
             
         }
@@ -1059,16 +1062,16 @@ class BackendApi:
     @validate_call
     async def read_backends_backends_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,
         location: Optional[StrictStr] = None,
         backend_type_id: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         last_heartbeat: Optional[datetime] = 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)],
@@ -1086,14 +1089,6 @@ class BackendApi:
 
         Read backends.
 
-        :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:
@@ -1106,6 +1101,14 @@ class BackendApi:
         :type status: BackendStatus
         :param last_heartbeat:
         :type last_heartbeat: datetime
+        :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
@@ -1129,16 +1132,16 @@ class BackendApi:
         """ # noqa: E501
 
         _param = self._read_backends_backends_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             location=location,
             backend_type_id=backend_type_id,
             status=status,
             last_heartbeat=last_heartbeat,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1146,7 +1149,7 @@ class BackendApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Backend]",
+            '200': "PageBackend",
             '422': "HTTPValidationError"
             
         }
@@ -1159,16 +1162,16 @@ class BackendApi:
 
     def _read_backends_backends_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         name,
         location,
         backend_type_id,
         status,
         last_heartbeat,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -1190,22 +1193,6 @@ class BackendApi:
 
         # 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))
@@ -1239,6 +1226,22 @@ class BackendApi:
             else:
                 _query_params.append(('last_heartbeat', last_heartbeat))
             
+        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