| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /settings/changelog | Get change log for settings | Returns a log of all changes made to company settings. Supports filtering and pagination via AutoQuery. |
|---|
<?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 QueryBase implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var int|null */
public ?int $Skip=null,
// @DataMember(Order=2)
/** @var int|null */
public ?int $Take=null,
// @DataMember(Order=3)
/** @var string|null */
public ?string $OrderBy=null,
// @DataMember(Order=4)
/** @var string|null */
public ?string $OrderByDesc=null,
// @DataMember(Order=5)
/** @var string|null */
public ?string $Include=null,
// @DataMember(Order=6)
/** @var string|null */
public ?string $Fields=null,
// @DataMember(Order=7)
/** @var array<string,string>|null */
public ?array $Meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Skip'])) $this->Skip = $o['Skip'];
if (isset($o['Take'])) $this->Take = $o['Take'];
if (isset($o['OrderBy'])) $this->OrderBy = $o['OrderBy'];
if (isset($o['OrderByDesc'])) $this->OrderByDesc = $o['OrderByDesc'];
if (isset($o['Include'])) $this->Include = $o['Include'];
if (isset($o['Fields'])) $this->Fields = $o['Fields'];
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Skip)) $o['Skip'] = $this->Skip;
if (isset($this->Take)) $o['Take'] = $this->Take;
if (isset($this->OrderBy)) $o['OrderBy'] = $this->OrderBy;
if (isset($this->OrderByDesc)) $o['OrderByDesc'] = $this->OrderByDesc;
if (isset($this->Include)) $o['Include'] = $this->Include;
if (isset($this->Fields)) $o['Fields'] = $this->Fields;
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template From
* @template Into
*/
class QueryDb2 extends QueryBase implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryDb2 {
$to = new QueryDb2();
$to->genericArgs = $genericArgs;
return $to;
}
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
mixed $Skip=null,
mixed $Take=null,
mixed $OrderBy=null,
mixed $OrderByDesc=null,
mixed $Include=null,
mixed $Fields=null,
mixed $Meta=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @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;
}
}
class SettingsChangeLogQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The change log entry id */
// @ApiMember(Description="The change log entry id")
/** @var int */
public int $Id=0,
/** @description The company id */
// @ApiMember(Description="The company id")
/** @var string */
public string $CompanyId='',
/** @description The settings type that was changed, e.g. BookingSettings */
// @ApiMember(Description="The settings type that was changed, e.g. BookingSettings")
/** @var string */
public string $SettingsType='',
/** @description The property name that was changed */
// @ApiMember(Description="The property name that was changed")
/** @var string */
public string $PropertyName='',
/** @description The value before the change */
// @ApiMember(Description="The value before the change")
/** @var string|null */
public ?string $OldValue=null,
/** @description The value after the change */
// @ApiMember(Description="The value after the change")
/** @var string|null */
public ?string $NewValue=null,
/** @description The user who made the change */
// @ApiMember(Description="The user who made the change")
/** @var string|null */
public ?string $ModifiedBy=null,
/** @description When the change was made */
// @ApiMember(Description="When the change was made")
/** @var DateTime */
public DateTime $CreatedDate=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['SettingsType'])) $this->SettingsType = $o['SettingsType'];
if (isset($o['PropertyName'])) $this->PropertyName = $o['PropertyName'];
if (isset($o['OldValue'])) $this->OldValue = $o['OldValue'];
if (isset($o['NewValue'])) $this->NewValue = $o['NewValue'];
if (isset($o['ModifiedBy'])) $this->ModifiedBy = $o['ModifiedBy'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->SettingsType)) $o['SettingsType'] = $this->SettingsType;
if (isset($this->PropertyName)) $o['PropertyName'] = $this->PropertyName;
if (isset($this->OldValue)) $o['OldValue'] = $this->OldValue;
if (isset($this->NewValue)) $o['NewValue'] = $this->NewValue;
if (isset($this->ModifiedBy)) $o['ModifiedBy'] = $this->ModifiedBy;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
return empty($o) ? new class(){} : $o;
}
}
class BaseModel implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
class SettingsChangeLog extends BaseModel implements IBaseModelCreated, JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
// @Required()
/** @var string */
public string $CompanyId='',
// @Required()
// @StringLength(128)
/** @var string */
public string $SettingsType='',
// @Required()
// @StringLength(256)
/** @var string */
public string $PropertyName='',
// @StringLength(2147483647)
/** @var string|null */
public ?string $OldValue=null,
// @StringLength(2147483647)
/** @var string|null */
public ?string $NewValue=null,
// @StringLength(256)
/** @var string|null */
public ?string $ModifiedBy=null,
// @Required()
/** @var DateTime */
public DateTime $CreatedDate=new DateTime(),
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['SettingsType'])) $this->SettingsType = $o['SettingsType'];
if (isset($o['PropertyName'])) $this->PropertyName = $o['PropertyName'];
if (isset($o['OldValue'])) $this->OldValue = $o['OldValue'];
if (isset($o['NewValue'])) $this->NewValue = $o['NewValue'];
if (isset($o['ModifiedBy'])) $this->ModifiedBy = $o['ModifiedBy'];
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->SettingsType)) $o['SettingsType'] = $this->SettingsType;
if (isset($this->PropertyName)) $o['PropertyName'] = $this->PropertyName;
if (isset($this->OldValue)) $o['OldValue'] = $this->OldValue;
if (isset($this->NewValue)) $o['NewValue'] = $this->NewValue;
if (isset($this->ModifiedBy)) $o['ModifiedBy'] = $this->ModifiedBy;
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
/**
* @template QueryDb2 of SettingsChangeLog
* @template QueryDb21 of SettingsChangeLogQueryResponse
*/
class SettingsChangeLogQuery extends QueryDb2 implements ICompany, JsonSerializable
{
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
?int $Skip=null,
?int $Take=null,
?string $OrderBy=null,
?string $OrderByDesc=null,
?string $Include=null,
?string $Fields=null,
?array $Meta=null,
/** @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.", ParameterType="query")
/** @var string|null */
public ?string $CompanyId=null,
/** @description Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings */
// @ApiMember(Description="Filter by settings type, e.g. BookingSettings, PaymentSettings, CompanySetting, EAccountingSettings", ParameterType="query")
/** @var string|null */
public ?string $SettingsType=null,
/** @description Filter by property name, e.g. SendEmailReminder */
// @ApiMember(Description="Filter by property name, e.g. SendEmailReminder", ParameterType="query")
/** @var string|null */
public ?string $PropertyName=null,
/** @description Filter by who made the change */
// @ApiMember(Description="Filter by who made the change", ParameterType="query")
/** @var string|null */
public ?string $ModifiedBy=null,
/** @description Filter changes created on or after this date */
// @ApiMember(Description="Filter changes created on or after this date", ParameterType="query")
/** @var DateTime|null */
public ?DateTime $CreatedDateGreaterThanOrEqualTo=null,
/** @description Filter changes created on or before this date */
// @ApiMember(Description="Filter changes created on or before this date", ParameterType="query")
/** @var DateTime|null */
public ?DateTime $CreatedDateLessThanOrEqualTo=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['SettingsType'])) $this->SettingsType = $o['SettingsType'];
if (isset($o['PropertyName'])) $this->PropertyName = $o['PropertyName'];
if (isset($o['ModifiedBy'])) $this->ModifiedBy = $o['ModifiedBy'];
if (isset($o['CreatedDateGreaterThanOrEqualTo'])) $this->CreatedDateGreaterThanOrEqualTo = JsonConverters::from('DateTime', $o['CreatedDateGreaterThanOrEqualTo']);
if (isset($o['CreatedDateLessThanOrEqualTo'])) $this->CreatedDateLessThanOrEqualTo = JsonConverters::from('DateTime', $o['CreatedDateLessThanOrEqualTo']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->SettingsType)) $o['SettingsType'] = $this->SettingsType;
if (isset($this->PropertyName)) $o['PropertyName'] = $this->PropertyName;
if (isset($this->ModifiedBy)) $o['ModifiedBy'] = $this->ModifiedBy;
if (isset($this->CreatedDateGreaterThanOrEqualTo)) $o['CreatedDateGreaterThanOrEqualTo'] = JsonConverters::to('DateTime', $this->CreatedDateGreaterThanOrEqualTo);
if (isset($this->CreatedDateLessThanOrEqualTo)) $o['CreatedDateLessThanOrEqualTo'] = JsonConverters::to('DateTime', $this->CreatedDateLessThanOrEqualTo);
return empty($o) ? new class(){} : $o;
}
}
class AccessKeyTypeResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string */
public string $KeyType='',
/** @var string */
public string $Description=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['KeyType'])) $this->KeyType = $o['KeyType'];
if (isset($o['Description'])) $this->Description = $o['Description'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->KeyType)) $o['KeyType'] = $this->KeyType;
if (isset($this->Description)) $o['Description'] = $this->Description;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
/**
* @template T
*/
class QueryResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryResponse {
$to = new QueryResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var int */
public mixed $Offset=0,
// @DataMember(Order=2)
/** @var int */
public mixed $Total=0,
// @DataMember(Order=3)
/** @var array<AccessKeyTypeResponse>|null */
public mixed $Results=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public mixed $Meta=null,
// @DataMember(Order=5)
/** @var ResponseStatus|null */
public mixed $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Offset'])) $this->Offset = $o['Offset'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('AccessKeyTypeResponse', $o['Results']);
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Offset)) $o['Offset'] = $this->Offset;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('AccessKeyTypeResponse', $this->Results);
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
PHP SettingsChangeLogQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /settings/changelog HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
SettingsType: String,
PropertyName: String,
OldValue: String,
NewValue: String,
ModifiedBy: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}