Evo Voice

ForgotPassword

Sends a password recovery email to the email address on file

The following routes are available for this service:
POST	/auth/forgot-password

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Sends a password recovery email to the email address on file */
// @Api(Description="Sends a password recovery email to the email address on file")
class ForgotPassword implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The email address associated with the account you want to recover */
        // @ApiMember(Description="The email address associated with the account you want to recover")
        /** @var string|null */
        public ?string $emailAddress=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ForgotPassword DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth/forgot-password HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ForgotPassword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
  <EmailAddress>String</EmailAddress>
</ForgotPassword>