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

compute_api_client/docs/Reservation.md

@@ -5,13 +5,30 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | 
+**member_id** | **int** |  | 
 **start_time** | **datetime** |  | 
 **end_time** | **datetime** |  | 
-**is_terminated** | **bool** |  | [optional] [default to False]
-**member_id** | **int** |  | 
-**runtime_id** | **int** |  | [optional] 
-**runtime_type_id** | **int** |  | 
+**backend_type_id** | **int** |  | 
+**backend_id** | **int** |  | 
+**is_terminated** | **bool** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.reservation import Reservation
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Reservation from a JSON string
+reservation_instance = Reservation.from_json(json)
+# print the JSON string representation of the object
+print Reservation.to_json()
 
+# convert the object into a dict
+reservation_dict = reservation_instance.to_dict()
+# create an instance of Reservation from a dict
+reservation_form_dict = reservation.from_dict(reservation_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/ReservationIn.md

@@ -4,11 +4,28 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**member_id** | **int** |  | 
 **start_time** | **datetime** |  | 
 **end_time** | **datetime** |  | 
-**member_id** | **int** |  | 
-**runtime_type_id** | **int** |  | 
+**backend_type_id** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.reservation_in import ReservationIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ReservationIn from a JSON string
+reservation_in_instance = ReservationIn.from_json(json)
+# print the JSON string representation of the object
+print ReservationIn.to_json()
 
+# convert the object into a dict
+reservation_in_dict = reservation_in_instance.to_dict()
+# create an instance of ReservationIn from a dict
+reservation_in_form_dict = reservation_in.from_dict(reservation_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/ReservationsApi.md

@@ -21,11 +21,14 @@ Create new reservation.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.reservation import Reservation
+from compute_api_client.models.reservation_in import ReservationIn
 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(
@@ -38,25 +41,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.ReservationsApi(api_client)
     reservation_in = compute_api_client.ReservationIn() # ReservationIn | 
 
     try:
         # Create reservation
-        api_response = api_instance.create_reservation_reservations_post(reservation_in)
+        api_response = await api_instance.create_reservation_reservations_post(reservation_in)
+        print("The response of ReservationsApi->create_reservation_reservations_post:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling ReservationsApi->create_reservation_reservations_post: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -95,11 +101,13 @@ Get reservation 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.reservation import Reservation
 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(
@@ -112,25 +120,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.ReservationsApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve reservation
-        api_response = api_instance.read_reservation_reservations_id_get(id)
+        api_response = await api_instance.read_reservation_reservations_id_get(id)
+        print("The response of ReservationsApi->read_reservation_reservations_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling ReservationsApi->read_reservation_reservations_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -160,7 +171,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_reservations_reservations_get**
-> list[Reservation] read_reservations_reservations_get()
+> List[Reservation] read_reservations_reservations_get(latest=latest, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated)
 
 List reservations
 
@@ -170,11 +181,13 @@ Read reservations.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.reservation import Reservation
 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(
@@ -187,30 +200,53 @@ 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.ReservationsApi(api_client)
-    
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    member_id = 56 # int |  (optional)
+    start_time = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
+    end_time = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
+    backend_type_id = 56 # int |  (optional)
+    backend_id__isnull = True # bool |  (optional)
+    backend_id = 56 # int |  (optional)
+    is_terminated = True # bool |  (optional)
+
     try:
         # List reservations
-        api_response = api_instance.read_reservations_reservations_get()
+        api_response = await api_instance.read_reservations_reservations_get(latest=latest, id=id, member_id=member_id, start_time=start_time, end_time=end_time, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, is_terminated=is_terminated)
+        print("The response of ReservationsApi->read_reservations_reservations_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling ReservationsApi->read_reservations_reservations_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **member_id** | **int**|  | [optional] 
+ **start_time** | **datetime**|  | [optional] 
+ **end_time** | **datetime**|  | [optional] 
+ **backend_type_id** | **int**|  | [optional] 
+ **backend_id__isnull** | **bool**|  | [optional] 
+ **backend_id** | **int**|  | [optional] 
+ **is_terminated** | **bool**|  | [optional] 
 
 ### Return type
 
-[**list[Reservation]**](Reservation.md)
+[**List[Reservation]**](Reservation.md)
 
 ### Authorization
 
@@ -225,6 +261,7 @@ This endpoint does not need any parameter.
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
+**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)
 
@@ -239,11 +276,13 @@ Terminate reservation 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.reservation import Reservation
 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(
@@ -256,25 +295,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.ReservationsApi(api_client)
     id = 56 # int | 
 
     try:
         # Terminate reservation
-        api_response = api_instance.terminate_reservation_reservations_id_terminate_patch(id)
+        api_response = await api_instance.terminate_reservation_reservations_id_terminate_patch(id)
+        print("The response of ReservationsApi->terminate_reservation_reservations_id_terminate_patch:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling ReservationsApi->terminate_reservation_reservations_id_terminate_patch: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes

compute_api_client/docs/Result.md

@@ -4,16 +4,33 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created_on** | **datetime** |  | [readonly] 
 **id** | **int** |  | 
+**created_on** | **datetime** |  | 
+**job_id** | **int** |  | 
+**metadata_id** | **int** |  | 
 **number_of_qubits** | **int** |  | 
 **execution_time_in_seconds** | **float** |  | 
-**shots_requested** | **int** |  | [optional] 
-**shots_done** | **int** |  | [optional] 
-**results** | **object** |  | [optional] 
-**metadata_id** | **int** |  | 
-**run_id** | **int** |  | 
+**shots_requested** | **int** |  | 
+**shots_done** | **int** |  | 
+**results** | **object** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.result import Result
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Result from a JSON string
+result_instance = Result.from_json(json)
+# print the JSON string representation of the object
+print Result.to_json()
 
+# convert the object into a dict
+result_dict = result_instance.to_dict()
+# create an instance of Result from a dict
+result_form_dict = result.from_dict(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/ResultIn.md

@@ -4,14 +4,31 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**job_id** | **int** |  | 
+**metadata_id** | **int** |  | [optional] 
 **number_of_qubits** | **int** |  | 
 **execution_time_in_seconds** | **float** |  | 
 **shots_requested** | **int** |  | [optional] 
 **shots_done** | **int** |  | [optional] 
 **results** | **object** |  | [optional] 
-**metadata_id** | **int** |  | 
-**run_id** | **int** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.result_in import ResultIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ResultIn from a JSON string
+result_in_instance = ResultIn.from_json(json)
+# print the JSON string representation of the object
+print ResultIn.to_json()
+
+# convert the object into a dict
+result_in_dict = result_in_instance.to_dict()
+# create an instance of ResultIn from a dict
+result_in_form_dict = result_in.from_dict(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/ResultsApi.md

@@ -6,7 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_result_results_post**](ResultsApi.md#create_result_results_post) | **POST** /results | Create result
 [**read_result_results_id_get**](ResultsApi.md#read_result_results_id_get) | **GET** /results/{id} | Retrieve result
-[**read_results_by_run_id_results_run_run_id_get**](ResultsApi.md#read_results_by_run_id_results_run_run_id_get) | **GET** /results/run/{run_id} | Retrieve result
+[**read_results_by_job_id_results_job_job_id_get**](ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve result
 
 
 # **create_result_results_post**
@@ -18,13 +18,16 @@ Create new result.
 
 ### Example
 
-* Api Key Authentication (runtime):
+* Api Key Authentication (backend):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.result import Result
+from compute_api_client.models.result_in import ResultIn
 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 +39,28 @@ 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'
-
-# 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'
+# 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['user'] = 'Bearer'
+# configuration.api_key_prefix['backend'] = '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.ResultsApi(api_client)
     result_in = compute_api_client.ResultIn() # ResultIn | 
 
     try:
         # Create result
-        api_response = api_instance.create_result_results_post(result_in)
+        api_response = await api_instance.create_result_results_post(result_in)
+        print("The response of ResultsApi->create_result_results_post:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling ResultsApi->create_result_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.ResultsApi(api_client)
-    result_in = compute_api_client.ResultIn() # ResultIn | 
-
-    try:
-        # Create result
-        api_response = api_instance.create_result_results_post(result_in)
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling ResultsApi->create_result_results_post: %s\n" % e)
-```
 
 ### Parameters
 
@@ -118,7 +74,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[runtime](../README.md#runtime), [user](../README.md#user)
+[backend](../README.md#backend)
 
 ### HTTP request headers
 
@@ -144,11 +100,13 @@ Get 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.result import Result
 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,25 +119,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.ResultsApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve result
-        api_response = api_instance.read_result_results_id_get(id)
+        api_response = await api_instance.read_result_results_id_get(id)
+        print("The response of ResultsApi->read_result_results_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling ResultsApi->read_result_results_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -208,8 +169,8 @@ 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_run_id_results_run_run_id_get**
-> list[Result] read_results_by_run_id_results_run_run_id_get(run_id)
+# **read_results_by_job_id_results_job_job_id_get**
+> List[Result] read_results_by_job_id_results_job_job_id_get(job_id)
 
 Retrieve result
 
@@ -219,11 +180,13 @@ Get 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.result import Result
 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(
@@ -236,34 +199,37 @@ 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.ResultsApi(api_client)
-    run_id = 56 # int | 
+    job_id = 56 # int | 
 
     try:
         # Retrieve result
-        api_response = api_instance.read_results_by_run_id_results_run_run_id_get(run_id)
+        api_response = await api_instance.read_results_by_job_id_results_job_job_id_get(job_id)
+        print("The response of ResultsApi->read_results_by_job_id_results_job_job_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling ResultsApi->read_results_by_run_id_results_run_run_id_get: %s\n" % e)
+    except Exception as e:
+        print("Exception when calling ResultsApi->read_results_by_job_id_results_job_job_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **run_id** | **int**|  | 
+ **job_id** | **int**|  | 
 
 ### Return type
 
-[**list[Result]**](Result.md)
+[**List[Result]**](Result.md)
 
 ### Authorization
 

compute_api_client/docs/Role.md

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

compute_api_client/docs/ShareType.md

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

compute_api_client/docs/Team.md

@@ -7,8 +7,25 @@ Name | Type | Description | Notes
 **id** | **int** |  | 
 **name** | **str** |  | 
 **slug** | **str** |  | 
-**individual_user** | **bool** |  | [optional] [default to False]
+**individual_user** | **bool** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.team import Team
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Team from a JSON string
+team_instance = Team.from_json(json)
+# print the JSON string representation of the object
+print Team.to_json()
+
+# convert the object into a dict
+team_dict = team_instance.to_dict()
+# create an instance of Team from a dict
+team_form_dict = team.from_dict(team_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)