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

compute_api_client/docs/Member.md

@@ -0,0 +1,33 @@
+# Member
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The id of the member | 
+**team_id** | **int** | The id of the team | 
+**user_id** | **int** | The id of the user | 
+**role** | [**Role**](Role.md) | The role of the member | 
+**is_active** | **bool** | If the member is active | 
+
+## Example
+
+```python
+from compute_api_client.models.member import Member
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Member from a JSON string
+member_instance = Member.from_json(json)
+# print the JSON string representation of the object
+print(Member.to_json())
+
+# convert the object into a dict
+member_dict = member_instance.to_dict()
+# create an instance of Member from a dict
+member_from_dict = Member.from_dict(member_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/MemberId.md

@@ -0,0 +1,28 @@
+# MemberId
+
+The id of the member who initiated the transaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from compute_api_client.models.member_id import MemberId
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MemberId from a JSON string
+member_id_instance = MemberId.from_json(json)
+# print the JSON string representation of the object
+print MemberId.to_json()
+
+# convert the object into a dict
+member_id_dict = member_id_instance.to_dict()
+# create an instance of MemberId from a dict
+member_id_form_dict = member_id.from_dict(member_id_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/MemberIn.md

@@ -0,0 +1,32 @@
+# MemberIn
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**team_id** | **int** | The id of the team | 
+**user_id** | **int** | The id of the user | 
+**role** | [**Role**](Role.md) | The role of the member | 
+**is_active** | **bool** | If the member is active | [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_from_dict = MemberIn.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

@@ -0,0 +1,331 @@
+# compute_api_client.MembersApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_member_members_post**](MembersApi.md#create_member_members_post) | **POST** /members | Create member
+[**delete_member_members_id_delete**](MembersApi.md#delete_member_members_id_delete) | **DELETE** /members/{id} | Destroy member
+[**read_member_members_id_get**](MembersApi.md#read_member_members_id_get) | **GET** /members/{id} | Retrieve member
+[**read_members_members_get**](MembersApi.md#read_members_members_get) | **GET** /members | List members
+
+
+# **create_member_members_post**
+> Member create_member_members_post(member_in)
+
+Create member
+
+Create new member.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.MembersApi(api_client)
+    member_in = compute_api_client.MemberIn() # MemberIn | 
+
+    try:
+        # Create member
+        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 Exception as e:
+        print("Exception when calling MembersApi->create_member_members_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_in** | [**MemberIn**](MemberIn.md)|  | 
+
+### Return type
+
+[**Member**](Member.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_member_members_id_delete**
+> delete_member_members_id_delete(id)
+
+Destroy member
+
+Delete a member.
+
+### 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.MembersApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Destroy member
+        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
+------------- | ------------- | ------------- | -------------
+ **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_member_members_id_get**
+> Member read_member_members_id_get(id)
+
+Retrieve member
+
+Get member by ID.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+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(
+    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.MembersApi(api_client)
+    id = 56 # int | 
+
+    try:
+        # Retrieve member
+        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 Exception as e:
+        print("Exception when calling MembersApi->read_member_members_id_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+
+### Return type
+
+[**Member**](Member.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_members_members_get**
+> PageMember read_members_members_get(id=id, team_id=team_id, role=role, is_active=is_active, sort_by=sort_by, latest=latest, page=page, size=size)
+
+List members
+
+Read members.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+
+```python
+import compute_api_client
+from compute_api_client.models.page_member import PageMember
+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(
+    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.MembersApi(api_client)
+    id = 56 # int |  (optional)
+    team_id = 56 # int |  (optional)
+    role = compute_api_client.Role() # Role |  (optional)
+    is_active = True # bool |  (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 members
+        api_response = await api_instance.read_members_members_get(id=id, team_id=team_id, role=role, is_active=is_active, sort_by=sort_by, latest=latest, page=page, size=size)
+        print("The response of MembersApi->read_members_members_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling MembersApi->read_members_members_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | [optional] 
+ **team_id** | **int**|  | [optional] 
+ **role** | [**Role**](.md)|  | [optional] 
+ **is_active** | **bool**|  | [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
+
+[**PageMember**](PageMember.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/PageAlgorithm.md

@@ -0,0 +1,33 @@
+# PageAlgorithm
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Algorithm]**](Algorithm.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_algorithm import PageAlgorithm
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageAlgorithm from a JSON string
+page_algorithm_instance = PageAlgorithm.from_json(json)
+# print the JSON string representation of the object
+print(PageAlgorithm.to_json())
+
+# convert the object into a dict
+page_algorithm_dict = page_algorithm_instance.to_dict()
+# create an instance of PageAlgorithm from a dict
+page_algorithm_from_dict = PageAlgorithm.from_dict(page_algorithm_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/PageBackend.md

@@ -0,0 +1,33 @@
+# PageBackend
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Backend]**](Backend.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_backend import PageBackend
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageBackend from a JSON string
+page_backend_instance = PageBackend.from_json(json)
+# print the JSON string representation of the object
+print(PageBackend.to_json())
+
+# convert the object into a dict
+page_backend_dict = page_backend_instance.to_dict()
+# create an instance of PageBackend from a dict
+page_backend_from_dict = PageBackend.from_dict(page_backend_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/PageBackendType.md

@@ -0,0 +1,33 @@
+# PageBackendType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[BackendType]**](BackendType.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_backend_type import PageBackendType
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageBackendType from a JSON string
+page_backend_type_instance = PageBackendType.from_json(json)
+# print the JSON string representation of the object
+print(PageBackendType.to_json())
+
+# convert the object into a dict
+page_backend_type_dict = page_backend_type_instance.to_dict()
+# create an instance of PageBackendType from a dict
+page_backend_type_from_dict = PageBackendType.from_dict(page_backend_type_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/PageBatchJob.md

@@ -0,0 +1,33 @@
+# PageBatchJob
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[BatchJob]**](BatchJob.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_batch_job import PageBatchJob
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageBatchJob from a JSON string
+page_batch_job_instance = PageBatchJob.from_json(json)
+# print the JSON string representation of the object
+print(PageBatchJob.to_json())
+
+# convert the object into a dict
+page_batch_job_dict = page_batch_job_instance.to_dict()
+# create an instance of PageBatchJob from a dict
+page_batch_job_from_dict = PageBatchJob.from_dict(page_batch_job_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/PageCommit.md

@@ -0,0 +1,33 @@
+# PageCommit
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Commit]**](Commit.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_commit import PageCommit
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageCommit from a JSON string
+page_commit_instance = PageCommit.from_json(json)
+# print the JSON string representation of the object
+print(PageCommit.to_json())
+
+# convert the object into a dict
+page_commit_dict = page_commit_instance.to_dict()
+# create an instance of PageCommit from a dict
+page_commit_from_dict = PageCommit.from_dict(page_commit_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/PageFile.md

@@ -0,0 +1,33 @@
+# PageFile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[File]**](File.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_file import PageFile
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageFile from a JSON string
+page_file_instance = PageFile.from_json(json)
+# print the JSON string representation of the object
+print(PageFile.to_json())
+
+# convert the object into a dict
+page_file_dict = page_file_instance.to_dict()
+# create an instance of PageFile from a dict
+page_file_from_dict = PageFile.from_dict(page_file_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/PageJob.md

@@ -0,0 +1,33 @@
+# PageJob
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Job]**](Job.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_job import PageJob
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageJob from a JSON string
+page_job_instance = PageJob.from_json(json)
+# print the JSON string representation of the object
+print(PageJob.to_json())
+
+# convert the object into a dict
+page_job_dict = page_job_instance.to_dict()
+# create an instance of PageJob from a dict
+page_job_from_dict = PageJob.from_dict(page_job_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/PageLanguage.md

@@ -0,0 +1,33 @@
+# PageLanguage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Language]**](Language.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.page_language import PageLanguage
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageLanguage from a JSON string
+page_language_instance = PageLanguage.from_json(json)
+# print the JSON string representation of the object
+print(PageLanguage.to_json())
+
+# convert the object into a dict
+page_language_dict = page_language_instance.to_dict()
+# create an instance of PageLanguage from a dict
+page_language_from_dict = PageLanguage.from_dict(page_language_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)
+
+