qi-compute-api-client 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

compute_api_client/docs/Backend.md

@@ -2,14 +2,15 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**location** | **str** |  | 
-**backend_type_id** | **int** |  | 
-**status** | [**BackendStatus**](BackendStatus.md) |  | 
-**last_heartbeat** | **datetime** |  | 
+**id** | **int** | The id of the backend | 
+**name** | **str** | The name of the backend | 
+**location** | **str** | The location of the backend | 
+**backend_type_id** | **int** | The id of the backend type | 
+**status** | [**BackendStatus**](BackendStatus.md) | Status of the backend | 
+**last_heartbeat** | **datetime** | Time of last heartbeat | 
 
 ## Example
 
@@ -21,12 +22,12 @@ json = "{}"
 # create an instance of Backend from a JSON string
 backend_instance = Backend.from_json(json)
 # print the JSON string representation of the object
-print Backend.to_json()
+print(Backend.to_json())
 
 # convert the object into a dict
 backend_dict = backend_instance.to_dict()
 # create an instance of Backend from a dict
-backend_form_dict = backend.from_dict(backend_dict)
+backend_from_dict = Backend.from_dict(backend_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)
 

compute_api_client/docs/BackendApi.md

@@ -21,9 +21,8 @@ Create new backend.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.backend_in import BackendIn
 from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
@@ -62,6 +61,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **backend_in** | [**BackendIn**](BackendIn.md)|  | 
@@ -80,6 +80,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -97,9 +98,8 @@ Get backend by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.backend import Backend
 from compute_api_client.rest import ApiException
@@ -137,6 +137,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -155,6 +156,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -173,9 +175,8 @@ Read backend.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.backend import Backend
 from compute_api_client.rest import ApiException
@@ -215,6 +216,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -231,6 +233,7 @@ This endpoint does not need any parameter.
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -247,9 +250,8 @@ Read backends.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.backend_status import BackendStatus
 from compute_api_client.models.page_backend import PageBackend
@@ -297,6 +299,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -324,6 +327,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -341,9 +345,8 @@ Update backend.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.backend import Backend
 from compute_api_client.models.backend_patch import BackendPatch
@@ -386,6 +389,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **backend_patch** | [**BackendPatch**](BackendPatch.md)|  | 
@@ -404,6 +408,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/BackendIn.md

@@ -2,13 +2,14 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** |  | 
-**location** | **str** |  | 
-**backend_type_id** | **int** |  | 
-**status** | [**BackendStatus**](BackendStatus.md) |  | 
-**last_heartbeat** | **datetime** |  | 
+**name** | **str** | The name of the backend | 
+**location** | **str** | The location of the backend | 
+**backend_type_id** | **int** | The id of the backend type | 
+**status** | [**BackendStatus**](BackendStatus.md) | Status of the backend | 
+**last_heartbeat** | **datetime** | Time of last heartbeat | 
 
 ## Example
 
@@ -20,12 +21,12 @@ json = "{}"
 # create an instance of BackendIn from a JSON string
 backend_in_instance = BackendIn.from_json(json)
 # print the JSON string representation of the object
-print BackendIn.to_json()
+print(BackendIn.to_json())
 
 # convert the object into a dict
 backend_in_dict = backend_in_instance.to_dict()
 # create an instance of BackendIn from a dict
-backend_in_form_dict = backend_in.from_dict(backend_in_dict)
+backend_in_from_dict = BackendIn.from_dict(backend_in_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)
 

compute_api_client/docs/BackendPatch.md

@@ -2,10 +2,11 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | [**BackendStatus**](BackendStatus.md) |  | 
-**last_heartbeat** | **datetime** |  | 
+**status** | [**BackendStatus**](BackendStatus.md) | Status of the backend | 
+**last_heartbeat** | **datetime** | Time of last heartbeat | 
 
 ## Example
 
@@ -17,12 +18,12 @@ json = "{}"
 # create an instance of BackendPatch from a JSON string
 backend_patch_instance = BackendPatch.from_json(json)
 # print the JSON string representation of the object
-print BackendPatch.to_json()
+print(BackendPatch.to_json())
 
 # convert the object into a dict
 backend_patch_dict = backend_patch_instance.to_dict()
 # create an instance of BackendPatch from a dict
-backend_patch_form_dict = backend_patch.from_dict(backend_patch_dict)
+backend_patch_from_dict = BackendPatch.from_dict(backend_patch_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)
 

compute_api_client/docs/BackendStatus.md

