qi-compute-api-client 0.56.0__py3-none-any.whl

compute_api_client/docs/ReservationsApi.md

@@ -0,0 +1,341 @@
+# compute_api_client.ReservationsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_reservation_reservations_post**](ReservationsApi.md#create_reservation_reservations_post) | **POST** /reservations | Create reservation
+[**read_reservation_reservations_id_get**](ReservationsApi.md#read_reservation_reservations_id_get) | **GET** /reservations/{id} | Retrieve reservation
+[**read_reservations_reservations_get**](ReservationsApi.md#read_reservations_reservations_get) | **GET** /reservations | List reservations
+[**terminate_reservation_reservations_id_terminate_patch**](ReservationsApi.md#terminate_reservation_reservations_id_terminate_patch) | **PATCH** /reservations/{id}/terminate | Terminate reservation
+
+
+# **create_reservation_reservations_post**
+> Reservation create_reservation_reservations_post(reservation_in)
+
+Create reservation
+
+Create new reservation.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# 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.ReservationsApi(api_client)
+    reservation_in = compute_api_client.ReservationIn() # ReservationIn | 
+
+    try:
+        # Create reservation
+        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 Exception as e:
+        print("Exception when calling ReservationsApi->create_reservation_reservations_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **reservation_in** | [**ReservationIn**](ReservationIn.md)|  | 
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | 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)
+
+# **read_reservation_reservations_id_get**
+> Reservation read_reservation_reservations_id_get(id)
+
+Retrieve reservation
+
+Get reservation by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# 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.ReservationsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve reservation
+        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 Exception as e:
+        print("Exception when calling ReservationsApi->read_reservation_reservations_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **read_reservations_reservations_get**
+> PageReservation read_reservations_reservations_get(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, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List reservations
+
+Read reservations.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.page_reservation import PageReservation
+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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# 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.ReservationsApi(api_client)
+    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)
+    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)
+    size = 50 # int | Page size (optional) (default to 50)
+
+    try:
+        # List reservations
+        api_response = await api_instance.read_reservations_reservations_get(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, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of ReservationsApi->read_reservations_reservations_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ReservationsApi->read_reservations_reservations_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **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]
+ **size** | **int**| Page size | [optional] [default to 50]
+
+### Return type
+
+[**PageReservation**](PageReservation.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| 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)
+
+# **terminate_reservation_reservations_id_terminate_patch**
+> Reservation terminate_reservation_reservations_id_terminate_patch(id)
+
+Terminate reservation
+
+Terminate reservation by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# 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.ReservationsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Terminate reservation
+        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 Exception as e:
+        print("Exception when calling ReservationsApi->terminate_reservation_reservations_id_terminate_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Reservation**](Reservation.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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/Result.md

@@ -0,0 +1,36 @@
+# Result
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The ID of the result | 
+**created_on** | **datetime** | Time of creation of the result | 
+**job_id** | **int** | The ID of the job | 
+**execution_time_in_seconds** | **float** | Time it took to compute the result | 
+**shots_requested** | **int** |  | 
+**shots_done** | **int** |  | 
+**results** | **Dict[str, object]** |  | 
+**raw_data** | **List[str]** |  | 
+
+## 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_from_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

@@ -0,0 +1,34 @@
+# ResultIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_id** | **int** | The ID of the result | 
+**execution_time_in_seconds** | **float** | Time it took to compute the result | 
+**shots_requested** | **int** |  | [optional] 
+**shots_done** | **int** |  | [optional] 
+**results** | **Dict[str, object]** |  | [optional] 
+**raw_data** | **List[str]** |  | [optional] 
+
+## 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_from_dict = ResultIn.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)
+
+