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

compute_api_client/docs/Project.md

@@ -2,14 +2,15 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**created_on** | **datetime** |  | 
-**owner_id** | **int** |  | 
-**name** | **str** |  | 
-**description** | **str** |  | 
-**starred** | **bool** |  | 
+**id** | **int** | The ID of the project | 
+**created_on** | **datetime** | Time of creation of the project | 
+**owner_id** | **int** | The ID of the project owner | 
+**name** | **str** | The name of the project | 
+**description** | **str** | The description of the project | 
+**starred** | **bool** | If the project is starred | 
 
 ## Example
 
@@ -21,12 +22,12 @@ json = "{}"
 # create an instance of Project from a JSON string
 project_instance = Project.from_json(json)
 # print the JSON string representation of the object
-print Project.to_json()
+print(Project.to_json())
 
 # convert the object into a dict
 project_dict = project_instance.to_dict()
 # create an instance of Project from a dict
-project_form_dict = project.from_dict(project_dict)
+project_from_dict = Project.from_dict(project_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/ProjectIn.md

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**owner_id** | **int** |  | 
-**name** | **str** |  | 
-**description** | **str** |  | 
-**starred** | **bool** |  | [optional] [default to False]
+**owner_id** | **int** | The ID of the project | 
+**name** | **str** | The name of the project | 
+**description** | **str** | The description of the project | 
+**starred** | **bool** | If the project is starred | [optional] [default to False]
 
 ## Example
 
@@ -19,12 +20,12 @@ json = "{}"
 # create an instance of ProjectIn from a JSON string
 project_in_instance = ProjectIn.from_json(json)
 # print the JSON string representation of the object
-print ProjectIn.to_json()
+print(ProjectIn.to_json())
 
 # convert the object into a dict
 project_in_dict = project_in_instance.to_dict()
 # create an instance of ProjectIn from a dict
-project_in_form_dict = project_in.from_dict(project_in_dict)
+project_in_from_dict = ProjectIn.from_dict(project_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/ProjectPatch.md

@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **owner_id** | **int** |  | [optional] 
@@ -19,12 +20,12 @@ json = "{}"
 # create an instance of ProjectPatch from a JSON string
 project_patch_instance = ProjectPatch.from_json(json)
 # print the JSON string representation of the object
-print ProjectPatch.to_json()
+print(ProjectPatch.to_json())
 
 # convert the object into a dict
 project_patch_dict = project_patch_instance.to_dict()
 # create an instance of ProjectPatch from a dict
-project_patch_form_dict = project_patch.from_dict(project_patch_dict)
+project_patch_from_dict = ProjectPatch.from_dict(project_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/ProjectsApi.md

@@ -22,9 +22,8 @@ Create new project.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.project import Project
 from compute_api_client.models.project_in import ProjectIn
@@ -63,6 +62,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_in** | [**ProjectIn**](ProjectIn.md)|  | 
@@ -81,6 +81,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -98,9 +99,8 @@ Delete a project.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -135,6 +135,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -153,6 +154,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -171,9 +173,8 @@ Partially update a project.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.project import Project
 from compute_api_client.models.project_patch import ProjectPatch
@@ -213,6 +214,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -232,6 +234,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -250,9 +253,8 @@ Get project by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.project import Project
 from compute_api_client.rest import ApiException
@@ -290,6 +292,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -308,6 +311,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -321,14 +325,17 @@ Name | Type | Description  | Notes
 
 List projects
 
-List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
+List projects.
+
+If the search parameter is provided, the list is filtered based on the condition that either the project name OR
+description contains the specified substring. The filter considers exact matches for other parameters provided. The
+final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_project import PageProject
 from compute_api_client.rest import ApiException
@@ -376,6 +383,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **search** | **str**| Substring search for project names or description | [optional] 
@@ -404,6 +412,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -421,9 +430,8 @@ Update a project.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.project import Project
 from compute_api_client.models.project_in import ProjectIn
@@ -463,6 +471,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -482,6 +491,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Reservation.md

@@ -2,15 +2,16 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**member_id** | **int** |  | 
-**start_time** | **datetime** |  | 
-**end_time** | **datetime** |  | 
-**backend_type_id** | **int** |  | 
+**id** | **int** | The id of the reservation | 
+**member_id** | **int** | The id of the member who made the reservation | 
+**start_time** | **datetime** | Starting time of lthe reservation | 
+**end_time** | **datetime** | End time of the reservation | 
+**backend_type_id** | **int** | The id of the backend_type | 
 **backend_id** | **int** |  | 
-**is_terminated** | **bool** |  | 
+**is_terminated** | **bool** | If the reservation has been terminated | 
 
 ## Example
 
@@ -22,12 +23,12 @@ 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()
+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)
+reservation_from_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

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**member_id** | **int** |  | 
-**start_time** | **datetime** |  | 
-**end_time** | **datetime** |  | 
-**backend_type_id** | **int** |  | 
+**member_id** | **int** | The id of the member who made the reservation | 
+**start_time** | **datetime** | Starting time of lthe reservation | 
+**end_time** | **datetime** | End time of the reservation | 
+**backend_type_id** | **int** | The id of the backend_type | 
 
 ## Example
 
@@ -19,12 +20,12 @@ 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()
+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)
+reservation_in_from_dict = ReservationIn.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

@@ -20,9 +20,8 @@ Create new reservation.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-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
@@ -61,6 +60,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **reservation_in** | [**ReservationIn**](ReservationIn.md)|  | 
@@ -79,6 +79,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -96,9 +97,8 @@ Get reservation by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.reservation import Reservation
 from compute_api_client.rest import ApiException
@@ -136,6 +136,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -154,6 +155,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -172,9 +174,8 @@ Read reservations.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_reservation import PageReservation
 from compute_api_client.rest import ApiException
@@ -223,6 +224,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -252,6 +254,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -269,9 +272,8 @@ Terminate reservation by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.reservation import Reservation
 from compute_api_client.rest import ApiException
@@ -309,6 +311,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -327,6 +330,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Result.md

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**created_on** | **datetime** |  | 
-**job_id** | **int** |  | 
-**execution_time_in_seconds** | **float** |  | 
+**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]** |  | 
@@ -23,12 +24,12 @@ 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()
+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)
+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

