qi-compute-api-client 0.38.2__py3-none-any.whl → 0.42.0__py3-none-any.whl

compute_api_client/__init__.py

@@ -18,6 +18,7 @@ __version__ = "1.0.0"
 
 # import apis into sdk package
 from compute_api_client.api.algorithms_api import AlgorithmsApi
+from compute_api_client.api.auth_config_api import AuthConfigApi
 from compute_api_client.api.backend_api import BackendApi
 from compute_api_client.api.backend_types_api import BackendTypesApi
 from compute_api_client.api.batch_jobs_api import BatchJobsApi
@@ -52,6 +53,7 @@ from compute_api_client.exceptions import ApiException
 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.auth_config import AuthConfig
 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
@@ -70,6 +72,7 @@ from compute_api_client.models.file import File
 from compute_api_client.models.file_in import FileIn
 from compute_api_client.models.final_result import FinalResult
 from compute_api_client.models.final_result_in import FinalResultIn
+from compute_api_client.models.http_bad_request_error import HTTPBadRequestError
 from compute_api_client.models.http_not_found_error import HTTPNotFoundError
 from compute_api_client.models.http_validation_error import HTTPValidationError
 from compute_api_client.models.job import Job

compute_api_client/api/__init__.py

@@ -2,6 +2,7 @@
 
 # import apis into api package
 from compute_api_client.api.algorithms_api import AlgorithmsApi
+from compute_api_client.api.auth_config_api import AuthConfigApi
 from compute_api_client.api.backend_api import BackendApi
 from compute_api_client.api.backend_types_api import BackendTypesApi
 from compute_api_client.api.batch_jobs_api import BatchJobsApi

compute_api_client/api/auth_config_api.py

