Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /licenses/company | Find licenses for the logged in users company | Find licenses for the logged in users 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};
// @DataContract
class QueryBase implements JsonSerializable
{
public function __construct(
/** @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
// @DataMember(Order=1)
/** @var int|null */
public ?int $Skip=null,
/** @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
// @DataMember(Order=2)
/** @var int|null */
public ?int $Take=null,
/** @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
// @DataMember(Order=3)
/** @var string|null */
public ?string $OrderBy=null,
/** @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
// @DataMember(Order=4)
/** @var string|null */
public ?string $OrderByDesc=null,
/** @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
// @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 LicenseItemsResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $Name=null,
/** @var int */
public int $AllowedItems=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['AllowedItems'])) $this->AllowedItems = $o['AllowedItems'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->AllowedItems)) $o['AllowedItems'] = $this->AllowedItems;
return empty($o) ? new class(){} : $o;
}
}
class BaseModel implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
class Currency extends BaseModel implements JsonSerializable
{
public function __construct(
// @Required()
/** @var string */
public string $Name='',
// @Required()
/** @var string */
public string $CurrencySign='',
// @Required()
/** @var bool|null */
public ?bool $Active=null,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
// @Required()
/** @var string */
public string $Id=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['CurrencySign'])) $this->CurrencySign = $o['CurrencySign'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->CurrencySign)) $o['CurrencySign'] = $this->CurrencySign;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
class Country extends BaseModel implements JsonSerializable
{
public function __construct(
// @References("typeof(BokaMera.API.ServiceModel.Db.Currency)")
/** @var string|null */
public ?string $CurrencyId=null,
/** @var Currency|null */
public ?Currency $CurrencyInfo=null,
// @Required()
/** @var string */
public string $Name='',
/** @var string|null */
public ?string $Culture=null,
/** @var string|null */
public ?string $TimeZone=null,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
// @Required()
/** @var string */
public string $Id=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['CurrencyId'])) $this->CurrencyId = $o['CurrencyId'];
if (isset($o['CurrencyInfo'])) $this->CurrencyInfo = JsonConverters::from('Currency', $o['CurrencyInfo']);
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Culture'])) $this->Culture = $o['Culture'];
if (isset($o['TimeZone'])) $this->TimeZone = $o['TimeZone'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CurrencyId)) $o['CurrencyId'] = $this->CurrencyId;
if (isset($this->CurrencyInfo)) $o['CurrencyInfo'] = JsonConverters::to('Currency', $this->CurrencyInfo);
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Culture)) $o['Culture'] = $this->Culture;
if (isset($this->TimeZone)) $o['TimeZone'] = $this->TimeZone;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
class LicensePrice extends BaseModel implements JsonSerializable
{
public function __construct(
// @Ignore()
/** @var Country|null */
public ?Country $Country=null,
// @Ignore()
/** @var bool|null */
public ?bool $MonthlyPayment=null,
// @Required()
/** @var int */
public int $LicenseTypeId=0,
// @Required()
/** @var string */
public string $CountryId='',
// @Required()
/** @var int */
public int $Price=0,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Country'])) $this->Country = JsonConverters::from('Country', $o['Country']);
if (isset($o['MonthlyPayment'])) $this->MonthlyPayment = $o['MonthlyPayment'];
if (isset($o['LicenseTypeId'])) $this->LicenseTypeId = $o['LicenseTypeId'];
if (isset($o['CountryId'])) $this->CountryId = $o['CountryId'];
if (isset($o['Price'])) $this->Price = $o['Price'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Country)) $o['Country'] = JsonConverters::to('Country', $this->Country);
if (isset($this->MonthlyPayment)) $o['MonthlyPayment'] = $this->MonthlyPayment;
if (isset($this->LicenseTypeId)) $o['LicenseTypeId'] = $this->LicenseTypeId;
if (isset($this->CountryId)) $o['CountryId'] = $this->CountryId;
if (isset($this->Price)) $o['Price'] = $this->Price;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
return empty($o) ? new class(){} : $o;
}
}
class LicenseTypeQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The license type id */
// @ApiMember(Description="The license type id")
/** @var int */
public int $Id=0,
/** @description The license type name */
// @ApiMember(Description="The license type name")
/** @var string|null */
public ?string $Name=null,
/** @description The license type description */
// @ApiMember(Description="The license type description")
/** @var string|null */
public ?string $Description=null,
/** @description If the license type is not a standard license but instead an extra license option. An example would be sending new letter license. */
// @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")
/** @var bool|null */
public ?bool $IsExtraLicenseOption=null,
/** @description The period of notice for the license in days. */
// @ApiMember(Description="The period of notice for the license in days.")
/** @var int */
public int $PeriodOfNoticeDays=0,
/** @description The license items for the license type */
// @ApiMember(Description="The license items for the license type")
/** @var array<LicenseItemsResponse>|null */
public ?array $Items=null,
/** @description The license prices in each country for the license type */
// @ApiMember(Description="The license prices in each country for the license type")
/** @var array<LicensePrice>|null */
public ?array $Prices=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['IsExtraLicenseOption'])) $this->IsExtraLicenseOption = $o['IsExtraLicenseOption'];
if (isset($o['PeriodOfNoticeDays'])) $this->PeriodOfNoticeDays = $o['PeriodOfNoticeDays'];
if (isset($o['Items'])) $this->Items = JsonConverters::fromArray('LicenseItemsResponse', $o['Items']);
if (isset($o['Prices'])) $this->Prices = JsonConverters::fromArray('LicensePrice', $o['Prices']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->IsExtraLicenseOption)) $o['IsExtraLicenseOption'] = $this->IsExtraLicenseOption;
if (isset($this->PeriodOfNoticeDays)) $o['PeriodOfNoticeDays'] = $this->PeriodOfNoticeDays;
if (isset($this->Items)) $o['Items'] = JsonConverters::toArray('LicenseItemsResponse', $this->Items);
if (isset($this->Prices)) $o['Prices'] = JsonConverters::toArray('LicensePrice', $this->Prices);
return empty($o) ? new class(){} : $o;
}
}
class CompanyLicenseQueryResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var int */
public int $TypeId=0,
/** @var LicenseTypeQueryResponse|null */
public ?LicenseTypeQueryResponse $Type=null,
/** @var DateTime */
public DateTime $ValidFrom=new DateTime(),
/** @var DateTime */
public DateTime $ValidTo=new DateTime(),
/** @var string|null */
public ?string $MetaData=null,
/** @var bool|null */
public ?bool $Active=null,
/** @var bool|null */
public ?bool $Canceled=null,
/** @var DateTime */
public DateTime $Updated=new DateTime(),
/** @var DateTime */
public DateTime $Created=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['TypeId'])) $this->TypeId = $o['TypeId'];
if (isset($o['Type'])) $this->Type = JsonConverters::from('LicenseTypeQueryResponse', $o['Type']);
if (isset($o['ValidFrom'])) $this->ValidFrom = JsonConverters::from('DateTime', $o['ValidFrom']);
if (isset($o['ValidTo'])) $this->ValidTo = JsonConverters::from('DateTime', $o['ValidTo']);
if (isset($o['MetaData'])) $this->MetaData = $o['MetaData'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['Canceled'])) $this->Canceled = $o['Canceled'];
if (isset($o['Updated'])) $this->Updated = JsonConverters::from('DateTime', $o['Updated']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->TypeId)) $o['TypeId'] = $this->TypeId;
if (isset($this->Type)) $o['Type'] = JsonConverters::to('LicenseTypeQueryResponse', $this->Type);
if (isset($this->ValidFrom)) $o['ValidFrom'] = JsonConverters::to('DateTime', $this->ValidFrom);
if (isset($this->ValidTo)) $o['ValidTo'] = JsonConverters::to('DateTime', $this->ValidTo);
if (isset($this->MetaData)) $o['MetaData'] = $this->MetaData;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->Canceled)) $o['Canceled'] = $this->Canceled;
if (isset($this->Updated)) $o['Updated'] = JsonConverters::to('DateTime', $this->Updated);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
return empty($o) ? new class(){} : $o;
}
}
class LicenseTypeItem extends BaseModel implements JsonSerializable
{
public function __construct(
// @Ignore()
/** @var string|null */
public ?string $Name=null,
// @Ignore()
/** @var LicenseType|null */
public ?LicenseType $LicenseType=null,
// @Required()
/** @var int */
public int $LicenseTypesId=0,
// @Required()
/** @var int */
public int $LicenseItemsId=0,
// @Required()
/** @var int */
public int $NumberOfItems=0,
/** @var int */
public int $Id=0,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['LicenseType'])) $this->LicenseType = JsonConverters::from('LicenseType', $o['LicenseType']);
if (isset($o['LicenseTypesId'])) $this->LicenseTypesId = $o['LicenseTypesId'];
if (isset($o['LicenseItemsId'])) $this->LicenseItemsId = $o['LicenseItemsId'];
if (isset($o['NumberOfItems'])) $this->NumberOfItems = $o['NumberOfItems'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->LicenseType)) $o['LicenseType'] = JsonConverters::to('LicenseType', $this->LicenseType);
if (isset($this->LicenseTypesId)) $o['LicenseTypesId'] = $this->LicenseTypesId;
if (isset($this->LicenseItemsId)) $o['LicenseItemsId'] = $this->LicenseItemsId;
if (isset($this->NumberOfItems)) $o['NumberOfItems'] = $this->NumberOfItems;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
return empty($o) ? new class(){} : $o;
}
}
class LicenseType extends BaseModel implements JsonSerializable
{
public function __construct(
// @Ignore()
/** @var array<LicenseTypeItem>|null */
public ?array $LicenseItems=null,
// @Ignore()
/** @var array<LicensePrice>|null */
public ?array $Prices=null,
// @Ignore()
/** @var int */
public int $PeriodOfNoticeDays=0,
// @Ignore()
/** @var LicenseType|null */
public ?LicenseType $NextLicenseOption=null,
// @Required()
/** @var string */
public string $Name='',
// @Required()
/** @var string */
public string $Description='',
// @Required()
/** @var bool|null */
public ?bool $ExtraLicenseOption=null,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
/** @var bool|null */
public ?bool $Active=null,
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['LicenseItems'])) $this->LicenseItems = JsonConverters::fromArray('LicenseTypeItem', $o['LicenseItems']);
if (isset($o['Prices'])) $this->Prices = JsonConverters::fromArray('LicensePrice', $o['Prices']);
if (isset($o['PeriodOfNoticeDays'])) $this->PeriodOfNoticeDays = $o['PeriodOfNoticeDays'];
if (isset($o['NextLicenseOption'])) $this->NextLicenseOption = JsonConverters::from('LicenseType', $o['NextLicenseOption']);
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ExtraLicenseOption'])) $this->ExtraLicenseOption = $o['ExtraLicenseOption'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->LicenseItems)) $o['LicenseItems'] = JsonConverters::toArray('LicenseTypeItem', $this->LicenseItems);
if (isset($this->Prices)) $o['Prices'] = JsonConverters::toArray('LicensePrice', $this->Prices);
if (isset($this->PeriodOfNoticeDays)) $o['PeriodOfNoticeDays'] = $this->PeriodOfNoticeDays;
if (isset($this->NextLicenseOption)) $o['NextLicenseOption'] = JsonConverters::to('LicenseType', $this->NextLicenseOption);
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ExtraLicenseOption)) $o['ExtraLicenseOption'] = $this->ExtraLicenseOption;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
class License extends BaseModel implements JsonSerializable
{
public function __construct(
/** @var LicenseType|null */
public ?LicenseType $Type=null,
// @Required()
/** @var string */
public string $CompanyId='',
/** @var int */
public int $Id=0,
// @Required()
/** @var int */
public int $TypeId=0,
// @Required()
/** @var DateTime */
public DateTime $ValidFrom=new DateTime(),
// @Required()
/** @var DateTime */
public DateTime $ValidTo=new DateTime(),
// @Required()
/** @var bool|null */
public ?bool $Active=null,
// @Required()
/** @var DateTime */
public DateTime $Updated=new DateTime(),
// @Required()
/** @var DateTime */
public DateTime $Created=new DateTime(),
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
/** @var string|null */
public ?string $MetaData=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Type'])) $this->Type = JsonConverters::from('LicenseType', $o['Type']);
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['TypeId'])) $this->TypeId = $o['TypeId'];
if (isset($o['ValidFrom'])) $this->ValidFrom = JsonConverters::from('DateTime', $o['ValidFrom']);
if (isset($o['ValidTo'])) $this->ValidTo = JsonConverters::from('DateTime', $o['ValidTo']);
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['Updated'])) $this->Updated = JsonConverters::from('DateTime', $o['Updated']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['MetaData'])) $this->MetaData = $o['MetaData'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Type)) $o['Type'] = JsonConverters::to('LicenseType', $this->Type);
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->TypeId)) $o['TypeId'] = $this->TypeId;
if (isset($this->ValidFrom)) $o['ValidFrom'] = JsonConverters::to('DateTime', $this->ValidFrom);
if (isset($this->ValidTo)) $o['ValidTo'] = JsonConverters::to('DateTime', $this->ValidTo);
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->Updated)) $o['Updated'] = JsonConverters::to('DateTime', $this->Updated);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->MetaData)) $o['MetaData'] = $this->MetaData;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
/**
* @template QueryDb2 of License
* @template QueryDb21 of CompanyLicenseQueryResponse
*/
class CompanyLicenseQuery extends QueryDb2 implements 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.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description If you want to include the connected license items */
// @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
/** @var bool|null */
public ?bool $OnlyActiveLicenses=null,
/** @description What country you want to list the prices for */
// @ApiMember(DataType="string", Description="What country you want to list the prices for")
/** @var string|null */
public ?string $CountryId=null,
/** @description Search by the Meta data information on the license */
// @ApiMember(DataType="string", Description="Search by the Meta data information on the license")
/** @var string|null */
public ?string $MetaData=null,
/** @description Id of the license type */
// @ApiMember(Description="Id of the license type")
/** @var int|null */
public ?int $TypeId=null,
/** @description If you want to only select Extra license options */
// @ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")
/** @var bool|null */
public ?bool $IsExtraLicenseOption=null,
/** @description If you want to include the connected license items */
// @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeLicenseItems=null,
/** @description If you want to include the connected licens prices */
// @ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeLicensePrices=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=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['OnlyActiveLicenses'])) $this->OnlyActiveLicenses = $o['OnlyActiveLicenses'];
if (isset($o['CountryId'])) $this->CountryId = $o['CountryId'];
if (isset($o['MetaData'])) $this->MetaData = $o['MetaData'];
if (isset($o['TypeId'])) $this->TypeId = $o['TypeId'];
if (isset($o['IsExtraLicenseOption'])) $this->IsExtraLicenseOption = $o['IsExtraLicenseOption'];
if (isset($o['IncludeLicenseItems'])) $this->IncludeLicenseItems = $o['IncludeLicenseItems'];
if (isset($o['IncludeLicensePrices'])) $this->IncludeLicensePrices = $o['IncludeLicensePrices'];
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->OnlyActiveLicenses)) $o['OnlyActiveLicenses'] = $this->OnlyActiveLicenses;
if (isset($this->CountryId)) $o['CountryId'] = $this->CountryId;
if (isset($this->MetaData)) $o['MetaData'] = $this->MetaData;
if (isset($this->TypeId)) $o['TypeId'] = $this->TypeId;
if (isset($this->IsExtraLicenseOption)) $o['IsExtraLicenseOption'] = $this->IsExtraLicenseOption;
if (isset($this->IncludeLicenseItems)) $o['IncludeLicenseItems'] = $this->IncludeLicenseItems;
if (isset($this->IncludeLicensePrices)) $o['IncludeLicensePrices'] = $this->IncludeLicensePrices;
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class AccessKeyTypeResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $KeyType=null,
/** @var string|null */
public ?string $Description=null
) {
}
/** @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 AccessKeyTypeResponse
*/
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($this->genericArgs[0], $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($this->genericArgs[0], $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;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /licenses/company HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfCompanyLicenseQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <d2p1:CompanyLicenseQueryResponse> <d2p1:Active>false</d2p1:Active> <d2p1:Canceled>false</d2p1:Canceled> <d2p1:Created>0001-01-01T00:00:00</d2p1:Created> <d2p1:Id>0</d2p1:Id> <d2p1:MetaData>String</d2p1:MetaData> <d2p1:Type> <d2p1:Description>String</d2p1:Description> <d2p1:Id>0</d2p1:Id> <d2p1:IsExtraLicenseOption>false</d2p1:IsExtraLicenseOption> <d2p1:Items> <d2p1:LicenseItemsResponse> <d2p1:AllowedItems>0</d2p1:AllowedItems> <d2p1:Id>0</d2p1:Id> <d2p1:Name>String</d2p1:Name> </d2p1:LicenseItemsResponse> </d2p1:Items> <d2p1:Name>String</d2p1:Name> <d2p1:PeriodOfNoticeDays>0</d2p1:PeriodOfNoticeDays> <d2p1:Prices xmlns:d5p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db"> <d5p1:LicensePrice> <d5p1:Country> <d5p1:Culture>String</d5p1:Culture> <d5p1:CurrencyId>String</d5p1:CurrencyId> <d5p1:CurrencyInfo> <d5p1:Active>false</d5p1:Active> <d5p1:CurrencySign>String</d5p1:CurrencySign> <d5p1:Id>String</d5p1:Id> <d5p1:ModifiedDate xmlns:d9p1="http://schemas.datacontract.org/2004/07/System"> <d9p1:DateTime>0001-01-01T00:00:00Z</d9p1:DateTime> <d9p1:OffsetMinutes>0</d9p1:OffsetMinutes> </d5p1:ModifiedDate> <d5p1:Name>String</d5p1:Name> </d5p1:CurrencyInfo> <d5p1:Id>String</d5p1:Id> <d5p1:ModifiedDate xmlns:d8p1="http://schemas.datacontract.org/2004/07/System"> <d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime> <d8p1:OffsetMinutes>0</d8p1:OffsetMinutes> </d5p1:ModifiedDate> <d5p1:Name>String</d5p1:Name> <d5p1:TimeZone>String</d5p1:TimeZone> </d5p1:Country> <d5p1:CountryId>String</d5p1:CountryId> <d5p1:LicenseTypeId>0</d5p1:LicenseTypeId> <d5p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System"> <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime> <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes> </d5p1:ModifiedDate> <d5p1:Price>0</d5p1:Price> </d5p1:LicensePrice> </d2p1:Prices> </d2p1:Type> <d2p1:TypeId>0</d2p1:TypeId> <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated> <d2p1:ValidFrom>0001-01-01T00:00:00</d2p1:ValidFrom> <d2p1:ValidTo>0001-01-01T00:00:00</d2p1:ValidTo> </d2p1:CompanyLicenseQueryResponse> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfCompanyLicenseQueryResponseWg5EthtI>