@@ -2,10 +2,11 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**job_id** | **int** |  | 
-**execution_time_in_seconds** | **float** |  | 
+**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] 
@@ -21,12 +22,12 @@ 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()
+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)
+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)
 

compute_api_client/docs/ResultsApi.md

@@ -21,9 +21,8 @@ Create new result.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-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
@@ -66,6 +65,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **result_in** | [**ResultIn**](ResultIn.md)|  | 
@@ -84,6 +84,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -101,9 +102,8 @@ Delete results by job ID.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -142,6 +142,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_id** | **int**|  | 
@@ -160,6 +161,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -178,9 +180,8 @@ Get result by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.result import Result
 from compute_api_client.rest import ApiException
@@ -218,6 +219,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -236,6 +238,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -254,9 +257,8 @@ Get results by algorithm ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_result import PageResult
 from compute_api_client.rest import ApiException
@@ -308,6 +310,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **algorithm_id** | **int**|  | 
@@ -340,6 +343,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -358,9 +362,8 @@ Get results by job ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_result import PageResult
 from compute_api_client.rest import ApiException
@@ -402,6 +405,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_id** | **int**|  | 
@@ -424,6 +428,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Role.md

@@ -1,9 +1,11 @@
 # Role
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `MEMBER` (value: `'member'`)
+
+* `ADMIN` (value: `'admin'`)
 
 [[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/ShareType.md

@@ -1,9 +1,13 @@
 # ShareType
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `PRIVATE` (value: `'private'`)
+
+* `LINK_ONLY` (value: `'link_only'`)
+
+* `TEAM` (value: `'team'`)
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)