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

compute_api_client/docs/TeamsApi.md

@@ -19,11 +19,13 @@ Get team 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.team import Team
 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,25 +38,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.TeamsApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve teams
-        api_response = api_instance.read_team_teams_id_get(id)
+        api_response = await api_instance.read_team_teams_id_get(id)
+        print("The response of TeamsApi->read_team_teams_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling TeamsApi->read_team_teams_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -84,7 +89,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_teams_teams_get**
-> list[Team] read_teams_teams_get()
+> List[Team] read_teams_teams_get(latest=latest, id=id, name=name, slug=slug, individual_user=individual_user)
 
 List teams
 
@@ -94,11 +99,13 @@ Read teams.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.team import Team
 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,30 +118,45 @@ 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.TeamsApi(api_client)
-    
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    name = 'name_example' # str |  (optional)
+    slug = 'slug_example' # str |  (optional)
+    individual_user = True # bool |  (optional)
+
     try:
         # List teams
-        api_response = api_instance.read_teams_teams_get()
+        api_response = await api_instance.read_teams_teams_get(latest=latest, id=id, name=name, slug=slug, individual_user=individual_user)
+        print("The response of TeamsApi->read_teams_teams_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling TeamsApi->read_teams_teams_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **name** | **str**|  | [optional] 
+ **slug** | **str**|  | [optional] 
+ **individual_user** | **bool**|  | [optional] 
 
 ### Return type
 
-[**list[Team]**](Team.md)
+[**List[Team]**](Team.md)
 
 ### Authorization
 
@@ -149,6 +171,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/Transaction.md

@@ -5,13 +5,30 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | 
-**domain** | [**Domain**](Domain.md) | COMPUTE: compute<br/>NETWORKING: networking<br/>SIMULATE: simulate | [optional] 
-**run** | **int** |  | [optional] 
+**domain** | [**Domain**](Domain.md) |  | 
+**job** | **int** |  | 
+**team_id** | **int** |  | 
+**user_id** | **int** |  | 
 **change** | **int** |  | 
 **timestamp** | **datetime** |  | 
-**team_id** | **int** |  | 
-**user_id** | **int** |  | [optional] 
 
+## Example
+
+```python
+from compute_api_client.models.transaction import Transaction
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Transaction from a JSON string
+transaction_instance = Transaction.from_json(json)
+# print the JSON string representation of the object
+print Transaction.to_json()
+
+# convert the object into a dict
+transaction_dict = transaction_instance.to_dict()
+# create an instance of Transaction from a dict
+transaction_form_dict = transaction.from_dict(transaction_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/TransactionsApi.md

@@ -19,11 +19,13 @@ Get transaction 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.transaction import Transaction
 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,25 +38,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.TransactionsApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve transactions
-        api_response = api_instance.read_transaction_transactions_id_get(id)
+        api_response = await api_instance.read_transaction_transactions_id_get(id)
+        print("The response of TransactionsApi->read_transaction_transactions_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling TransactionsApi->read_transaction_transactions_id_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -84,7 +89,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_transactions_transactions_get**
-> list[Transaction] read_transactions_transactions_get()
+> List[Transaction] read_transactions_transactions_get(latest=latest, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, user_id__isnull=user_id__isnull, user_id=user_id, change=change, timestamp=timestamp)
 
 List transactions
 
@@ -94,11 +99,14 @@ Read transactions.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.domain import Domain
+from compute_api_client.models.transaction import Transaction
 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,30 +119,57 @@ 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.TransactionsApi(api_client)
-    
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    domain__isnull = True # bool |  (optional)
+    domain = compute_api_client.Domain() # Domain |  (optional)
+    job__isnull = True # bool |  (optional)
+    job = 56 # int |  (optional)
+    team_id = 56 # int |  (optional)
+    user_id__isnull = True # bool |  (optional)
+    user_id = 56 # int |  (optional)
+    change = 56 # int |  (optional)
+    timestamp = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
+
     try:
         # List transactions
-        api_response = api_instance.read_transactions_transactions_get()
+        api_response = await api_instance.read_transactions_transactions_get(latest=latest, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, user_id__isnull=user_id__isnull, user_id=user_id, change=change, timestamp=timestamp)
+        print("The response of TransactionsApi->read_transactions_transactions_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling TransactionsApi->read_transactions_transactions_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **domain__isnull** | **bool**|  | [optional] 
+ **domain** | [**Domain**](.md)|  | [optional] 
+ **job__isnull** | **bool**|  | [optional] 
+ **job** | **int**|  | [optional] 
+ **team_id** | **int**|  | [optional] 
+ **user_id__isnull** | **bool**|  | [optional] 
+ **user_id** | **int**|  | [optional] 
+ **change** | **int**|  | [optional] 
+ **timestamp** | **datetime**|  | [optional] 
 
 ### Return type
 
-[**list[Transaction]**](Transaction.md)
+[**List[Transaction]**](Transaction.md)
 
 ### Authorization
 
@@ -149,6 +184,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/User.md

@@ -7,11 +7,28 @@ Name | Type | Description | Notes
 **id** | **int** |  | 
 **full_name** | **str** |  | 
 **email** | **str** |  | 
-**is_superuser** | **bool** |  | [optional] [default to False]
-**is_staff** | **bool** |  | [optional] [default to False]
-**is_active** | **bool** |  | [optional] [default to False]
-**is_confirmed** | **bool** |  | [optional] [default to False]
+**is_superuser** | **bool** |  | 
+**is_staff** | **bool** |  | 
+**is_active** | **bool** |  | 
+**is_confirmed** | **bool** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.user import User
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of User from a JSON string
+user_instance = User.from_json(json)
+# print the JSON string representation of the object
+print User.to_json()
+
+# convert the object into a dict
+user_dict = user_instance.to_dict()
+# create an instance of User from a dict
+user_form_dict = user.from_dict(user_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/UserIn.md

@@ -11,6 +11,23 @@ Name | Type | Description | Notes
 **is_active** | **bool** |  | [optional] [default to False]
 **is_confirmed** | **bool** |  | [optional] [default to False]
 
+## Example
+
+```python
+from compute_api_client.models.user_in import UserIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UserIn from a JSON string
+user_in_instance = UserIn.from_json(json)
+# print the JSON string representation of the object
+print UserIn.to_json()
+
+# convert the object into a dict
+user_in_dict = user_in_instance.to_dict()
+# create an instance of UserIn from a dict
+user_in_form_dict = user_in.from_dict(user_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/UsersApi.md

@@ -21,11 +21,14 @@ Create new user.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.user import User
+from compute_api_client.models.user_in import UserIn
 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.UsersApi(api_client)
     user_in = compute_api_client.UserIn() # UserIn | 
 
     try:
         # Create user
-        api_response = api_instance.create_user_users_post(user_in)
+        api_response = await api_instance.create_user_users_post(user_in)
+        print("The response of UsersApi->create_user_users_post:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling UsersApi->create_user_users_post: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -95,11 +101,12 @@ Delete a user.
 
 * 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.UsersApi(api_client)
     id = 56 # int | 
 
     try:
         # Destroy user
-        api_instance.delete_user_users_id_delete(id)
-    except ApiException as e:
+        await api_instance.delete_user_users_id_delete(id)
+    except Exception as e:
         print("Exception when calling UsersApi->delete_user_users_id_delete: %s\n" % e)
 ```
 
+
+
 ### Parameters
 
 Name | Type | Description  | Notes
@@ -169,11 +178,13 @@ Get user 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.user import User
 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.UsersApi(api_client)
     id = 56 # int | 
 
     try:
         # Retrieve user
-        api_response = api_instance.read_user_users_id_get(id)
+        api_response = await api_instance.read_user_users_id_get(id)
+        print("The response of UsersApi->read_user_users_id_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling UsersApi->read_user_users_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_users_users_get**
-> list[User] read_users_users_get()
+> List[User] read_users_users_get(latest=latest, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed)
 
 List users
 
@@ -244,11 +258,13 @@ Read users.
 
 * Api Key Authentication (user):
 ```python
-from __future__ import print_function
 import time
+import os
 import compute_api_client
+from compute_api_client.models.user import User
 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 +277,51 @@ 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.UsersApi(api_client)
-    
+    latest = True # bool |  (optional)
+    id = 56 # int |  (optional)
+    full_name = 'full_name_example' # str |  (optional)
+    email = 'email_example' # str |  (optional)
+    is_superuser = True # bool |  (optional)
+    is_staff = True # bool |  (optional)
+    is_active = True # bool |  (optional)
+    is_confirmed = True # bool |  (optional)
+
     try:
         # List users
-        api_response = api_instance.read_users_users_get()
+        api_response = await api_instance.read_users_users_get(latest=latest, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed)
+        print("The response of UsersApi->read_users_users_get:\n")
         pprint(api_response)
-    except ApiException as e:
+    except Exception as e:
         print("Exception when calling UsersApi->read_users_users_get: %s\n" % e)
 ```
 
+
+
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **latest** | **bool**|  | [optional] 
+ **id** | **int**|  | [optional] 
+ **full_name** | **str**|  | [optional] 
+ **email** | **str**|  | [optional] 
+ **is_superuser** | **bool**|  | [optional] 
+ **is_staff** | **bool**|  | [optional] 
+ **is_active** | **bool**|  | [optional] 
+ **is_confirmed** | **bool**|  | [optional] 
 
 ### Return type
 
-[**list[User]**](User.md)
+[**List[User]**](User.md)
 
 ### Authorization
 
@@ -299,6 +336,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/ValidationError.md

@@ -4,10 +4,27 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**loc** | [**list[LocationInner]**](LocationInner.md) |  | 
+**loc** | [**List[LocationInner]**](LocationInner.md) |  | 
 **msg** | **str** |  | 
 **type** | **str** |  | 
 
+## Example
+
+```python
+from compute_api_client.models.validation_error import ValidationError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationError from a JSON string
+validation_error_instance = ValidationError.from_json(json)
+# print the JSON string representation of the object
+print ValidationError.to_json()
+
+# convert the object into a dict
+validation_error_dict = validation_error_instance.to_dict()
+# create an instance of ValidationError from a dict
+validation_error_form_dict = validation_error.from_dict(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)