BokaMera.API.Host

SyncCompanyCustomerMembers

The following routes are available for this service:
PUT	/mailchimp/member/company/customer/sync	Sync mailchimp members

<?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};


// @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 .other suffix or ?format=other

HTTP + OTHER

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: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","DeleteNonExisting":false,"OnlySubscribed":false,"Test":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}