ConsumerApi

ResetPasswordRequest

Consumer

The following routes are available for this service:
POST	/recovery/reset_password

<?php namespace ConsumerApi;

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};


enum Locale : string
{
    case EnUs = 'EnUs';
    case NbNo = 'NbNo';
}

class DateOfBirth implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $year=0,
        /** @var int */
        public int $month=0,
        /** @var int */
        public int $dayOfMonth=0
    ) {
    }

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

enum Sex : string
{
    case Male = 'Male';
    case Female = 'Female';
}

class UserAddress implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $streetName='',
        /** @var string */
        public string $streetNumber='',
        /** @var string */
        public string $postalCode='',
        /** @var string */
        public string $region='',
        /** @var string */
        public string $countryCode=''
    ) {
    }

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

class HomeLocation implements JsonSerializable
{
    public function __construct(
        /** @var UserAddress|null */
        public ?UserAddress $address=null,
        /** @var float */
        public float $latitude=0.0,
        /** @var float */
        public float $longitude=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['address'])) $this->address = JsonConverters::from('UserAddress', $o['address']);
        if (isset($o['latitude'])) $this->latitude = $o['latitude'];
        if (isset($o['longitude'])) $this->longitude = $o['longitude'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->address)) $o['address'] = JsonConverters::to('UserAddress', $this->address);
        if (isset($this->latitude)) $o['latitude'] = $this->latitude;
        if (isset($this->longitude)) $o['longitude'] = $this->longitude;
        return empty($o) ? new class(){} : $o;
    }
}

enum DistanceUnit : string
{
    case Kilometer = 'Kilometer';
    case Mile = 'Mile';
}

PHP ResetPasswordRequest DTOs

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

HTTP + JSV

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

POST /recovery/reset_password HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	verifiedToken: String,
	newPassword: String,
	newPasswordConfirmation: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	userProfile: 
	{
		locale: EnUs,
		firstName: String,
		lastName: String,
		profilePhotoUrl: String,
		mobilePhone: String,
		mobilePhoneVerified: False,
		email: String,
		emailVerified: False,
		hasPassword: False,
		dateOfBirth: 
		{
			year: 0,
			month: 0,
			dayOfMonth: 0
		},
		sex: Male,
		home: 
		{
			address: 
			{
				streetName: String,
				streetNumber: String,
				postalCode: String,
				region: String,
				countryCode: String
			},
			latitude: 0,
			longitude: 0
		},
		showDistancesIn: Kilometer,
		legalIdentityVerified: False,
		managesPlacesInBusinessWeb: False,
		pointsTotal: 0
	},
	passwordScore: 0
}