| GET | /v2/settings/apple-services |
|---|
<?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 V2BaseRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class V2BaseResponse implements JsonSerializable
{
public function __construct(
// @DataMember(Name="responseStatus")
/** @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;
}
}
enum AffiliateSettingsOption : string
{
case None = 'none';
case Custom = 'custom';
case Booklinker = 'booklinker';
}
enum EnrollmentState : string
{
case None = 'none';
case Pending = 'pending';
case Approved = 'approved';
case Rejected = 'rejected';
}
// @DataContract
class GetAppleServicesSettingsResponseData implements JsonSerializable
{
public function __construct(
// @DataMember(Name="selectedOption")
/** @var AffiliateSettingsOption|null */
public ?AffiliateSettingsOption $selectedOption=null,
// @DataMember(Name="username")
/** @var string|null */
public ?string $username=null,
// @DataMember(Name="userEmail")
/** @var string|null */
public ?string $userEmail=null,
// @DataMember(Name="booklinkerToken")
/** @var string|null */
public ?string $booklinkerToken=null,
// @DataMember(Name="customToken")
/** @var string|null */
public ?string $customToken=null,
// @DataMember(Name="enrollmentState")
/** @var EnrollmentState|null */
public ?EnrollmentState $enrollmentState=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['selectedOption'])) $this->selectedOption = JsonConverters::from('AffiliateSettingsOption', $o['selectedOption']);
if (isset($o['username'])) $this->username = $o['username'];
if (isset($o['userEmail'])) $this->userEmail = $o['userEmail'];
if (isset($o['booklinkerToken'])) $this->booklinkerToken = $o['booklinkerToken'];
if (isset($o['customToken'])) $this->customToken = $o['customToken'];
if (isset($o['enrollmentState'])) $this->enrollmentState = JsonConverters::from('EnrollmentState', $o['enrollmentState']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->selectedOption)) $o['selectedOption'] = JsonConverters::to('AffiliateSettingsOption', $this->selectedOption);
if (isset($this->username)) $o['username'] = $this->username;
if (isset($this->userEmail)) $o['userEmail'] = $this->userEmail;
if (isset($this->booklinkerToken)) $o['booklinkerToken'] = $this->booklinkerToken;
if (isset($this->customToken)) $o['customToken'] = $this->customToken;
if (isset($this->enrollmentState)) $o['enrollmentState'] = JsonConverters::to('EnrollmentState', $this->enrollmentState);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetAppleServicesSettingsResponse extends V2BaseResponse implements JsonSerializable
{
/**
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
?ResponseStatus $responseStatus=null,
// @DataMember(Name="data")
/** @var GetAppleServicesSettingsResponseData|null */
public ?GetAppleServicesSettingsResponseData $data=null
) {
parent::__construct($responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['data'])) $this->data = JsonConverters::from('GetAppleServicesSettingsResponseData', $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->data)) $o['data'] = JsonConverters::to('GetAppleServicesSettingsResponseData', $this->data);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetAppleServicesSettingsRequest extends V2BaseRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
PHP GetAppleServicesSettingsRequest 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.
GET /v2/settings/apple-services HTTP/1.1 Host: api.booklinker.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetAppleServicesSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses.AppleServices">
<responseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V2.Responses">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</responseStatus>
<data>
<booklinkerToken>String</booklinkerToken>
<customToken>String</customToken>
<enrollmentState>None</enrollmentState>
<selectedOption>None</selectedOption>
<userEmail>String</userEmail>
<username>String</username>
</data>
</GetAppleServicesSettingsResponse>