@@ -1,9 +1,15 @@
 # BackendStatus
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `OFFLINE` (value: `'offline'`)
+
+* `IDLE` (value: `'idle'`)
+
+* `EXECUTING` (value: `'executing'`)
+
+* `CALIBRATING` (value: `'calibrating'`)
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

compute_api_client/docs/BackendType.md

@@ -2,25 +2,26 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**infrastructure** | **str** |  | 
-**description** | **str** |  | 
-**image_id** | **str** |  | 
-**is_hardware** | **bool** |  | 
-**supports_raw_data** | **bool** |  | 
-**features** | **List[str]** |  | 
-**default_compiler_config** | **Dict[str, object]** |  | 
-**gateset** | **List[str]** |  | 
-**topology** | **List[List[int]]** |  | 
-**nqubits** | **int** |  | 
-**status** | [**BackendStatus**](BackendStatus.md) |  | 
-**default_number_of_shots** | **int** |  | 
-**max_number_of_shots** | **int** |  | 
-**enabled** | **bool** |  | 
-**identifier** | **str** |  | 
+**id** | **int** | The id of the backend type | 
+**name** | **str** | Name of the backend type | 
+**infrastructure** | **str** | Name of the infrastructure | 
+**description** | **str** | Description of the backendtype | 
+**image_id** | **str** | The id of the image | 
+**is_hardware** | **bool** | If it is hardware | 
+**supports_raw_data** | **bool** | If it supports raw data extraction | 
+**features** | **List[Optional[str]]** | The features supported by backend type | 
+**default_compiler_config** | **Dict[str, object]** | The various passes for each stage | 
+**gateset** | **List[Optional[str]]** | The primary gatesets supported by the backend | 
+**topology** | **List[List[int]]** | The topology of the backend | 
+**nqubits** | **int** | The number of qubits on the backend | 
+**status** | [**BackendStatus**](BackendStatus.md) | The status of the backend type | 
+**default_number_of_shots** | **int** | The default shots | 
+**max_number_of_shots** | **int** | The maximum number of shots | 
+**enabled** | **bool** | If it is enabled | 
+**identifier** | **str** | The identifier of the backend | 
 **protocol_version** | **int** |  | [optional] 
 
 ## Example
@@ -33,12 +34,12 @@ json = "{}"
 # create an instance of BackendType from a JSON string
 backend_type_instance = BackendType.from_json(json)
 # print the JSON string representation of the object
-print BackendType.to_json()
+print(BackendType.to_json())
 
 # convert the object into a dict
 backend_type_dict = backend_type_instance.to_dict()
 # create an instance of BackendType from a dict
-backend_type_form_dict = backend_type.from_dict(backend_type_dict)
+backend_type_from_dict = BackendType.from_dict(backend_type_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)
 

compute_api_client/docs/BackendTypePatch.md

@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** |  | [optional] 
@@ -31,12 +32,12 @@ json = "{}"
 # create an instance of BackendTypePatch from a JSON string
 backend_type_patch_instance = BackendTypePatch.from_json(json)
 # print the JSON string representation of the object
-print BackendTypePatch.to_json()
+print(BackendTypePatch.to_json())
 
 # convert the object into a dict
 backend_type_patch_dict = backend_type_patch_instance.to_dict()
 # create an instance of BackendTypePatch from a dict
-backend_type_patch_form_dict = backend_type_patch.from_dict(backend_type_patch_dict)
+backend_type_patch_from_dict = BackendTypePatch.from_dict(backend_type_patch_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)
 

compute_api_client/docs/BackendTypesApi.md

@@ -20,9 +20,8 @@ Get backend type by ID.
 
 * OAuth Authentication (user_bearer):
 * 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.rest import ApiException
@@ -66,6 +65,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -84,6 +84,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -97,13 +98,14 @@ Name | Type | Description  | Notes
 
 List backend types
 
-Read backend types.  Only enabled backend types are returned.
+Read backend types.
+
+Only enabled backend types are returned.
 
 ### Example
 
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.backend_status import BackendStatus
 from compute_api_client.models.page_backend_type import PageBackendType
@@ -154,6 +156,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -190,6 +193,7 @@ No authorization required
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -202,14 +206,15 @@ No authorization required
 
 Update backend type
 
-Update backend type by ID.  This endpoint allows for partial updates of backend type properties.
+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
@@ -252,6 +257,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **backend_type_patch** | [**BackendTypePatch**](BackendTypePatch.md)|  | 
@@ -270,6 +276,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/BackendWithAuthentication.md

