| PUT | /mailchimp/member/company/customer/sync | sync mailchimp memebers |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class MemberTag implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $Name=null,
/** @var DateTime|null */
public ?DateTime $DateAdded=null,
/** @var string|null */
public ?string $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['DateAdded'])) $this->DateAdded = JsonConverters::from('DateTime', $o['DateAdded']);
if (isset($o['Status'])) $this->Status = $o['Status'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->DateAdded)) $o['DateAdded'] = JsonConverters::to('DateTime', $this->DateAdded);
if (isset($this->Status)) $o['Status'] = $this->Status;
return empty($o) ? new class(){} : $o;
}
}
class MemberResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $EmailAddress=null,
/** @var string|null */
public ?string $FullName=null,
/** @var array<MemberTag>|null */
public ?array $Tags=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['EmailAddress'])) $this->EmailAddress = $o['EmailAddress'];
if (isset($o['FullName'])) $this->FullName = $o['FullName'];
if (isset($o['Tags'])) $this->Tags = JsonConverters::fromArray('MemberTag', $o['Tags']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->EmailAddress)) $o['EmailAddress'] = $this->EmailAddress;
if (isset($this->FullName)) $o['FullName'] = $this->FullName;
if (isset($this->Tags)) $o['Tags'] = JsonConverters::toArray('MemberTag', $this->Tags);
return empty($o) ? new class(){} : $o;
}
}
class SyncMembersResponse implements JsonSerializable
{
public function __construct(
/** @var array<MemberResponse>|null */
public ?array $FailedSyncedMembers=null,
/** @var array<MemberResponse>|null */
public ?array $SuccessSyncedMembers=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FailedSyncedMembers'])) $this->FailedSyncedMembers = JsonConverters::fromArray('MemberResponse', $o['FailedSyncedMembers']);
if (isset($o['SuccessSyncedMembers'])) $this->SuccessSyncedMembers = JsonConverters::fromArray('MemberResponse', $o['SuccessSyncedMembers']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FailedSyncedMembers)) $o['FailedSyncedMembers'] = JsonConverters::toArray('MemberResponse', $this->FailedSyncedMembers);
if (isset($this->SuccessSyncedMembers)) $o['SuccessSyncedMembers'] = JsonConverters::toArray('MemberResponse', $this->SuccessSyncedMembers);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class SyncCompanyCustomerMembers implements ICompany, JsonSerializable
{
public function __construct(
/** @description The company id, if empty will use the company id for the user you are logged in with. */
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description Should we delete emails that do not exist in BokaMera. */
// @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
/** @var bool|null */
public ?bool $DeleteNonExisting=null,
/** @description Should we target only subscribed to newsletter customers. */
// @ApiMember(Description="Should we target only subscribed to newsletter customers.")
/** @var bool|null */
public ?bool $OnlySubscribed=null,
/** @description Determines if it is a test user */
// @ApiMember(Description="Determines if it is a test user")
/** @var bool|null */
public ?bool $Test=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['DeleteNonExisting'])) $this->DeleteNonExisting = $o['DeleteNonExisting'];
if (isset($o['OnlySubscribed'])) $this->OnlySubscribed = $o['OnlySubscribed'];
if (isset($o['Test'])) $this->Test = $o['Test'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->DeleteNonExisting)) $o['DeleteNonExisting'] = $this->DeleteNonExisting;
if (isset($this->OnlySubscribed)) $o['OnlySubscribed'] = $this->OnlySubscribed;
if (isset($this->Test)) $o['Test'] = $this->Test;
return empty($o) ? new class(){} : $o;
}
}
PHP SyncCompanyCustomerMembers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /mailchimp/member/company/customer/sync HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
DeleteNonExisting: False,
OnlySubscribed: False,
Test: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
FailedSyncedMembers:
[
{
EmailAddress: String,
FullName: String,
Tags:
[
{
Id: 0,
Name: String,
DateAdded: "0001-01-01T00:00:00",
Status: String
}
]
}
],
SuccessSyncedMembers:
[
{
EmailAddress: String,
FullName: String,
Tags:
[
{
Id: 0,
Name: String,
DateAdded: "0001-01-01T00:00:00",
Status: String
}
]
}
]
}