Nephila Tartarus

InitiateCitiBankStatementRequest

Cash

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

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

<?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 InitiateCitiBankStatementResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var bool|null */
        public ?bool $statementIsStillGenerating=null,
        /** @var string|null */
        public ?string $statementId=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['statementId'])) $this->statementId = $o['statementId'];
    }
    
    /** @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->statementId)) $o['statementId'] = $this->statementId;
        return empty($o) ? new class(){} : $o;
    }
}

class InitiateCitiBankStatementRequest implements IGet, IPost, JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $bankAccountNumber='',
        /** @var DateTime */
        public DateTime $fromDate=new DateTime(),
        /** @var DateTime */
        public DateTime $toDate=new DateTime(),
        /** @var string|null */
        public ?string $formatName=null
    ) {
    }

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

PHP InitiateCitiBankStatementRequest 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/initiate-citi-bank-statement HTTP/1.1 
Host: tartarus.nephila.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	bankAccountNumber: String,
	fromDate: 0001-01-01,
	toDate: 0001-01-01,
	formatName: String
}

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,
	statementId: String
}