| POST | /payment/billmate/apisettings/test | Test Qvickly api settings | Test Qvickly api settings for the logged in company |
|---|
<?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};
class QvicklyApiSettingsTestResponse implements JsonSerializable
{
public function __construct(
/** @description If the settings works or not */
// @ApiMember(Description="If the settings works or not")
/** @var bool|null */
public ?bool $Success=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Success'])) $this->Success = $o['Success'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Success)) $o['Success'] = $this->Success;
return empty($o) ? new class(){} : $o;
}
}
// @ValidateRequest(Validator="IsAuthenticated")
class TestQvicklyApiSettingsQuery implements ICompany, JsonSerializable
{
public function __construct(
/** @description The company id, if empty will use the company id for the user you are logged in with. */
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description The Qvickly Id */
// @ApiMember(Description="The Qvickly Id")
/** @var int */
public int $Id=0,
/** @description The Qvickly secret */
// @ApiMember(Description="The Qvickly secret")
/** @var string|null */
public ?string $Secret=null,
/** @description The Qvickly receiver email */
// @ApiMember(Description="The Qvickly receiver email")
/** @var string|null */
public ?string $ReceiverEmail=null,
/** @description The Qvickly receiver firstname */
// @ApiMember(Description="The Qvickly receiver firstname")
/** @var string|null */
public ?string $ReceiverFirstname=null,
/** @description The Qvickly receiver lastname */
// @ApiMember(Description="The Qvickly receiver lastname")
/** @var string|null */
public ?string $ReceiverLastname=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Secret'])) $this->Secret = $o['Secret'];
if (isset($o['ReceiverEmail'])) $this->ReceiverEmail = $o['ReceiverEmail'];
if (isset($o['ReceiverFirstname'])) $this->ReceiverFirstname = $o['ReceiverFirstname'];
if (isset($o['ReceiverLastname'])) $this->ReceiverLastname = $o['ReceiverLastname'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Secret)) $o['Secret'] = $this->Secret;
if (isset($this->ReceiverEmail)) $o['ReceiverEmail'] = $this->ReceiverEmail;
if (isset($this->ReceiverFirstname)) $o['ReceiverFirstname'] = $this->ReceiverFirstname;
if (isset($this->ReceiverLastname)) $o['ReceiverLastname'] = $this->ReceiverLastname;
return empty($o) ? new class(){} : $o;
}
}
PHP TestQvicklyApiSettingsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /payment/billmate/apisettings/test HTTP/1.1
Host: api.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Secret":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Success":false}