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

compute_api_client/docs/FinalResultIn.md

@@ -2,10 +2,11 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**job_id** | **int** |  | 
-**final_result** | **Dict[str, object]** |  | 
+**job_id** | **int** | ID of the job | 
+**final_result** | **Dict[str, object]** | The final results of the job | 
 
 ## Example
 
@@ -17,12 +18,12 @@ 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()
+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)
+final_result_in_from_dict = FinalResultIn.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

@@ -20,9 +20,8 @@ Create new final result.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-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
@@ -67,6 +66,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **final_result_in** | [**FinalResultIn**](FinalResultIn.md)|  | 
@@ -85,6 +85,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -102,9 +103,8 @@ Get final result by job ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.final_result import FinalResult
 from compute_api_client.rest import ApiException
@@ -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 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -177,9 +179,8 @@ Get final result by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.final_result import FinalResult
 from compute_api_client.rest import ApiException
@@ -217,6 +218,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -235,6 +237,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/HTTPBadRequestError.md

@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | **str** |  | 
@@ -16,12 +17,12 @@ json = "{}"
 # create an instance of HTTPBadRequestError from a JSON string
 http_bad_request_error_instance = HTTPBadRequestError.from_json(json)
 # print the JSON string representation of the object
-print HTTPBadRequestError.to_json()
+print(HTTPBadRequestError.to_json())
 
 # convert the object into a dict
 http_bad_request_error_dict = http_bad_request_error_instance.to_dict()
 # create an instance of HTTPBadRequestError from a dict
-http_bad_request_error_form_dict = http_bad_request_error.from_dict(http_bad_request_error_dict)
+http_bad_request_error_from_dict = HTTPBadRequestError.from_dict(http_bad_request_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/HTTPNotFoundError.md

@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | **str** |  | 
@@ -16,12 +17,12 @@ 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()
+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)
+http_not_found_error_from_dict = HTTPNotFoundError.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

@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | [**List[ValidationError]**](ValidationError.md) |  | [optional] 
@@ -16,12 +17,12 @@ 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()
+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)
+http_validation_error_from_dict = HTTPValidationError.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/HealthApi.md

@@ -16,9 +16,8 @@ Health endpoint.
 
 ### Example
 
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -47,6 +46,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -63,6 +63,7 @@ No authorization required
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Job.md

@@ -2,21 +2,22 @@
 
 
 ## 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** |  | 
+**id** | **int** | The ID of the job | 
+**created_on** | **datetime** | Time of creation of the Job | 
+**file_id** | **int** | The ID of the file | 
+**algorithm_type** | [**AlgorithmType**](AlgorithmType.md) | The type of the algorithm | 
+**status** | [**JobStatus**](JobStatus.md) | The status of the Job | 
+**batch_job_id** | **int** | The ID of the batch job | 
 **queued_at** | **datetime** |  | 
 **finished_at** | **datetime** |  | 
 **number_of_shots** | **int** |  | 
-**raw_data_enabled** | **bool** |  | 
-**session_id** | **str** |  | 
-**trace_id** | **str** |  | 
-**message** | **str** |  | 
+**raw_data_enabled** | **bool** | If raw data is to be attached to results | 
+**session_id** | **str** | The uuid assigned to the job | 
+**trace_id** | **str** | The uuid of the trace in case of job failure | 
+**message** | **str** | The message associated with the executed job if it failed | 
 **source** | **str** | The source application of an exception that caused a job to fail (if applicable). | [optional] [default to '']
 
 ## Example
@@ -29,12 +30,12 @@ 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()
+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)
+job_from_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

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file_id** | **int** |  | 
-**batch_job_id** | **int** |  | 
+**file_id** | **int** | The ID of the file | 
+**batch_job_id** | **int** | The ID of the batch job | 
 **number_of_shots** | **int** |  | [optional] 
-**raw_data_enabled** | **bool** |  | [optional] [default to False]
+**raw_data_enabled** | **bool** | If raw data is to be attached to results | [optional] [default to False]
 
 ## Example
 
@@ -19,12 +20,12 @@ 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()
+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)
+job_in_from_dict = JobIn.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

@@ -2,14 +2,15 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | [**JobStatus**](JobStatus.md) |  | 
-**session_id** | **str** |  | [optional] [default to '']
-**trace_id** | **str** |  | [optional] [default to '']
-**message** | **str** |  | [optional] [default to '']
+**status** | [**JobStatus**](JobStatus.md) | The status of the Job | 
+**session_id** | **str** | The uuid assigned to the job | [optional] [default to '']
+**trace_id** | **str** | The uuid of the trace in case of job failure | [optional] [default to '']
+**message** | **str** | The message associated with the executed job if it failed | [optional] [default to '']
 **source** | **str** | The source application of an exception that caused a job to fail (if applicable). | [optional] [default to '']
