Booklinker.API

PutAccountRequest

The following routes are available for this service:
PUT	/v1/account

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


// @DataContract
class V2BaseResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="responseStatus")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class PutAccountResponseData implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="oneTimeToken")
        /** @var string|null */
        public ?string $oneTimeToken=null
    ) {
    }

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

// @DataContract
class PutAccountResponse extends V2BaseResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        // @DataMember(Name="data")
        /** @var PutAccountResponseData|null */
        public ?PutAccountResponseData $data=null
    ) {
        parent::__construct($responseStatus);
    }

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

enum SignatureAppearance : string
{
    case None = 'none';
    case Text = 'text';
    case Upload = 'upload';
}

// @DataContract
class PutAccountRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="emailAddress")
        /** @var string|null */
        public ?string $emailAddress=null,

        // @DataMember(Name="fullName")
        /** @var string|null */
        public ?string $fullName=null,

        // @DataMember(Name="profileImageId")
        /** @var string|null */
        public ?string $profileImageId=null,

        // @DataMember(Name="signatureImageId")
        /** @var string|null */
        public ?string $signatureImageId=null,

        // @DataMember(Name="signatureFont")
        /** @var string|null */
        public ?string $signatureFont=null,

        // @DataMember(Name="signatureAppearance")
        /** @var SignatureAppearance|null */
        public ?SignatureAppearance $signatureAppearance=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
        if (isset($o['fullName'])) $this->fullName = $o['fullName'];
        if (isset($o['profileImageId'])) $this->profileImageId = $o['profileImageId'];
        if (isset($o['signatureImageId'])) $this->signatureImageId = $o['signatureImageId'];
        if (isset($o['signatureFont'])) $this->signatureFont = $o['signatureFont'];
        if (isset($o['signatureAppearance'])) $this->signatureAppearance = JsonConverters::from('SignatureAppearance', $o['signatureAppearance']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
        if (isset($this->fullName)) $o['fullName'] = $this->fullName;
        if (isset($this->profileImageId)) $o['profileImageId'] = $this->profileImageId;
        if (isset($this->signatureImageId)) $o['signatureImageId'] = $this->signatureImageId;
        if (isset($this->signatureFont)) $o['signatureFont'] = $this->signatureFont;
        if (isset($this->signatureAppearance)) $o['signatureAppearance'] = JsonConverters::to('SignatureAppearance', $this->signatureAppearance);
        return empty($o) ? new class(){} : $o;
    }
}

PHP PutAccountRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /v1/account HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"newEmail":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"success":false,"oneTimeToken":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}