Trendsic Platform Service

AgentEmailCredentialsRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS	/v1/AgentEmailCredentials

<?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 AgentEmailCredentials implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $EmailAddress=null,
        /** @var string|null */
        public ?string $Username=null,
        /** @var string|null */
        public ?string $Password=null,
        /** @var string|null */
        public ?string $SMTPServer=null,
        /** @var int|null */
        public ?int $SMTPPort=null,
        /** @var string|null */
        public ?string $SMTPAuthType=null,
        /** @var string|null */
        public ?string $POP3Server=null,
        /** @var int|null */
        public ?int $POP3Port=null,
        /** @var string|null */
        public ?string $POP3AuthType=null,
        /** @var string|null */
        public ?string $IMAPServer=null,
        /** @var int|null */
        public ?int $IMAPPort=null,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var DateTime */
        public DateTime $DateModified=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['EmailAddress'])) $this->EmailAddress = $o['EmailAddress'];
        if (isset($o['Username'])) $this->Username = $o['Username'];
        if (isset($o['Password'])) $this->Password = $o['Password'];
        if (isset($o['SMTPServer'])) $this->SMTPServer = $o['SMTPServer'];
        if (isset($o['SMTPPort'])) $this->SMTPPort = $o['SMTPPort'];
        if (isset($o['SMTPAuthType'])) $this->SMTPAuthType = $o['SMTPAuthType'];
        if (isset($o['POP3Server'])) $this->POP3Server = $o['POP3Server'];
        if (isset($o['POP3Port'])) $this->POP3Port = $o['POP3Port'];
        if (isset($o['POP3AuthType'])) $this->POP3AuthType = $o['POP3AuthType'];
        if (isset($o['IMAPServer'])) $this->IMAPServer = $o['IMAPServer'];
        if (isset($o['IMAPPort'])) $this->IMAPPort = $o['IMAPPort'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateModified'])) $this->DateModified = JsonConverters::from('DateTime', $o['DateModified']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->EmailAddress)) $o['EmailAddress'] = $this->EmailAddress;
        if (isset($this->Username)) $o['Username'] = $this->Username;
        if (isset($this->Password)) $o['Password'] = $this->Password;
        if (isset($this->SMTPServer)) $o['SMTPServer'] = $this->SMTPServer;
        if (isset($this->SMTPPort)) $o['SMTPPort'] = $this->SMTPPort;
        if (isset($this->SMTPAuthType)) $o['SMTPAuthType'] = $this->SMTPAuthType;
        if (isset($this->POP3Server)) $o['POP3Server'] = $this->POP3Server;
        if (isset($this->POP3Port)) $o['POP3Port'] = $this->POP3Port;
        if (isset($this->POP3AuthType)) $o['POP3AuthType'] = $this->POP3AuthType;
        if (isset($this->IMAPServer)) $o['IMAPServer'] = $this->IMAPServer;
        if (isset($this->IMAPPort)) $o['IMAPPort'] = $this->IMAPPort;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateModified)) $o['DateModified'] = JsonConverters::to('DateTime', $this->DateModified);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AgentEmailCredentialsRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<AgentEmailCredentials>|null */
        public ?array $AgentEmailCredentials=null
    ) {
    }

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

PHP AgentEmailCredentialsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/AgentEmailCredentials HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgentEmailCredentialsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentEmailCredentials>
    <AgentEmailCredentials>
      <AgentId>0</AgentId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <EmailAddress>String</EmailAddress>
      <IMAPPort>0</IMAPPort>
      <IMAPServer>String</IMAPServer>
      <Id>0</Id>
      <POP3AuthType>String</POP3AuthType>
      <POP3Port>0</POP3Port>
      <POP3Server>String</POP3Server>
      <Password>String</Password>
      <SMTPAuthType>String</SMTPAuthType>
      <SMTPPort>0</SMTPPort>
      <SMTPServer>String</SMTPServer>
      <Username>String</Username>
    </AgentEmailCredentials>
  </AgentEmailCredentials>
</AgentEmailCredentialsRequest>

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

<AgentEmailCredentialsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentEmailCredentials>
    <AgentEmailCredentials>
      <AgentId>0</AgentId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <EmailAddress>String</EmailAddress>
      <IMAPPort>0</IMAPPort>
      <IMAPServer>String</IMAPServer>
      <Id>0</Id>
      <POP3AuthType>String</POP3AuthType>
      <POP3Port>0</POP3Port>
      <POP3Server>String</POP3Server>
      <Password>String</Password>
      <SMTPAuthType>String</SMTPAuthType>
      <SMTPPort>0</SMTPPort>
      <SMTPServer>String</SMTPServer>
      <Username>String</Username>
    </AgentEmailCredentials>
  </AgentEmailCredentials>
  <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>
</AgentEmailCredentialsResponse>