Nephila Tartarus

GetCitiBankAccountBalanceRequest

Cash

**Requires Authentication**
Required role:	Tartarus.Read

The following routes are available for this service:
GET,POST	/api/citi-bank-account-balance

<?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};


enum BankEntryType : int
{
    case Balance = 1;
    case Transaction = 2;
}

class CitiBankAccountEntry implements JsonSerializable
{
    public function __construct(
        /** @var BankEntryType|null */
        public ?BankEntryType $entryType=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var float|null */
        public ?float $amount=null,
        /** @var string|null */
        public ?string $currencyCode=null,
        /** @var string|null */
        public ?string $creditDebitIndicator=null,
        /** @var DateTime|null */
        public ?DateTime $entryDate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['entryType'])) $this->entryType = JsonConverters::from('BankEntryType', $o['entryType']);
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['currencyCode'])) $this->currencyCode = $o['currencyCode'];
        if (isset($o['creditDebitIndicator'])) $this->creditDebitIndicator = $o['creditDebitIndicator'];
        if (isset($o['entryDate'])) $this->entryDate = JsonConverters::from('DateTime', $o['entryDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->entryType)) $o['entryType'] = JsonConverters::to('BankEntryType', $this->entryType);
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->currencyCode)) $o['currencyCode'] = $this->currencyCode;
        if (isset($this->creditDebitIndicator)) $o['creditDebitIndicator'] = $this->creditDebitIndicator;
        if (isset($this->entryDate)) $o['entryDate'] = JsonConverters::to('DateTime', $this->entryDate);
        return empty($o) ? new class(){} : $o;
    }
}

class CitiBankEntriesResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var bool|null */
        public ?bool $statementIsStillGenerating=null,
        /** @var array<CitiBankAccountEntry>|null */
        public ?array $entries=null
    ) {
    }

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

class GetCitiBankAccountBalanceRequest implements IGet, IPost, JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $accountNumber='',
        /** @var string */
        public string $currencyCode='',
        /** @var DateTime */
        public DateTime $fromDate=new DateTime(),
        /** @var DateTime */
        public DateTime $toDate=new DateTime()
    ) {
    }

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

PHP GetCitiBankAccountBalanceRequest 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 /api/citi-bank-account-balance HTTP/1.1 
Host: tartarus.nephila.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	accountNumber: String,
	currencyCode: String,
	fromDate: 0001-01-01,
	toDate: 0001-01-01
}

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

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	statementIsStillGenerating: False,
	entries: 
	[
		{
			entryType: Balance,
			description: String,
			amount: 0,
			currencyCode: String,
			creditDebitIndicator: String,
			entryDate: 0001-01-01
		}
	]
}