eliona.api_client.WidgetsTypesApi

All URIs are relative to https://name.eliona.io/v2

Method	HTTP request	Description
delete_widget_type_by_name	DELETE /widget-types/{widget-type-name}	Delete a widget type
get_widget_type_by_name	GET /widget-types/{widget-type-name}	Information about a widget type
get_widget_types	GET /widget-types	List of widget types
post_widget_type	POST /widget-types	Create a widget type
put_widget_type	PUT /widget-types	Create or update a widget type
put_widget_type_by_name	PUT /widget-types/{widget-type-name}	Update a widget type

delete_widget_type_by_name

delete_widget_type_by_name(widget_type_name)

Delete a widget type

Deletes a widget type and the elements for this widget type.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import widgets_types_api
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = widgets_types_api.WidgetsTypesApi(api_client)
    widget_type_name = "weather" # str | The name of the widget type

    # example passing only required values which don't have defaults set
    try:
        # Delete a widget type
        api_instance.delete_widget_type_by_name(widget_type_name)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->delete_widget_type_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
widget_type_name	str	The name of the widget type

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successfully deleted the widget type	-
404	Widget type with name not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_widget_type_by_name

WidgetType get_widget_type_by_name(widget_type_name)

Information about a widget type

Gets information about a widget type.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import widgets_types_api
from eliona.api_client.model.widget_type import WidgetType
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = widgets_types_api.WidgetsTypesApi(api_client)
    widget_type_name = "weather" # str | The name of the widget type
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Information about a widget type
        api_response = api_instance.get_widget_type_by_name(widget_type_name)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->get_widget_type_by_name: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Information about a widget type
        api_response = api_instance.get_widget_type_by_name(widget_type_name, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->get_widget_type_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
widget_type_name	str	The name of the widget type
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

WidgetType

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a widget type by name.	-
404	Widget type with name not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_widget_types

[WidgetType] get_widget_types()

List of widget types

Returns a list of widget types

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import widgets_types_api
from eliona.api_client.model.widget_type import WidgetType
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = widgets_types_api.WidgetsTypesApi(api_client)
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List of widget types
        api_response = api_instance.get_widget_types(expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->get_widget_types: %s\n" % e)

Parameters

Name	Type	Description	Notes
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

[WidgetType]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a list of widget types	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_widget_type

WidgetType post_widget_type(widget_type)

Create a widget type

Create a new widget type.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import widgets_types_api
from eliona.api_client.model.widget_type import WidgetType
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = widgets_types_api.WidgetsTypesApi(api_client)
    widget_type = WidgetType(
        name="weather",
        custom=True,
        translation=Translation(
            de="Das ist ein deutscher Text",
            en="This is an english text",
            fr="Ceci est en texte anglais",
            it="Questo è nel testo inglese",
        ),
        icon="weather",
        with_alarm=False,
        with_timespan=False,
        elements=[
            WidgetTypeElement(
                category="weather",
                sequence=1,
                config={},
            ),
        ],
    ) # WidgetType | 
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create a widget type
        api_response = api_instance.post_widget_type(widget_type)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->post_widget_type: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a widget type
        api_response = api_instance.post_widget_type(widget_type, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->post_widget_type: %s\n" % e)

Parameters

Name	Type	Description	Notes
widget_type	WidgetType
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

WidgetType

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successfully created widget type	-
409	Widget type name already exists	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_widget_type

WidgetType put_widget_type(widget_type)

Create or update a widget type

Create a new widget type or update it if already exists. Uses the unique widget type name for updating.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import widgets_types_api
from eliona.api_client.model.widget_type import WidgetType
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = widgets_types_api.WidgetsTypesApi(api_client)
    widget_type = WidgetType(
        name="weather",
        custom=True,
        translation=Translation(
            de="Das ist ein deutscher Text",
            en="This is an english text",
            fr="Ceci est en texte anglais",
            it="Questo è nel testo inglese",
        ),
        icon="weather",
        with_alarm=False,
        with_timespan=False,
        elements=[
            WidgetTypeElement(
                category="weather",
                sequence=1,
                config={},
            ),
        ],
    ) # WidgetType | 
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create or update a widget type
        api_response = api_instance.put_widget_type(widget_type)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->put_widget_type: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create or update a widget type
        api_response = api_instance.put_widget_type(widget_type, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->put_widget_type: %s\n" % e)

Parameters

Name	Type	Description	Notes
widget_type	WidgetType
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

WidgetType

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully added or updated widget type	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_widget_type_by_name

WidgetType put_widget_type_by_name(widget_type_name, widget_type)

Update a widget type

Update a widget type.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import time
import eliona.api_client
from eliona.api_client.api import widgets_types_api
from eliona.api_client.model.widget_type import WidgetType
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = widgets_types_api.WidgetsTypesApi(api_client)
    widget_type_name = "weather" # str | The name of the widget type
    widget_type = WidgetType(
        name="weather",
        custom=True,
        translation=Translation(
            de="Das ist ein deutscher Text",
            en="This is an english text",
            fr="Ceci est en texte anglais",
            it="Questo è nel testo inglese",
        ),
        icon="weather",
        with_alarm=False,
        with_timespan=False,
        elements=[
            WidgetTypeElement(
                category="weather",
                sequence=1,
                config={},
            ),
        ],
    ) # WidgetType | 
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update a widget type
        api_response = api_instance.put_widget_type_by_name(widget_type_name, widget_type)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->put_widget_type_by_name: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a widget type
        api_response = api_instance.put_widget_type_by_name(widget_type_name, widget_type, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling WidgetsTypesApi->put_widget_type_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
widget_type_name	str	The name of the widget type
widget_type	WidgetType
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

WidgetType

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully updated widget type	-
404	Widget type with name not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

WidgetsTypesApi.md

Latest commit

History

WidgetsTypesApi.md

File metadata and controls

eliona.api_client.WidgetsTypesApi

delete_widget_type_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_widget_type_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_widget_types

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_widget_type

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_widget_type

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_widget_type_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details