email_verification_api module#

class edgeimpulse_api.api.email_verification_api.EmailVerificationApi(api_client=None)[source]#

Bases: object

get_email_verification_status(
email_id: StrictInt[StrictInt],
**kwargs,
) → GetEmailVerificationStatusResponse[source]#

Get email verification status

Get the status of an email verification.

Parameters:

  • email_id (int) – Unique identifier for an email verification request (required)

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

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

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

Returns:

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

Return type:

GetEmailVerificationStatusResponse

request_email_verification(
email: StrictStr[StrictStr],
request_email_verification_request: RequestEmailVerificationRequest,
**kwargs,
) → EntityCreatedResponse[source]#

Request email verification

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

Parameters:

  • email (str) – Email address (required)

  • request_email_verification_request (RequestEmailVerificationRequest) – (required)

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

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

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

Returns:

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

Return type:

EntityCreatedResponse

verify_email(
activate_user_or_verify_email_request: ActivateUserOrVerifyEmailRequest,
**kwargs,
) → VerifyEmailResponse[source]#

Verify email

Verify an email address using the specified verification code.

Parameters:

  • activate_user_or_verify_email_request (ActivateUserOrVerifyEmailRequest) – (required)

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

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

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

Returns:

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

Return type:

VerifyEmailResponse