email_verification_api module

EmailVerificationApi

class edgeimpulse_api.api.email_verification_api.EmailVerificationApi(
		api_client=None
)

Parameters

• api_client=None

Methods

get_email_verification_status

edgeimpulse_api.api.email_verification_api.get_email_verification_status(
		self,
		email_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Unique identifier for an email verification request', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_email_verification_status_response.GetEmailVerificationStatusResponse

Get email verification status

Get the status of an email verification.

Parameters

• self

• email_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Unique identifier for an email verification request', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_email_verification_status_response.GetEmailVerificationStatusResponse

request_email_verification

edgeimpulse_api.api.email_verification_api.request_email_verification(
		self,
		email: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Email address', extra={})],
		request_email_verification_request: edgeimpulse_api.models.request_email_verification_request.RequestEmailVerificationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

Request email verification

Request an email activation code to be sent to the specified email address.

Parameters

• self

• email: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Email address', extra={})]

• request_email_verification_request: edgeimpulse_api.models.request_email_verification_request.RequestEmailVerificationRequest

• **kwargs

Return

edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

verify_email

edgeimpulse_api.api.email_verification_api.verify_email(
		self,
		activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest,
		**kwargs
) ‑> edgeimpulse_api.models.verify_email_response.VerifyEmailResponse

Verify email

Verify an email address using the specified verification code.

Parameters

• self

• activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest

• **kwargs

Return

edgeimpulse_api.models.verify_email_response.VerifyEmailResponse