Trendsic Platform Service

NotaryInviteRequest

The following routes are available for this service:
GET,POST	/v1/witness/notary/invite

<?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 NotaryInvitePreview implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Link=null,
        /** @var string|null */
        public ?string $Subject=null,
        /** @var string|null */
        public ?string $Greeting=null,
        /** @var string|null */
        public ?string $Lead=null,
        /** @var string|null */
        public ?string $SignIn=null,
        /** @var string|null */
        public ?string $Sms=null,
        /** @var int */
        public int $SmsLength=0,
        /** @var int */
        public int $SmsSegments=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Link'])) $this->Link = $o['Link'];
        if (isset($o['Subject'])) $this->Subject = $o['Subject'];
        if (isset($o['Greeting'])) $this->Greeting = $o['Greeting'];
        if (isset($o['Lead'])) $this->Lead = $o['Lead'];
        if (isset($o['SignIn'])) $this->SignIn = $o['SignIn'];
        if (isset($o['Sms'])) $this->Sms = $o['Sms'];
        if (isset($o['SmsLength'])) $this->SmsLength = $o['SmsLength'];
        if (isset($o['SmsSegments'])) $this->SmsSegments = $o['SmsSegments'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Link)) $o['Link'] = $this->Link;
        if (isset($this->Subject)) $o['Subject'] = $this->Subject;
        if (isset($this->Greeting)) $o['Greeting'] = $this->Greeting;
        if (isset($this->Lead)) $o['Lead'] = $this->Lead;
        if (isset($this->SignIn)) $o['SignIn'] = $this->SignIn;
        if (isset($this->Sms)) $o['Sms'] = $this->Sms;
        if (isset($this->SmsLength)) $o['SmsLength'] = $this->SmsLength;
        if (isset($this->SmsSegments)) $o['SmsSegments'] = $this->SmsSegments;
        return empty($o) ? new class(){} : $o;
    }
}

class NotaryInviteResponse implements JsonSerializable
{
    public function __construct(
        /** @var NotaryInvitePreview|null */
        public ?NotaryInvitePreview $Preview=null,
        /** @var array<string>|null */
        public ?array $Lines=null,
        /** @var string|null */
        public ?string $EmailedTo=null,
        /** @var string|null */
        public ?string $TextedTo=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class NotaryInviteRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Email=null,
        /** @var string|null */
        public ?string $Phone=null,
        /** @var int|null */
        public ?int $NotaryId=null
    ) {
    }

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

PHP NotaryInviteRequest DTOs

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

HTTP + JSV

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

POST /v1/witness/notary/invite HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	Phone: String,
	NotaryId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Preview: 
	{
		Link: String,
		Subject: String,
		Greeting: String,
		Lead: String,
		SignIn: String,
		Sms: String,
		SmsLength: 0,
		SmsSegments: 0
	},
	Lines: 
	[
		String
	],
	EmailedTo: String,
	TextedTo: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}