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

compute_api_client/__init__.py

@@ -5,7 +5,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)
@@ -52,6 +52,7 @@ from compute_api_client.models.algorithm import Algorithm
 from compute_api_client.models.algorithm_in import AlgorithmIn
 from compute_api_client.models.algorithm_type import AlgorithmType
 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_type import BackendType

compute_api_client/api/algorithms_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)
@@ -23,6 +23,8 @@ 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
@@ -307,6 +309,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -566,6 +569,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -834,6 +838,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -859,13 +864,19 @@ class AlgorithmsApi:
     @validate_call
     async def read_algorithms_algorithms_get(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = 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,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
         shared: Optional[ShareType] = None,
         link__isnull: Optional[StrictBool] = None,
         link: Optional[StrictStr] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -883,8 +894,16 @@ class AlgorithmsApi:
 
         List algorithms.
 
+        :param search: Substring search for algorithm names
+        :type search: 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 project_id:
@@ -897,6 +916,10 @@ class AlgorithmsApi:
         :type link__isnull: bool
         :param link:
         :type link: str
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :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
@@ -920,13 +943,19 @@ class AlgorithmsApi:
         """ # noqa: E501
 
         _param = self._read_algorithms_algorithms_get_serialize(
+            search=search,
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
             shared=shared,
             link__isnull=link__isnull,
             link=link,
+            name__isnull=name__isnull,
+            name=name,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -952,13 +981,19 @@ class AlgorithmsApi:
     @validate_call
     async def read_algorithms_algorithms_get_with_http_info(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = 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,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
         shared: Optional[ShareType] = None,
         link__isnull: Optional[StrictBool] = None,
         link: Optional[StrictStr] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -976,8 +1011,16 @@ class AlgorithmsApi:
 
         List algorithms.
 
+        :param search: Substring search for algorithm names
+        :type search: 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 project_id:
@@ -990,6 +1033,10 @@ class AlgorithmsApi:
         :type link__isnull: bool
         :param link:
         :type link: str
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :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
@@ -1013,13 +1060,19 @@ class AlgorithmsApi:
         """ # noqa: E501
 
         _param = self._read_algorithms_algorithms_get_serialize(
+            search=search,
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
             shared=shared,
             link__isnull=link__isnull,
             link=link,
+            name__isnull=name__isnull,
+            name=name,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1045,13 +1098,19 @@ class AlgorithmsApi:
     @validate_call
     async def read_algorithms_algorithms_get_without_preload_content(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = 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,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
         shared: Optional[ShareType] = None,
         link__isnull: Optional[StrictBool] = None,
         link: Optional[StrictStr] = None,
+        name__isnull: Optional[StrictBool] = None,
+        name: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1069,8 +1128,16 @@ class AlgorithmsApi:
 
         List algorithms.
 
+        :param search: Substring search for algorithm names
+        :type search: 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 project_id:
@@ -1083,6 +1150,10 @@ class AlgorithmsApi:
         :type link__isnull: bool
         :param link:
         :type link: str
+        :param name__isnull:
+        :type name__isnull: bool
+        :param name:
+        :type name: str
         :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
@@ -1106,13 +1177,19 @@ class AlgorithmsApi:
         """ # noqa: E501
 
         _param = self._read_algorithms_algorithms_get_serialize(
+            search=search,
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
             shared=shared,
             link__isnull=link__isnull,
             link=link,
+            name__isnull=name__isnull,
+            name=name,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1133,13 +1210,19 @@ class AlgorithmsApi:
 
     def _read_algorithms_algorithms_get_serialize(
         self,
+        search,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         project_id,
         type,
         shared,
         link__isnull,
         link,
+        name__isnull,
+        name,
         _request_auth,
         _content_type,
         _headers,
@@ -1161,10 +1244,26 @@ class AlgorithmsApi:
 
         # process the path parameters
         # process the query parameters
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
         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))
@@ -1189,6 +1288,14 @@ class AlgorithmsApi:
             
             _query_params.append(('link', link))
             
+        if name__isnull is not None:
+            
+            _query_params.append(('name__isnull', name__isnull))
+            
+        if name is not None:
+            
+            _query_params.append(('name', name))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1204,6 +1311,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1500,6 +1608,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/backend_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)
@@ -30,6 +30,7 @@ from pydantic import StrictBool, StrictInt, StrictStr
 from typing import List, 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
@@ -55,7 +56,7 @@ class BackendApi:
     @validate_call
     async def create_backend_backends_post(
         self,
-        backend: Backend,
+        backend_in: BackendIn,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -73,8 +74,8 @@ class BackendApi:
 
         Create new backend.
 
-        :param backend: (required)
-        :type backend: Backend
+        :param backend_in: (required)
+        :type backend_in: BackendIn
         :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
@@ -98,7 +99,7 @@ class BackendApi:
         """ # noqa: E501
 
         _param = self._create_backend_backends_post_serialize(
-            backend=backend,
+            backend_in=backend_in,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -124,7 +125,7 @@ class BackendApi:
     @validate_call
     async def create_backend_backends_post_with_http_info(
         self,
-        backend: Backend,
+        backend_in: BackendIn,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -142,8 +143,8 @@ class BackendApi:
 
         Create new backend.
 
-        :param backend: (required)
-        :type backend: Backend
+        :param backend_in: (required)
+        :type backend_in: BackendIn
         :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
@@ -167,7 +168,7 @@ class BackendApi:
         """ # noqa: E501
 
         _param = self._create_backend_backends_post_serialize(
-            backend=backend,
+            backend_in=backend_in,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -193,7 +194,7 @@ class BackendApi:
     @validate_call
     async def create_backend_backends_post_without_preload_content(
         self,
-        backend: Backend,
+        backend_in: BackendIn,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -211,8 +212,8 @@ class BackendApi:
 
         Create new backend.
 
-        :param backend: (required)
-        :type backend: Backend
+        :param backend_in: (required)
+        :type backend_in: BackendIn
         :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
@@ -236,7 +237,7 @@ class BackendApi:
         """ # noqa: E501
 
         _param = self._create_backend_backends_post_serialize(
-            backend=backend,
+            backend_in=backend_in,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -257,7 +258,7 @@ class BackendApi:
 
     def _create_backend_backends_post_serialize(
         self,
-        backend,
+        backend_in,
         _request_auth,
         _content_type,
         _headers,
@@ -282,8 +283,8 @@ class BackendApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if backend is not None:
-            _body_params = backend
+        if backend_in is not None:
+            _body_params = backend_in
 
 
         # set the HTTP header `Accept`
@@ -309,6 +310,7 @@ class BackendApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -577,6 +579,7 @@ class BackendApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -849,6 +852,9 @@ class BackendApi:
     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,
@@ -874,6 +880,12 @@ class BackendApi:
 
         :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:
@@ -910,6 +922,9 @@ class BackendApi:
 
         _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,
@@ -942,6 +957,9 @@ class BackendApi:
     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,
@@ -967,6 +985,12 @@ class BackendApi:
 
         :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:
@@ -1003,6 +1027,9 @@ class BackendApi:
 
         _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,
@@ -1035,6 +1062,9 @@ class BackendApi:
     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,
@@ -1060,6 +1090,12 @@ class BackendApi:
 
         :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:
@@ -1096,6 +1132,9 @@ class BackendApi:
 
         _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,
@@ -1123,6 +1162,9 @@ class BackendApi:
     def _read_backends_backends_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         name,
         location,
@@ -1154,6 +1196,18 @@ class BackendApi:
             
             _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))
@@ -1202,6 +1256,7 @@ class BackendApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]