qi-compute-api-client 0.49.0__py3-none-any.whl → 0.51.0__py3-none-any.whl

compute_api_client/docs/BackendTypesApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**read_backend_type_backend_types_id_get**](BackendTypesApi.md#read_backend_type_backend_types_id_get) | **GET** /backend_types/{id} | Retrieve backend type
 [**read_backend_types_backend_types_get**](BackendTypesApi.md#read_backend_types_backend_types_get) | **GET** /backend_types/ | List backend types
+[**update_backend_type_backend_types_me_patch**](BackendTypesApi.md#update_backend_type_backend_types_me_patch) | **PATCH** /backend_types/me | Update backend type
 
 
 # **read_backend_type_backend_types_id_get**
@@ -92,11 +93,11 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_backend_types_backend_types_get**
-> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, 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, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size)
+> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, 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, max_number_of_shots=max_number_of_shots, enabled=enabled, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List backend types
 
-Read backend types.
+Read backend types.  Only enabled backend types are returned.
 
 ### Example
 
@@ -131,6 +132,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     status = compute_api_client.BackendStatus() # BackendStatus |  (optional)
     default_number_of_shots = 56 # int |  (optional)
     max_number_of_shots = 56 # int |  (optional)
+    enabled = True # bool |  (optional)
     sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
     latest = True # bool | If True gets the most recently created object. (optional)
     page = 1 # int | Page number (optional) (default to 1)
@@ -138,7 +140,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
     try:
         # List backend types
-        api_response = await api_instance.read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, 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, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size)
+        api_response = await api_instance.read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, 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, max_number_of_shots=max_number_of_shots, enabled=enabled, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -162,6 +164,7 @@ Name | Type | Description  | Notes
  **status** | [**BackendStatus**](.md)|  | [optional] 
  **default_number_of_shots** | **int**|  | [optional] 
  **max_number_of_shots** | **int**|  | [optional] 
+ **enabled** | **bool**|  | [optional] 
  **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
  **latest** | **bool**| If True gets the most recently created object. | [optional] 
  **page** | **int**| Page number | [optional] [default to 1]
@@ -188,3 +191,84 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **update_backend_type_backend_types_me_patch**
+> BackendType update_backend_type_backend_types_me_patch(backend_type_patch)
+
+Update backend type
+
+Update backend type by ID.  This endpoint allows for partial updates of backend type properties.
+
+### Example
+
+* Api Key Authentication (backend):
+```python
+import time
+import os
+import compute_api_client
+from compute_api_client.models.backend_type import BackendType
+from compute_api_client.models.backend_type_patch import BackendTypePatch
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: backend
+configuration.api_key['backend'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['backend'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.BackendTypesApi(api_client)
+    backend_type_patch = compute_api_client.BackendTypePatch() # BackendTypePatch | 
+
+    try:
+        # Update backend type
+        api_response = await api_instance.update_backend_type_backend_types_me_patch(backend_type_patch)
+        print("The response of BackendTypesApi->update_backend_type_backend_types_me_patch:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling BackendTypesApi->update_backend_type_backend_types_me_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **backend_type_patch** | [**BackendTypePatch**](BackendTypePatch.md)|  | 
+
+### Return type
+
+[**BackendType**](BackendType.md)
+
+### Authorization
+
+[backend](../README.md#backend)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

compute_api_client/docs/File.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **content** | **str** |  | 
 **language_id** | **int** |  | 
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | 
-**compile_properties** | **object** |  | 
+**compile_properties** | **Dict[str, object]** |  | 
 **generated** | **bool** |  | 
 **name** | **str** |  | [optional] 
 

compute_api_client/docs/FileIn.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **content** | **str** |  | 
 **language_id** | **int** |  | 
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | 
-**compile_properties** | **object** |  | 
+**compile_properties** | **Dict[str, object]** |  | 
 **generated** | **bool** |  | [optional] [default to False]
 **name** | **str** |  | [optional] 
 

compute_api_client/docs/FinalResult.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **int** |  | 
 **created_on** | **datetime** |  | 
 **job_id** | **int** |  | 
-**final_result** | **object** |  | 
+**final_result** | **Dict[str, object]** |  | 
 
 ## Example
 

compute_api_client/docs/FinalResultIn.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **job_id** | **int** |  | 
-**final_result** | **object** |  | 
+**final_result** | **Dict[str, object]** |  | 
 
 ## Example
 

compute_api_client/docs/Job.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **session_id** | **str** |  | 
 **trace_id** | **str** |  | 
 **message** | **str** |  | 
-**source** | **str** |  | 
+**source** | **str** | The source application of an exception that caused a job to fail (if applicable). | [optional] [default to '']
 
 ## Example
 

compute_api_client/docs/JobPatch.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **session_id** | **str** |  | [optional] [default to '']
 **trace_id** | **str** |  | [optional] [default to '']
 **message** | **str** |  | [optional] [default to '']
-**source** | **str** |  | [optional] [default to '']
+**source** | **str** | The source application of an exception that caused a job to fail (if applicable). | [optional] [default to '']
 **traceback** | **str** |  | [optional] [default to '']
 
 ## Example

compute_api_client/docs/PageAlgorithm.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Algorithm]**](Algorithm.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageBackend.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Backend]**](Backend.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageBackendType.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[BackendType]**](BackendType.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageBatchJob.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[BatchJob]**](BatchJob.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageCommit.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Commit]**](Commit.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageFile.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[File]**](File.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageJob.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Job]**](Job.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageLanguage.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Language]**](Language.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageMember.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Member]**](Member.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PagePermission.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Permission]**](Permission.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PagePermissionGroup.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[PermissionGroup]**](PermissionGroup.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageProject.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Project]**](Project.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageReservation.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Reservation]**](Reservation.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageResult.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Result]**](Result.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageTeam.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Team]**](Team.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageTransaction.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[Transaction]**](Transaction.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/PageUser.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **items** | [**List[User]**](User.md) |  | 
-**total** | **int** |  | 
+**total** | **int** |  | [optional] 
 **page** | **int** |  | 
 **size** | **int** |  | 
 **pages** | **int** |  | [optional] 

compute_api_client/docs/Result.md

@@ -7,11 +7,10 @@ Name | Type | Description | Notes
 **id** | **int** |  | 
 **created_on** | **datetime** |  | 
 **job_id** | **int** |  | 
-**metadata_id** | **int** |  | 
 **execution_time_in_seconds** | **float** |  | 
 **shots_requested** | **int** |  | 
 **shots_done** | **int** |  | 
-**results** | **object** |  | 
+**results** | **Dict[str, object]** |  | 
 **raw_data** | **List[str]** |  | 
 
 ## Example

compute_api_client/docs/ResultIn.md

@@ -5,11 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **job_id** | **int** |  | 
-**metadata_id** | **int** |  | [optional] 
 **execution_time_in_seconds** | **float** |  | 
 **shots_requested** | **int** |  | [optional] 
 **shots_done** | **int** |  | [optional] 
-**results** | **object** |  | [optional] 
+**results** | **Dict[str, object]** |  | [optional] 
 **raw_data** | **List[str]** |  | [optional] 
 
 ## Example

compute_api_client/docs/ResultsApi.md

@@ -245,7 +245,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_results_by_algorithm_id_results_algorithm_algorithm_id_get**
-> PageResult read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, 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, size=size)
+> PageResult read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, 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, size=size)
 
 Retrieve results by algorithm ID
 
@@ -283,7 +283,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     id = 56 # int |  (optional)
     created_on = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
     job_id = 56 # int |  (optional)
-    metadata_id = 56 # int |  (optional)
     execution_time_in_seconds = 3.4 # float |  (optional)
     shots_requested__isnull = True # bool |  (optional)
     shots_requested = 56 # int |  (optional)
@@ -298,7 +297,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
     try:
         # Retrieve results by algorithm ID
-        api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, 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, size=size)
+        api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, 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, size=size)
         print("The response of ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -315,7 +314,6 @@ Name | Type | Description  | Notes
  **id** | **int**|  | [optional] 
  **created_on** | **datetime**|  | [optional] 
  **job_id** | **int**|  | [optional] 
- **metadata_id** | **int**|  | [optional] 
  **execution_time_in_seconds** | **float**|  | [optional] 
  **shots_requested__isnull** | **bool**|  | [optional] 
  **shots_requested** | **int**|  | [optional] 

compute_api_client/models/__init__.py

@@ -23,6 +23,7 @@ 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
+from compute_api_client.models.backend_type_patch import BackendTypePatch
 from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.models.batch_job_in import BatchJobIn
@@ -47,8 +48,6 @@ from compute_api_client.models.language import Language
 from compute_api_client.models.location_inner import LocationInner
 from compute_api_client.models.member import Member
 from compute_api_client.models.member_in import MemberIn
-from compute_api_client.models.metadata import Metadata
-from compute_api_client.models.metadata_in import MetadataIn
 from compute_api_client.models.page_algorithm import PageAlgorithm
 from compute_api_client.models.page_backend import PageBackend
 from compute_api_client.models.page_backend_type import PageBackendType
@@ -58,7 +57,6 @@ from compute_api_client.models.page_file import PageFile
 from compute_api_client.models.page_job import PageJob
 from compute_api_client.models.page_language import PageLanguage
 from compute_api_client.models.page_member import PageMember
-from compute_api_client.models.page_metadata import PageMetadata
 from compute_api_client.models.page_permission import PagePermission
 from compute_api_client.models.page_permission_group import PagePermissionGroup
 from compute_api_client.models.page_project import PageProject

compute_api_client/models/backend_type.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
 from pydantic import Field
 from typing_extensions import Annotated
@@ -40,14 +40,15 @@ class BackendType(BaseModel):
     is_hardware: StrictBool
     supports_raw_data: StrictBool
     features: List[StrictStr]
-    default_compiler_config: Union[str, Any]
+    default_compiler_config: Dict[str, Any]
     gateset: List[StrictStr]
     topology: List[List[StrictInt]]
     nqubits: StrictInt
     status: BackendStatus
     default_number_of_shots: StrictInt
     max_number_of_shots: StrictInt
-    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots"]
+    enabled: StrictBool
+    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled"]
 
     model_config = {
         "populate_by_name": True,
@@ -111,7 +112,8 @@ class BackendType(BaseModel):
             "nqubits": obj.get("nqubits"),
             "status": obj.get("status"),
             "default_number_of_shots": obj.get("default_number_of_shots"),
-            "max_number_of_shots": obj.get("max_number_of_shots")
+            "max_number_of_shots": obj.get("max_number_of_shots"),
+            "enabled": obj.get("enabled")
         })
         return _obj