@@ -2,15 +2,16 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**location** | **str** |  | 
-**backend_type_id** | **int** |  | 
-**status** | [**BackendStatus**](BackendStatus.md) |  | 
-**last_heartbeat** | **datetime** |  | 
-**authentication_hash** | **str** |  | 
+**id** | **int** | The id of the backend | 
+**name** | **str** | The name of the backend | 
+**location** | **str** | The location of the backend | 
+**backend_type_id** | **int** | The id of the backend type | 
+**status** | [**BackendStatus**](BackendStatus.md) | Status of the backend | 
+**last_heartbeat** | **datetime** | Time of last heartbeat | 
+**authentication_hash** | **str** | The authentication hash of the backend | 
 
 ## Example
 
@@ -22,12 +23,12 @@ json = "{}"
 # create an instance of BackendWithAuthentication from a JSON string
 backend_with_authentication_instance = BackendWithAuthentication.from_json(json)
 # print the JSON string representation of the object
-print BackendWithAuthentication.to_json()
+print(BackendWithAuthentication.to_json())
 
 # convert the object into a dict
 backend_with_authentication_dict = backend_with_authentication_instance.to_dict()
 # create an instance of BackendWithAuthentication from a dict
-backend_with_authentication_form_dict = backend_with_authentication.from_dict(backend_with_authentication_dict)
+backend_with_authentication_from_dict = BackendWithAuthentication.from_dict(backend_with_authentication_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)
 

compute_api_client/docs/BatchJob.md

@@ -2,19 +2,20 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**created_on** | **datetime** |  | 
-**status** | [**BatchJobStatus**](BatchJobStatus.md) |  | 
-**user_id** | **int** |  | 
-**backend_type_id** | **int** |  | 
+**id** | **int** | ID of the batch job | 
+**created_on** | **datetime** | Time of batchjob creation | 
+**status** | [**BatchJobStatus**](BatchJobStatus.md) | Status of the batchjob | 
+**user_id** | **int** | ID of the user to whom this job belongs | 
+**backend_type_id** | **int** | ID of the backendtype | 
 **backend_id** | **int** |  | 
 **queued_at** | **datetime** |  | 
 **reserved_at** | **datetime** |  | 
 **finished_at** | **datetime** |  | 
-**job_ids** | **List[int]** |  | 
-**aggregated_algorithm_type** | [**AlgorithmType**](AlgorithmType.md) |  | 
+**job_ids** | **List[int]** | Job ids in the batch job | 
+**aggregated_algorithm_type** | [**AlgorithmType**](AlgorithmType.md) | Algorithm type submitted | 
 
 ## Example
 
@@ -26,12 +27,12 @@ json = "{}"
 # create an instance of BatchJob from a JSON string
 batch_job_instance = BatchJob.from_json(json)
 # print the JSON string representation of the object
-print BatchJob.to_json()
+print(BatchJob.to_json())
 
 # convert the object into a dict
 batch_job_dict = batch_job_instance.to_dict()
 # create an instance of BatchJob from a dict
-batch_job_form_dict = batch_job.from_dict(batch_job_dict)
+batch_job_from_dict = BatchJob.from_dict(batch_job_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)
 

compute_api_client/docs/BatchJobIn.md

@@ -2,9 +2,10 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backend_type_id** | **int** |  | 
+**backend_type_id** | **int** | ID of the batch job | 
 
 ## Example
 
@@ -16,12 +17,12 @@ json = "{}"
 # create an instance of BatchJobIn from a JSON string
 batch_job_in_instance = BatchJobIn.from_json(json)
 # print the JSON string representation of the object
-print BatchJobIn.to_json()
+print(BatchJobIn.to_json())
 
 # convert the object into a dict
 batch_job_in_dict = batch_job_in_instance.to_dict()
 # create an instance of BatchJobIn from a dict
-batch_job_in_form_dict = batch_job_in.from_dict(batch_job_in_dict)
+batch_job_in_from_dict = BatchJobIn.from_dict(batch_job_in_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)
 

compute_api_client/docs/BatchJobStatus.md

@@ -1,9 +1,17 @@
 # BatchJobStatus
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `PLANNED` (value: `'planned'`)
+
+* `QUEUED` (value: `'queued'`)
+
+* `RESERVED` (value: `'reserved'`)
+
+* `RUNNING` (value: `'running'`)
+
+* `FINISHED` (value: `'finished'`)
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)