Booster.Microservices

<back to all web services

CreateWarrantyCardRequest

Requires Authentication
The following routes are available for this service:
POST/warranty/v1/site/{siteId}/card
<?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};


/**
 * @template TResponse
 */
class BaseRequest implements IRequest, JsonSerializable
{
    public array $genericArgs = [];
    public static function create(array $genericArgs=[]): BaseRequest {
        $to = new BaseRequest();
        $to->genericArgs = $genericArgs;
        return $to;
    }

    public function __construct(
        /** @var string|null */
        public mixed $sid=null,
        /** @var string|null */
        public mixed $app=null,
        /** @var string|null */
        public mixed $_os=null,
        /** @var string|null */
        public mixed $_appVersion=null,
        /** @var string|null */
        public mixed $_searchMethod=null
    ) {
    }

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

class BaseResponse implements IRespose, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $_xmlns=null,
        /** @var string|null */
        public ?string $_type=null,
        /** @var string|null */
        public ?string $_source=null,
        /** @var string|null */
        public ?string $_tstamp=null,
        /** @var string|null */
        public ?string $_user=null,
        /** @var string|null */
        public ?string $_env=null,
        /** @var string|null */
        public ?string $_uri=null,
        /** @var string|null */
        public ?string $_query=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['_xmlns'])) $this->_xmlns = $o['_xmlns'];
        if (isset($o['_type'])) $this->_type = $o['_type'];
        if (isset($o['_source'])) $this->_source = $o['_source'];
        if (isset($o['_tstamp'])) $this->_tstamp = $o['_tstamp'];
        if (isset($o['_user'])) $this->_user = $o['_user'];
        if (isset($o['_env'])) $this->_env = $o['_env'];
        if (isset($o['_uri'])) $this->_uri = $o['_uri'];
        if (isset($o['_query'])) $this->_query = $o['_query'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->_xmlns)) $o['_xmlns'] = $this->_xmlns;
        if (isset($this->_type)) $o['_type'] = $this->_type;
        if (isset($this->_source)) $o['_source'] = $this->_source;
        if (isset($this->_tstamp)) $o['_tstamp'] = $this->_tstamp;
        if (isset($this->_user)) $o['_user'] = $this->_user;
        if (isset($this->_env)) $o['_env'] = $this->_env;
        if (isset($this->_uri)) $o['_uri'] = $this->_uri;
        if (isset($this->_query)) $o['_query'] = $this->_query;
        return empty($o) ? new class(){} : $o;
    }
}

class CreateWarrantyCardResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param string|null $_xmlns
     * @param string|null $_type
     * @param string|null $_source
     * @param string|null $_tstamp
     * @param string|null $_user
     * @param string|null $_env
     * @param string|null $_uri
     * @param string|null $_query
     */
    public function __construct(
        ?string $_xmlns=null,
        ?string $_type=null,
        ?string $_source=null,
        ?string $_tstamp=null,
        ?string $_user=null,
        ?string $_env=null,
        ?string $_uri=null,
        ?string $_query=null
    ) {
        parent::__construct($_xmlns,$_type,$_source,$_tstamp,$_user,$_env,$_uri,$_query);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template BaseRequest of CreateWarrantyCardResponse
 */
class CreateWarrantyCardRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string|null $sid
     * @param string|null $app
     * @param string|null $_os
     * @param string|null $_appVersion
     * @param string|null $_searchMethod
     */
    public function __construct(
        ?string $sid=null,
        ?string $app=null,
        ?string $_os=null,
        ?string $_appVersion=null,
        ?string $_searchMethod=null,
        /** @var int */
        public int $siteId=0,
        /** @var bool|null */
        public ?bool $force=null,
        /** @var string|null */
        public ?string $ref=null,
        /** @var string|null */
        public ?string $serial=null,
        /** @var string|null */
        public ?string $invoiceNumber=null,
        /** @var DateTime|null */
        public ?DateTime $activationDate=null,
        /** @var string|null */
        public ?string $note=null,
        /** @var string|null */
        public ?string $promoterTypeId=null,
        /** @var string|null */
        public ?string $issuedBy=null,
        /** @var string|null */
        public ?string $nfcCardUID=null,
        /** @var string|null */
        public ?string $appVersion=null,
        /** @var string|null */
        public ?string $searchMethod=null,
        /** @var string|null */
        public ?string $deviceOS=null
    ) {
        parent::__construct($sid,$app,$_os,$_appVersion,$_searchMethod);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['siteId'])) $this->siteId = $o['siteId'];
        if (isset($o['force'])) $this->force = $o['force'];
        if (isset($o['ref'])) $this->ref = $o['ref'];
        if (isset($o['serial'])) $this->serial = $o['serial'];
        if (isset($o['invoiceNumber'])) $this->invoiceNumber = $o['invoiceNumber'];
        if (isset($o['activationDate'])) $this->activationDate = JsonConverters::from('DateTime', $o['activationDate']);
        if (isset($o['note'])) $this->note = $o['note'];
        if (isset($o['promoterTypeId'])) $this->promoterTypeId = $o['promoterTypeId'];
        if (isset($o['issuedBy'])) $this->issuedBy = $o['issuedBy'];
        if (isset($o['nfcCardUID'])) $this->nfcCardUID = $o['nfcCardUID'];
        if (isset($o['appVersion'])) $this->appVersion = $o['appVersion'];
        if (isset($o['searchMethod'])) $this->searchMethod = $o['searchMethod'];
        if (isset($o['deviceOS'])) $this->deviceOS = $o['deviceOS'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->siteId)) $o['siteId'] = $this->siteId;
        if (isset($this->force)) $o['force'] = $this->force;
        if (isset($this->ref)) $o['ref'] = $this->ref;
        if (isset($this->serial)) $o['serial'] = $this->serial;
        if (isset($this->invoiceNumber)) $o['invoiceNumber'] = $this->invoiceNumber;
        if (isset($this->activationDate)) $o['activationDate'] = JsonConverters::to('DateTime', $this->activationDate);
        if (isset($this->note)) $o['note'] = $this->note;
        if (isset($this->promoterTypeId)) $o['promoterTypeId'] = $this->promoterTypeId;
        if (isset($this->issuedBy)) $o['issuedBy'] = $this->issuedBy;
        if (isset($this->nfcCardUID)) $o['nfcCardUID'] = $this->nfcCardUID;
        if (isset($this->appVersion)) $o['appVersion'] = $this->appVersion;
        if (isset($this->searchMethod)) $o['searchMethod'] = $this->searchMethod;
        if (isset($this->deviceOS)) $o['deviceOS'] = $this->deviceOS;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateWarrantyCardRequest DTOs

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

HTTP + OTHER

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

POST /warranty/v1/site/{siteId}/card HTTP/1.1 
Host: qp-microservices-booster.richemont.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"siteId":0,"force":false,"ref":"String","serial":"String","invoiceNumber":"String","activationDate":"\/Date(-62135596800000-0000)\/","note":"String","promoterTypeId":"String","issuedBy":"String","nfcCardUID":"String","appVersion":"String","searchMethod":"String","deviceOS":"String","sid":"String","app":"String","_os":"String","_appVersion":"String","_searchMethod":"String"}

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

{"_xmlns":"String","_type":"String","_source":"String","_tstamp":"String","_user":"String","_env":"String","_uri":"String","_query":"String"}