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

compute_api_client/docs/PermissionsApi.md

@@ -0,0 +1,340 @@
+# compute_api_client.PermissionsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read_permission_group_permission_groups_id_get**](PermissionsApi.md#read_permission_group_permission_groups_id_get) | **GET** /permission_groups/{id} | Retrieve permission groups
+[**read_permission_groups_permission_groups_get**](PermissionsApi.md#read_permission_groups_permission_groups_get) | **GET** /permission_groups/ | List permission groups
+[**read_permission_permissions_id_get**](PermissionsApi.md#read_permission_permissions_id_get) | **GET** /permissions/{id} | Retrieve permissions
+[**read_permissions_permissions_get**](PermissionsApi.md#read_permissions_permissions_get) | **GET** /permissions/ | List permissions
+
+
+# **read_permission_group_permission_groups_id_get**
+> PermissionGroup read_permission_group_permission_groups_id_get(id)
+
+Retrieve permission groups
+
+Get permission group by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.permission_group import PermissionGroup
+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.PermissionsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve permission groups
+        api_response = await api_instance.read_permission_group_permission_groups_id_get(id)
+        print("The response of PermissionsApi->read_permission_group_permission_groups_id_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PermissionsApi->read_permission_group_permission_groups_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**PermissionGroup**](PermissionGroup.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_permission_groups_permission_groups_get**
+> PagePermissionGroup read_permission_groups_permission_groups_get(id=id, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List permission groups
+
+Read permissions groups.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.page_permission_group import PagePermissionGroup
+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.PermissionsApi(api_client)
+    id = 56 # int |  (optional)
+    name = 'name_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 permission groups
+        api_response = await api_instance.read_permission_groups_permission_groups_get(id=id, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of PermissionsApi->read_permission_groups_permission_groups_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PermissionsApi->read_permission_groups_permission_groups_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | [optional] 
+ **name** | **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
+
+[**PagePermissionGroup**](PagePermissionGroup.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)
+
+# **read_permission_permissions_id_get**
+> Permission read_permission_permissions_id_get(id)
+
+Retrieve permissions
+
+Get permission by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.permission import Permission
+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.PermissionsApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve permissions
+        api_response = await api_instance.read_permission_permissions_id_get(id)
+        print("The response of PermissionsApi->read_permission_permissions_id_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PermissionsApi->read_permission_permissions_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Permission**](Permission.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_permissions_permissions_get**
+> PagePermission read_permissions_permissions_get(id=id, permission=permission, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List permissions
+
+Read permissions.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.page_permission import PagePermission
+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.PermissionsApi(api_client)
+    id = 56 # int |  (optional)
+    permission = 'permission_example' # str |  (optional)
+    name = 'name_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 permissions
+        api_response = await api_instance.read_permissions_permissions_get(id=id, permission=permission, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of PermissionsApi->read_permissions_permissions_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PermissionsApi->read_permissions_permissions_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | [optional] 
+ **permission** | **str**|  | [optional] 
+ **name** | **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
+
+[**PagePermission**](PagePermission.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/Project.md

@@ -0,0 +1,34 @@
+# Project
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The ID of the project | 
+**created_on** | **datetime** | Time of creation of the project | 
+**owner_id** | **int** | The ID of the project owner | 
+**name** | **str** | The name of the project | 
+**description** | **str** | The description of the project | 
+**starred** | **bool** | If the project is starred | 
+
+## Example
+
+```python
+from compute_api_client.models.project import Project
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Project from a JSON string
+project_instance = Project.from_json(json)
+# print the JSON string representation of the object
+print(Project.to_json())
+
+# convert the object into a dict
+project_dict = project_instance.to_dict()
+# create an instance of Project from a dict
+project_from_dict = Project.from_dict(project_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/ProjectIn.md

@@ -0,0 +1,32 @@
+# ProjectIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**owner_id** | **int** | The ID of the project | 
+**name** | **str** | The name of the project | 
+**description** | **str** | The description of the project | 
+**starred** | **bool** | If the project is starred | [optional] [default to False]
+
+## Example
+
+```python
+from compute_api_client.models.project_in import ProjectIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ProjectIn from a JSON string
+project_in_instance = ProjectIn.from_json(json)
+# print the JSON string representation of the object
+print(ProjectIn.to_json())
+
+# convert the object into a dict
+project_in_dict = project_in_instance.to_dict()
+# create an instance of ProjectIn from a dict
+project_in_from_dict = ProjectIn.from_dict(project_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/ProjectPatch.md

@@ -0,0 +1,32 @@
+# ProjectPatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**owner_id** | **int** |  | [optional] 
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**starred** | **bool** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.project_patch import ProjectPatch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ProjectPatch from a JSON string
+project_patch_instance = ProjectPatch.from_json(json)
+# print the JSON string representation of the object
+print(ProjectPatch.to_json())
+
+# convert the object into a dict
+project_patch_dict = project_patch_instance.to_dict()
+# create an instance of ProjectPatch from a dict
+project_patch_from_dict = ProjectPatch.from_dict(project_patch_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)
+
+