# design-server-connector
Mentortools service for getting and editing design data

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

- API version: 0.1.0
- Package version: 0.1.0+2376437399
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

## Requirements.

Python 3.7+

## 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 design_server_connector
```

### 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 design_server_connector
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import time
import design_server_connector
from design_server_connector.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 = design_server_connector.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: APIKeyHeader
configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
async with design_server_connector.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = design_server_connector.DefaultApi(api_client)

    try:
        # Active App Design Get
        api_response = await api_instance.active_app_design_get_v1_app_design_active_get()
        print("The response of DefaultApi->active_app_design_get_v1_app_design_active_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->active_app_design_get_v1_app_design_active_get: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**active_app_design_get_v1_app_design_active_get**](docs/DefaultApi.md#active_app_design_get_v1_app_design_active_get) | **GET** /v1/app/design/active | Active App Design Get
*DefaultApi* | [**active_web_design_get_v1_web_design_active_get**](docs/DefaultApi.md#active_web_design_get_v1_web_design_active_get) | **GET** /v1/web/design/active | Active Web Design Get
*DefaultApi* | [**app_designs_custom_get_v1_app_design_custom_get**](docs/DefaultApi.md#app_designs_custom_get_v1_app_design_custom_get) | **GET** /v1/app/design/custom | App Designs Custom Get
*DefaultApi* | [**app_designs_custom_update_v1_app_design_custom_post**](docs/DefaultApi.md#app_designs_custom_update_v1_app_design_custom_post) | **POST** /v1/app/design/custom | App Designs Custom Update
*DefaultApi* | [**app_designs_get_v1_app_design_get**](docs/DefaultApi.md#app_designs_get_v1_app_design_get) | **GET** /v1/app/design/ | App Designs Get
*DefaultApi* | [**font_delete_v1_fonts_font_id_delete**](docs/DefaultApi.md#font_delete_v1_fonts_font_id_delete) | **DELETE** /v1/fonts/{font_id} | Font Delete
*DefaultApi* | [**font_get_v1_fonts_font_id_get**](docs/DefaultApi.md#font_get_v1_fonts_font_id_get) | **GET** /v1/fonts/{font_id} | Font Get
*DefaultApi* | [**font_update_v1_fonts_font_id_patch**](docs/DefaultApi.md#font_update_v1_fonts_font_id_patch) | **PATCH** /v1/fonts/{font_id} | Font Update
*DefaultApi* | [**font_upload_v1_fonts_post**](docs/DefaultApi.md#font_upload_v1_fonts_post) | **POST** /v1/fonts/ | Font Upload
*DefaultApi* | [**fonts_get_v1_fonts_get**](docs/DefaultApi.md#fonts_get_v1_fonts_get) | **GET** /v1/fonts/ | Fonts Get
*DefaultApi* | [**health_check_get**](docs/DefaultApi.md#health_check_get) | **GET** / | Health Check
*DefaultApi* | [**portal_design_settings_get_v1_portal_settings_get**](docs/DefaultApi.md#portal_design_settings_get_v1_portal_settings_get) | **GET** /v1/portal/settings/ | Portal Design Settings Get
*DefaultApi* | [**portal_design_settings_update_v1_portal_settings_patch**](docs/DefaultApi.md#portal_design_settings_update_v1_portal_settings_patch) | **PATCH** /v1/portal/settings/ | Portal Design Settings Update
*DefaultApi* | [**web_designs_custom_get_v1_web_design_custom_get**](docs/DefaultApi.md#web_designs_custom_get_v1_web_design_custom_get) | **GET** /v1/web/design/custom | Web Designs Custom Get
*DefaultApi* | [**web_designs_custom_update_v1_web_design_custom_post**](docs/DefaultApi.md#web_designs_custom_update_v1_web_design_custom_post) | **POST** /v1/web/design/custom | Web Designs Custom Update
*DefaultApi* | [**web_designs_get_v1_web_design_get**](docs/DefaultApi.md#web_designs_get_v1_web_design_get) | **GET** /v1/web/design/ | Web Designs Get
*DefaultApi* | [**web_newdesign_get_v1_web_design_newdesign_get**](docs/DefaultApi.md#web_newdesign_get_v1_web_design_newdesign_get) | **GET** /v1/web/design/newdesign | Web Newdesign Get
*DefaultApi* | [**web_newdesign_update_v1_web_design_newdesign_post**](docs/DefaultApi.md#web_newdesign_update_v1_web_design_newdesign_post) | **POST** /v1/web/design/newdesign | Web Newdesign Update


## Documentation For Models

 - [AppColors](docs/AppColors.md)
 - [AppColorsUpdate](docs/AppColorsUpdate.md)
 - [AppThemeGet](docs/AppThemeGet.md)
 - [AppThemeListGet](docs/AppThemeListGet.md)
 - [AppThemeUpdate](docs/AppThemeUpdate.md)
 - [FontGet](docs/FontGet.md)
 - [FontUpdate](docs/FontUpdate.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [LocationInner](docs/LocationInner.md)
 - [PortalDesignSettingsGet](docs/PortalDesignSettingsGet.md)
 - [PortalDesignSettingsUpdate](docs/PortalDesignSettingsUpdate.md)
 - [PortalNewdesignSwitch](docs/PortalNewdesignSwitch.md)
 - [ResponseWrapper](docs/ResponseWrapper.md)
 - [ResponseWrapperAppThemeGet](docs/ResponseWrapperAppThemeGet.md)
 - [ResponseWrapperBool](docs/ResponseWrapperBool.md)
 - [ResponseWrapperFontGet](docs/ResponseWrapperFontGet.md)
 - [ResponseWrapperInt](docs/ResponseWrapperInt.md)
 - [ResponseWrapperListAppThemeListGet](docs/ResponseWrapperListAppThemeListGet.md)
 - [ResponseWrapperListFontGet](docs/ResponseWrapperListFontGet.md)
 - [ResponseWrapperListWebThemeListGet](docs/ResponseWrapperListWebThemeListGet.md)
 - [ResponseWrapperPortalDesignSettingsGet](docs/ResponseWrapperPortalDesignSettingsGet.md)
 - [ResponseWrapperWebThemeGet](docs/ResponseWrapperWebThemeGet.md)
 - [Result](docs/Result.md)
 - [ThemeSetup](docs/ThemeSetup.md)
 - [ThemeType](docs/ThemeType.md)
 - [ValidationError](docs/ValidationError.md)
 - [WebColors](docs/WebColors.md)
 - [WebThemeGet](docs/WebThemeGet.md)
 - [WebThemeListGet](docs/WebThemeListGet.md)
 - [WebThemeUpdate](docs/WebThemeUpdate.md)


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


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

- **Type**: Bearer authentication

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

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


## Author