@@ -0,0 +1,286 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    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)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import warnings
+
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Dict, List, Optional, Tuple, Union, Any
+
+try:
+    from typing import Annotated
+except ImportError:
+    from typing_extensions import Annotated
+
+from compute_api_client.models.auth_config import AuthConfig
+
+from compute_api_client.api_client import ApiClient
+from compute_api_client.api_response import ApiResponse
+from compute_api_client.rest import RESTResponseType
+
+
+class AuthConfigApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    async def auth_config_auth_config_get(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AuthConfig:
+        """Get suggested authentication configuration
+
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._auth_config_auth_config_get_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AuthConfig"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def auth_config_auth_config_get_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AuthConfig]:
+        """Get suggested authentication configuration
+
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._auth_config_auth_config_get_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AuthConfig"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def auth_config_auth_config_get_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get suggested authentication configuration
+
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._auth_config_auth_config_get_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AuthConfig"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _auth_config_auth_config_get_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/auth_config',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

compute_api_client/api/backend_types_api.py

@@ -298,7 +298,8 @@ class BackendTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'user_bearer'
+            'user_bearer', 
+            'backend'
         ]
 
         return self.api_client.param_serialize(
@@ -328,6 +329,7 @@ class BackendTypesApi:
         description: Optional[StrictStr] = None,
         image_id: Optional[StrictStr] = None,
         is_hardware: Optional[StrictBool] = None,
+        supports_raw_data: Optional[StrictBool] = None,
         nqubits: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         default_number_of_shots: Optional[StrictInt] = None,
@@ -365,6 +367,8 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :param supports_raw_data:
+        :type supports_raw_data: bool
         :param nqubits:
         :type nqubits: int
         :param status:
@@ -410,6 +414,7 @@ class BackendTypesApi:
             description=description,
             image_id=image_id,
             is_hardware=is_hardware,
+            supports_raw_data=supports_raw_data,
             nqubits=nqubits,
             status=status,
             default_number_of_shots=default_number_of_shots,
@@ -449,6 +454,7 @@ class BackendTypesApi:
         description: Optional[StrictStr] = None,
         image_id: Optional[StrictStr] = None,
         is_hardware: Optional[StrictBool] = None,
+        supports_raw_data: Optional[StrictBool] = None,
         nqubits: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         default_number_of_shots: Optional[StrictInt] = None,
@@ -486,6 +492,8 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :param supports_raw_data:
+        :type supports_raw_data: bool
         :param nqubits:
         :type nqubits: int
         :param status:
@@ -531,6 +539,7 @@ class BackendTypesApi:
             description=description,
             image_id=image_id,
             is_hardware=is_hardware,
+            supports_raw_data=supports_raw_data,
             nqubits=nqubits,
             status=status,
             default_number_of_shots=default_number_of_shots,
@@ -570,6 +579,7 @@ class BackendTypesApi:
         description: Optional[StrictStr] = None,
         image_id: Optional[StrictStr] = None,
         is_hardware: Optional[StrictBool] = None,
+        supports_raw_data: Optional[StrictBool] = None,
         nqubits: Optional[StrictInt] = None,
         status: Optional[BackendStatus] = None,
         default_number_of_shots: Optional[StrictInt] = None,
@@ -607,6 +617,8 @@ class BackendTypesApi:
         :type image_id: str
         :param is_hardware:
         :type is_hardware: bool
+        :param supports_raw_data:
+        :type supports_raw_data: bool
         :param nqubits:
         :type nqubits: int
         :param status:
@@ -652,6 +664,7 @@ class BackendTypesApi:
             description=description,
             image_id=image_id,
             is_hardware=is_hardware,
+            supports_raw_data=supports_raw_data,
             nqubits=nqubits,
             status=status,
             default_number_of_shots=default_number_of_shots,
@@ -686,6 +699,7 @@ class BackendTypesApi:
         description,
         image_id,
         is_hardware,
+        supports_raw_data,
         nqubits,
         status,
         default_number_of_shots,
@@ -739,6 +753,10 @@ class BackendTypesApi:
             
             _query_params.append(('is_hardware', is_hardware))
             
+        if supports_raw_data is not None:
+            
+            _query_params.append(('supports_raw_data', supports_raw_data))
+            
         if nqubits is not None:
             
             _query_params.append(('nqubits', nqubits))

compute_api_client/api/jobs_api.py

@@ -877,6 +877,7 @@ class JobsApi:
         finished_at: Optional[datetime] = None,
         number_of_shots__isnull: Optional[StrictBool] = None,
         number_of_shots: Optional[StrictInt] = None,
+        raw_data_enabled: Optional[StrictBool] = 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,
@@ -922,6 +923,8 @@ class JobsApi:
         :type number_of_shots__isnull: bool
         :param number_of_shots:
         :type number_of_shots: int
+        :param raw_data_enabled:
+        :type raw_data_enabled: bool
         :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.
@@ -965,6 +968,7 @@ class JobsApi:
             finished_at=finished_at,
             number_of_shots__isnull=number_of_shots__isnull,
             number_of_shots=number_of_shots,
+            raw_data_enabled=raw_data_enabled,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1006,6 +1010,7 @@ class JobsApi:
         finished_at: Optional[datetime] = None,
         number_of_shots__isnull: Optional[StrictBool] = None,
         number_of_shots: Optional[StrictInt] = None,
+        raw_data_enabled: Optional[StrictBool] = 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,
@@ -1051,6 +1056,8 @@ class JobsApi:
         :type number_of_shots__isnull: bool
         :param number_of_shots:
         :type number_of_shots: int
+        :param raw_data_enabled:
+        :type raw_data_enabled: bool
         :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.
@@ -1094,6 +1101,7 @@ class JobsApi:
             finished_at=finished_at,
             number_of_shots__isnull=number_of_shots__isnull,
             number_of_shots=number_of_shots,
+            raw_data_enabled=raw_data_enabled,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1135,6 +1143,7 @@ class JobsApi:
         finished_at: Optional[datetime] = None,
         number_of_shots__isnull: Optional[StrictBool] = None,
         number_of_shots: Optional[StrictInt] = None,
+        raw_data_enabled: Optional[StrictBool] = 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,
@@ -1180,6 +1189,8 @@ class JobsApi:
         :type number_of_shots__isnull: bool
         :param number_of_shots:
         :type number_of_shots: int
+        :param raw_data_enabled:
+        :type raw_data_enabled: bool
         :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.
@@ -1223,6 +1234,7 @@ class JobsApi:
             finished_at=finished_at,
             number_of_shots__isnull=number_of_shots__isnull,
             number_of_shots=number_of_shots,
+            raw_data_enabled=raw_data_enabled,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1259,6 +1271,7 @@ class JobsApi:
         finished_at,
         number_of_shots__isnull,
         number_of_shots,
+        raw_data_enabled,
         sort_by,
         latest,
         page,
@@ -1359,6 +1372,10 @@ class JobsApi:
             
             _query_params.append(('number_of_shots', number_of_shots))
             
+        if raw_data_enabled is not None:
+            
+            _query_params.append(('raw_data_enabled', raw_data_enabled))
+            
         if sort_by is not None:
             
             _query_params.append(('sort_by', sort_by))

compute_api_client/api/results_api.py

@@ -872,6 +872,7 @@ class ResultsApi:
         shots_done__isnull: Optional[StrictBool] = None,
         shots_done: Optional[StrictInt] = None,
         results__isnull: Optional[StrictBool] = None,
+        raw_data__isnull: Optional[StrictBool] = 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,
@@ -915,6 +916,8 @@ class ResultsApi:
         :type shots_done: int
         :param results__isnull:
         :type results__isnull: bool
+        :param raw_data__isnull:
+        :type raw_data__isnull: bool
         :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.
@@ -957,6 +960,7 @@ class ResultsApi:
             shots_done__isnull=shots_done__isnull,
             shots_done=shots_done,
             results__isnull=results__isnull,
+            raw_data__isnull=raw_data__isnull,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -998,6 +1002,7 @@ class ResultsApi:
         shots_done__isnull: Optional[StrictBool] = None,
         shots_done: Optional[StrictInt] = None,
         results__isnull: Optional[StrictBool] = None,
+        raw_data__isnull: Optional[StrictBool] = 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,
@@ -1041,6 +1046,8 @@ class ResultsApi:
         :type shots_done: int
         :param results__isnull:
         :type results__isnull: bool
+        :param raw_data__isnull:
+        :type raw_data__isnull: bool
         :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.
@@ -1083,6 +1090,7 @@ class ResultsApi:
             shots_done__isnull=shots_done__isnull,
             shots_done=shots_done,
             results__isnull=results__isnull,
+            raw_data__isnull=raw_data__isnull,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1124,6 +1132,7 @@ class ResultsApi:
         shots_done__isnull: Optional[StrictBool] = None,
         shots_done: Optional[StrictInt] = None,
         results__isnull: Optional[StrictBool] = None,
+        raw_data__isnull: Optional[StrictBool] = 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,
@@ -1167,6 +1176,8 @@ class ResultsApi:
         :type shots_done: int
         :param results__isnull:
         :type results__isnull: bool
+        :param raw_data__isnull:
+        :type raw_data__isnull: bool
         :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.
@@ -1209,6 +1220,7 @@ class ResultsApi:
             shots_done__isnull=shots_done__isnull,
             shots_done=shots_done,
             results__isnull=results__isnull,
+            raw_data__isnull=raw_data__isnull,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1245,6 +1257,7 @@ class ResultsApi:
         shots_done__isnull,
         shots_done,
         results__isnull,
+        raw_data__isnull,
         sort_by,
         latest,
         page,
@@ -1321,6 +1334,10 @@ class ResultsApi:
             
             _query_params.append(('results__isnull', results__isnull))
             
+        if raw_data__isnull is not None:
+            
+            _query_params.append(('raw_data__isnull', raw_data__isnull))
+            
         if sort_by is not None:
             
             _query_params.append(('sort_by', sort_by))

compute_api_client/docs/AuthConfig.md

@@ -0,0 +1,30 @@
+# AuthConfig
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **str** |  | 
+**audience** | **str** |  | 
+**well_known_endpoint** | **str** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.auth_config import AuthConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AuthConfig from a JSON string
+auth_config_instance = AuthConfig.from_json(json)
+# print the JSON string representation of the object
+print AuthConfig.to_json()
+
+# convert the object into a dict
+auth_config_dict = auth_config_instance.to_dict()
+# create an instance of AuthConfig from a dict
+auth_config_form_dict = auth_config.from_dict(auth_config_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+