| POST, GET | /api/GetCustomerTokens |
|---|
<?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};
// @DataContract
class BaseRequest implements JsonSerializable
{
public function __construct(
/** @description This is your AIM API Key provided by Tri-Tech */
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
/** @var string */
public string $ApiKey='',
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
/** @var string|null */
public ?string $OAuthToken=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
/** @var string|null */
public ?string $Token=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
/** @var string|null */
public ?string $DeviceId=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
/** @var string */
public string $AppId=''
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Token'])) $this->Token = $o['Token'];
if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
if (isset($o['AppId'])) $this->AppId = $o['AppId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Token)) $o['Token'] = $this->Token;
if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
if (isset($this->AppId)) $o['AppId'] = $this->AppId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponseResult implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
/** @var string|null */
public ?string $StatusCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
/** @var string|null */
public ?string $Login=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
/** @var string|null */
public ?string $ErrorCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
/** @var string|null */
public ?string $ErrorDisplayText=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
/** @var string|null */
public ?string $ErrorMessage=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
/** @var string|null */
public ?string $DomainName=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
/** @var string|null */
public ?string $IpAddress=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['Login'])) $this->Login = $o['Login'];
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->Login)) $o['Login'] = $this->Login;
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponse implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
/** @var BaseResponseResult|null */
public ?BaseResponseResult $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract(Name="CCInfo")
class CcInfo implements JsonSerializable
{
public function __construct(
/** @description Token returned from processor */
// @DataMember
// @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
/** @var string */
public string $TokenStr='',
/** @description Card Type (VISA, MCARD, AMEX, DSCVR) */
// @DataMember
// @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
/** @var string */
public string $CardType='',
/** @description Last four of the card */
// @DataMember
// @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
/** @var string */
public string $LastFour='',
/** @description Expiration Date of the Card. (MM/YY) */
// @DataMember
// @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
/** @var string|null */
public ?string $Expiration=null,
/** @description Reason the card is on file. */
// @DataMember
// @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
/** @var string|null */
public ?string $ReasonOnFile=null,
/** @description ID of the existing Token Record in AIM, if applicable */
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
/** @var int|null */
public ?int $TokenPk=null,
/** @description Is this the customer's primary card? Defaults to false. */
// @DataMember
// @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
/** @var bool|null */
public ?bool $Primary=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TokenStr'])) $this->TokenStr = $o['TokenStr'];
if (isset($o['CardType'])) $this->CardType = $o['CardType'];
if (isset($o['LastFour'])) $this->LastFour = $o['LastFour'];
if (isset($o['Expiration'])) $this->Expiration = $o['Expiration'];
if (isset($o['ReasonOnFile'])) $this->ReasonOnFile = $o['ReasonOnFile'];
if (isset($o['TokenPk'])) $this->TokenPk = $o['TokenPk'];
if (isset($o['Primary'])) $this->Primary = $o['Primary'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TokenStr)) $o['TokenStr'] = $this->TokenStr;
if (isset($this->CardType)) $o['CardType'] = $this->CardType;
if (isset($this->LastFour)) $o['LastFour'] = $this->LastFour;
if (isset($this->Expiration)) $o['Expiration'] = $this->Expiration;
if (isset($this->ReasonOnFile)) $o['ReasonOnFile'] = $this->ReasonOnFile;
if (isset($this->TokenPk)) $o['TokenPk'] = $this->TokenPk;
if (isset($this->Primary)) $o['Primary'] = $this->Primary;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class AchDetail implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $BankNumber=null,
// @DataMember
/** @var string|null */
public ?string $Routing=null,
// @DataMember
/** @var string|null */
public ?string $Type=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['BankNumber'])) $this->BankNumber = $o['BankNumber'];
if (isset($o['Routing'])) $this->Routing = $o['Routing'];
if (isset($o['Type'])) $this->Type = $o['Type'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->BankNumber)) $o['BankNumber'] = $this->BankNumber;
if (isset($this->Routing)) $o['Routing'] = $this->Routing;
if (isset($this->Type)) $o['Type'] = $this->Type;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetCustomerTokensResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<CcInfo>|null */
public ?array $CustomerTokens=null,
// @DataMember
/** @var AchDetail|null */
public ?AchDetail $Ach=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['CustomerTokens'])) $this->CustomerTokens = JsonConverters::fromArray('CcInfo', $o['CustomerTokens']);
if (isset($o['Ach'])) $this->Ach = JsonConverters::from('AchDetail', $o['Ach']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CustomerTokens)) $o['CustomerTokens'] = JsonConverters::toArray('CcInfo', $this->CustomerTokens);
if (isset($this->Ach)) $o['Ach'] = JsonConverters::to('AchDetail', $this->Ach);
return empty($o) ? new class(){} : $o;
}
}
/** @description GetCustomerTokensRequires active-e Customer Service. */
// @DataContract
class GetCustomerTokensRequest extends BaseSecureRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
* @param string|null $Token
* @param string|null $DeviceId
* @param string $AppId
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
?string $Token=null,
?string $DeviceId=null,
string $AppId='',
// @DataMember
/** @var bool|null */
public ?bool $GetExpiredCards=null,
// @DataMember
/** @var bool|null */
public ?bool $GetInactiveCards=null,
// @DataMember
/** @var int|null */
public ?int $Acct=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['GetExpiredCards'])) $this->GetExpiredCards = $o['GetExpiredCards'];
if (isset($o['GetInactiveCards'])) $this->GetInactiveCards = $o['GetInactiveCards'];
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->GetExpiredCards)) $o['GetExpiredCards'] = $this->GetExpiredCards;
if (isset($this->GetInactiveCards)) $o['GetInactiveCards'] = $this->GetInactiveCards;
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
return empty($o) ? new class(){} : $o;
}
}
PHP GetCustomerTokensRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/GetCustomerTokens HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCustomerTokensRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<Acct>0</Acct>
<GetExpiredCards>false</GetExpiredCards>
<GetInactiveCards>false</GetInactiveCards>
</GetCustomerTokensRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCustomerTokensResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<Ach>
<BankNumber>String</BankNumber>
<Name>String</Name>
<Routing>String</Routing>
<Type>String</Type>
</Ach>
<CustomerTokens>
<CCInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CCInfo>
</CustomerTokens>
</GetCustomerTokensResponse>