qi-compute-api-client 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

compute_api_client/docs/ResultsApi.md

@@ -21,9 +21,8 @@ Create new result.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.result import Result
 from compute_api_client.models.result_in import ResultIn
@@ -66,6 +65,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **result_in** | [**ResultIn**](ResultIn.md)|  | 
@@ -84,6 +84,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -101,9 +102,8 @@ Delete results by job ID.
 ### Example
 
 * Api Key Authentication (backend):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -142,6 +142,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_id** | **int**|  | 
@@ -160,6 +161,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -178,9 +180,8 @@ Get result by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.result import Result
 from compute_api_client.rest import ApiException
@@ -218,6 +219,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -236,6 +238,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -254,9 +257,8 @@ Get results by algorithm ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_result import PageResult
 from compute_api_client.rest import ApiException
@@ -308,6 +310,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **algorithm_id** | **int**|  | 
@@ -340,6 +343,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -358,9 +362,8 @@ Get results by job ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_result import PageResult
 from compute_api_client.rest import ApiException
@@ -402,6 +405,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **job_id** | **int**|  | 
@@ -424,6 +428,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Role.md

@@ -1,9 +1,11 @@
 # Role
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `MEMBER` (value: `'member'`)
+
+* `ADMIN` (value: `'admin'`)
 
 [[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/ShareType.md

@@ -1,9 +1,13 @@
 # ShareType
 
 
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+## Enum
+
+* `PRIVATE` (value: `'private'`)
+
+* `LINK_ONLY` (value: `'link_only'`)
+
+* `TEAM` (value: `'team'`)
 
 [[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/Team.md

@@ -2,12 +2,13 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**name** | **str** |  | 
-**slug** | **str** |  | 
-**individual_user** | **bool** |  | 
+**id** | **int** | The id of the team | 
+**name** | **str** | The name of the team | 
+**slug** | **str** | The slugified name | 
+**individual_user** | **bool** | If it is an individual user | 
 
 ## Example
 
@@ -19,12 +20,12 @@ json = "{}"
 # create an instance of Team from a JSON string
 team_instance = Team.from_json(json)
 # print the JSON string representation of the object
-print Team.to_json()
+print(Team.to_json())
 
 # convert the object into a dict
 team_dict = team_instance.to_dict()
 # create an instance of Team from a dict
-team_form_dict = team.from_dict(team_dict)
+team_from_dict = Team.from_dict(team_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/TeamsApi.md

@@ -18,9 +18,8 @@ Get team by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.team import Team
 from compute_api_client.rest import ApiException
@@ -58,6 +57,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -76,6 +76,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -94,9 +95,8 @@ Read teams.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_team import PageTeam
 from compute_api_client.rest import ApiException
@@ -141,6 +141,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -166,6 +167,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/Transaction.md

@@ -2,15 +2,16 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
+**id** | **int** | The id of the transaction | 
 **domain** | [**Domain**](Domain.md) |  | 
 **job** | **int** |  | 
-**team_id** | **int** |  | 
+**team_id** | **int** | The id of the team who initiated the transaction | 
 **member_id** | **int** |  | 
 **change** | **int** |  | 
-**timestamp** | **datetime** |  | 
+**timestamp** | **datetime** | Time when the transaction was started | 
 
 ## Example
 
@@ -22,12 +23,12 @@ 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()
+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)
+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

@@ -18,9 +18,8 @@ Get transaction by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.transaction import Transaction
 from compute_api_client.rest import ApiException
@@ -58,6 +57,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -76,6 +76,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -94,9 +95,8 @@ Read transactions.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.domain import Domain
 from compute_api_client.models.page_transaction import PageTransaction
@@ -148,6 +148,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -179,6 +180,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/User.md

@@ -2,16 +2,17 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **int** |  | 
-**full_name** | **str** |  | 
-**email** | **str** |  | 
-**is_superuser** | **bool** |  | 
-**is_staff** | **bool** |  | 
-**is_active** | **bool** |  | 
-**is_confirmed** | **bool** |  | 
-**oidc_sub** | **str** |  | 
+**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
 
@@ -23,12 +24,12 @@ 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()
+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)
+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

@@ -2,15 +2,16 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
-**oidc_sub** | **str** |  | 
+**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
 
@@ -22,12 +23,12 @@ 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()
+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)
+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

@@ -20,9 +20,8 @@ Create new user.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-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
@@ -61,6 +60,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_in** | [**UserIn**](UserIn.md)|  | 
@@ -79,6 +79,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **201** | Successful Response |  -  |
@@ -96,9 +97,8 @@ Delete a user.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -133,6 +133,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -151,6 +152,7 @@ void (empty response body)
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **204** | Successful Response |  -  |
@@ -169,9 +171,8 @@ Get user by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.user import User
 from compute_api_client.rest import ApiException
@@ -209,6 +210,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -227,6 +229,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |
@@ -245,9 +248,8 @@ Read users.
 ### Example
 
 * OAuth Authentication (user_bearer):
+
 ```python
-import time
-import os
 import compute_api_client
 from compute_api_client.models.page_user import PageUser
 from compute_api_client.rest import ApiException
@@ -296,6 +298,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | [optional] 
@@ -325,6 +328,7 @@ Name | Type | Description  | Notes
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 **200** | Successful Response |  -  |

compute_api_client/docs/ValidationError.md

@@ -2,9 +2,10 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**loc** | [**List[LocationInner]**](LocationInner.md) |  | 
+**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) |  | 
 **msg** | **str** |  | 
 **type** | **str** |  | 
 
@@ -18,12 +19,12 @@ 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()
+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)
+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)
 

compute_api_client/docs/ValidationErrorLocInner.md

@@ -0,0 +1,28 @@
+# ValidationErrorLocInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from compute_api_client.models.validation_error_loc_inner import ValidationErrorLocInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationErrorLocInner from a JSON string
+validation_error_loc_inner_instance = ValidationErrorLocInner.from_json(json)
+# print the JSON string representation of the object
+print(ValidationErrorLocInner.to_json())
+
+# convert the object into a dict
+validation_error_loc_inner_dict = validation_error_loc_inner_instance.to_dict()
+# create an instance of ValidationErrorLocInner from a dict
+validation_error_loc_inner_from_dict = ValidationErrorLocInner.from_dict(validation_error_loc_inner_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)
+
+