qi-compute-api-client 0.4.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

compute_api_client/docs/CommitsApi.md

@@ -21,11 +21,14 @@ Create new commit.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 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
 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(
@@ -38,25 +41,28 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as 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 = api_instance.create_commit_commits_post(commit_in)
+        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 ApiException as e:
+    except Exception as e:
         print("Exception when calling CommitsApi->create_commit_commits_post: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -95,11 +101,12 @@ Delete a commit.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 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(
@@ -112,24 +119,26 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as 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
-        api_instance.delete_commit_commits_id_delete(id)
-    except ApiException as e:
+        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
@@ -167,13 +176,16 @@ Get commit by ID.
 
 ### Example
 
-* Api Key Authentication (runtime):
+* Api Key Authentication (backend):
+* Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 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(
@@ -185,75 +197,34 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: runtime
-configuration.api_key['runtime'] = 'YOUR_API_KEY'
+# 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['runtime'] = 'Bearer'
+# configuration.api_key_prefix['backend'] = 'Bearer'
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as 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 = api_instance.read_commit_commits_id_get(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 ApiException as e:
+    except Exception as e:
         print("Exception when calling CommitsApi->read_commit_commits_id_get: %s\n" % e)
 ```
 
-* Api Key Authentication (user):
-```python
-from __future__ import print_function
-import time
-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.
-
-# Configure API key authorization: runtime
-configuration.api_key['runtime'] = 'YOUR_API_KEY'
 
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['runtime'] = 'Bearer'
-
-# Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-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 = api_instance.read_commit_commits_id_get(id)
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling CommitsApi->read_commit_commits_id_get: %s\n" % e)
-```
 
 ### Parameters
 
@@ -267,7 +238,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[runtime](../README.md#runtime), [user](../README.md#user)
+[backend](../README.md#backend), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -284,7 +255,7 @@ Name | Type | Description  | Notes
 [[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**
-> list[Commit] read_commits_commits_get()
+> List[Commit] read_commits_commits_get(latest=latest, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id)
 
 List commits
 
@@ -294,11 +265,13 @@ List commits.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 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(
@@ -311,30 +284,47 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as 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)
-    
+    latest = True # bool |  (optional)
+    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)
+
     try:
         # List commits
-        api_response = api_instance.read_commits_commits_get()
+        api_response = await api_instance.read_commits_commits_get(latest=latest, id=id, created_on=created_on, hash=hash, description=description, algorithm_id=algorithm_id)
+        print("The response of CommitsApi->read_commits_commits_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling CommitsApi->read_commits_commits_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **created_on** | **datetime**|  | [optional] 
+ **hash** | **str**|  | [optional] 
+ **description** | **str**|  | [optional] 
+ **algorithm_id** | **int**|  | [optional] 
 
 ### Return type
 
-[**list[Commit]**](Commit.md)
+[**List[Commit]**](Commit.md)
 
 ### Authorization
 
@@ -349,6 +339,7 @@ This endpoint does not need any parameter.
 | 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/CompileStage.md

@@ -1,6 +1,5 @@
 # CompileStage
 
-An enumeration.
 
 ## Properties
 Name | Type | Description | Notes

compute_api_client/docs/Domain.md

@@ -1,6 +1,5 @@
 # Domain
 
-An enumeration.
 
 ## Properties
 Name | Type | Description | Notes

compute_api_client/docs/File.md

@@ -5,13 +5,30 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | 
-**content** | **str** |  | 
-**compile_stage** | [**CompileStage**](CompileStage.md) | NONE: none<br/>MAPPED: mapped<br/>NATIVE_GATESET: native_gateset<br/>SCHEDULED: scheduled | 
-**compile_properties** | **object** |  | [optional] 
-**generated** | **bool** |  | [optional] [default to False]
 **commit_id** | **int** |  | 
+**content** | **str** |  | 
 **language_id** | **int** |  | 
+**compile_stage** | [**CompileStage**](CompileStage.md) |  | 
+**compile_properties** | **object** |  | 
+**generated** | **bool** |  | 
+
+## 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_form_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

@@ -4,13 +4,30 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**content** | **str** |  | 
-**compile_stage** | [**CompileStage**](CompileStage.md) | NONE: none<br/>MAPPED: mapped<br/>NATIVE_GATESET: native_gateset<br/>SCHEDULED: scheduled | [optional] 
-**compile_properties** | **object** |  | [optional] 
-**generated** | **bool** |  | [optional] [default to False]
 **commit_id** | **int** |  | 
+**content** | **str** |  | 
 **language_id** | **int** |  | 
+**compile_stage** | [**CompileStage**](CompileStage.md) |  | 
+**compile_properties** | **object** |  | 
+**generated** | **bool** |  | [optional] [default to False]
+
+## 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_form_dict = file_in.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

@@ -21,11 +21,14 @@ Create new file.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 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
 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(
@@ -38,25 +41,28 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FilesApi(api_client)
     file_in = compute_api_client.FileIn() # FileIn | 
 
     try:
         # Create file
-        api_response = api_instance.create_file_files_post(file_in)
+        api_response = await api_instance.create_file_files_post(file_in)
+        print("The response of FilesApi->create_file_files_post:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling FilesApi->create_file_files_post: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -95,11 +101,12 @@ Delete a file.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 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(
@@ -112,24 +119,26 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FilesApi(api_client)
     id = 56 # int | 
 
     try:
         # Destroy file
-        api_instance.delete_file_files_id_delete(id)
-    except ApiException as e:
+        await api_instance.delete_file_files_id_delete(id)
+    except Exception as e:
         print("Exception when calling FilesApi->delete_file_files_id_delete: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -167,13 +176,16 @@ Get file by ID.
 
 ### Example
 
-* Api Key Authentication (runtime):
+* Api Key Authentication (backend):
+* Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.file import File
 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(
@@ -185,75 +197,34 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: runtime
-configuration.api_key['runtime'] = 'YOUR_API_KEY'
+# 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['runtime'] = 'Bearer'
+# configuration.api_key_prefix['backend'] = 'Bearer'
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FilesApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve file
-        api_response = api_instance.read_file_files_id_get(id)
+        api_response = await api_instance.read_file_files_id_get(id)
+        print("The response of FilesApi->read_file_files_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling FilesApi->read_file_files_id_get: %s\n" % e)
 ```
 
-* Api Key Authentication (user):
-```python
-from __future__ import print_function
-import time
-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.
-
-# Configure API key authorization: runtime
-configuration.api_key['runtime'] = 'YOUR_API_KEY'
 
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['runtime'] = 'Bearer'
-
-# Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = compute_api_client.FilesApi(api_client)
-    id = 56 # int | 
-
-    try:
-        # Retrieve file
-        api_response = api_instance.read_file_files_id_get(id)
-        pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling FilesApi->read_file_files_id_get: %s\n" % e)
-```
 
 ### Parameters
 
@@ -267,7 +238,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[runtime](../README.md#runtime), [user](../README.md#user)
+[backend](../README.md#backend), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -284,7 +255,7 @@ Name | Type | Description  | Notes
 [[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_files_files_get**
-> list[File] read_files_files_get()
+> List[File] read_files_files_get(latest=latest, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated)
 
 List files
 
@@ -294,11 +265,14 @@ List files.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.compile_stage import CompileStage
+from compute_api_client.models.file import File
 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(
@@ -311,30 +285,49 @@ configuration = compute_api_client.Configuration(
 # satisfies your auth use case.
 
 # Configure API key authorization: user
-configuration.api_key['user'] = 'YOUR_API_KEY'
+configuration.api_key['user'] = os.environ["API_KEY"]
 
 # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
 # configuration.api_key_prefix['user'] = 'Bearer'
 
 # Enter a context with an instance of the API client
-with compute_api_client.ApiClient(configuration) as api_client:
+async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.FilesApi(api_client)
-    
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    commit_id = 56 # int |  (optional)
+    content = 'content_example' # str |  (optional)
+    language_id = 56 # int |  (optional)
+    compile_stage = compute_api_client.CompileStage() # CompileStage |  (optional)
+    generated = True # bool |  (optional)
+
     try:
         # List files
-        api_response = api_instance.read_files_files_get()
+        api_response = await api_instance.read_files_files_get(latest=latest, id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated)
+        print("The response of FilesApi->read_files_files_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling FilesApi->read_files_files_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **commit_id** | **int**|  | [optional] 
+ **content** | **str**|  | [optional] 
+ **language_id** | **int**|  | [optional] 
+ **compile_stage** | [**CompileStage**](.md)|  | [optional] 
+ **generated** | **bool**|  | [optional] 
 
 ### Return type
 
-[**list[File]**](File.md)
+[**List[File]**](File.md)
 
 ### Authorization
 
@@ -349,6 +342,7 @@ This endpoint does not need any parameter.
 | 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)