Trendsic Platform Service

<back to all web services

DocumentShareAuditRequest

<?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 DocumentShareAccessLog implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DocumentShareAccessLogId=0,
        /** @var int|null */
        public ?int $DocumentShareId=null,
        /** @var string|null */
        public ?string $AttachmentId=null,
        /** @var string|null */
        public ?string $EventType=null,
        /** @var string|null */
        public ?string $Outcome=null,
        /** @var string|null */
        public ?string $DetailMessage=null,
        /** @var string|null */
        public ?string $IpAddress=null,
        /** @var string|null */
        public ?string $UserAgent=null,
        /** @var string|null */
        public ?string $ActorUserId=null,
        /** @var string|null */
        public ?string $ActorRole=null,
        /** @var DateTime */
        public DateTime $CreatedAtUtc=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DocumentShareAccessLogId'])) $this->DocumentShareAccessLogId = $o['DocumentShareAccessLogId'];
        if (isset($o['DocumentShareId'])) $this->DocumentShareId = $o['DocumentShareId'];
        if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
        if (isset($o['EventType'])) $this->EventType = $o['EventType'];
        if (isset($o['Outcome'])) $this->Outcome = $o['Outcome'];
        if (isset($o['DetailMessage'])) $this->DetailMessage = $o['DetailMessage'];
        if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
        if (isset($o['UserAgent'])) $this->UserAgent = $o['UserAgent'];
        if (isset($o['ActorUserId'])) $this->ActorUserId = $o['ActorUserId'];
        if (isset($o['ActorRole'])) $this->ActorRole = $o['ActorRole'];
        if (isset($o['CreatedAtUtc'])) $this->CreatedAtUtc = JsonConverters::from('DateTime', $o['CreatedAtUtc']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DocumentShareAccessLogId)) $o['DocumentShareAccessLogId'] = $this->DocumentShareAccessLogId;
        if (isset($this->DocumentShareId)) $o['DocumentShareId'] = $this->DocumentShareId;
        if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
        if (isset($this->EventType)) $o['EventType'] = $this->EventType;
        if (isset($this->Outcome)) $o['Outcome'] = $this->Outcome;
        if (isset($this->DetailMessage)) $o['DetailMessage'] = $this->DetailMessage;
        if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
        if (isset($this->UserAgent)) $o['UserAgent'] = $this->UserAgent;
        if (isset($this->ActorUserId)) $o['ActorUserId'] = $this->ActorUserId;
        if (isset($this->ActorRole)) $o['ActorRole'] = $this->ActorRole;
        if (isset($this->CreatedAtUtc)) $o['CreatedAtUtc'] = JsonConverters::to('DateTime', $this->CreatedAtUtc);
        return empty($o) ? new class(){} : $o;
    }
}

class DocumentShareAccessLogExtended extends DocumentShareAccessLog implements JsonSerializable
{
    /**
     * @param int $DocumentShareAccessLogId
     * @param int|null $DocumentShareId
     * @param string|null $AttachmentId
     * @param string|null $EventType
     * @param string|null $Outcome
     * @param string|null $DetailMessage
     * @param string|null $IpAddress
     * @param string|null $UserAgent
     * @param string|null $ActorUserId
     * @param string|null $ActorRole
     * @param DateTime $CreatedAtUtc
     */
    public function __construct(
        int $DocumentShareAccessLogId=0,
        ?int $DocumentShareId=null,
        ?string $AttachmentId=null,
        ?string $EventType=null,
        ?string $Outcome=null,
        ?string $DetailMessage=null,
        ?string $IpAddress=null,
        ?string $UserAgent=null,
        ?string $ActorUserId=null,
        ?string $ActorRole=null,
        DateTime $CreatedAtUtc=new DateTime(),
        /** @var string|null */
        public ?string $RecipientDisplayName=null,
        /** @var string|null */
        public ?string $RecipientEmail=null,
        /** @var string|null */
        public ?string $RecipientType=null,
        /** @var string|null */
        public ?string $SensitivityTier=null,
        /** @var string|null */
        public ?string $ActorName=null
    ) {
        parent::__construct($DocumentShareAccessLogId,$DocumentShareId,$AttachmentId,$EventType,$Outcome,$DetailMessage,$IpAddress,$UserAgent,$ActorUserId,$ActorRole,$CreatedAtUtc);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['RecipientDisplayName'])) $this->RecipientDisplayName = $o['RecipientDisplayName'];
        if (isset($o['RecipientEmail'])) $this->RecipientEmail = $o['RecipientEmail'];
        if (isset($o['RecipientType'])) $this->RecipientType = $o['RecipientType'];
        if (isset($o['SensitivityTier'])) $this->SensitivityTier = $o['SensitivityTier'];
        if (isset($o['ActorName'])) $this->ActorName = $o['ActorName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->RecipientDisplayName)) $o['RecipientDisplayName'] = $this->RecipientDisplayName;
        if (isset($this->RecipientEmail)) $o['RecipientEmail'] = $this->RecipientEmail;
        if (isset($this->RecipientType)) $o['RecipientType'] = $this->RecipientType;
        if (isset($this->SensitivityTier)) $o['SensitivityTier'] = $this->SensitivityTier;
        if (isset($this->ActorName)) $o['ActorName'] = $this->ActorName;
        return empty($o) ? new class(){} : $o;
    }
}

class DocumentShareAuditResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<DocumentShareAccessLogExtended>|null */
        public ?array $AuditLog=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['AuditLog'])) $this->AuditLog = JsonConverters::fromArray('DocumentShareAccessLogExtended', $o['AuditLog']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->AuditLog)) $o['AuditLog'] = JsonConverters::toArray('DocumentShareAccessLogExtended', $this->AuditLog);
        return empty($o) ? new class(){} : $o;
    }
}

class DocumentShareAuditRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $AttachmentId=''
    ) {
    }

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

PHP DocumentShareAuditRequest DTOs

GET /v1/documentshare/attachment/{AttachmentId}/log HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentShareAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AuditLog>
    <DocumentShareAccessLogExtended>
      <ActorRole>String</ActorRole>
      <ActorUserId>00000000-0000-0000-0000-000000000000</ActorUserId>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
      <DetailMessage>String</DetailMessage>
      <DocumentShareAccessLogId>0</DocumentShareAccessLogId>
      <DocumentShareId>0</DocumentShareId>
      <EventType>String</EventType>
      <IpAddress>String</IpAddress>
      <Outcome>String</Outcome>
      <UserAgent>String</UserAgent>
      <ActorName>String</ActorName>
      <RecipientDisplayName>String</RecipientDisplayName>
      <RecipientEmail>String</RecipientEmail>
      <RecipientType>String</RecipientType>
      <SensitivityTier>String</SensitivityTier>
    </DocumentShareAccessLogExtended>
  </AuditLog>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentShareAuditResponse>