organizations_api module

OrganizationsApi

class edgeimpulse_api.api.organizations_api.OrganizationsApi(
		api_client=None
)

Parameters

• api_client=None

Methods

add_organization_api_key

edgeimpulse_api.api.organizations_api.add_organization_api_key(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		add_organization_api_key_request: edgeimpulse_api.models.add_organization_api_key_request.AddOrganizationApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Add API key

Add an API key.

Parameters

• self

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

• add_organization_api_key_request: edgeimpulse_api.models.add_organization_api_key_request.AddOrganizationApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

add_organization_member

edgeimpulse_api.api.organizations_api.add_organization_member(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		add_member_request: edgeimpulse_api.models.add_member_request.AddMemberRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Add member

Add a member to an organization.

Parameters

• self

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

• add_member_request: edgeimpulse_api.models.add_member_request.AddMemberRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

create_organization

edgeimpulse_api.api.organizations_api.create_organization(
		self,
		create_organization_request: edgeimpulse_api.models.create_organization_request.CreateOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

Create new organization

Create a new organization. This is an internal API.

Parameters

• self

• create_organization_request: edgeimpulse_api.models.create_organization_request.CreateOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

delete_organization

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

Remove organization

Remove the current organization, and all data associated with it. This is irrevocable!

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

download_organization_data_export

edgeimpulse_api.api.organizations_api.download_organization_data_export(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> None

Download organization data export

Download a data export for an organization.

Parameters

• self

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

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

• **kwargs

Return

None

get_organization_data_export

edgeimpulse_api.api.organizations_api.get_organization_data_export(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

Get organization data export

Get a data export for an organization.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

get_organization_data_exports

edgeimpulse_api.api.organizations_api.get_organization_data_exports(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

Get all organization data exports

Get all data exports for an organization.

Parameters

• self

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

• limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

get_organization_info

edgeimpulse_api.api.organizations_api.get_organization_info(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.organization_info_response.OrganizationInfoResponse

Organization information

List all information about this organization.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.organization_info_response.OrganizationInfoResponse

get_organization_metrics

edgeimpulse_api.api.organizations_api.get_organization_metrics(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		exclude_edge_impulse_users: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude Edge Impulse users when counting enterprise entitlements usage', extra={})] = None,
		project_visibility: typing_extensions.Annotated[Optional[edgeimpulse_api.models.project_visibility.ProjectVisibility], FieldInfo(default=PydanticUndefined, description='What project visibility type to include when counting enterprise entitlements usage', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.organization_metrics_response.OrganizationMetricsResponse

Organization metrics

Get general metrics for this organization.

Parameters

• self

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

• exclude_edge_impulse_users: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to exclude Edge Impulse users when counting enterprise entitlements usage', extra={})] = None

• project_visibility: typing_extensions.Annotated[Optional[edgeimpulse_api.models.project_visibility.ProjectVisibility], FieldInfo(default=PydanticUndefined, description='What project visibility type to include when counting enterprise entitlements usage', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.organization_metrics_response.OrganizationMetricsResponse

invite_organization_member

edgeimpulse_api.api.organizations_api.invite_organization_member(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		invite_organization_member_request: edgeimpulse_api.models.invite_organization_member_request.InviteOrganizationMemberRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Invite member

Invite a member to an organization.

Parameters

• self

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

• invite_organization_member_request: edgeimpulse_api.models.invite_organization_member_request.InviteOrganizationMemberRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

list_organization_api_keys

edgeimpulse_api.api.organizations_api.list_organization_api_keys(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_organization_api_keys_response.ListOrganizationApiKeysResponse

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.list_organization_api_keys_response.ListOrganizationApiKeysResponse

list_organization_projects

edgeimpulse_api.api.organizations_api.list_organization_projects(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_projects_response.ListProjectsResponse

Get projects

Retrieve all projects for the organization.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.list_projects_response.ListProjectsResponse

list_organizations

edgeimpulse_api.api.organizations_api.list_organizations(
		self,
		**kwargs
) ‑> edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse

List active organizations

Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.

Parameters

• self

• **kwargs

Return

edgeimpulse_api.models.list_organizations_response.ListOrganizationsResponse

remove_organization_member

edgeimpulse_api.api.organizations_api.remove_organization_member(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		remove_member_request: edgeimpulse_api.models.remove_member_request.RemoveMemberRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove member

Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.

Parameters

• self

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

• remove_member_request: edgeimpulse_api.models.remove_member_request.RemoveMemberRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

request_enterprise_trial_extension

edgeimpulse_api.api.organizations_api.request_enterprise_trial_extension(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		enterprise_upgrade_or_trial_extension_request: edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Request trial extension

Request an extension for an enterprise trial.

Parameters

• self

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

• enterprise_upgrade_or_trial_extension_request: edgeimpulse_api.models.enterprise_upgrade_or_trial_extension_request.EnterpriseUpgradeOrTrialExtensionRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

resend_organization_member_invite

edgeimpulse_api.api.organizations_api.resend_organization_member_invite(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		member_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Resend invitation

Resend an invitation to a member in an organization.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

revoke_organization_api_key

edgeimpulse_api.api.organizations_api.revoke_organization_api_key(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		api_key_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Revoke API key

Revoke an API key.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_organization_member_datasets

edgeimpulse_api.api.organizations_api.set_organization_member_datasets(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		member_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})],
		set_member_datasets_request: edgeimpulse_api.models.set_member_datasets_request.SetMemberDatasetsRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set member datasets

Set the datasets a guest member has access to in an organization.

Parameters

• self

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

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

• set_member_datasets_request: edgeimpulse_api.models.set_member_datasets_request.SetMemberDatasetsRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_organization_member_role

edgeimpulse_api.api.organizations_api.set_organization_member_role(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		member_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Member ID', extra={})],
		set_member_role_request: edgeimpulse_api.models.set_member_role_request.SetMemberRoleRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set member role

Change the role of a member in an organization.

Parameters

• self

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

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

• set_member_role_request: edgeimpulse_api.models.set_member_role_request.SetMemberRoleRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

test_organization_admin

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

Admin endpoint

Test endpoint that can only be reached with admin rights.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_organization

edgeimpulse_api.api.organizations_api.update_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_organization_request: edgeimpulse_api.models.update_organization_request.UpdateOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update organization

Update organization properties such as name and logo.

Parameters

• self

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

• update_organization_request: edgeimpulse_api.models.update_organization_request.UpdateOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

upload_organization_header

edgeimpulse_api.api.organizations_api.upload_organization_header(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: Optional[pydantic.types.StrictStr] = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

Upload organization header image

Uploads and updates the organization header image

Parameters

• self

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

• image: Optional[pydantic.types.StrictStr] = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

upload_organization_logo

edgeimpulse_api.api.organizations_api.upload_organization_logo(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: Optional[pydantic.types.StrictStr] = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

Upload organization logo

Uploads and updates the organization logo

Parameters

• self

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

• image: Optional[pydantic.types.StrictStr] = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

upload_organization_readme_image

edgeimpulse_api.api.organizations_api.upload_organization_readme_image(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: pydantic.types.StrictStr,
		**kwargs
) ‑> edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse

Upload image for readme

Uploads an image to the user CDN and returns the path.

Parameters

• self

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

• image: pydantic.types.StrictStr

• **kwargs

Return

edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse

whitelabel_admin_add_development_board

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_development_board(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		development_board_request: Optional[edgeimpulse_api.models.development_board_request.DevelopmentBoardRequest] = None,
		**kwargs
) ‑> edgeimpulse_api.models.development_board_created_response.DevelopmentBoardCreatedResponse

White Label Admin - Add a development board to a whitelabel

White label admin only API to add a development board.

Parameters

• self

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

• development_board_request: Optional[edgeimpulse_api.models.development_board_request.DevelopmentBoardRequest] = None

• **kwargs

Return

edgeimpulse_api.models.development_board_created_response.DevelopmentBoardCreatedResponse

whitelabel_admin_add_organization_api_key

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_organization_api_key(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_add_organization_api_key_request: edgeimpulse_api.models.admin_add_organization_api_key_request.AdminAddOrganizationApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Add organization API key

White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_add_organization_api_key_request: edgeimpulse_api.models.admin_add_organization_api_key_request.AdminAddOrganizationApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_add_project_api_key

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_project_api_key(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		admin_add_project_api_key_request: edgeimpulse_api.models.admin_add_project_api_key_request.AdminAddProjectApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Add Project API key

White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.

Parameters

• self

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

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

• admin_add_project_api_key_request: edgeimpulse_api.models.admin_add_project_api_key_request.AdminAddProjectApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_add_user_to_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_user_to_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_add_organization_user_request: Optional[edgeimpulse_api.models.admin_add_organization_user_request.AdminAddOrganizationUserRequest] = None,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Add user to an organization

White label admin only API to add a user to an organization. If no user is provided, the current user is used.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_add_organization_user_request: Optional[edgeimpulse_api.models.admin_add_organization_user_request.AdminAddOrganizationUserRequest] = None

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_add_user_to_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_add_user_to_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		admin_add_project_user_request: Optional[edgeimpulse_api.models.admin_add_project_user_request.AdminAddProjectUserRequest] = None,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Add user to a project

White label admin only API to add a user to a project. If no user is provided, the current user is used.

Parameters

• self

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

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

• admin_add_project_user_request: Optional[edgeimpulse_api.models.admin_add_project_user_request.AdminAddProjectUserRequest] = None

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_create_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		whitelabel_admin_create_organization_request: edgeimpulse_api.models.whitelabel_admin_create_organization_request.WhitelabelAdminCreateOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

White Label Admin - Create new organization within white label context

Create a new organization. This is an API only available to white label admins

Parameters

• self

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

• whitelabel_admin_create_organization_request: edgeimpulse_api.models.whitelabel_admin_create_organization_request.WhitelabelAdminCreateOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.create_organization_response.CreateOrganizationResponse

whitelabel_admin_create_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization_export(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_create_organization_data_export_request: edgeimpulse_api.models.admin_create_organization_data_export_request.AdminCreateOrganizationDataExportRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

White Label Admin - Create a new organization data export

Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_create_organization_data_export_request: edgeimpulse_api.models.admin_create_organization_data_export_request.AdminCreateOrganizationDataExportRequest

• **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

whitelabel_admin_create_organization_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_project_response.CreateProjectResponse

White Label Admin - Create a new organization project

White label admin only API to create a new project for an organization.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.create_project_response.CreateProjectResponse

whitelabel_admin_create_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_organization_usage_report(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})],
		end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

White Label Admin - Creates a new usage report

Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]

• end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]

• **kwargs

Return

edgeimpulse_api.models.start_job_response.StartJobResponse

whitelabel_admin_create_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_create_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_project_response.CreateProjectResponse

White Label Admin - Create a new project within white label context.

Create a new free tier project. This is an API only available to white label admins.

Parameters

• self

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

• admin_create_project_request: edgeimpulse_api.models.admin_create_project_request.AdminCreateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.create_project_response.CreateProjectResponse

whitelabel_admin_delete_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Delete an organization

White label admin only API to delete an organization.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_delete_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_organization_export(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Delete organization data export

Delete a data export for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_delete_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_organization_usage_report(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		usage_report_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Usage report ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Delete usage report

Delete a usage report for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_delete_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Delete a project

White label admin only API to delete a project.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_delete_user

edgeimpulse_api.api.organizations_api.whitelabel_admin_delete_user(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete a user

White label admin only API to delete a user.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_download_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_download_organization_usage_report(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		usage_report_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Usage report ID', extra={})],
		**kwargs
) ‑> None

White Label Admin - Download usage report

Download a usage report for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• **kwargs

Return

None

whitelabel_admin_get_info

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

White Label Admin - Get white label information

White label admin only API to get the white label information.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.get_whitelabel_response.GetWhitelabelResponse

whitelabel_admin_get_metrics

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_metrics(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_metrics_response.AdminGetMetricsResponse

White Label Admin - Get global white label metrics

White label admin only API to get global metrics.

Parameters

• self

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

• **kwargs

Return

edgeimpulse_api.models.admin_get_metrics_response.AdminGetMetricsResponse

whitelabel_admin_get_organization_compute_time_usage

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_compute_time_usage(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})],
		end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_organization_compute_time_usage_response.AdminGetOrganizationComputeTimeUsageResponse

White Label Admin - Get organization compute time usage

Get compute time usage for an organization over a period of time. This is an API only available to white label admins

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• start_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})]

• end_date: typing_extensions.Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})]

• **kwargs

Return

edgeimpulse_api.models.admin_get_organization_compute_time_usage_response.AdminGetOrganizationComputeTimeUsageResponse

whitelabel_admin_get_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_export(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

White Label Admin - Get organization data export

Get a data export for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_export_response.GetOrganizationDataExportResponse

whitelabel_admin_get_organization_exports

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_exports(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

White Label Admin - Get all organization data exports

Get all data exports for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_organization_data_exports_response.GetOrganizationDataExportsResponse

whitelabel_admin_get_organization_info

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_info(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		include_deleted: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_organization_info_response.AdminOrganizationInfoResponse

White Label Admin - Get organization information

White label admin only API to list all information about an organization.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• include_deleted: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_organization_info_response.AdminOrganizationInfoResponse

whitelabel_admin_get_organization_usage_report

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_usage_report(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		usage_report_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Usage report ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_organization_usage_report_response.AdminGetOrganizationUsageReportResponse

White Label Admin - Get usage report

Get a usage report for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• **kwargs

Return

edgeimpulse_api.models.admin_get_organization_usage_report_response.AdminGetOrganizationUsageReportResponse

whitelabel_admin_get_organization_usage_reports

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organization_usage_reports(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_organization_usage_reports_response.AdminGetOrganizationUsageReportsResponse

White Label Admin - Get all usage reports

Get all usage reports for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_get_organization_usage_reports_response.AdminGetOrganizationUsageReportsResponse

whitelabel_admin_get_organizations

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_organizations(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None,
		include_deleted: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None,
		sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None,
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_organizations_response.AdminGetOrganizationsResponse

White Label Admin - Get all organizations within a white label

White label admin only API to get the list of all organizations.

Parameters

• self

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

• active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None

• include_deleted: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include deleted entities (users, projects, orgs)', extra={})] = None

• sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None

• limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_get_organizations_response.AdminGetOrganizationsResponse

whitelabel_admin_get_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.project_info_response.ProjectInfoResponse

White Label Admin - Get a white label project

White label admin only API to get project information.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.project_info_response.ProjectInfoResponse

whitelabel_admin_get_projects

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_projects(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None,
		sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None,
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_list_projects_response.AdminListProjectsResponse

White Label Admin - Get all white label projects

White label admin only API to get the list of all projects.

Parameters

• self

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

• active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None

• sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None

• limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_list_projects_response.AdminListProjectsResponse

whitelabel_admin_get_user

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_user(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_user_response.AdminGetUserResponse

White Label Admin - Get a white label user

White label admin only API to get information about a user.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.admin_get_user_response.AdminGetUserResponse

whitelabel_admin_get_user_metrics

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_user_metrics(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_user_metrics_response.AdminGetUserMetricsResponse

White Label Admin - Get white label user metrics

White label admin only API to get marketing metrics about a user.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.admin_get_user_metrics_response.AdminGetUserMetricsResponse

whitelabel_admin_get_users

edgeimpulse_api.api.organizations_api.whitelabel_admin_get_users(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None,
		tier: typing_extensions.Annotated[Optional[edgeimpulse_api.models.user_tier_enum.UserTierEnum], FieldInfo(default=PydanticUndefined, description='Whether to search for free, community plus, professional, or enterprise entities (users, projects)', extra={})] = None,
		fields: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Comma separated list of fields to fetch in a query', extra={})] = None,
		sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None,
		limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.admin_get_users_response.AdminGetUsersResponse

White Label Admin - Get all white label users

White label admin only API to get the list of all registered users.

Parameters

• self

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

• active: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Whether to search for entities (users, orgs) active in the last X days', extra={})] = None

• tier: typing_extensions.Annotated[Optional[edgeimpulse_api.models.user_tier_enum.UserTierEnum], FieldInfo(default=PydanticUndefined, description='Whether to search for free, community plus, professional, or enterprise entities (users, projects)', extra={})] = None

• fields: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Comma separated list of fields to fetch in a query', extra={})] = None

• sort: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None

• limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• search: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Search query', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.admin_get_users_response.AdminGetUsersResponse

whitelabel_admin_remove_development_board

edgeimpulse_api.api.organizations_api.whitelabel_admin_remove_development_board(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		development_board_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Development board ID.', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Remove a development board from a whitelabel

White label admin only API to remove a development board.

Parameters

• self

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_remove_user_from_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_remove_user_from_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Remove user from an organization

White label admin only API to remove a user from an organization.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_remove_user_from_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_remove_user_from_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Remove user from a project

White label admin only API to remove a user from a project.

Parameters

• self

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

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

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

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_restore_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_restore_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Restore an organization

White label admin only API to restore a deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_default_deployment_target

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_default_deployment_target(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_whitelabel_default_deployment_target_request: edgeimpulse_api.models.update_whitelabel_default_deployment_target_request.UpdateWhitelabelDefaultDeploymentTargetRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update default deployment target

White label admin only API to update the default deployment target for this white label.

Parameters

• self

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

• update_whitelabel_default_deployment_target_request: edgeimpulse_api.models.update_whitelabel_default_deployment_target_request.UpdateWhitelabelDefaultDeploymentTargetRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_deployment_options_order

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_deployment_options_order(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_whitelabel_deployment_options_order_request: edgeimpulse_api.models.update_whitelabel_deployment_options_order_request.UpdateWhitelabelDeploymentOptionsOrderRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update the order of deployment options in the deployment view

White label admin only API to customize the order of deployment options in the deployment view for this white label.

Parameters

• self

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

• update_whitelabel_deployment_options_order_request: edgeimpulse_api.models.update_whitelabel_deployment_options_order_request.UpdateWhitelabelDeploymentOptionsOrderRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_deployment_targets

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

White Label Admin - Update deployment targets

White label admin only API to update some or all of the deployment targets enabled for this white label.

Parameters

• self

• organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization 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

whitelabel_admin_update_development_board

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_development_board(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		development_board_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Development board ID.', extra={})],
		development_board_request_update: Optional[edgeimpulse_api.models.development_board_request_update.DevelopmentBoardRequestUpdate] = None,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update a development board in a whitelabel

White label admin only API to update a development board.

Parameters

• self

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

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

• development_board_request_update: Optional[edgeimpulse_api.models.development_board_request_update.DevelopmentBoardRequestUpdate] = None

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_development_board_image

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_development_board_image(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		development_board_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Development board ID.', extra={})],
		image: Optional[pydantic.types.StrictStr] = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

White Label Admin - Update the image of a whitelabel development board

White label admin only API to update the image of a development board.

Parameters

• self

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

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

• image: Optional[pydantic.types.StrictStr] = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

whitelabel_admin_update_info

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_info(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_whitelabel_request: edgeimpulse_api.models.update_whitelabel_request.UpdateWhitelabelRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update white label information

White label admin only API to update the white label information.

Parameters

• self

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

• update_whitelabel_request: edgeimpulse_api.models.update_whitelabel_request.UpdateWhitelabelRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_learning_blocks

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_learning_blocks(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_whitelabel_learning_blocks_request: edgeimpulse_api.models.update_whitelabel_learning_blocks_request.UpdateWhitelabelLearningBlocksRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update learning blocks

White label admin only API to update some or all of the learning blocks enabled for this white label.

Parameters

• self

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

• update_whitelabel_learning_blocks_request: edgeimpulse_api.models.update_whitelabel_learning_blocks_request.UpdateWhitelabelLearningBlocksRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_organization

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_organization(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		admin_update_organization_request: edgeimpulse_api.models.admin_update_organization_request.AdminUpdateOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update organization

White label admin only API to update organization properties such as name and logo.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

• admin_update_organization_request: edgeimpulse_api.models.admin_update_organization_request.AdminUpdateOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_organization_export

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_organization_export(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})],
		export_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Export ID', extra={})],
		admin_update_organization_data_export_request: edgeimpulse_api.models.admin_update_organization_data_export_request.AdminUpdateOrganizationDataExportRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update organization data export

Update a data export for an organization. This is an API only available to white label admins.

Parameters

• self

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

• inner_organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID within the context of a white label', extra={})]

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

• admin_update_organization_data_export_request: edgeimpulse_api.models.admin_update_organization_data_export_request.AdminUpdateOrganizationDataExportRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_project

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_project(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		update_project_request: edgeimpulse_api.models.update_project_request.UpdateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update white label project

White label admin only API to update project properties.

Parameters

• self

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

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

• update_project_request: edgeimpulse_api.models.update_project_request.UpdateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_theme_colors

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_theme_colors(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		update_theme_colors_request: edgeimpulse_api.models.update_theme_colors_request.UpdateThemeColorsRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update theme colors

White label admin only API to update some or all theme colors.

Parameters

• self

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

• update_theme_colors_request: edgeimpulse_api.models.update_theme_colors_request.UpdateThemeColorsRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_theme_device_logo

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_theme_device_logo(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: Optional[pydantic.types.StrictStr] = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

White Label Admin - Update theme device logo

White label admin only API to update the white label theme device logo.

Parameters

• self

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

• image: Optional[pydantic.types.StrictStr] = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

whitelabel_admin_update_theme_favicon

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_theme_favicon(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: pydantic.types.StrictStr,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update theme favicon

White label admin only API to update the theme favicon.

Parameters

• self

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

• image: pydantic.types.StrictStr

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

whitelabel_admin_update_theme_logo

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_theme_logo(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		image: Optional[pydantic.types.StrictStr] = None,
		**kwargs
) ‑> edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

White Label Admin - Update theme logo

White label admin only API to update the white label theme logo.

Parameters

• self

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

• image: Optional[pydantic.types.StrictStr] = None

• **kwargs

Return

edgeimpulse_api.models.upload_asset_response.UploadAssetResponse

whitelabel_admin_update_user

edgeimpulse_api.api.organizations_api.whitelabel_admin_update_user(
		self,
		organization_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		admin_update_user_request: edgeimpulse_api.models.admin_update_user_request.AdminUpdateUserRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

White Label Admin - Update white label user

White label admin only API to update user properties.

Parameters

• self

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

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

• admin_update_user_request: edgeimpulse_api.models.admin_update_user_request.AdminUpdateUserRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse