whitelabels_api module

WhitelabelsApi

class edgeimpulse_api.api.whitelabels_api.WhitelabelsApi(
		api_client=None
)

Parameters

• api_client=None

Methods

create_whitelabel

edgeimpulse_api.api.whitelabels_api.create_whitelabel(
		self,
		create_whitelabel_request: edgeimpulse_api.models.create_whitelabel_request.CreateWhitelabelRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_whitelabel_response.CreateWhitelabelResponse

Create a new white label

Create a new white label

Parameters

• self

• create_whitelabel_request: edgeimpulse_api.models.create_whitelabel_request.CreateWhitelabelRequest

• **kwargs

Return

edgeimpulse_api.models.create_whitelabel_response.CreateWhitelabelResponse

delete_whitelabel

edgeimpulse_api.api.whitelabels_api.delete_whitelabel(
		self,
		whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Deletes a white label

Deletes the white label with the given id.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

get_all_impulse_blocks

edgeimpulse_api.api.whitelabels_api.get_all_impulse_blocks(
		self,
		whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse

Get impulse blocks

Lists all possible DSP and ML blocks available for this white label.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse

get_all_whitelabels

edgeimpulse_api.api.whitelabels_api.get_all_whitelabels(
		self,
		**kwargs
) ‑> edgeimpulse_api.models.get_all_whitelabels_response.GetAllWhitelabelsResponse

List the registered white labels

Retrieve the list of registered white labels.

Parameters

• self

• **kwargs

Return

edgeimpulse_api.models.get_all_whitelabels_response.GetAllWhitelabelsResponse

get_whitelabel

edgeimpulse_api.api.whitelabels_api.get_whitelabel(
		self,
		whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse

White label information

Retrieve all the information about this white label.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse

get_whitelabel_domain

edgeimpulse_api.api.whitelabels_api.get_whitelabel_domain(
		self,
		whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_whitelabel_domain_response.GetWhitelabelDomainResponse

Get white label domain

Get a white label domain given its unique identifier.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_whitelabel_domain_response.GetWhitelabelDomainResponse

update_deployment_targets

edgeimpulse_api.api.whitelabels_api.update_deployment_targets(
		self,
		whitelabel_identifier: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Whitelabel ID', extra={})],
		update_whitelabel_deployment_targets_request: edgeimpulse_api.models.update_whitelabel_deployment_targets_request.UpdateWhitelabelDeploymentTargetsRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update deployment targets

Update some or all of the deployment targets enabled for this white label.

Parameters

• self

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

• update_whitelabel_deployment_targets_request: edgeimpulse_api.models.update_whitelabel_deployment_targets_request.UpdateWhitelabelDeploymentTargetsRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse