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

compute_api_client/docs/BatchJobsApi.md

@@ -23,9 +23,8 @@ Create new batch job.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.models.batch_job_in import BatchJobIn
@@ -64,6 +63,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **batch_job_in** | [**BatchJobIn**](BatchJobIn.md)|  | 
@@ -82,6 +82,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -99,9 +100,8 @@ Enqueue batch job for execution.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.rest import ApiException
@@ -139,6 +139,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -157,6 +158,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -176,9 +178,8 @@ Finish batch job.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.rest import ApiException
@@ -222,6 +223,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -240,6 +242,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -258,9 +261,8 @@ Get batch job that can be taken up, excluding list of IDs.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.rest import ApiException
@@ -287,7 +289,7 @@ configuration.api_key['backend'] = os.environ["API_KEY"]
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.BatchJobsApi(api_client)
-    request_body = [56] # List[int] | 
+    request_body = [56] # List[Optional[int]] | 
 
     try:
         # Peek batch job
@@ -302,9 +304,10 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **request_body** | [**List[int]**](int.md)|  | 
+ **request_body** | [**List[Optional[int]]**](int.md)|  | 
 
 ### Return type
 
@@ -320,6 +323,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -337,9 +341,8 @@ Claim batch job.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.rest import ApiException
@@ -379,6 +382,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -395,6 +399,7 @@ This endpoint does not need any parameter.
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -412,9 +417,8 @@ List batch jobs.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.algorithm_type import AlgorithmType
 from compute_api_client.models.batch_job_status import BatchJobStatus
@@ -470,6 +474,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -504,6 +509,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -521,9 +527,8 @@ Unclaim batch job.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.rest import ApiException
@@ -565,6 +570,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -583,6 +589,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Commit.md

@@ -2,13 +2,14 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**created_on** | **datetime** |  | 
-**hash** | **str** |  | 
-**description** | **str** |  | 
-**algorithm_id** | **int** |  | 
+**id** | **int** | ID of the commit | 
+**created_on** | **datetime** | Time of creation of the commit | 
+**hash** | **str** | Unique hash assigned to the commit | 
+**description** | **str** | Desriptive message of the commit | 
+**algorithm_id** | **int** | ID of the algorithm | 
 
 ## Example
 
@@ -20,12 +21,12 @@ json = "{}"
 # create an instance of Commit from a JSON string
 commit_instance = Commit.from_json(json)
 # print the JSON string representation of the object
-print Commit.to_json()
+print(Commit.to_json())
 
 # convert the object into a dict
 commit_dict = commit_instance.to_dict()
 # create an instance of Commit from a dict
