themes_api module#

class edgeimpulse_api.api.themes_api.ThemesApi(api_client=None)[source]#

Bases: object

delete_theme(
theme_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Delete theme by ID

Delete a theme given its unique identifier.

Parameters:

  • theme_id (int) – Theme ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

get_theme(
theme_id: StrictInt[StrictInt],
**kwargs,
) → GetThemeResponse[source]#

Get theme by ID

Get a theme given its unique identifier.

Parameters:

  • theme_id (int) – Theme ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetThemeResponse

get_themes(
**kwargs,
) → GetThemesResponse[source]#

Get themes

Get all available Studio themes.

Parameters:

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetThemesResponse

update_theme_colors(
theme_id: StrictInt[StrictInt],
update_theme_colors_request: UpdateThemeColorsRequest,
**kwargs,
) → GenericApiResponse[source]#

Update theme colors

Update some or all theme colors.

Parameters:

  • theme_id (int) – Theme ID (required)

  • update_theme_colors_request (UpdateThemeColorsRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

update_theme_favicon(
theme_id: StrictInt[StrictInt],
image: StrictStr,
**kwargs,
) → GenericApiResponse[source]#

Update theme favicon

Update the theme favicon

Parameters:

  • theme_id (int) – Theme ID (required)

  • image (str) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

update_theme_logos(
theme_id: StrictInt[StrictInt],
update_theme_logos_request: UpdateThemeLogosRequest,
**kwargs,
) → GenericApiResponse[source]#

Update theme logos

Update some or all theme logos.

Parameters:

  • theme_id (int) – Theme ID (required)

  • update_theme_logos_request (UpdateThemeLogosRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse