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

compute_api_client/docs/MemberIn.md

@@ -4,11 +4,28 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**role** | [**Role**](Role.md) | MEMBER: member<br/>ADMIN: admin | 
-**is_active** | **bool** |  | [optional] [default to False]
 **team_id** | **int** |  | 
 **user_id** | **int** |  | 
+**role** | [**Role**](Role.md) |  | 
+**is_active** | **bool** |  | [optional] [default to False]
+
+## Example
+
+```python
+from compute_api_client.models.member_in import MemberIn
+
+# TODO update the JSON string below
+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()
 
+# 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)
+```
 [[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/MembersApi.md

@@ -21,11 +21,14 @@ Create new member.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.member import Member
+from compute_api_client.models.member_in import MemberIn
 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.MembersApi(api_client)
     member_in = compute_api_client.MemberIn() # MemberIn | 
 
     try:
         # Create member
-        api_response = api_instance.create_member_members_post(member_in)
+        api_response = await api_instance.create_member_members_post(member_in)
+        print("The response of MembersApi->create_member_members_post:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling MembersApi->create_member_members_post: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -95,11 +101,12 @@ Delete a member.
 
 * 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.MembersApi(api_client)
     id = 56 # int | 
 
     try:
         # Destroy member
-        api_instance.delete_member_members_id_delete(id)
-    except ApiException as e:
+        await api_instance.delete_member_members_id_delete(id)
+    except Exception as e:
         print("Exception when calling MembersApi->delete_member_members_id_delete: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -169,11 +178,13 @@ Get member by ID.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.member import Member
 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(
@@ -186,25 +197,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.MembersApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve member
-        api_response = api_instance.read_member_members_id_get(id)
+        api_response = await api_instance.read_member_members_id_get(id)
+        print("The response of MembersApi->read_member_members_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling MembersApi->read_member_members_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -234,7 +248,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_members_members_get**
-> list[Member] read_members_members_get()
+> List[Member] read_members_members_get(latest=latest, id=id, team_id=team_id, user_id=user_id, role=role, is_active=is_active)
 
 List members
 
@@ -244,11 +258,14 @@ Read members.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.member import Member
+from compute_api_client.models.role import Role
 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(
@@ -261,30 +278,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.MembersApi(api_client)
-    
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    team_id = 56 # int |  (optional)
+    user_id = 56 # int |  (optional)
+    role = compute_api_client.Role() # Role |  (optional)
+    is_active = True # bool |  (optional)
+
     try:
         # List members
-        api_response = api_instance.read_members_members_get()
+        api_response = await api_instance.read_members_members_get(latest=latest, id=id, team_id=team_id, user_id=user_id, role=role, is_active=is_active)
+        print("The response of MembersApi->read_members_members_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling MembersApi->read_members_members_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **team_id** | **int**|  | [optional] 
+ **user_id** | **int**|  | [optional] 
+ **role** | [**Role**](.md)|  | [optional] 
+ **is_active** | **bool**|  | [optional] 
 
 ### Return type
 
-[**list[Member]**](Member.md)
+[**List[Member]**](Member.md)
 
 ### Authorization
 
@@ -299,6 +333,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/Metadata.md

@@ -4,11 +4,28 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created_on** | **datetime** |  | [readonly] 
 **id** | **int** |  | 
-**data** | **object** |  | [optional] 
-**runtime_id** | **int** |  | 
+**backend_id** | **int** |  | 
+**created_on** | **datetime** |  | 
+**data** | **object** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.metadata import Metadata
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Metadata from a JSON string
+metadata_instance = Metadata.from_json(json)
+# print the JSON string representation of the object
+print Metadata.to_json()
+
+# convert the object into a dict
+metadata_dict = metadata_instance.to_dict()
+# create an instance of Metadata from a dict
+metadata_form_dict = metadata.from_dict(metadata_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/MetadataApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create_metadata_metadata_post**](MetadataApi.md#create_metadata_metadata_post) | **POST** /metadata | Create metadata
-[**read_metadata_by_runtime_id_metadata_runtime_runtime_id_get**](MetadataApi.md#read_metadata_by_runtime_id_metadata_runtime_runtime_id_get) | **GET** /metadata/runtime/{runtime_id} | Retrieve metadata by runtime ID
+[**create_metadata_self_metadata_post**](MetadataApi.md#create_metadata_self_metadata_post) | **POST** /metadata | Create metadata
+[**read_metadata_by_backend_id_metadata_backend_backend_id_get**](MetadataApi.md#read_metadata_by_backend_id_metadata_backend_backend_id_get) | **GET** /metadata/backend/{backend_id} | Retrieve metadata by backend ID
 [**read_metadata_metadata_id_get**](MetadataApi.md#read_metadata_metadata_id_get) | **GET** /metadata/{id} | Get metadata by ID
 
 
-# **create_metadata_metadata_post**
-> Metadata create_metadata_metadata_post(metadata_in)
+# **create_metadata_self_metadata_post**
+> Metadata create_metadata_self_metadata_post(metadata_in)
 
 Create metadata
 
@@ -18,13 +18,16 @@ Create new metadata.
 
 ### Example
 
-* Api Key Authentication (user):
+* Api Key Authentication (backend):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.metadata import Metadata
+from compute_api_client.models.metadata_in import MetadataIn
 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(
@@ -36,26 +39,29 @@ 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: user
-configuration.api_key['user'] = '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['user'] = 'Bearer'
+# configuration.api_key_prefix['backend'] = '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.MetadataApi(api_client)
     metadata_in = compute_api_client.MetadataIn() # MetadataIn | 
 
     try:
         # Create metadata
-        api_response = api_instance.create_metadata_metadata_post(metadata_in)
+        api_response = await api_instance.create_metadata_self_metadata_post(metadata_in)
+        print("The response of MetadataApi->create_metadata_self_metadata_post:\n")
         pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling MetadataApi->create_metadata_metadata_post: %s\n" % e)
+    except Exception as e:
+        print("Exception when calling MetadataApi->create_metadata_self_metadata_post: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -68,7 +74,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[backend](../README.md#backend)
 
 ### HTTP request headers
 
@@ -83,22 +89,24 @@ 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_metadata_by_runtime_id_metadata_runtime_runtime_id_get**
-> list[Metadata] read_metadata_by_runtime_id_metadata_runtime_runtime_id_get(runtime_id)
+# **read_metadata_by_backend_id_metadata_backend_backend_id_get**
+> List[Metadata] read_metadata_by_backend_id_metadata_backend_backend_id_get(backend_id)
 
-Retrieve metadata by runtime ID
+Retrieve metadata by backend ID
 
-Get metadata by run ID.
+Get metadata by job ID.
 
 ### Example
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.metadata import Metadata
 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(
@@ -111,34 +119,37 @@ 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.MetadataApi(api_client)
-    runtime_id = 56 # int | 
+    backend_id = 56 # int | 
 
     try:
-        # Retrieve metadata by runtime ID
-        api_response = api_instance.read_metadata_by_runtime_id_metadata_runtime_runtime_id_get(runtime_id)
+        # Retrieve metadata by backend ID
+        api_response = await api_instance.read_metadata_by_backend_id_metadata_backend_backend_id_get(backend_id)
+        print("The response of MetadataApi->read_metadata_by_backend_id_metadata_backend_backend_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
-        print("Exception when calling MetadataApi->read_metadata_by_runtime_id_metadata_runtime_runtime_id_get: %s\n" % e)
+    except Exception as e:
+        print("Exception when calling MetadataApi->read_metadata_by_backend_id_metadata_backend_backend_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **runtime_id** | **int**|  | 
+ **backend_id** | **int**|  | 
 
 ### Return type
 
-[**list[Metadata]**](Metadata.md)
+[**List[Metadata]**](Metadata.md)
 
 ### Authorization
 
@@ -168,11 +179,13 @@ Get metadata by ID.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.metadata import Metadata
 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,25 +198,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.MetadataApi(api_client)
     id = 56 # int | 
 
     try:
         # Get metadata by ID
-        api_response = api_instance.read_metadata_metadata_id_get(id)
+        api_response = await api_instance.read_metadata_metadata_id_get(id)
+        print("The response of MetadataApi->read_metadata_metadata_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling MetadataApi->read_metadata_metadata_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes

compute_api_client/docs/MetadataIn.md

@@ -4,9 +4,26 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data** | **object** |  | [optional] 
-**runtime_id** | **int** |  | 
+**backend_id** | **int** |  | [optional] 
+**data** | **object** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.metadata_in import MetadataIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MetadataIn from a JSON string
+metadata_in_instance = MetadataIn.from_json(json)
+# print the JSON string representation of the object
+print MetadataIn.to_json()
+
+# convert the object into a dict
+metadata_in_dict = metadata_in_instance.to_dict()
+# create an instance of MetadataIn from a dict
+metadata_in_form_dict = metadata_in.from_dict(metadata_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/Permission.md

@@ -8,6 +8,23 @@ Name | Type | Description | Notes
 **permission** | **str** |  | 
 **name** | **str** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.permission import Permission
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Permission from a JSON string
+permission_instance = Permission.from_json(json)
+# print the JSON string representation of the object
+print Permission.to_json()
+
+# convert the object into a dict
+permission_dict = permission_instance.to_dict()
+# create an instance of Permission from a dict
+permission_form_dict = permission.from_dict(permission_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/PermissionGroup.md

@@ -7,6 +7,23 @@ Name | Type | Description | Notes
 **id** | **int** |  | 
 **name** | **str** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.permission_group import PermissionGroup
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PermissionGroup from a JSON string
+permission_group_instance = PermissionGroup.from_json(json)
+# print the JSON string representation of the object
+print PermissionGroup.to_json()
+
+# convert the object into a dict
+permission_group_dict = permission_group_instance.to_dict()
+# create an instance of PermissionGroup from a dict
+permission_group_form_dict = permission_group.from_dict(permission_group_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)