send_email_verification_code `async` ¶

send_email_verification_code(
    catalog: Catalog,
    email: Email,
    *,
    config_overrides: Optional[AsyncPartnerCentralAccountClientConfig] = None,
) -> SendEmailVerificationCodeResponse

Sends an email verification code to the specified email address for account verification purposes.

Parameters:

catalog (Catalog) –

The catalog identifier for the partner account.
email (Email) –

The email address to send the verification code to.

Raises:

AccessDeniedException –

The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
InternalServerException –

An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
ServiceQuotaExceededException –

The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.
ThrottlingException –

The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.
ValidationException –

The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_partnercentral_account/_services/async_partner_central_account.py

async def send_email_verification_code(
    self,
    catalog: "capo_partnercentral_account.types.catalog.Catalog",
    email: "capo_partnercentral_account.types.email.Email",
    *,
    config_overrides: Optional[AsyncPartnerCentralAccountClientConfig] = None,
) -> "capo_partnercentral_account.types.send_email_verification_code_response.SendEmailVerificationCodeResponse":
    """<p>Sends an email verification code to the specified email address for account verification purposes.</p>

    Args:
        catalog: <p>The catalog identifier for the partner account.</p>
        email: <p>The email address to send the verification code to.</p>

    Raises:
        capo_partnercentral_account.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.</p>
        capo_partnercentral_account.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.</p>
        capo_partnercentral_account.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.</p>
        capo_partnercentral_account.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.</p>
        capo_partnercentral_account.errors.validation_exception.ValidationException: <p>The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.</p>
        capo_partnercentral_account.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_partnercentral_account.types.send_email_verification_code_request.SendEmailVerificationCodeRequest]",
    ) -> AsyncOperationResponse[
        "capo_partnercentral_account.types.send_email_verification_code_response.SendEmailVerificationCodeResponse"
    ]:
        import capo_partnercentral_account._operations.partner_central_account.send_email_verification_code

        (
            output,
            http_response,
        ) = await capo_partnercentral_account._operations.partner_central_account.send_email_verification_code.async_send_email_verification_code(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendEmailVerificationCode")
    )
    input_: capo_partnercentral_account.types.send_email_verification_code_request.SendEmailVerificationCodeRequest = {
        "catalog": catalog,
        "email": email,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

send_email_verification_code async ¶

send_email_verification_code `async` ¶