-commit_form_dict = commit.from_dict(commit_dict)
+commit_from_dict = Commit.from_dict(commit_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/CommitIn.md

@@ -2,10 +2,11 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | **str** |  | 
-**algorithm_id** | **int** |  | 
+**description** | **str** | Desriptive message of the commit | 
+**algorithm_id** | **int** | ID of the algorithm | 
 
 ## Example
 
@@ -17,12 +18,12 @@ json = "{}"
 # create an instance of CommitIn from a JSON string
 commit_in_instance = CommitIn.from_json(json)
 # print the JSON string representation of the object
-print CommitIn.to_json()
+print(CommitIn.to_json())
 
 # convert the object into a dict
 commit_in_dict = commit_in_instance.to_dict()
 # create an instance of CommitIn from a dict
-commit_in_form_dict = commit_in.from_dict(commit_in_dict)
+commit_in_from_dict = CommitIn.from_dict(commit_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/CommitsApi.md

@@ -22,9 +22,8 @@ Compile file in a commit.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.compile_payload import CompilePayload
 from compute_api_client.rest import ApiException
@@ -67,6 +66,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -86,6 +86,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Compiled |  -  |
@@ -105,9 +106,8 @@ Create new commit.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.commit import Commit
 from compute_api_client.models.commit_in import CommitIn
@@ -146,6 +146,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **commit_in** | [**CommitIn**](CommitIn.md)|  | 
@@ -164,6 +165,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -181,9 +183,8 @@ Delete a commit.
 ### 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
@@ -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 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -255,9 +258,8 @@ Get commit by ID.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.commit import Commit
 from compute_api_client.rest import ApiException
@@ -301,6 +303,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -319,6 +322,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -337,9 +341,8 @@ List commits.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_commit import PageCommit
 from compute_api_client.rest import ApiException
@@ -385,6 +388,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -411,6 +415,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/CompilePayload.md

@@ -2,10 +2,11 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | [optional] 
-**backend_type_id** | **int** |  | 
+**backend_type_id** | **int** | ID of the backendtype | 
 
 ## Example
 
@@ -17,12 +18,12 @@ json = "{}"
 # create an instance of CompilePayload from a JSON string
 compile_payload_instance = CompilePayload.from_json(json)
 # print the JSON string representation of the object
-print CompilePayload.to_json()
+print(CompilePayload.to_json())
 
 # convert the object into a dict
 compile_payload_dict = compile_payload_instance.to_dict()
 # create an instance of CompilePayload from a dict
-compile_payload_form_dict = compile_payload.from_dict(compile_payload_dict)
+compile_payload_from_dict = CompilePayload.from_dict(compile_payload_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/CompileStage.md

@@ -1,9 +1,17 @@
 # CompileStage
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `NONE` (value: `'none'`)
+
+* `DECOMPOSITION` (value: `'decomposition'`)
+
+* `MAPPING` (value: `'mapping'`)
+
+* `OPTIMIZATION` (value: `'optimization'`)
+
+* `ROUTING` (value: `'routing'`)
 
 [[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/Domain.md

@@ -1,9 +1,13 @@
 # Domain
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `COMPUTE` (value: `'compute'`)
+
+* `NETWORKING` (value: `'networking'`)
+
+* `SIMULATE` (value: `'simulate'`)
 
 [[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/File.md

@@ -2,15 +2,16 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**commit_id** | **int** |  | 
-**content** | **str** |  | 
-**language_id** | **int** |  | 
-**compile_stage** | [**CompileStage**](CompileStage.md) |  | 
-**compile_properties** | **Dict[str, object]** |  | 
-**generated** | **bool** |  | 
+**id** | **int** | ID of the file | 
+**commit_id** | **int** | ID of the commit | 
+**content** | **str** | The content of the file | 
+**language_id** | **int** | ID of the language | 
+**compile_stage** | [**CompileStage**](CompileStage.md) | The stage upto which the file has been compiled | 
+**compile_properties** | **Dict[str, object]** | The compile properties of the file | 
+**generated** | **bool** | If the file is a generated file | 
 **name** | **str** |  | [optional] 
 
 ## Example
@@ -23,12 +24,12 @@ json = "{}"
 # create an instance of File from a JSON string
 file_instance = File.from_json(json)
 # print the JSON string representation of the object
-print File.to_json()
+print(File.to_json())
 
 # convert the object into a dict
 file_dict = file_instance.to_dict()
 # create an instance of File from a dict
-file_form_dict = file.from_dict(file_dict)
+file_from_dict = File.from_dict(file_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/FileIn.md

@@ -2,14 +2,15 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**commit_id** | **int** |  | 
-**content** | **str** |  | 
-**language_id** | **int** |  | 
-**compile_stage** | [**CompileStage**](CompileStage.md) |  | 
-**compile_properties** | **Dict[str, object]** |  | 
-**generated** | **bool** |  | [optional] [default to False]
+**commit_id** | **int** | ID of the commit | 
+**content** | **str** | The content of the file | 
+**language_id** | **int** | ID of the language | 
+**compile_stage** | [**CompileStage**](CompileStage.md) | Stage upto which the file has been compiled | 
+**compile_properties** | **Dict[str, object]** | The compile properties of the file | 
+**generated** | **bool** | If the file is a generated file | [optional] [default to False]
 **name** | **str** |  | [optional] 
 
 ## Example
@@ -22,12 +23,12 @@ json = "{}"
 # create an instance of FileIn from a JSON string
 file_in_instance = FileIn.from_json(json)
 # print the JSON string representation of the object
-print FileIn.to_json()
+print(FileIn.to_json())
 
 # convert the object into a dict
 file_in_dict = file_in_instance.to_dict()
 # create an instance of FileIn from a dict
-file_in_form_dict = file_in.from_dict(file_in_dict)
+file_in_from_dict = FileIn.from_dict(file_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/FilesApi.md

@@ -20,9 +20,8 @@ Create new file.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.file import File
 from compute_api_client.models.file_in import FileIn
@@ -61,6 +60,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **file_in** | [**FileIn**](FileIn.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 @@ Delete a file.
 ### 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
@@ -133,6 +133,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -151,6 +152,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -170,9 +172,8 @@ Get file by ID.
 
 * OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.file import File
 from compute_api_client.rest import ApiException
@@ -216,6 +217,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -234,6 +236,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -252,9 +255,8 @@ List files.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.compile_stage import CompileStage
 from compute_api_client.models.page_file import PageFile
@@ -304,6 +306,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -333,6 +336,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/FinalResult.md

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**created_on** | **datetime** |  | 
-**job_id** | **int** |  | 
-**final_result** | **Dict[str, object]** |  | 
+**id** | **int** | ID of the final result | 
+**created_on** | **datetime** | Time of creation of the final result | 
+**job_id** | **int** | ID of the job | 
+**final_result** | **Dict[str, object]** | The final results of the job | 
 
 ## Example
 
@@ -19,12 +20,12 @@ 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()
+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)
+final_result_from_dict = FinalResult.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)