ebiose-cloud-client 0.1.137
Backend
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Backend

# ebiose-cloud-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 0.1.137
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import ebiose_cloud_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import ebiose_cloud_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ebiose_cloud_client
from ebiose_cloud_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 = ebiose_cloud_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.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): Bearer
configuration = ebiose_cloud_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with ebiose_cloud_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ebiose_cloud_client.ApiKeyApi(api_client)
    api_key_input_model = ebiose_cloud_client.ApiKeyInputModel() # ApiKeyInputModel | 

    try:
        api_response = await api_instance.add_api_key(api_key_input_model)
        print("The response of ApiKeyApi->add_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiKeyApi->add_api_key: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiKeyApi* | [**add_api_key**](docs/ApiKeyApi.md#add_api_key) | **POST** /apikeys | 
*ApiKeyApi* | [**delete_api_key**](docs/ApiKeyApi.md#delete_api_key) | **DELETE** /apikeys/{apiKeyUuid} | 
*ApiKeyApi* | [**get_api_key**](docs/ApiKeyApi.md#get_api_key) | **GET** /apikeys/{apiKeyUuid} | 
*ApiKeyApi* | [**get_api_keys**](docs/ApiKeyApi.md#get_api_keys) | **GET** /apikeys | 
*ApiKeyApi* | [**self_add_api_key**](docs/ApiKeyApi.md#self_add_api_key) | **POST** /apikeys/self | 
*ApiKeyApi* | [**self_delete_api_key**](docs/ApiKeyApi.md#self_delete_api_key) | **DELETE** /apikeys/self/{apiKeyUuid} | 
*ApiKeyApi* | [**self_get_api_keys**](docs/ApiKeyApi.md#self_get_api_keys) | **GET** /apikeys/self | 
*ApiKeyApi* | [**update_api_key**](docs/ApiKeyApi.md#update_api_key) | **PUT** /apikeys/{apiKeyUuid} | 
*AuthEndpointsApi* | [**login**](docs/AuthEndpointsApi.md#login) | **POST** /auth/login | 
*AuthEndpointsApi* | [**login_github**](docs/AuthEndpointsApi.md#login_github) | **GET** /auth/github/login | 
*AuthEndpointsApi* | [**refresh_token**](docs/AuthEndpointsApi.md#refresh_token) | **GET** /auth/refresh-token | 
*AuthEndpointsApi* | [**self_update**](docs/AuthEndpointsApi.md#self_update) | **PUT** /auth/self-update | 
*AuthEndpointsApi* | [**sign_up**](docs/AuthEndpointsApi.md#sign_up) | **POST** /auth/signup | 
*AuthEndpointsApi* | [**update_password**](docs/AuthEndpointsApi.md#update_password) | **PUT** /auth/update-password | 
*AuthEndpointsApi* | [**user_info**](docs/AuthEndpointsApi.md#user_info) | **GET** /auth/user-info | 
*BackendApi* | [**root_get**](docs/BackendApi.md#root_get) | **GET** / | 
*EcosystemEndpointsApi* | [**ecosystems_ecosystem_uuid_agent_agent_uuid_get**](docs/EcosystemEndpointsApi.md#ecosystems_ecosystem_uuid_agent_agent_uuid_get) | **GET** /ecosystems/{ecosystemUuid}/agent/{agentUuid} | 
*EcosystemEndpointsApi* | [**ecosystems_ecosystem_uuid_agent_agent_uuid_put**](docs/EcosystemEndpointsApi.md#ecosystems_ecosystem_uuid_agent_agent_uuid_put) | **PUT** /ecosystems/{ecosystemUuid}/agent/{agentUuid} | 
*EcosystemEndpointsApi* | [**ecosystems_ecosystem_uuid_agent_post**](docs/EcosystemEndpointsApi.md#ecosystems_ecosystem_uuid_agent_post) | **POST** /ecosystems/{ecosystemUuid}/agent | 
*EcosystemEndpointsApi* | [**ecosystems_ecosystem_uuid_agents_delete**](docs/EcosystemEndpointsApi.md#ecosystems_ecosystem_uuid_agents_delete) | **DELETE** /ecosystems/{ecosystemUuid}/agents | 
*EcosystemEndpointsApi* | [**ecosystems_ecosystem_uuid_agents_get**](docs/EcosystemEndpointsApi.md#ecosystems_ecosystem_uuid_agents_get) | **GET** /ecosystems/{ecosystemUuid}/agents | 
*EcosystemEndpointsApi* | [**ecosystems_ecosystem_uuid_agents_post**](docs/EcosystemEndpointsApi.md#ecosystems_ecosystem_uuid_agents_post) | **POST** /ecosystems/{ecosystemUuid}/agents | 
*EcosystemEndpointsApi* | [**ecosystems_get**](docs/EcosystemEndpointsApi.md#ecosystems_get) | **GET** /ecosystems | 
*EcosystemEndpointsApi* | [**ecosystems_post**](docs/EcosystemEndpointsApi.md#ecosystems_post) | **POST** /ecosystems | 
*EcosystemEndpointsApi* | [**ecosystems_uuid_delete**](docs/EcosystemEndpointsApi.md#ecosystems_uuid_delete) | **DELETE** /ecosystems/{uuid} | 
*EcosystemEndpointsApi* | [**ecosystems_uuid_get**](docs/EcosystemEndpointsApi.md#ecosystems_uuid_get) | **GET** /ecosystems/{uuid} | 
*EcosystemEndpointsApi* | [**ecosystems_uuid_put**](docs/EcosystemEndpointsApi.md#ecosystems_uuid_put) | **PUT** /ecosystems/{uuid} | 
*ForgeEndpointsApi* | [**add_agent_during_forge_cycle**](docs/ForgeEndpointsApi.md#add_agent_during_forge_cycle) | **POST** /forges/cycles/{forgeCycleUuid}/agent | 
*ForgeEndpointsApi* | [**add_agents_during_forge_cycle**](docs/ForgeEndpointsApi.md#add_agents_during_forge_cycle) | **POST** /forges/cycles/{forgeCycleUuid}/agents | 
*ForgeEndpointsApi* | [**delete_forge**](docs/ForgeEndpointsApi.md#delete_forge) | **DELETE** /forges/{forgeUuid} | 
*ForgeEndpointsApi* | [**end_forge_cycle**](docs/ForgeEndpointsApi.md#end_forge_cycle) | **POST** /forges/cycles/{forgeCycleUuid}/end | 
*ForgeEndpointsApi* | [**forges_cycles_forge_cycle_uuid_deduct_compute_banks_post**](docs/ForgeEndpointsApi.md#forges_cycles_forge_cycle_uuid_deduct_compute_banks_post) | **POST** /forges/cycles/{forgeCycleUuid}/deduct-compute-banks | 
*ForgeEndpointsApi* | [**forges_cycles_forge_cycle_uuid_select_agents_get**](docs/ForgeEndpointsApi.md#forges_cycles_forge_cycle_uuid_select_agents_get) | **GET** /forges/cycles/{forgeCycleUuid}/select-agents | 
*ForgeEndpointsApi* | [**forges_cycles_forge_cycle_uuid_usage_post**](docs/ForgeEndpointsApi.md#forges_cycles_forge_cycle_uuid_usage_post) | **POST** /forges/cycles/{forgeCycleUuid}/usage | 
*ForgeEndpointsApi* | [**get_forge**](docs/ForgeEndpointsApi.md#get_forge) | **GET** /forges/{forgeUuid} | 
*ForgeEndpointsApi* | [**get_forge_cycles**](docs/ForgeEndpointsApi.md#get_forge_cycles) | **GET** /forges/cycles | 
*ForgeEndpointsApi* | [**get_forges**](docs/ForgeEndpointsApi.md#get_forges) | **GET** /forges | 
*ForgeEndpointsApi* | [**get_spend**](docs/ForgeEndpointsApi.md#get_spend) | **GET** /forges/cycles/{forgeCycleUuid}/spend | 
*ForgeEndpointsApi* | [**start_new_forge_cycle**](docs/ForgeEndpointsApi.md#start_new_forge_cycle) | **POST** /forges/cycles/start | 
*ForgeEndpointsApi* | [**update_forge**](docs/ForgeEndpointsApi.md#update_forge) | **PUT** /forges/{forgeUuid} | 
*FrontApiApi* | [**front_api_agents_agent_uuid_get**](docs/FrontApiApi.md#front_api_agents_agent_uuid_get) | **GET** /front-api/agents/{agentUuid} | 
*FrontApiApi* | [**front_api_agents_get**](docs/FrontApiApi.md#front_api_agents_get) | **GET** /front-api/agents | 
*UsersApi* | [**users_email_email_get**](docs/UsersApi.md#users_email_email_get) | **GET** /users/email/{email} | 
*UsersApi* | [**users_get**](docs/UsersApi.md#users_get) | **GET** /users | 
*UsersApi* | [**users_post**](docs/UsersApi.md#users_post) | **POST** /users | 
*UsersApi* | [**users_user_uuid_delete**](docs/UsersApi.md#users_user_uuid_delete) | **DELETE** /users/{userUuid} | 
*UsersApi* | [**users_user_uuid_get**](docs/UsersApi.md#users_user_uuid_get) | **GET** /users/{userUuid} | 
*UsersApi* | [**users_user_uuid_put**](docs/UsersApi.md#users_user_uuid_put) | **PUT** /users/{userUuid} | 


## Documentation For Models

 - [AgentInputModel](docs/AgentInputModel.md)
 - [AgentModelInputModel](docs/AgentModelInputModel.md)
 - [AgentModelOutputModel](docs/AgentModelOutputModel.md)
 - [AgentModelType](docs/AgentModelType.md)
 - [AgentOutputModel](docs/AgentOutputModel.md)
 - [AgentType](docs/AgentType.md)
 - [ApiKeyInputModel](docs/ApiKeyInputModel.md)
 - [ApiKeyOutputModel](docs/ApiKeyOutputModel.md)
 - [EcosystemInputModel](docs/EcosystemInputModel.md)
 - [EcosystemOutputModel](docs/EcosystemOutputModel.md)
 - [ForgeCycleInputModel](docs/ForgeCycleInputModel.md)
 - [ForgeCycleOutputModel](docs/ForgeCycleOutputModel.md)
 - [ForgeCycleStatus](docs/ForgeCycleStatus.md)
 - [ForgeInputModel](docs/ForgeInputModel.md)
 - [ForgeOutputModel](docs/ForgeOutputModel.md)
 - [FrontApiAgentDetailsOutputModel](docs/FrontApiAgentDetailsOutputModel.md)
 - [FrontApiAgentOutputModel](docs/FrontApiAgentOutputModel.md)
 - [LoginInputModel](docs/LoginInputModel.md)
 - [LoginOutputModel](docs/LoginOutputModel.md)
 - [NewCycleOutputModel](docs/NewCycleOutputModel.md)
 - [NodeModel](docs/NodeModel.md)
 - [NodeType](docs/NodeType.md)
 - [Role](docs/Role.md)
 - [SelfApiKeyInputModel](docs/SelfApiKeyInputModel.md)
 - [SelfUserInputModel](docs/SelfUserInputModel.md)
 - [SignupInputModel](docs/SignupInputModel.md)
 - [StartForgeCycleInputModel](docs/StartForgeCycleInputModel.md)
 - [UserInputModel](docs/UserInputModel.md)
 - [UserOutputModel](docs/UserOutputModel.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKey"></a>
### ApiKey

- **Type**: API key
- **API key parameter name**: ApiKey
- **Location**: HTTP header

<a id="Bearer"></a>
### Bearer

- **Type**: Bearer authentication (JWT)


## Author