| GET | /QcComments |
|---|
<?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(Name="Metadata", Namespace="schemas.agentivity.com/types")
class PagingMetadata implements JsonSerializable
{
public function __construct(
/** @description Starting Record */
// @DataMember
// @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
/** @var string|null */
public ?string $Offset=null,
/** @description Number of records to return (PageSize) */
// @DataMember
// @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
/** @var string|null */
public ?string $Limit=null,
/** @description Total Number of Records in a Full Reponse (if no paging) */
// @DataMember
// @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
/** @var int */
public int $TotalRecords=0,
/** @description Total Number of Records in this Reponse (on this page) */
// @DataMember
// @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
/** @var int */
public int $ResponseRecords=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Offset'])) $this->Offset = $o['Offset'];
if (isset($o['Limit'])) $this->Limit = $o['Limit'];
if (isset($o['TotalRecords'])) $this->TotalRecords = $o['TotalRecords'];
if (isset($o['ResponseRecords'])) $this->ResponseRecords = $o['ResponseRecords'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Offset)) $o['Offset'] = $this->Offset;
if (isset($this->Limit)) $o['Limit'] = $this->Limit;
if (isset($this->TotalRecords)) $o['TotalRecords'] = $this->TotalRecords;
if (isset($this->ResponseRecords)) $o['ResponseRecords'] = $this->ResponseRecords;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode, JsonSerializable
{
/**
* @param string|null $Offset
* @param string|null $Limit
* @param int $TotalRecords
* @param int $ResponseRecords
*/
public function __construct(
?string $Offset=null,
?string $Limit=null,
int $TotalRecords=0,
int $ResponseRecords=0,
/** @description Comma Delimited List of Owning Company Codes */
// @DataMember
/** @var string[]|null */
public ?array $OwningCompanyCode=null,
/** @description UserName in form of an email address */
// @DataMember
/** @var string|null */
public ?string $UserName=null
) {
parent::__construct($Offset,$Limit,$TotalRecords,$ResponseRecords);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['OwningCompanyCode'])) $this->OwningCompanyCode = JsonConverters::fromArray('string', $o['OwningCompanyCode']);
if (isset($o['UserName'])) $this->UserName = $o['UserName'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->OwningCompanyCode)) $o['OwningCompanyCode'] = JsonConverters::toArray('string', $this->OwningCompanyCode);
if (isset($this->UserName)) $o['UserName'] = $this->UserName;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="QcComments", Namespace="schemas.agentivity.com/types")
class QcComments implements JsonSerializable
{
public function __construct(
// @DataMember(Order=10)
/** @var string|null */
public ?string $Consultant=null,
// @DataMember(Order=20)
/** @var string|null */
public ?string $AgentInitials=null,
// @DataMember(Order=30)
/** @var int */
public int $BookingsCount=0,
// @DataMember(Order=40)
/** @var int */
public int $CommentsCount=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Consultant'])) $this->Consultant = $o['Consultant'];
if (isset($o['AgentInitials'])) $this->AgentInitials = $o['AgentInitials'];
if (isset($o['BookingsCount'])) $this->BookingsCount = $o['BookingsCount'];
if (isset($o['CommentsCount'])) $this->CommentsCount = $o['CommentsCount'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Consultant)) $o['Consultant'] = $this->Consultant;
if (isset($this->AgentInitials)) $o['AgentInitials'] = $this->AgentInitials;
if (isset($this->BookingsCount)) $o['BookingsCount'] = $this->BookingsCount;
if (isset($this->CommentsCount)) $o['CommentsCount'] = $this->CommentsCount;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
class CacheMetadata implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var DateTime */
public DateTime $CachedAt=new DateTime(),
// @DataMember(Order=2)
/** @var DateTime */
public DateTime $CacheExpiresAt=new DateTime(),
// @DataMember(Order=0)
/** @var bool|null */
public ?bool $IsFromCache=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CachedAt'])) $this->CachedAt = JsonConverters::from('DateTime', $o['CachedAt']);
if (isset($o['CacheExpiresAt'])) $this->CacheExpiresAt = JsonConverters::from('DateTime', $o['CacheExpiresAt']);
if (isset($o['IsFromCache'])) $this->IsFromCache = $o['IsFromCache'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CachedAt)) $o['CachedAt'] = JsonConverters::to('DateTime', $this->CachedAt);
if (isset($this->CacheExpiresAt)) $o['CacheExpiresAt'] = JsonConverters::to('DateTime', $this->CacheExpiresAt);
if (isset($this->IsFromCache)) $o['IsFromCache'] = $this->IsFromCache;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class ResponseMetadata implements JsonSerializable
{
public function __construct(
// @DataMember(Order=0)
/** @var bool|null */
public ?bool $Success=null,
// @DataMember(Order=1)
/** @var bool|null */
public ?bool $HasCache=null,
// @DataMember(Order=2)
/** @var bool|null */
public ?bool $HasPaging=null,
// @DataMember(Order=3, EmitDefaultValue=false)
/** @var CacheMetadata|null */
public ?CacheMetadata $CacheMetadata=null,
// @DataMember(Order=4, EmitDefaultValue=false)
/** @var PagingMetadata|null */
public ?PagingMetadata $PagingMetadata=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Success'])) $this->Success = $o['Success'];
if (isset($o['HasCache'])) $this->HasCache = $o['HasCache'];
if (isset($o['HasPaging'])) $this->HasPaging = $o['HasPaging'];
if (isset($o['CacheMetadata'])) $this->CacheMetadata = JsonConverters::from('CacheMetadata', $o['CacheMetadata']);
if (isset($o['PagingMetadata'])) $this->PagingMetadata = JsonConverters::from('PagingMetadata', $o['PagingMetadata']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Success)) $o['Success'] = $this->Success;
if (isset($this->HasCache)) $o['HasCache'] = $this->HasCache;
if (isset($this->HasPaging)) $o['HasPaging'] = $this->HasPaging;
if (isset($this->CacheMetadata)) $o['CacheMetadata'] = JsonConverters::to('CacheMetadata', $this->CacheMetadata);
if (isset($this->PagingMetadata)) $o['PagingMetadata'] = JsonConverters::to('PagingMetadata', $this->PagingMetadata);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
class ApiRequestPerHour implements JsonSerializable
{
public function __construct(
// @DataMember(Order=10)
/** @var DateTime */
public DateTime $RequestDate=new DateTime(),
// @DataMember(Order=100)
/** @var int */
public int $Hour0=0,
// @DataMember(Order=110)
/** @var int */
public int $Hour1=0,
// @DataMember(Order=120)
/** @var int */
public int $Hour2=0,
// @DataMember(Order=130)
/** @var int */
public int $Hour3=0,
// @DataMember(Order=140)
/** @var int */
public int $Hour4=0,
// @DataMember(Order=150)
/** @var int */
public int $Hour5=0,
// @DataMember(Order=160)
/** @var int */
public int $Hour6=0,
// @DataMember(Order=170)
/** @var int */
public int $Hour7=0,
// @DataMember(Order=180)
/** @var int */
public int $Hour8=0,
// @DataMember(Order=190)
/** @var int */
public int $Hour9=0,
// @DataMember(Order=200)
/** @var int */
public int $Hour10=0,
// @DataMember(Order=210)
/** @var int */
public int $Hour11=0,
// @DataMember(Order=220)
/** @var int */
public int $Hour12=0,
// @DataMember(Order=230)
/** @var int */
public int $Hour13=0,
// @DataMember(Order=240)
/** @var int */
public int $Hour14=0,
// @DataMember(Order=250)
/** @var int */
public int $Hour15=0,
// @DataMember(Order=260)
/** @var int */
public int $Hour16=0,
// @DataMember(Order=270)
/** @var int */
public int $Hour17=0,
// @DataMember(Order=280)
/** @var int */
public int $Hour18=0,
// @DataMember(Order=290)
/** @var int */
public int $Hour19=0,
// @DataMember(Order=300)
/** @var int */
public int $Hour20=0,
// @DataMember(Order=310)
/** @var int */
public int $Hour21=0,
// @DataMember(Order=320)
/** @var int */
public int $Hour22=0,
// @DataMember(Order=330)
/** @var int */
public int $Hour23=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RequestDate'])) $this->RequestDate = JsonConverters::from('DateTime', $o['RequestDate']);
if (isset($o['Hour0'])) $this->Hour0 = $o['Hour0'];
if (isset($o['Hour1'])) $this->Hour1 = $o['Hour1'];
if (isset($o['Hour2'])) $this->Hour2 = $o['Hour2'];
if (isset($o['Hour3'])) $this->Hour3 = $o['Hour3'];
if (isset($o['Hour4'])) $this->Hour4 = $o['Hour4'];
if (isset($o['Hour5'])) $this->Hour5 = $o['Hour5'];
if (isset($o['Hour6'])) $this->Hour6 = $o['Hour6'];
if (isset($o['Hour7'])) $this->Hour7 = $o['Hour7'];
if (isset($o['Hour8'])) $this->Hour8 = $o['Hour8'];
if (isset($o['Hour9'])) $this->Hour9 = $o['Hour9'];
if (isset($o['Hour10'])) $this->Hour10 = $o['Hour10'];
if (isset($o['Hour11'])) $this->Hour11 = $o['Hour11'];
if (isset($o['Hour12'])) $this->Hour12 = $o['Hour12'];
if (isset($o['Hour13'])) $this->Hour13 = $o['Hour13'];
if (isset($o['Hour14'])) $this->Hour14 = $o['Hour14'];
if (isset($o['Hour15'])) $this->Hour15 = $o['Hour15'];
if (isset($o['Hour16'])) $this->Hour16 = $o['Hour16'];
if (isset($o['Hour17'])) $this->Hour17 = $o['Hour17'];
if (isset($o['Hour18'])) $this->Hour18 = $o['Hour18'];
if (isset($o['Hour19'])) $this->Hour19 = $o['Hour19'];
if (isset($o['Hour20'])) $this->Hour20 = $o['Hour20'];
if (isset($o['Hour21'])) $this->Hour21 = $o['Hour21'];
if (isset($o['Hour22'])) $this->Hour22 = $o['Hour22'];
if (isset($o['Hour23'])) $this->Hour23 = $o['Hour23'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RequestDate)) $o['RequestDate'] = JsonConverters::to('DateTime', $this->RequestDate);
if (isset($this->Hour0)) $o['Hour0'] = $this->Hour0;
if (isset($this->Hour1)) $o['Hour1'] = $this->Hour1;
if (isset($this->Hour2)) $o['Hour2'] = $this->Hour2;
if (isset($this->Hour3)) $o['Hour3'] = $this->Hour3;
if (isset($this->Hour4)) $o['Hour4'] = $this->Hour4;
if (isset($this->Hour5)) $o['Hour5'] = $this->Hour5;
if (isset($this->Hour6)) $o['Hour6'] = $this->Hour6;
if (isset($this->Hour7)) $o['Hour7'] = $this->Hour7;
if (isset($this->Hour8)) $o['Hour8'] = $this->Hour8;
if (isset($this->Hour9)) $o['Hour9'] = $this->Hour9;
if (isset($this->Hour10)) $o['Hour10'] = $this->Hour10;
if (isset($this->Hour11)) $o['Hour11'] = $this->Hour11;
if (isset($this->Hour12)) $o['Hour12'] = $this->Hour12;
if (isset($this->Hour13)) $o['Hour13'] = $this->Hour13;
if (isset($this->Hour14)) $o['Hour14'] = $this->Hour14;
if (isset($this->Hour15)) $o['Hour15'] = $this->Hour15;
if (isset($this->Hour16)) $o['Hour16'] = $this->Hour16;
if (isset($this->Hour17)) $o['Hour17'] = $this->Hour17;
if (isset($this->Hour18)) $o['Hour18'] = $this->Hour18;
if (isset($this->Hour19)) $o['Hour19'] = $this->Hour19;
if (isset($this->Hour20)) $o['Hour20'] = $this->Hour20;
if (isset($this->Hour21)) $o['Hour21'] = $this->Hour21;
if (isset($this->Hour22)) $o['Hour22'] = $this->Hour22;
if (isset($this->Hour23)) $o['Hour23'] = $this->Hour23;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class AgentivityError implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $ErrorCode=null,
// @DataMember
/** @var string|null */
public ?string $Message=null,
// @DataMember
/** @var string|null */
public ?string $StatusCode=null,
// @DataMember
/** @var string|null */
public ?string $VerboseMessage=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['VerboseMessage'])) $this->VerboseMessage = $o['VerboseMessage'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->VerboseMessage)) $o['VerboseMessage'] = $this->VerboseMessage;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
/**
* @template TItem
*/
class CollectionResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): CollectionResponse {
$to = new CollectionResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var ResponseMetadata|null */
public mixed $ResponseMetadata=null,
// @DataMember(Order=2, EmitDefaultValue=false)
/** @var array<ApiRequestPerHour>|null */
public mixed $ResponseReport=null,
// @DataMember(Order=3, EmitDefaultValue=false)
/** @var AgentivityError|null */
public mixed $ResponseError=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseMetadata'])) $this->ResponseMetadata = JsonConverters::from('ResponseMetadata', $o['ResponseMetadata']);
if (isset($o['ResponseReport'])) $this->ResponseReport = JsonConverters::fromArray('ApiRequestPerHour', $o['ResponseReport']);
if (isset($o['ResponseError'])) $this->ResponseError = JsonConverters::from('AgentivityError', $o['ResponseError']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseMetadata)) $o['ResponseMetadata'] = JsonConverters::to('ResponseMetadata', $this->ResponseMetadata);
if (isset($this->ResponseReport)) $o['ResponseReport'] = JsonConverters::toArray('ApiRequestPerHour', $this->ResponseReport);
if (isset($this->ResponseError)) $o['ResponseError'] = JsonConverters::to('AgentivityError', $this->ResponseError);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
/**
* @template CollectionResponse of QcComments
*/
class QcCommentsResponse extends CollectionResponse implements JsonSerializable
{
/**
* @param ResponseMetadata|null $ResponseMetadata
* @param array<ApiRequestPerHour>|null $ResponseReport
* @param AgentivityError|null $ResponseError
*/
public function __construct(
?ResponseMetadata $ResponseMetadata=null,
?array $ResponseReport=null,
?AgentivityError $ResponseError=null
) {
parent::__construct($ResponseMetadata,$ResponseReport,$ResponseError);
}
/** @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;
}
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class GetQcComments extends CompanyLevelRequestBase implements JsonSerializable
{
/**
* @param string|null $Offset
* @param string|null $Limit
* @param int $TotalRecords
* @param int $ResponseRecords
* @param string[]|null $OwningCompanyCode
* @param string|null $UserName
*/
public function __construct(
?string $Offset=null,
?string $Limit=null,
int $TotalRecords=0,
int $ResponseRecords=0,
?array $OwningCompanyCode=null,
?string $UserName=null,
/** @description Date in format YYYYMMDD */
// @DataMember
/** @var string */
public string $DateStart='',
/** @description Date in format YYYYMMDD */
// @DataMember
/** @var string */
public string $DateEnd='',
/** @description Comma Delimited List of PCCs */
// @DataMember
/** @var string[] */
public array $OwningAgencyLocationID=[],
/** @description Team name */
// @DataMember
/** @var string|null */
public ?string $Team=null,
/** @description Sort date by comments */
// @DataMember
/** @var bool|null */
public ?bool $DateByComments=null,
/** @description Group by agent initials */
// @DataMember
/** @var bool|null */
public ?bool $GroupByAgentInitials=null,
/** @description Comma Delimited List of Division codes */
// @DataMember
/** @var string[]|null */
public ?array $DivisionCode=null
) {
parent::__construct($Offset,$Limit,$TotalRecords,$ResponseRecords,$OwningCompanyCode,$UserName);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['DateStart'])) $this->DateStart = $o['DateStart'];
if (isset($o['DateEnd'])) $this->DateEnd = $o['DateEnd'];
if (isset($o['OwningAgencyLocationID'])) $this->OwningAgencyLocationID = JsonConverters::fromArray('string', $o['OwningAgencyLocationID']);
if (isset($o['Team'])) $this->Team = $o['Team'];
if (isset($o['DateByComments'])) $this->DateByComments = $o['DateByComments'];
if (isset($o['GroupByAgentInitials'])) $this->GroupByAgentInitials = $o['GroupByAgentInitials'];
if (isset($o['DivisionCode'])) $this->DivisionCode = JsonConverters::fromArray('string', $o['DivisionCode']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->DateStart)) $o['DateStart'] = $this->DateStart;
if (isset($this->DateEnd)) $o['DateEnd'] = $this->DateEnd;
if (isset($this->OwningAgencyLocationID)) $o['OwningAgencyLocationID'] = JsonConverters::toArray('string', $this->OwningAgencyLocationID);
if (isset($this->Team)) $o['Team'] = $this->Team;
if (isset($this->DateByComments)) $o['DateByComments'] = $this->DateByComments;
if (isset($this->GroupByAgentInitials)) $o['GroupByAgentInitials'] = $this->GroupByAgentInitials;
if (isset($this->DivisionCode)) $o['DivisionCode'] = JsonConverters::toArray('string', $this->DivisionCode);
return empty($o) ? new class(){} : $o;
}
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /QcComments HTTP/1.1 Host: api.agentivity.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"Consultant":"String","AgentInitials":"String","BookingsCount":0,"CommentsCount":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}