design-server-connector-v2

Mentortools service for getting and editing design data

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.0+2439411908
• Generator version: 7.21.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:

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:

import design_server_connector_v2

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import design_server_connector_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import design_server_connector_v2
from design_server_connector_v2.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_v2.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_v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = design_server_connector_v2.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

Documentation For Models

• AppColors
• AppColorsUpdate
• AppThemeGet
• AppThemeListGet
• AppThemeUpdate
• FontGet
• FontUpdate
• HTTPValidationError
• LocationInner
• PortalDesignSettingsGet
• PortalDesignSettingsUpdate
• PortalNewdesignSwitch
• ResponseWrapper
• ResponseWrapperAppThemeGet
• ResponseWrapperBool
• ResponseWrapperFontGet
• ResponseWrapperInt
• ResponseWrapperListAppThemeListGet
• ResponseWrapperListFontGet
• ResponseWrapperListWebThemeListGet
• ResponseWrapperPortalDesignSettingsGet
• ResponseWrapperWebThemeGet
• Result
• ThemeSetup
• ThemeType
• ValidationError
• WebColors
• WebThemeGet
• WebThemeListGet
• WebThemePatch
• WebThemeUpdate

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

APIKeyHeader

• Type: API key
• API key parameter name: server_name
• Location: HTTP header

Author