qi-compute-api-client 0.21.0__tar.gz → 0.27.0__tar.gz

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/PKG-INFO

@@ -1,16 +1,15 @@
 Metadata-Version: 2.1
 Name: qi-compute-api-client
-Version: 0.21.0
+Version: 0.27.0
 Summary: An API client for the Compute Job Manager of Quantum Inspire.
 Home-page: https://github.com/QuTech-Delft/compute-api-client
 License: Apache-2.0
 Author: Quantum Inspire
 Author-email: support@quantum-inspire.eu
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.8,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -68,6 +67,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -175,6 +176,7 @@ Class | Method | HTTP request | Description
  - [AlgorithmIn](compute_api_client/docs/AlgorithmIn.md)
  - [AlgorithmType](compute_api_client/docs/AlgorithmType.md)
  - [Backend](compute_api_client/docs/Backend.md)
+ - [BackendIn](compute_api_client/docs/BackendIn.md)
  - [BackendPatch](compute_api_client/docs/BackendPatch.md)
  - [BackendStatus](compute_api_client/docs/BackendStatus.md)
  - [BackendType](compute_api_client/docs/BackendType.md)
@@ -232,6 +234,14 @@ Authentication schemes defined for the API:
 - **API key parameter name**: X-userid
 - **Location**: HTTP header
 
+<a id="user_bearer"></a>
+### user_bearer
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_staging/protocol/openid-connect/auth
+- **Scopes**: N/A
+
 <a id="backend"></a>
 ### backend
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/README.md

@@ -45,6 +45,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -152,6 +154,7 @@ Class | Method | HTTP request | Description
  - [AlgorithmIn](compute_api_client/docs/AlgorithmIn.md)
  - [AlgorithmType](compute_api_client/docs/AlgorithmType.md)
  - [Backend](compute_api_client/docs/Backend.md)
+ - [BackendIn](compute_api_client/docs/BackendIn.md)
  - [BackendPatch](compute_api_client/docs/BackendPatch.md)
  - [BackendStatus](compute_api_client/docs/BackendStatus.md)
  - [BackendType](compute_api_client/docs/BackendType.md)
@@ -209,6 +212,14 @@ Authentication schemes defined for the API:
 - **API key parameter name**: X-userid
 - **Location**: HTTP header
 
+<a id="user_bearer"></a>
+### user_bearer
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_staging/protocol/openid-connect/auth
+- **Scopes**: N/A
+
 <a id="backend"></a>
 ### backend
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/__init__.py

@@ -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

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/algorithms_api.py

@@ -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,6 +864,7 @@ 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,
@@ -888,6 +894,8 @@ class AlgorithmsApi:
 
         List algorithms.
 
+        :param search: Substring search for algorithm names
+        :type search: str
         :param latest:
         :type latest: bool
         :param sort_by:
@@ -935,6 +943,7 @@ class AlgorithmsApi:
         """ # noqa: E501
 
         _param = self._read_algorithms_algorithms_get_serialize(
+            search=search,
             latest=latest,
             sort_by=sort_by,
             page_number=page_number,
@@ -972,6 +981,7 @@ 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,
@@ -1001,6 +1011,8 @@ class AlgorithmsApi:
 
         List algorithms.
 
+        :param search: Substring search for algorithm names
+        :type search: str
         :param latest:
         :type latest: bool
         :param sort_by:
@@ -1048,6 +1060,7 @@ class AlgorithmsApi:
         """ # noqa: E501
 
         _param = self._read_algorithms_algorithms_get_serialize(
+            search=search,
             latest=latest,
             sort_by=sort_by,
             page_number=page_number,
@@ -1085,6 +1098,7 @@ 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,
@@ -1114,6 +1128,8 @@ class AlgorithmsApi:
 
         List algorithms.
 
+        :param search: Substring search for algorithm names
+        :type search: str
         :param latest:
         :type latest: bool
         :param sort_by:
@@ -1161,6 +1177,7 @@ class AlgorithmsApi:
         """ # noqa: E501
 
         _param = self._read_algorithms_algorithms_get_serialize(
+            search=search,
             latest=latest,
             sort_by=sort_by,
             page_number=page_number,
@@ -1193,6 +1210,7 @@ class AlgorithmsApi:
 
     def _read_algorithms_algorithms_get_serialize(
         self,
+        search,
         latest,
         sort_by,
         page_number,
@@ -1226,6 +1244,10 @@ 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))
@@ -1289,6 +1311,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1585,6 +1608,7 @@ class AlgorithmsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/backend_api.py

@@ -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'
         ]
 
@@ -1253,6 +1256,7 @@ class BackendApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/backend_types_api.py

@@ -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'
         ]
 
@@ -328,6 +330,9 @@ class BackendTypesApi:
         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)],
@@ -365,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
@@ -398,6 +409,9 @@ class BackendTypesApi:
             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,
@@ -433,6 +447,9 @@ class BackendTypesApi:
         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)],
@@ -470,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
@@ -503,6 +526,9 @@ class BackendTypesApi:
             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,
@@ -538,6 +564,9 @@ class BackendTypesApi:
         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)],
@@ -575,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
@@ -608,6 +643,9 @@ class BackendTypesApi:
             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,
@@ -638,6 +676,9 @@ class BackendTypesApi:
         description,
         image_id,
         is_hardware,
+        status,
+        default_number_of_shots,
+        max_number_of_shots,
         _request_auth,
         _content_type,
         _headers,
@@ -699,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
@@ -714,6 +767,7 @@ class BackendTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/batch_jobs_api.py

@@ -309,6 +309,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -577,6 +578,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -845,6 +847,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -1967,6 +1970,7 @@ class BatchJobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/commits_api.py

@@ -307,6 +307,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -566,6 +567,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -834,6 +836,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -1247,6 +1250,7 @@ class CommitsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/files_api.py

@@ -306,6 +306,7 @@ class FilesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -565,6 +566,7 @@ class FilesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -833,6 +835,7 @@ class FilesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -1254,6 +1257,7 @@ class FilesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/final_results_api.py

@@ -303,6 +303,7 @@ class FinalResultsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -569,6 +570,7 @@ class FinalResultsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -837,6 +839,7 @@ class FinalResultsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/jobs_api.py

@@ -310,6 +310,7 @@ class JobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -569,6 +570,7 @@ class JobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -837,6 +839,7 @@ class JobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -1387,6 +1390,7 @@ class JobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]
@@ -1684,6 +1688,7 @@ class JobsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'backend', 
             'user'
         ]

{qi_compute_api_client-0.21.0 → qi_compute_api_client-0.27.0}/compute_api_client/api/languages_api.py

@@ -294,6 +294,7 @@ class LanguagesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -680,6 +681,7 @@ class LanguagesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]