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

compute_api_client/docs/Transaction.md

@@ -0,0 +1,35 @@
+# Transaction
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The id of the transaction | 
+**domain** | [**Domain**](Domain.md) |  | 
+**job** | **int** |  | 
+**team_id** | **int** | The id of the team who initiated the transaction | 
+**member_id** | **int** |  | 
+**change** | **int** |  | 
+**timestamp** | **datetime** | Time when the transaction was started | 
+
+## 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_from_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/TransactionDomain.md

@@ -0,0 +1,28 @@
+# TransactionDomain
+
+The domain type of the transaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from compute_api_client.models.transaction_domain import TransactionDomain
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of TransactionDomain from a JSON string
+transaction_domain_instance = TransactionDomain.from_json(json)
+# print the JSON string representation of the object
+print TransactionDomain.to_json()
+
+# convert the object into a dict
+transaction_domain_dict = transaction_domain_instance.to_dict()
+# create an instance of TransactionDomain from a dict
+transaction_domain_form_dict = transaction_domain.from_dict(transaction_domain_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

@@ -0,0 +1,190 @@
+# compute_api_client.TransactionsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read_transaction_transactions_id_get**](TransactionsApi.md#read_transaction_transactions_id_get) | **GET** /transactions/{id} | Retrieve transactions
+[**read_transactions_transactions_get**](TransactionsApi.md#read_transactions_transactions_get) | **GET** /transactions/ | List transactions
+
+
+# **read_transaction_transactions_id_get**
+> Transaction read_transaction_transactions_id_get(id)
+
+Retrieve transactions
+
+Get transaction by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.TransactionsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve transactions
+        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 Exception as e:
+        print("Exception when calling TransactionsApi->read_transaction_transactions_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Transaction**](Transaction.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 |  -  |
+**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_transactions_transactions_get**
+> PageTransaction read_transactions_transactions_get(id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List transactions
+
+Read transactions.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.domain import Domain
+from compute_api_client.models.page_transaction import PageTransaction
+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.TransactionsApi(api_client)
+    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)
+    member_id__isnull = True # bool |  (optional)
+    member_id = 56 # int |  (optional)
+    change = 56 # int |  (optional)
+    timestamp = '2013-10-20T19:20:30+01:00' # datetime |  (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 transactions
+        api_response = await api_instance.read_transactions_transactions_get(id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of TransactionsApi->read_transactions_transactions_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling TransactionsApi->read_transactions_transactions_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | [optional] 
+ **domain__isnull** | **bool**|  | [optional] 
+ **domain** | [**Domain**](.md)|  | [optional] 
+ **job__isnull** | **bool**|  | [optional] 
+ **job** | **int**|  | [optional] 
+ **team_id** | **int**|  | [optional] 
+ **member_id__isnull** | **bool**|  | [optional] 
+ **member_id** | **int**|  | [optional] 
+ **change** | **int**|  | [optional] 
+ **timestamp** | **datetime**|  | [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
+
+[**PageTransaction**](PageTransaction.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/User.md

@@ -0,0 +1,36 @@
+# User
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The id of the user | 
+**full_name** | **str** | The full name of the user | 
+**email** | **str** | The email id of the user | 
+**is_superuser** | **bool** | If the user is superuser | 
+**is_staff** | **bool** | If the user is staff | 
+**is_active** | **bool** | If the user is active | 
+**is_confirmed** | **bool** | If the user is confirmed | 
+**oidc_sub** | **str** | User identifier from OIDC provider | 
+
+## 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_from_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

@@ -0,0 +1,35 @@
+# UserIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**full_name** | **str** | The full name of the user | 
+**email** | **str** | The email id of the user | 
+**is_superuser** | **bool** | If the user is superuser | [optional] [default to False]
+**is_staff** | **bool** | If the user is staff | [optional] [default to False]
+**is_active** | **bool** | If the user is active | [optional] [default to False]
+**is_confirmed** | **bool** | If the user is confirmed | [optional] [default to False]
+**oidc_sub** | **str** | User identifier from OIDC provider | 
+
+## 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_from_dict = UserIn.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

@@ -0,0 +1,338 @@
+# compute_api_client.UsersApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_user_users_post**](UsersApi.md#create_user_users_post) | **POST** /users | Create user
+[**delete_user_users_id_delete**](UsersApi.md#delete_user_users_id_delete) | **DELETE** /users/{id} | Destroy user
+[**read_user_users_id_get**](UsersApi.md#read_user_users_id_get) | **GET** /users/{id} | Retrieve user
+[**read_users_users_get**](UsersApi.md#read_users_users_get) | **GET** /users | List users
+
+
+# **create_user_users_post**
+> User create_user_users_post(user_in)
+
+Create user
+
+Create new user.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.UsersApi(api_client)
+    user_in = compute_api_client.UserIn() # UserIn | 
+
+    try:
+        # Create user
+        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 Exception as e:
+        print("Exception when calling UsersApi->create_user_users_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_in** | [**UserIn**](UserIn.md)|  | 
+
+### Return type
+
+[**User**](User.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_user_users_id_delete**
+> delete_user_users_id_delete(id)
+
+Destroy user
+
+Delete a user.
+
+### 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.UsersApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Destroy user
+        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
+------------- | ------------- | ------------- | -------------
+ **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_user_users_id_get**
+> User read_user_users_id_get(id)
+
+Retrieve user
+
+Get user by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.UsersApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve user
+        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 Exception as e:
+        print("Exception when calling UsersApi->read_user_users_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**User**](User.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 |  -  |
+**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_users_users_get**
+> PageUser read_users_users_get(id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List users
+
+Read users.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.page_user import PageUser
+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.UsersApi(api_client)
+    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)
+    oidc_sub = 'oidc_sub_example' # str |  (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 users
+        api_response = await api_instance.read_users_users_get(id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of UsersApi->read_users_users_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->read_users_users_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **oidc_sub** | **str**|  | [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
+
+[**PageUser**](PageUser.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/ValidationError.md

@@ -0,0 +1,31 @@
+# ValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.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_from_dict = ValidationError.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)
+
+