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

compute_api_client/docs/CommitsApi.md

@@ -0,0 +1,425 @@
+# compute_api_client.CommitsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**compile_commit_commits_id_compile_post**](CommitsApi.md#compile_commit_commits_id_compile_post) | **POST** /commits/{id}/compile | Compile file in a commit
+[**create_commit_commits_post**](CommitsApi.md#create_commit_commits_post) | **POST** /commits | Create commit
+[**delete_commit_commits_id_delete**](CommitsApi.md#delete_commit_commits_id_delete) | **DELETE** /commits/{id} | Destroy commit
+[**read_commit_commits_id_get**](CommitsApi.md#read_commit_commits_id_get) | **GET** /commits/{id} | Get commit by ID
+[**read_commits_commits_get**](CommitsApi.md#read_commits_commits_get) | **GET** /commits | List commits
+
+
+# **compile_commit_commits_id_compile_post**
+> compile_commit_commits_id_compile_post(id, compile_payload)
+
+Compile file in a commit
+
+Compile file in a commit.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+* Api Key Authentication (backend):
+
+```python
+import compute_api_client
+from compute_api_client.models.compile_payload import CompilePayload
+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"]
+
+# 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['backend'] = 'Bearer'
+
+# 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.CommitsApi(api_client)
+    id = 56 # int | 
+    compile_payload = compute_api_client.CompilePayload() # CompilePayload | 
+
+    try:
+        # Compile file in a commit
+        await api_instance.compile_commit_commits_id_compile_post(id, compile_payload)
+    except Exception as e:
+        print("Exception when calling CommitsApi->compile_commit_commits_id_compile_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+ **compile_payload** | [**CompilePayload**](CompilePayload.md)|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer), [backend](../README.md#backend)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Compiled |  -  |
+**404** | Not Found |  -  |
+**400** | Bad Request |  -  |
+**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)
+
+# **create_commit_commits_post**
+> Commit create_commit_commits_post(commit_in)
+
+Create commit
+
+Create new commit.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.commit import Commit
+from compute_api_client.models.commit_in import CommitIn
+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.CommitsApi(api_client)
+    commit_in = compute_api_client.CommitIn() # CommitIn | 
+
+    try:
+        # Create commit
+        api_response = await api_instance.create_commit_commits_post(commit_in)
+        print("The response of CommitsApi->create_commit_commits_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CommitsApi->create_commit_commits_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **commit_in** | [**CommitIn**](CommitIn.md)|  | 
+
+### Return type
+
+[**Commit**](Commit.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)
+
+# **delete_commit_commits_id_delete**
+> delete_commit_commits_id_delete(id)
+
+Destroy commit
+
+Delete a commit.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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.
+
+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.CommitsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Destroy commit
+        await api_instance.delete_commit_commits_id_delete(id)
+    except Exception as e:
+        print("Exception when calling CommitsApi->delete_commit_commits_id_delete: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+void (empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+**204** | 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_commit_commits_id_get**
+> Commit read_commit_commits_id_get(id)
+
+Get commit by ID
+
+Get commit by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+* Api Key Authentication (backend):
+
+```python
+import compute_api_client
+from compute_api_client.models.commit import Commit
+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"]
+
+# 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['backend'] = 'Bearer'
+
+# 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.CommitsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Get commit by ID
+        api_response = await api_instance.read_commit_commits_id_get(id)
+        print("The response of CommitsApi->read_commit_commits_id_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CommitsApi->read_commit_commits_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Commit**](Commit.md)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer), [backend](../README.md#backend)
+
+### 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_commits_commits_get**
+> PageCommit read_commits_commits_get(id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List commits
+
+List commits.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.page_commit import PageCommit
+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.CommitsApi(api_client)
+    id = 56 # int |  (optional)
+    created_on = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
+    hash = 'hash_example' # str |  (optional)
+    description = 'description_example' # str |  (optional)
+    algorithm_id = 56 # int |  (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 commits
+        api_response = await api_instance.read_commits_commits_get(id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of CommitsApi->read_commits_commits_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CommitsApi->read_commits_commits_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | [optional] 
+ **created_on** | **datetime**|  | [optional] 
+ **hash** | **str**|  | [optional] 
+ **description** | **str**|  | [optional] 
+ **algorithm_id** | **int**|  | [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
+
+[**PageCommit**](PageCommit.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)
+

compute_api_client/docs/CompilePayload.md

@@ -0,0 +1,30 @@
+# CompilePayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**compile_stage** | [**CompileStage**](CompileStage.md) |  | [optional] 
+**backend_type_id** | **int** | ID of the backendtype | 
+
+## Example
+
+```python
+from compute_api_client.models.compile_payload import CompilePayload
+
+# TODO update the JSON string below
+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())
+
+# convert the object into a dict
+compile_payload_dict = compile_payload_instance.to_dict()
+# create an instance of CompilePayload from a 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

@@ -0,0 +1,18 @@
+# CompileStage
+
+
+## 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

@@ -0,0 +1,14 @@
+# Domain
+
+
+## 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

@@ -0,0 +1,36 @@
+# File
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```python
+from compute_api_client.models.file import File
+
+# TODO update the JSON string below
+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())
+
+# convert the object into a dict
+file_dict = file_instance.to_dict()
+# create an instance of File from a 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

@@ -0,0 +1,35 @@
+# FileIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```python
+from compute_api_client.models.file_in import FileIn
+
+# TODO update the JSON string below
+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())
+
+# convert the object into a dict
+file_in_dict = file_in_instance.to_dict()
+# create an instance of FileIn from a 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)
+
+