-**traceback** | **str** |  | [optional] [default to '']
+**traceback** | **str** | The traceback of the exception | [optional] [default to '']
 
 ## Example
 
@@ -21,12 +22,12 @@ 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()
+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)
+job_patch_from_dict = JobPatch.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/JobStatus.md

@@ -1,9 +1,17 @@
 # JobStatus
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `PLANNED` (value: `'planned'`)
+
+* `RUNNING` (value: `'running'`)
+
+* `COMPLETED` (value: `'completed'`)
+
+* `CANCELLED` (value: `'cancelled'`)
+
+* `FAILED` (value: `'failed'`)
 
 [[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/JobsApi.md

@@ -21,9 +21,8 @@ Create new job.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.job import Job
 from compute_api_client.models.job_in import JobIn
@@ -62,6 +61,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_in** | [**JobIn**](JobIn.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 @@ Delete a job.
 ### 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
@@ -134,6 +134,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -152,6 +153,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -171,9 +173,8 @@ Get job by ID.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.job import Job
 from compute_api_client.rest import ApiException
@@ -217,6 +218,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -235,6 +237,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -254,9 +257,8 @@ List jobs.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.algorithm_type import AlgorithmType
 from compute_api_client.models.job_status import JobStatus
@@ -322,6 +324,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -360,6 +363,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -378,9 +382,8 @@ Update status of a job.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.job import Job
 from compute_api_client.models.job_patch import JobPatch
@@ -426,6 +429,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -445,6 +449,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Language.md

@@ -2,11 +2,12 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**version** | **str** |  | 
+**id** | **int** | The ID of the language | 
+**name** | **str** | Name of the language | 
+**version** | **str** | Version of the language | 
 
 ## Example
 
@@ -18,12 +19,12 @@ json = "{}"
 # create an instance of Language from a JSON string
 language_instance = Language.from_json(json)
 # print the JSON string representation of the object
-print Language.to_json()
+print(Language.to_json())
 
 # convert the object into a dict
 language_dict = language_instance.to_dict()
 # create an instance of Language from a dict
-language_form_dict = language.from_dict(language_dict)
+language_from_dict = Language.from_dict(language_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/LanguagesApi.md

@@ -18,9 +18,8 @@ Get language by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.language import Language
 from compute_api_client.rest import ApiException
@@ -58,6 +57,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -76,6 +76,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -94,9 +95,8 @@ List languages.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_language import PageLanguage
 from compute_api_client.rest import ApiException
@@ -141,6 +141,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **q** | **str**|  | [optional] 
@@ -166,6 +167,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Member.md

@@ -2,13 +2,14 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**team_id** | **int** |  | 
-**user_id** | **int** |  | 
-**role** | [**Role**](Role.md) |  | 
-**is_active** | **bool** |  | 
+**id** | **int** | The id of the member | 
+**team_id** | **int** | The id of the team | 
+**user_id** | **int** | The id of the user | 
+**role** | [**Role**](Role.md) | The role of the member | 
+**is_active** | **bool** | If the member is active | 
 
 ## Example
 
@@ -20,12 +21,12 @@ json = "{}"
 # create an instance of Member from a JSON string
 member_instance = Member.from_json(json)
 # print the JSON string representation of the object
-print Member.to_json()
+print(Member.to_json())
 
 # convert the object into a dict
 member_dict = member_instance.to_dict()
 # create an instance of Member from a dict
-member_form_dict = member.from_dict(member_dict)
+member_from_dict = Member.from_dict(member_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/MemberId.md

@@ -0,0 +1,28 @@
+# MemberId
+
+The id of the member who initiated the transaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from compute_api_client.models.member_id import MemberId
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MemberId from a JSON string
+member_id_instance = MemberId.from_json(json)
+# print the JSON string representation of the object
+print MemberId.to_json()
+
+# convert the object into a dict
+member_id_dict = member_id_instance.to_dict()
+# create an instance of MemberId from a dict
+member_id_form_dict = member_id.from_dict(member_id_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/MemberIn.md

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**team_id** | **int** |  | 
-**user_id** | **int** |  | 
-**role** | [**Role**](Role.md) |  | 
-**is_active** | **bool** |  | [optional] [default to False]
+**team_id** | **int** | The id of the team | 
+**user_id** | **int** | The id of the user | 
+**role** | [**Role**](Role.md) | The role of the member | 
+**is_active** | **bool** | If the member is active | [optional] [default to False]
 
 ## Example
 
@@ -19,12 +20,12 @@ json = "{}"
 # create an instance of MemberIn from a JSON string
 member_in_instance = MemberIn.from_json(json)
 # print the JSON string representation of the object
-print MemberIn.to_json()
+print(MemberIn.to_json())
 
 # convert the object into a dict
 member_in_dict = member_in_instance.to_dict()
 # create an instance of MemberIn from a dict
-member_in_form_dict = member_in.from_dict(member_in_dict)
+member_in_from_dict = MemberIn.from_dict(member_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)