Tax Filing Service
| Requires the role: | AllowAnyUser | Required permission: | CanAccess |
| GET | /sync/accounts/retrieve |
|---|
<?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};
/** @description The number of query results to skip. */
// @Api(Description="The number of query results to skip.")
class PaginationBase implements IPaginate, JsonSerializable
{
public function __construct(
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
/** @var int|null */
public ?int $skip=null,
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
/** @var int|null */
public ?int $take=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['skip'])) $this->skip = $o['skip'];
if (isset($o['take'])) $this->take = $o['take'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->skip)) $o['skip'] = $this->skip;
if (isset($this->take)) $o['take'] = $this->take;
return empty($o) ? new class(){} : $o;
}
}
/** @description Specifies a service request to retrieve an account. */
// @Api(Description="Specifies a service request to retrieve an account.")
class RetrieveAccountBase extends PaginationBase implements IGet, JsonSerializable
{
/**
* @param int|null $skip
* @param int|null $take
*/
public function __construct(
?int $skip=null,
?int $take=null,
/** @description The user name of the account. */
// @ApiMember(Description="The user name of the account.")
/** @var string|null */
public ?string $userName=null,
/** @description Should the related products of the account be included in the retrieved account? */
// @ApiMember(Description="Should the related products of the account be included in the retrieved account?")
/** @var bool|null */
public ?bool $includeProducts=null,
/** @description Should the related orders of the account be included in the retrieved account? */
// @ApiMember(Description="Should the related orders of the account be included in the retrieved account?")
/** @var bool|null */
public ?bool $includeOrders=null,
/** @description Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. */
// @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ")
/** @var int|null */
public ?int $skipProducts=null,
/** @description Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. */
// @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ")
/** @var int|null */
public ?int $takeProducts=null,
/** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. */
// @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
/** @var int|null */
public ?int $skipOrders=null,
/** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. */
// @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
/** @var int|null */
public ?int $takeOrders=null
) {
parent::__construct($skip,$take);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['userName'])) $this->userName = $o['userName'];
if (isset($o['includeProducts'])) $this->includeProducts = $o['includeProducts'];
if (isset($o['includeOrders'])) $this->includeOrders = $o['includeOrders'];
if (isset($o['skipProducts'])) $this->skipProducts = $o['skipProducts'];
if (isset($o['takeProducts'])) $this->takeProducts = $o['takeProducts'];
if (isset($o['skipOrders'])) $this->skipOrders = $o['skipOrders'];
if (isset($o['takeOrders'])) $this->takeOrders = $o['takeOrders'];
if (isset($o['skip'])) $this->skip = $o['skip'];
if (isset($o['take'])) $this->take = $o['take'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->userName)) $o['userName'] = $this->userName;
if (isset($this->includeProducts)) $o['includeProducts'] = $this->includeProducts;
if (isset($this->includeOrders)) $o['includeOrders'] = $this->includeOrders;
if (isset($this->skipProducts)) $o['skipProducts'] = $this->skipProducts;
if (isset($this->takeProducts)) $o['takeProducts'] = $this->takeProducts;
if (isset($this->skipOrders)) $o['skipOrders'] = $this->skipOrders;
if (isset($this->takeOrders)) $o['takeOrders'] = $this->takeOrders;
if (isset($this->skip)) $o['skip'] = $this->skip;
if (isset($this->take)) $o['take'] = $this->take;
return empty($o) ? new class(){} : $o;
}
}
/** @description Specifies a base service response class that contains a structured error information. */
// @Api(Description="Specifies a base service response class that contains a structured error information.")
class ServiceResponseBase implements JsonSerializable
{
public function __construct(
/** @description Data structure that holds error information from a service operation. */
// @ApiMember(Description="Data structure that holds error information from a service operation.")
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a user account. */
// @Api(Description="Represents a user account.")
class Account implements IHasUserName, JsonSerializable
{
public function __construct(
/** @description The unique identifier of the user account. */
// @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
/** @var int */
public int $id=0,
/** @description The position of this instance in a collection of 'Account' instances */
// @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
/** @var int */
public int $index=0,
/** @description The unique identifier of the customer associated with this account. */
// @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
/** @var int */
public int $refId=0,
/** @description The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'. */
// @ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
/** @var string|null */
public ?string $refIdStr=null,
/** @description The unique user name of the user account. */
// @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
/** @var string */
public string $userName='',
/** @description The electronic mail address of the user account. */
// @ApiMember(Description="The electronic mail address of the user account.")
/** @var string|null */
public ?string $email=null,
/** @description The friendly name of the user account. */
// @ApiMember(Description="The friendly name of the user account.")
/** @var string|null */
public ?string $displayName=null,
/** @description The first name of the owner (natural person) of the user account. */
// @ApiMember(Description="The first name of the owner (natural person) of the user account.")
/** @var string|null */
public ?string $firstName=null,
/** @description The last name of the owner (natural person) of the user account. */
// @ApiMember(Description="The last name of the owner (natural person) of the user account.")
/** @var string|null */
public ?string $lastName=null,
/** @description The unique identifier of the customer associated with this account. */
// @ApiMember(Description="The unique identifier of the customer associated with this account.")
/** @var string|null */
public ?string $fullName=null,
/** @description The gender of the owner (natural person) of the user account. */
// @ApiMember(Description="The gender of the owner (natural person) of the user account.")
/** @var string|null */
public ?string $gender=null,
/** @description The language of the owner of teh user account. */
// @ApiMember(Description="The language of the owner of teh user account.")
/** @var string|null */
public ?string $language=null,
/** @description The company, where the user is an employee. */
// @ApiMember(Description="The company, where the user is an employee.")
/** @var string|null */
public ?string $company=null,
/** @description The profile URL of the user account. */
// @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
/** @var string */
public string $profileUrl='',
/** @description The roles assigned to the user account. */
// @ApiMember(Description="The roles assigned to the user account.")
/** @var array<string>|null */
public ?array $roles=null,
/** @description The permissions assigned to the user account. */
// @ApiMember(Description="The permissions assigned to the user account.")
/** @var array<string>|null */
public ?array $permissions=null,
/** @description The primary e-mail address of the user. */
// @ApiMember(Description="The primary e-mail address of the user.")
/** @var string|null */
public ?string $primaryEmail=null,
/** @description Random data to enhance the security of the user password. */
// @ApiMember(Description="Random data to enhance the security of the user password.")
/** @var string|null */
public ?string $salt=null,
/** @description The hash value of the user password that the PBKDF2 algorithm produces. */
// @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
/** @var string|null */
public ?string $passwordHash=null,
/** @description The hash value of the user password that the DigestHa1 algorithm produces. */
// @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
/** @var string|null */
public ?string $digestHa1Hash=null,
/** @description The number of times the user account tried to sign in but failed. */
// @ApiMember(Description="The number of times the user account tried to sign in but failed.")
/** @var int */
public int $invalidLoginAttempts=0,
/** @description The last time the user account attempted a sign in. */
// @ApiMember(Description="The last time the user account attempted a sign in.")
/** @var DateTime|null */
public ?DateTime $lastLoginAttempt=null,
/** @description The date and time when the user acount was denied access. */
// @ApiMember(Description="The date and time when the user acount was denied access.")
/** @var DateTime|null */
public ?DateTime $lockedDate=null,
/** @description The date and time when the user account was created. */
// @ApiMember(Description="The date and time when the user account was created.")
/** @var DateTime */
public DateTime $createdDate=new DateTime(),
/** @description The date and time when the user account was last modified. */
// @ApiMember(Description="The date and time when the user account was last modified.")
/** @var DateTime */
public DateTime $modifiedDate=new DateTime(),
/** @description The telephone number of the owner of the user account. */
// @ApiMember(Description="The telephone number of the owner of the user account.")
/** @var string|null */
public ?string $phoneNumber=null,
/** @description The birth date of the owner of the user account */
// @ApiMember(Description="The birth date of the owner of the user account")
/** @var DateTime|null */
public ?DateTime $birthDate=null,
/** @description The string representation of the birth date of the user account. */
// @ApiMember(Description="The string representation of the birth date of the user account.")
/** @var string|null */
public ?string $birthDateRaw=null,
/** @description The mail address of the user account. */
// @ApiMember(Description="The mail address of the user account.")
/** @var string|null */
public ?string $address=null,
/** @description Additional information for the specified 'Address' of the user. */
// @ApiMember(Description="Additional information for the specified 'Address' of the user.")
/** @var string|null */
public ?string $address2=null,
/** @description The city of the owner of the user account. */
// @ApiMember(Description="The city of the owner of the user account.")
/** @var string|null */
public ?string $city=null,
/** @description The state of the owner of the user account. */
// @ApiMember(Description="The state of the owner of the user account.")
/** @var string|null */
public ?string $state=null,
/** @description The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'. */
// @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
/** @var string|null */
public ?string $country=null,
/** @description The locale of the user account. */
// @ApiMember(Description="The locale of the user account.")
/** @var string|null */
public ?string $culture=null,
/** @description The mail address of the user account. */
// @ApiMember(Description="The mail address of the user account.")
/** @var string|null */
public ?string $mailAddress=null,
/** @description The nickname of the user of the user account. */
// @ApiMember(Description="The nickname of the user of the user account.")
/** @var string|null */
public ?string $nickname=null,
/** @description The postal code of the user account. */
// @ApiMember(Description="The postal code of the user account.")
/** @var string|null */
public ?string $postalCode=null,
/** @description The time zone of the user of the user account. */
// @ApiMember(Description="The time zone of the user of the user account.")
/** @var string|null */
public ?string $timeZone=null,
/** @description Additional information to attach to the user account. */
// @ApiMember(Description="Additional information to attach to the user account.")
/** @var array<string,string>|null */
public ?array $meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['index'])) $this->index = $o['index'];
if (isset($o['refId'])) $this->refId = $o['refId'];
if (isset($o['refIdStr'])) $this->refIdStr = $o['refIdStr'];
if (isset($o['userName'])) $this->userName = $o['userName'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['displayName'])) $this->displayName = $o['displayName'];
if (isset($o['firstName'])) $this->firstName = $o['firstName'];
if (isset($o['lastName'])) $this->lastName = $o['lastName'];
if (isset($o['fullName'])) $this->fullName = $o['fullName'];
if (isset($o['gender'])) $this->gender = $o['gender'];
if (isset($o['language'])) $this->language = $o['language'];
if (isset($o['company'])) $this->company = $o['company'];
if (isset($o['profileUrl'])) $this->profileUrl = $o['profileUrl'];
if (isset($o['roles'])) $this->roles = JsonConverters::fromArray('string', $o['roles']);
if (isset($o['permissions'])) $this->permissions = JsonConverters::fromArray('string', $o['permissions']);
if (isset($o['primaryEmail'])) $this->primaryEmail = $o['primaryEmail'];
if (isset($o['salt'])) $this->salt = $o['salt'];
if (isset($o['passwordHash'])) $this->passwordHash = $o['passwordHash'];
if (isset($o['digestHa1Hash'])) $this->digestHa1Hash = $o['digestHa1Hash'];
if (isset($o['invalidLoginAttempts'])) $this->invalidLoginAttempts = $o['invalidLoginAttempts'];
if (isset($o['lastLoginAttempt'])) $this->lastLoginAttempt = JsonConverters::from('DateTime', $o['lastLoginAttempt']);
if (isset($o['lockedDate'])) $this->lockedDate = JsonConverters::from('DateTime', $o['lockedDate']);
if (isset($o['createdDate'])) $this->createdDate = JsonConverters::from('DateTime', $o['createdDate']);
if (isset($o['modifiedDate'])) $this->modifiedDate = JsonConverters::from('DateTime', $o['modifiedDate']);
if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
if (isset($o['birthDate'])) $this->birthDate = JsonConverters::from('DateTime', $o['birthDate']);
if (isset($o['birthDateRaw'])) $this->birthDateRaw = $o['birthDateRaw'];
if (isset($o['address'])) $this->address = $o['address'];
if (isset($o['address2'])) $this->address2 = $o['address2'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['state'])) $this->state = $o['state'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['culture'])) $this->culture = $o['culture'];
if (isset($o['mailAddress'])) $this->mailAddress = $o['mailAddress'];
if (isset($o['nickname'])) $this->nickname = $o['nickname'];
if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
if (isset($o['timeZone'])) $this->timeZone = $o['timeZone'];
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->index)) $o['index'] = $this->index;
if (isset($this->refId)) $o['refId'] = $this->refId;
if (isset($this->refIdStr)) $o['refIdStr'] = $this->refIdStr;
if (isset($this->userName)) $o['userName'] = $this->userName;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->displayName)) $o['displayName'] = $this->displayName;
if (isset($this->firstName)) $o['firstName'] = $this->firstName;
if (isset($this->lastName)) $o['lastName'] = $this->lastName;
if (isset($this->fullName)) $o['fullName'] = $this->fullName;
if (isset($this->gender)) $o['gender'] = $this->gender;
if (isset($this->language)) $o['language'] = $this->language;
if (isset($this->company)) $o['company'] = $this->company;
if (isset($this->profileUrl)) $o['profileUrl'] = $this->profileUrl;
if (isset($this->roles)) $o['roles'] = JsonConverters::toArray('string', $this->roles);
if (isset($this->permissions)) $o['permissions'] = JsonConverters::toArray('string', $this->permissions);
if (isset($this->primaryEmail)) $o['primaryEmail'] = $this->primaryEmail;
if (isset($this->salt)) $o['salt'] = $this->salt;
if (isset($this->passwordHash)) $o['passwordHash'] = $this->passwordHash;
if (isset($this->digestHa1Hash)) $o['digestHa1Hash'] = $this->digestHa1Hash;
if (isset($this->invalidLoginAttempts)) $o['invalidLoginAttempts'] = $this->invalidLoginAttempts;
if (isset($this->lastLoginAttempt)) $o['lastLoginAttempt'] = JsonConverters::to('DateTime', $this->lastLoginAttempt);
if (isset($this->lockedDate)) $o['lockedDate'] = JsonConverters::to('DateTime', $this->lockedDate);
if (isset($this->createdDate)) $o['createdDate'] = JsonConverters::to('DateTime', $this->createdDate);
if (isset($this->modifiedDate)) $o['modifiedDate'] = JsonConverters::to('DateTime', $this->modifiedDate);
if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
if (isset($this->birthDate)) $o['birthDate'] = JsonConverters::to('DateTime', $this->birthDate);
if (isset($this->birthDateRaw)) $o['birthDateRaw'] = $this->birthDateRaw;
if (isset($this->address)) $o['address'] = $this->address;
if (isset($this->address2)) $o['address2'] = $this->address2;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->state)) $o['state'] = $this->state;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->culture)) $o['culture'] = $this->culture;
if (isset($this->mailAddress)) $o['mailAddress'] = $this->mailAddress;
if (isset($this->nickname)) $o['nickname'] = $this->nickname;
if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
if (isset($this->timeZone)) $o['timeZone'] = $this->timeZone;
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a product. */
// @Api(Description="Represents a product.")
class Product implements IHasName, JsonSerializable
{
public function __construct(
/** @description The unique identifier of the product. */
// @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
/** @var int */
public int $id=0,
/** @description The position of this instance in a collection of 'Product' instances */
// @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
/** @var int */
public int $index=0,
/** @description The name of the product. */
// @ApiMember(Description="The name of the product.", IsRequired=true)
// @Validate(Validator="NotEmpty")
/** @var string */
public string $name='',
/** @description The version of the product. */
// @ApiMember(Description="The version of the product.", IsRequired=true)
// @Validate(Validator="NotEmpty")
/** @var string */
public string $version='',
/** @description The version of the product. */
// @ApiMember(Description="The version of the product.")
/** @var string|null */
public ?string $description=null,
/** @description Tags associated with the product. */
// @ApiMember(Description="Tags associated with the product.")
/** @var array<string>|null */
public ?array $tags=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['index'])) $this->index = $o['index'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['version'])) $this->version = $o['version'];
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['tags'])) $this->tags = JsonConverters::fromArray('string', $o['tags']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->index)) $o['index'] = $this->index;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->version)) $o['version'] = $this->version;
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->tags)) $o['tags'] = JsonConverters::toArray('string', $this->tags);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a commission to consume services. */
// @Api(Description="Represents a commission to consume services.")
class Order implements IHasName, JsonSerializable
{
public function __construct(
/** @description The unique identifier of the order. */
// @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
/** @var int */
public int $id=0,
/** @description The unique identifier of the product, for which the order is made. */
// @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
/** @var int */
public int $productId=0,
/** @description The unique identifier of the user account, who placed the order. */
// @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
/** @var int */
public int $accountId=0,
/** @description A name to identify the order. */
// @ApiMember(Description="A name to identify the order.", IsRequired=true)
// @Validate(Validator="NotEmpty")
/** @var string */
public string $name='',
/** @description The name of the service, for which the order was made. */
// @ApiMember(Description="The name of the service, for which the order was made.")
/** @var string|null */
public ?string $serviceName=null,
/** @description The time stamp at which the order was initiated. */
// @ApiMember(Description="The time stamp at which the order was initiated.")
/** @var DateTime|null */
public ?DateTime $requestTimestamp=null,
/** @description The time stamp at which the order was completed. */
// @ApiMember(Description="The time stamp at which the order was completed.")
/** @var DateTime|null */
public ?DateTime $responseTimestamp=null,
/** @description The URI from which the order was initiated. */
// @ApiMember(Description="The URI from which the order was initiated.")
/** @var string|null */
public ?string $requestUri=null,
/** @description The HTTP method of the order request. */
// @ApiMember(Description="The HTTP method of the order request.")
/** @var string|null */
public ?string $requestHttpMethod=null,
/** @description The duration of the order request. */
// @ApiMember(Description="The duration of the order request.")
/** @var DateInterval|null */
public ?DateInterval $requestDuration=null,
/** @description The HTTP status code of the order request. */
// @ApiMember(Description="The HTTP status code of the order request.")
/** @var HttpStatusCode|null */
public ?HttpStatusCode $responseStatusCode=null,
/** @description The IP address of client, who placed the order. */
// @ApiMember(Description="The IP address of client, who placed the order.")
/** @var string|null */
public ?string $clientIPAddress=null,
/** @description The unit of measurement for the order. */
// @ApiMember(Description="The unit of measurement for the order.")
/** @var string|null */
public ?string $unitOfMeasurement=null,
/** @description The type of process, for which the order is charged. */
// @ApiMember(Description="The type of process, for which the order is charged.")
/** @var string|null */
public ?string $processType=null,
/** @description The type of data, for which the order is charged. */
// @ApiMember(Description="The type of data, for which the order is charged.")
/** @var string|null */
public ?string $dataType=null,
/** @description The name of the data, for which the order is charged. */
// @ApiMember(Description="The name of the data, for which the order is charged.")
/** @var string|null */
public ?string $dataName=null,
/** @description The date of creation of the order. */
// @ApiMember(Description="The date of creation of the order.")
/** @var DateTime */
public DateTime $creationDate=new DateTime(),
/** @description The final date to retain the order in the records. After this date, the order is expunged from the records. */
// @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
/** @var DateTime|null */
public ?DateTime $expiryDate=null,
/** @description Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes. */
// @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
/** @var bool|null */
public ?bool $isTest=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['productId'])) $this->productId = $o['productId'];
if (isset($o['accountId'])) $this->accountId = $o['accountId'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['serviceName'])) $this->serviceName = $o['serviceName'];
if (isset($o['requestTimestamp'])) $this->requestTimestamp = JsonConverters::from('DateTime', $o['requestTimestamp']);
if (isset($o['responseTimestamp'])) $this->responseTimestamp = JsonConverters::from('DateTime', $o['responseTimestamp']);
if (isset($o['requestUri'])) $this->requestUri = $o['requestUri'];
if (isset($o['requestHttpMethod'])) $this->requestHttpMethod = $o['requestHttpMethod'];
if (isset($o['requestDuration'])) $this->requestDuration = JsonConverters::from('TimeSpan', $o['requestDuration']);
if (isset($o['responseStatusCode'])) $this->responseStatusCode = JsonConverters::from('HttpStatusCode', $o['responseStatusCode']);
if (isset($o['clientIPAddress'])) $this->clientIPAddress = $o['clientIPAddress'];
if (isset($o['unitOfMeasurement'])) $this->unitOfMeasurement = $o['unitOfMeasurement'];
if (isset($o['processType'])) $this->processType = $o['processType'];
if (isset($o['dataType'])) $this->dataType = $o['dataType'];
if (isset($o['dataName'])) $this->dataName = $o['dataName'];
if (isset($o['creationDate'])) $this->creationDate = JsonConverters::from('DateTime', $o['creationDate']);
if (isset($o['expiryDate'])) $this->expiryDate = JsonConverters::from('DateTime', $o['expiryDate']);
if (isset($o['isTest'])) $this->isTest = $o['isTest'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->productId)) $o['productId'] = $this->productId;
if (isset($this->accountId)) $o['accountId'] = $this->accountId;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->serviceName)) $o['serviceName'] = $this->serviceName;
if (isset($this->requestTimestamp)) $o['requestTimestamp'] = JsonConverters::to('DateTime', $this->requestTimestamp);
if (isset($this->responseTimestamp)) $o['responseTimestamp'] = JsonConverters::to('DateTime', $this->responseTimestamp);
if (isset($this->requestUri)) $o['requestUri'] = $this->requestUri;
if (isset($this->requestHttpMethod)) $o['requestHttpMethod'] = $this->requestHttpMethod;
if (isset($this->requestDuration)) $o['requestDuration'] = JsonConverters::to('TimeSpan', $this->requestDuration);
if (isset($this->responseStatusCode)) $o['responseStatusCode'] = JsonConverters::to('HttpStatusCode', $this->responseStatusCode);
if (isset($this->clientIPAddress)) $o['clientIPAddress'] = $this->clientIPAddress;
if (isset($this->unitOfMeasurement)) $o['unitOfMeasurement'] = $this->unitOfMeasurement;
if (isset($this->processType)) $o['processType'] = $this->processType;
if (isset($this->dataType)) $o['dataType'] = $this->dataType;
if (isset($this->dataName)) $o['dataName'] = $this->dataName;
if (isset($this->creationDate)) $o['creationDate'] = JsonConverters::to('DateTime', $this->creationDate);
if (isset($this->expiryDate)) $o['expiryDate'] = JsonConverters::to('DateTime', $this->expiryDate);
if (isset($this->isTest)) $o['isTest'] = $this->isTest;
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a service response that contains a structured error information and encapsulates a user account. */
// @Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.")
class AccountResponse extends ServiceResponseBase implements JsonSerializable
{
/**
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
?ResponseStatus $responseStatus=null,
/** @description The user account encapsulated in the response. */
// @ApiMember(Description="The user account encapsulated in the response.")
/** @var Account|null */
public ?Account $account=null,
/** @description The index position of the reponse in a collection, if it were returned together with other responses. */
// @ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")
/** @var int */
public int $index=0,
/** @description The list of products associated with the encapsulated user account. */
// @ApiMember(Description="The list of products associated with the encapsulated user account.")
/** @var array<Product>|null */
public ?array $products=null,
/** @description The list of orders associated with the encapsulated user account. */
// @ApiMember(Description="The list of orders associated with the encapsulated user account.")
/** @var array<Order>|null */
public ?array $orders=null
) {
parent::__construct($responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['account'])) $this->account = JsonConverters::from('Account', $o['account']);
if (isset($o['index'])) $this->index = $o['index'];
if (isset($o['products'])) $this->products = JsonConverters::fromArray('Product', $o['products']);
if (isset($o['orders'])) $this->orders = JsonConverters::fromArray('Order', $o['orders']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->account)) $o['account'] = JsonConverters::to('Account', $this->account);
if (isset($this->index)) $o['index'] = $this->index;
if (isset($this->products)) $o['products'] = JsonConverters::toArray('Product', $this->products);
if (isset($this->orders)) $o['orders'] = JsonConverters::toArray('Order', $this->orders);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a service request to retrieve an account. */
// @Api(Description="Represents a service request to retrieve an account.")
class RetrieveAccount extends RetrieveAccountBase implements JsonSerializable
{
/**
* @param int|null $skip
* @param int|null $take
* @param string|null $userName
* @param bool|null $includeProducts
* @param bool|null $includeOrders
* @param int|null $skipProducts
* @param int|null $takeProducts
* @param int|null $skipOrders
* @param int|null $takeOrders
* @param int|null $skip
* @param int|null $take
*/
public function __construct(
?int $skip=null,
?int $take=null,
?string $userName=null,
?bool $includeProducts=null,
?bool $includeOrders=null,
?int $skipProducts=null,
?int $takeProducts=null,
?int $skipOrders=null,
?int $takeOrders=null,
?int $skip=null,
?int $take=null
) {
parent::__construct($skip,$take,$userName,$includeProducts,$includeOrders,$skipProducts,$takeProducts,$skipOrders,$takeOrders,$skip,$take);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['userName'])) $this->userName = $o['userName'];
if (isset($o['includeProducts'])) $this->includeProducts = $o['includeProducts'];
if (isset($o['includeOrders'])) $this->includeOrders = $o['includeOrders'];
if (isset($o['skipProducts'])) $this->skipProducts = $o['skipProducts'];
if (isset($o['takeProducts'])) $this->takeProducts = $o['takeProducts'];
if (isset($o['skipOrders'])) $this->skipOrders = $o['skipOrders'];
if (isset($o['takeOrders'])) $this->takeOrders = $o['takeOrders'];
if (isset($o['skip'])) $this->skip = $o['skip'];
if (isset($o['take'])) $this->take = $o['take'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->userName)) $o['userName'] = $this->userName;
if (isset($this->includeProducts)) $o['includeProducts'] = $this->includeProducts;
if (isset($this->includeOrders)) $o['includeOrders'] = $this->includeOrders;
if (isset($this->skipProducts)) $o['skipProducts'] = $this->skipProducts;
if (isset($this->takeProducts)) $o['takeProducts'] = $this->takeProducts;
if (isset($this->skipOrders)) $o['skipOrders'] = $this->skipOrders;
if (isset($this->takeOrders)) $o['takeOrders'] = $this->takeOrders;
if (isset($this->skip)) $o['skip'] = $this->skip;
if (isset($this->take)) $o['take'] = $this->take;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/accounts/retrieve HTTP/1.1 Host: taxfiling.pwc.de Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"account":{"id":0,"index":0,"refId":0,"refIdStr":"String","userName":"String","email":"String","displayName":"String","firstName":"String","lastName":"String","fullName":"String","gender":"String","language":"String","company":"String","profileUrl":"String","roles":["String"],"permissions":["String"],"primaryEmail":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","invalidLoginAttempts":0,"lastLoginAttempt":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","phoneNumber":"String","birthDate":"\/Date(-62135596800000-0000)\/","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","meta":{"String":"String"}},"index":0,"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}],"orders":[{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}