themes_api module

ThemesApi

class edgeimpulse_api.api.themes_api.ThemesApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

delete_theme

edgeimpulse_api.api.themes_api.delete_theme(
		self,
		theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete theme by ID

Delete a theme given its unique identifier.

Parameters

  • self

  • theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

get_theme

edgeimpulse_api.api.themes_api.get_theme(
		self,
		theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})],
		**kwargs
)> edgeimpulse_api.models.get_theme_response.GetThemeResponse

Get theme by ID

Get a theme given its unique identifier.

Parameters

  • self

  • theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]

  • **kwargs

Return

edgeimpulse_api.models.get_theme_response.GetThemeResponse

get_themes

edgeimpulse_api.api.themes_api.get_themes(
		self,
		**kwargs
)> edgeimpulse_api.models.get_themes_response.GetThemesResponse

Get themes

Get all available Studio themes.

Parameters

  • self

  • **kwargs

Return

edgeimpulse_api.models.get_themes_response.GetThemesResponse

update_theme_colors

edgeimpulse_api.api.themes_api.update_theme_colors(
		self,
		theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})],
		update_theme_colors_request: edgeimpulse_api.models.update_theme_colors_request.UpdateThemeColorsRequest,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update theme colors

Update some or all theme colors.

Parameters

  • self

  • theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]

  • update_theme_colors_request: edgeimpulse_api.models.update_theme_colors_request.UpdateThemeColorsRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_theme_favicon

edgeimpulse_api.api.themes_api.update_theme_favicon(
		self,
		theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})],
		image: pydantic.types.StrictStr,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update theme favicon

Update the theme favicon

Parameters

  • self

  • theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]

  • image: pydantic.types.StrictStr

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_theme_logos

edgeimpulse_api.api.themes_api.update_theme_logos(
		self,
		theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})],
		update_theme_logos_request: edgeimpulse_api.models.update_theme_logos_request.UpdateThemeLogosRequest,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update theme logos

Update some or all theme logos.

Parameters

  • self

  • theme_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Theme ID', extra={})]

  • update_theme_logos_request: edgeimpulse_api.models.update_theme_logos_request.UpdateThemeLogosRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

Last updated