Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/customers/search |
|---|
<?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;
}
}
enum CustomerType : string
{
case Internal = 'Internal';
case Network = 'Network';
case External = 'External';
}
/** @description Specifies a service to search for customers. */
// @Api(Description="Specifies a service to search for customers.")
class SearchCustomersBase extends PaginationBase implements IGet, JsonSerializable
{
/**
* @param int|null $skip
* @param int|null $take
*/
public function __construct(
?int $skip=null,
?int $take=null,
/** @description The unique identifier of the customer. */
// @ApiMember(Description="The unique identifier of the customer.")
/** @var int|null */
public ?int $customerId=null,
/** @description The name of the customer. */
// @ApiMember(Description="The name of the customer.")
/** @var string|null */
public ?string $name=null,
/** @description Search by using the name of the customer that starts with the specified value. */
// @ApiMember(Description="Search by using the name of the customer that starts with the specified value.")
/** @var string|null */
public ?string $nameStartsWith=null,
/** @description Search by using the name of the customer that ends with the specified value. */
// @ApiMember(Description="Search by using the name of the customer that ends with the specified value.")
/** @var string|null */
public ?string $nameEndsWith=null,
/** @description Search by using the name of the customer that contains the specified value. */
// @ApiMember(Description="Search by using the name of the customer that contains the specified value.")
/** @var string|null */
public ?string $nameContains=null,
/** @description The country of residence or headquarters of customer. */
// @ApiMember(Description="The country of residence or headquarters of customer.")
/** @var string|null */
public ?string $country=null,
/** @description Search by using the country of the customer that starts with the specified value. */
// @ApiMember(Description="Search by using the country of the customer that starts with the specified value.")
/** @var string|null */
public ?string $countryStartsWith=null,
/** @description Search by using the country of the customer that ends with the specified value. */
// @ApiMember(Description="Search by using the country of the customer that ends with the specified value.")
/** @var string|null */
public ?string $countryEndsWith=null,
/** @description Search by using the country of the customer that contains the specified value. */
// @ApiMember(Description="Search by using the country of the customer that contains the specified value.")
/** @var string|null */
public ?string $countryContains=null,
/** @description The type of customer. */
// @ApiMember(Description="The type of customer.")
/** @var CustomerType|null */
public ?CustomerType $type=null,
/** @description Should related accounts be included in the retrieved customers? */
// @ApiMember(Description="Should related accounts be included in the retrieved customers?")
/** @var bool|null */
public ?bool $includeAccounts=null,
/** @description Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. */
// @ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
/** @var int|null */
public ?int $skipAccounts=null,
/** @description Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. */
// @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
/** @var int|null */
public ?int $takeAccounts=null
) {
parent::__construct($skip,$take);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['customerId'])) $this->customerId = $o['customerId'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['nameStartsWith'])) $this->nameStartsWith = $o['nameStartsWith'];
if (isset($o['nameEndsWith'])) $this->nameEndsWith = $o['nameEndsWith'];
if (isset($o['nameContains'])) $this->nameContains = $o['nameContains'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['countryStartsWith'])) $this->countryStartsWith = $o['countryStartsWith'];
if (isset($o['countryEndsWith'])) $this->countryEndsWith = $o['countryEndsWith'];
if (isset($o['countryContains'])) $this->countryContains = $o['countryContains'];
if (isset($o['type'])) $this->type = JsonConverters::from('CustomerType', $o['type']);
if (isset($o['includeAccounts'])) $this->includeAccounts = $o['includeAccounts'];
if (isset($o['skipAccounts'])) $this->skipAccounts = $o['skipAccounts'];
if (isset($o['takeAccounts'])) $this->takeAccounts = $o['takeAccounts'];
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->customerId)) $o['customerId'] = $this->customerId;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->nameStartsWith)) $o['nameStartsWith'] = $this->nameStartsWith;
if (isset($this->nameEndsWith)) $o['nameEndsWith'] = $this->nameEndsWith;
if (isset($this->nameContains)) $o['nameContains'] = $this->nameContains;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->countryStartsWith)) $o['countryStartsWith'] = $this->countryStartsWith;
if (isset($this->countryEndsWith)) $o['countryEndsWith'] = $this->countryEndsWith;
if (isset($this->countryContains)) $o['countryContains'] = $this->countryContains;
if (isset($this->type)) $o['type'] = JsonConverters::to('CustomerType', $this->type);
if (isset($this->includeAccounts)) $o['includeAccounts'] = $this->includeAccounts;
if (isset($this->skipAccounts)) $o['skipAccounts'] = $this->skipAccounts;
if (isset($this->takeAccounts)) $o['takeAccounts'] = $this->takeAccounts;
if (isset($this->skip)) $o['skip'] = $this->skip;
if (isset($this->take)) $o['take'] = $this->take;
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 customer (business organization or entrepreneur). */
// @Api(Description="Represents a customer (business organization or entrepreneur).")
class Customer implements IHasName, JsonSerializable
{
public function __construct(
/** @description The unique identifier of the customer. */
// @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
/** @var int */
public int $id=0,
/** @description The position of this instance in a collection of 'Customer' instances */
// @ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)
/** @var int */
public int $index=0,
/** @description Full name or organization name of customer. */
// @ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
// @Validate(Validator="NotEmpty")
/** @var string */
public string $name='',
/** @description The country of residence or business of customer. */
// @ApiMember(Description="The country of residence or business of customer.")
/** @var string|null */
public ?string $country=null,
/** @description The type of customer. */
// @ApiMember(Description="The type of customer.")
/** @var CustomerType|null */
public ?CustomerType $type=null,
/** @description The list of user accounts associated with this customer. */
// @ApiMember(Description="The list of user accounts associated with this customer.")
// @Ignore()
/** @var array<Account>|null */
public ?array $accounts=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['country'])) $this->country = $o['country'];
if (isset($o['type'])) $this->type = JsonConverters::from('CustomerType', $o['type']);
if (isset($o['accounts'])) $this->accounts = JsonConverters::fromArray('Account', $o['accounts']);
}
/** @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->country)) $o['country'] = $this->country;
if (isset($this->type)) $o['type'] = JsonConverters::to('CustomerType', $this->type);
if (isset($this->accounts)) $o['accounts'] = JsonConverters::toArray('Account', $this->accounts);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a query response that contains a structured error information and encapsulates customers. */
// @Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
/**
* @template QueryResponse of Customer
*/
class CustomerQueryResponse extends QueryResponse implements JsonSerializable
{
/**
* @param int $offset
* @param int $total
* @param array<T>|null $results
* @param array<string,string>|null $meta
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
int $offset=0,
int $total=0,
?array $results=null,
?array $meta=null,
?ResponseStatus $responseStatus=null
) {
parent::__construct($offset,$total,$results,$meta,$responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['offset'])) $this->offset = $o['offset'];
if (isset($o['total'])) $this->total = $o['total'];
if (isset($o['results'])) $this->results = JsonConverters::fromArray('Customer', $o['results']);
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->offset)) $o['offset'] = $this->offset;
if (isset($this->total)) $o['total'] = $this->total;
if (isset($this->results)) $o['results'] = JsonConverters::toArray('Customer', $this->results);
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Represents a service request to query customer data in an asynchronous operation. */
// @Api(Description="Represents a service request to query customer data in an asynchronous operation.")
class SearchCustomersAsync extends SearchCustomersBase implements JsonSerializable
{
/**
* @param int|null $skip
* @param int|null $take
* @param int|null $customerId
* @param string|null $name
* @param string|null $nameStartsWith
* @param string|null $nameEndsWith
* @param string|null $nameContains
* @param string|null $country
* @param string|null $countryStartsWith
* @param string|null $countryEndsWith
* @param string|null $countryContains
* @param CustomerType|null $type
* @param bool|null $includeAccounts
* @param int|null $skipAccounts
* @param int|null $takeAccounts
* @param int|null $skip
* @param int|null $take
*/
public function __construct(
?int $skip=null,
?int $take=null,
?int $customerId=null,
?string $name=null,
?string $nameStartsWith=null,
?string $nameEndsWith=null,
?string $nameContains=null,
?string $country=null,
?string $countryStartsWith=null,
?string $countryEndsWith=null,
?string $countryContains=null,
?CustomerType $type=null,
?bool $includeAccounts=null,
?int $skipAccounts=null,
?int $takeAccounts=null,
?int $skip=null,
?int $take=null
) {
parent::__construct($skip,$take,$customerId,$name,$nameStartsWith,$nameEndsWith,$nameContains,$country,$countryStartsWith,$countryEndsWith,$countryContains,$type,$includeAccounts,$skipAccounts,$takeAccounts,$skip,$take);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['customerId'])) $this->customerId = $o['customerId'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['nameStartsWith'])) $this->nameStartsWith = $o['nameStartsWith'];
if (isset($o['nameEndsWith'])) $this->nameEndsWith = $o['nameEndsWith'];
if (isset($o['nameContains'])) $this->nameContains = $o['nameContains'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['countryStartsWith'])) $this->countryStartsWith = $o['countryStartsWith'];
if (isset($o['countryEndsWith'])) $this->countryEndsWith = $o['countryEndsWith'];
if (isset($o['countryContains'])) $this->countryContains = $o['countryContains'];
if (isset($o['type'])) $this->type = JsonConverters::from('CustomerType', $o['type']);
if (isset($o['includeAccounts'])) $this->includeAccounts = $o['includeAccounts'];
if (isset($o['skipAccounts'])) $this->skipAccounts = $o['skipAccounts'];
if (isset($o['takeAccounts'])) $this->takeAccounts = $o['takeAccounts'];
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->customerId)) $o['customerId'] = $this->customerId;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->nameStartsWith)) $o['nameStartsWith'] = $this->nameStartsWith;
if (isset($this->nameEndsWith)) $o['nameEndsWith'] = $this->nameEndsWith;
if (isset($this->nameContains)) $o['nameContains'] = $this->nameContains;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->countryStartsWith)) $o['countryStartsWith'] = $this->countryStartsWith;
if (isset($this->countryEndsWith)) $o['countryEndsWith'] = $this->countryEndsWith;
if (isset($this->countryContains)) $o['countryContains'] = $this->countryContains;
if (isset($this->type)) $o['type'] = JsonConverters::to('CustomerType', $this->type);
if (isset($this->includeAccounts)) $o['includeAccounts'] = $this->includeAccounts;
if (isset($this->skipAccounts)) $o['skipAccounts'] = $this->skipAccounts;
if (isset($this->takeAccounts)) $o['takeAccounts'] = $this->takeAccounts;
if (isset($this->skip)) $o['skip'] = $this->skip;
if (isset($this->take)) $o['take'] = $this->take;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
/**
* @template T
*/
class QueryResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryResponse {
$to = new QueryResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var int */
public mixed $offset=0,
// @DataMember(Order=2)
/** @var int */
public mixed $total=0,
// @DataMember(Order=3)
/** @var array<T>|null */
public mixed $results=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public mixed $meta=null,
// @DataMember(Order=5)
/** @var ResponseStatus|null */
public mixed $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['offset'])) $this->offset = $o['offset'];
if (isset($o['total'])) $this->total = $o['total'];
if (isset($o['results'])) $this->results = JsonConverters::fromArray($this->genericArgs[0], $o['results']);
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->offset)) $o['offset'] = $this->offset;
if (isset($this->total)) $o['total'] = $this->total;
if (isset($this->results)) $o['results'] = JsonConverters::toArray($this->genericArgs[0], $this->results);
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /async/customers/search HTTP/1.1 Host: taxfiling.pwc.de Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"id":0,"index":0,"name":"String","country":"String","type":"Internal","accounts":[{"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"}}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}