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

compute_api_client/docs/FinalResult.md

@@ -4,11 +4,28 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created_on** | **datetime** |  | [readonly] 
 **id** | **int** |  | 
-**final_result** | **object** |  | [optional] 
-**run_id** | **int** |  | 
+**created_on** | **datetime** |  | 
+**job_id** | **int** |  | 
+**final_result** | **object** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.final_result import FinalResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FinalResult from a JSON string
+final_result_instance = FinalResult.from_json(json)
+# print the JSON string representation of the object
+print FinalResult.to_json()
+
+# convert the object into a dict
+final_result_dict = final_result_instance.to_dict()
+# create an instance of FinalResult from a dict
+final_result_form_dict = final_result.from_dict(final_result_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/FinalResultIn.md

@@ -4,9 +4,26 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**final_result** | **object** |  | [optional] 
-**run_id** | **int** |  | 
+**job_id** | **int** |  | 
+**final_result** | **object** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.final_result_in import FinalResultIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FinalResultIn from a JSON string
+final_result_in_instance = FinalResultIn.from_json(json)
+# print the JSON string representation of the object
+print FinalResultIn.to_json()
+
+# convert the object into a dict
+final_result_in_dict = final_result_in_instance.to_dict()
+# create an instance of FinalResultIn from a dict
+final_result_in_form_dict = final_result_in.from_dict(final_result_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/FinalResultsApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *http://localhost*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_final_result_final_results_post**](FinalResultsApi.md#create_final_result_final_results_post) | **POST** /final_results | Create final result
-[**read_final_result_by_run_id_final_results_run_run_id_get**](FinalResultsApi.md#read_final_result_by_run_id_final_results_run_run_id_get) | **GET** /final_results/run/{run_id} | Retrieve final result by run ID
+[**read_final_result_by_job_id_final_results_job_job_id_get**](FinalResultsApi.md#read_final_result_by_job_id_final_results_job_job_id_get) | **GET** /final_results/job/{job_id} | Retrieve final result by job ID
 [**read_final_result_final_results_id_get**](FinalResultsApi.md#read_final_result_final_results_id_get) | **GET** /final_results/{id} | Retrieve final result
 
 
@@ -18,13 +18,17 @@ Create new final result.
 
 ### Example
 
-* Api Key Authentication (runtime):
+* Api Key Authentication (backend):
+* Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.final_result import FinalResult
+from compute_api_client.models.final_result_in import FinalResultIn
 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(
@@ -36,75 +40,34 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: runtime
-configuration.api_key['runtime'] = 'YOUR_API_KEY'
+# 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['runtime'] = 'Bearer'
+# configuration.api_key_prefix['backend'] = 'Bearer'
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FinalResultsApi(api_client)
     final_result_in = compute_api_client.FinalResultIn() # FinalResultIn | 
 
     try:
         # Create final result
-        api_response = api_instance.create_final_result_final_results_post(final_result_in)
+        api_response = await api_instance.create_final_result_final_results_post(final_result_in)
+        print("The response of FinalResultsApi->create_final_result_final_results_post:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling FinalResultsApi->create_final_result_final_results_post: %s\n" % e)
 ```
 
-* Api Key Authentication (user):
-```python
-from __future__ import print_function
-import time
-import compute_api_client
-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: runtime
-configuration.api_key['runtime'] = 'YOUR_API_KEY'
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['runtime'] = 'Bearer'
-
-# Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
 
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = compute_api_client.FinalResultsApi(api_client)
-    final_result_in = compute_api_client.FinalResultIn() # FinalResultIn | 
-
-    try:
-        # Create final result
-        api_response = api_instance.create_final_result_final_results_post(final_result_in)
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling FinalResultsApi->create_final_result_final_results_post: %s\n" % e)
-```
 
 ### Parameters
 
@@ -118,7 +81,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[runtime](../README.md#runtime), [user](../README.md#user)
+[backend](../README.md#backend), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -133,22 +96,24 @@ 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_final_result_by_run_id_final_results_run_run_id_get**
-> FinalResult read_final_result_by_run_id_final_results_run_run_id_get(run_id)
+# **read_final_result_by_job_id_final_results_job_job_id_get**
+> FinalResult read_final_result_by_job_id_final_results_job_job_id_get(job_id)
 
-Retrieve final result by run ID
+Retrieve final result by job ID
 
-Get final result by run ID.
+Get final result by job ID.
 
 ### Example
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.final_result import FinalResult
 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(
@@ -161,30 +126,33 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FinalResultsApi(api_client)
-    run_id = 56 # int | 
+    job_id = 56 # int | 
 
     try:
-        # Retrieve final result by run ID
-        api_response = api_instance.read_final_result_by_run_id_final_results_run_run_id_get(run_id)
+        # Retrieve final result by job ID
+        api_response = await api_instance.read_final_result_by_job_id_final_results_job_job_id_get(job_id)
+        print("The response of FinalResultsApi->read_final_result_by_job_id_final_results_job_job_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling FinalResultsApi->read_final_result_by_run_id_final_results_run_run_id_get: %s\n" % e)
+    except Exception as e:
+        print("Exception when calling FinalResultsApi->read_final_result_by_job_id_final_results_job_job_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **run_id** | **int**|  | 
+ **job_id** | **int**|  | 
 
 ### Return type
 
@@ -218,11 +186,13 @@ Get final result by ID.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.final_result import FinalResult
 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(
@@ -235,25 +205,28 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FinalResultsApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve final result
-        api_response = api_instance.read_final_result_final_results_id_get(id)
+        api_response = await api_instance.read_final_result_final_results_id_get(id)
+        print("The response of FinalResultsApi->read_final_result_final_results_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling FinalResultsApi->read_final_result_final_results_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes

compute_api_client/docs/HTTPNotFoundError.md

@@ -6,6 +6,23 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | **str** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.http_not_found_error import HTTPNotFoundError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of HTTPNotFoundError from a JSON string
+http_not_found_error_instance = HTTPNotFoundError.from_json(json)
+# print the JSON string representation of the object
+print HTTPNotFoundError.to_json()
+
+# convert the object into a dict
+http_not_found_error_dict = http_not_found_error_instance.to_dict()
+# create an instance of HTTPNotFoundError from a dict
+http_not_found_error_form_dict = http_not_found_error.from_dict(http_not_found_error_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/HTTPValidationError.md

@@ -4,8 +4,25 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**detail** | [**list[ValidationError]**](ValidationError.md) |  | [optional] 
+**detail** | [**List[ValidationError]**](ValidationError.md) |  | [optional] 
 
+## Example
+
+```python
+from compute_api_client.models.http_validation_error import HTTPValidationError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of HTTPValidationError from a JSON string
+http_validation_error_instance = HTTPValidationError.from_json(json)
+# print the JSON string representation of the object
+print HTTPValidationError.to_json()
+
+# convert the object into a dict
+http_validation_error_dict = http_validation_error_instance.to_dict()
+# create an instance of HTTPValidationError from a dict
+http_validation_error_form_dict = http_validation_error.from_dict(http_validation_error_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/Job.md

@@ -0,0 +1,36 @@
+# Job
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**created_on** | **datetime** |  | 
+**file_id** | **int** |  | 
+**algorithm_type** | [**AlgorithmType**](AlgorithmType.md) |  | 
+**status** | [**JobStatus**](JobStatus.md) |  | 
+**batch_job_id** | **int** |  | 
+**queued_at** | **datetime** |  | 
+**finished_at** | **datetime** |  | 
+**number_of_shots** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.job import Job
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Job from a JSON string
+job_instance = Job.from_json(json)
+# print the JSON string representation of the object
+print Job.to_json()
+
+# convert the object into a dict
+job_dict = job_instance.to_dict()
+# create an instance of Job from a dict
+job_form_dict = job.from_dict(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/JobIn.md

@@ -0,0 +1,31 @@
+# JobIn
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_id** | **int** |  | 
+**status** | [**JobStatus**](JobStatus.md) |  | [optional] 
+**batch_job_id** | **int** |  | 
+**number_of_shots** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.job_in import JobIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of JobIn from a JSON string
+job_in_instance = JobIn.from_json(json)
+# print the JSON string representation of the object
+print JobIn.to_json()
+
+# convert the object into a dict
+job_in_dict = job_in_instance.to_dict()
+# create an instance of JobIn from a dict
+job_in_form_dict = job_in.from_dict(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/JobPatch.md

@@ -0,0 +1,28 @@
+# JobPatch
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**JobStatus**](JobStatus.md) |  | 
+
+## Example
+
+```python
+from compute_api_client.models.job_patch import JobPatch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of JobPatch from a JSON string
+job_patch_instance = JobPatch.from_json(json)
+# print the JSON string representation of the object
+print JobPatch.to_json()
+
+# convert the object into a dict
+job_patch_dict = job_patch_instance.to_dict()
+# create an instance of JobPatch from a dict
+job_patch_form_dict = job_patch.from_dict(job_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/{BatchRunStatus.md → JobStatus.md}

@@ -1,6 +1,5 @@
-# BatchRunStatus
+# JobStatus
 
-An enumeration.
 
 ## Properties
 Name | Type | Description | Notes