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

compute_api_client/api/backend_types_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)
@@ -27,6 +27,7 @@ from pydantic import StrictBool, StrictInt, StrictStr
 
 from typing import List, Optional
 
+from compute_api_client.models.backend_status import BackendStatus
 from compute_api_client.models.backend_type import BackendType
 
 from compute_api_client.api_client import ApiClient
@@ -294,6 +295,7 @@ class BackendTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -319,12 +321,18 @@ class BackendTypesApi:
     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,
+        status: Optional[BackendStatus] = None,
+        default_number_of_shots: Optional[StrictInt] = None,
+        max_number_of_shots: Optional[StrictInt] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -344,6 +352,12 @@ class BackendTypesApi:
 
         :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:
@@ -356,6 +370,12 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :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 _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
@@ -380,12 +400,18 @@ class BackendTypesApi:
 
         _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,
+            status=status,
+            default_number_of_shots=default_number_of_shots,
+            max_number_of_shots=max_number_of_shots,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -412,12 +438,18 @@ class BackendTypesApi:
     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,
+        status: Optional[BackendStatus] = None,
+        default_number_of_shots: Optional[StrictInt] = None,
+        max_number_of_shots: Optional[StrictInt] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -437,6 +469,12 @@ class BackendTypesApi:
 
         :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:
@@ -449,6 +487,12 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :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 _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
@@ -473,12 +517,18 @@ class BackendTypesApi:
 
         _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,
+            status=status,
+            default_number_of_shots=default_number_of_shots,
+            max_number_of_shots=max_number_of_shots,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -505,12 +555,18 @@ class BackendTypesApi:
     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,
+        status: Optional[BackendStatus] = None,
+        default_number_of_shots: Optional[StrictInt] = None,
+        max_number_of_shots: Optional[StrictInt] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -530,6 +586,12 @@ class BackendTypesApi:
 
         :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:
@@ -542,6 +604,12 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :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 _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
@@ -566,12 +634,18 @@ class BackendTypesApi:
 
         _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,
+            status=status,
+            default_number_of_shots=default_number_of_shots,
+            max_number_of_shots=max_number_of_shots,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -593,12 +667,18 @@ 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,
+        status,
+        default_number_of_shots,
+        max_number_of_shots,
         _request_auth,
         _content_type,
         _headers,
@@ -624,6 +704,18 @@ class BackendTypesApi:
             
             _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))
@@ -648,6 +740,18 @@ class BackendTypesApi:
             
             _query_params.append(('is_hardware', is_hardware))
             
+        if status is not None:
+            
+            _query_params.append(('status', status.value))
+            
+        if default_number_of_shots is not None:
+            
+            _query_params.append(('default_number_of_shots', default_number_of_shots))
+            
+        if max_number_of_shots is not None:
+            
+            _query_params.append(('max_number_of_shots', max_number_of_shots))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -663,6 +767,7 @@ class BackendTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]