BokaMera.API.Host

<back to all web services

SyncCompanyCustomerMembers

Requires Authentication
The following routes are available for this service:
PUT/mailchimp/member/company/customer/syncsync mailchimp memebers
import 'package:servicestack/servicestack.dart';

class MemberTag implements IConvertible
{
    int? Id;
    String? Name;
    DateTime? DateAdded;
    String? Status;

    MemberTag({this.Id,this.Name,this.DateAdded,this.Status});
    MemberTag.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        DateAdded = JsonConverters.fromJson(json['DateAdded'],'DateTime',context!);
        Status = json['Status'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'DateAdded': JsonConverters.toJson(DateAdded,'DateTime',context!),
        'Status': Status
    };

    getTypeName() => "MemberTag";
    TypeContext? context = _ctx;
}

class MemberResponse implements IConvertible
{
    String? EmailAddress;
    String? FullName;
    List<MemberTag>? Tags;

    MemberResponse({this.EmailAddress,this.FullName,this.Tags});
    MemberResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EmailAddress = json['EmailAddress'];
        FullName = json['FullName'];
        Tags = JsonConverters.fromJson(json['Tags'],'List<MemberTag>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EmailAddress': EmailAddress,
        'FullName': FullName,
        'Tags': JsonConverters.toJson(Tags,'List<MemberTag>',context!)
    };

    getTypeName() => "MemberResponse";
    TypeContext? context = _ctx;
}

class SyncMembersResponse implements IConvertible
{
    List<MemberResponse>? FailedSyncedMembers;
    List<MemberResponse>? SuccessSyncedMembers;

    SyncMembersResponse({this.FailedSyncedMembers,this.SuccessSyncedMembers});
    SyncMembersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FailedSyncedMembers = JsonConverters.fromJson(json['FailedSyncedMembers'],'List<MemberResponse>',context!);
        SuccessSyncedMembers = JsonConverters.fromJson(json['SuccessSyncedMembers'],'List<MemberResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FailedSyncedMembers': JsonConverters.toJson(FailedSyncedMembers,'List<MemberResponse>',context!),
        'SuccessSyncedMembers': JsonConverters.toJson(SuccessSyncedMembers,'List<MemberResponse>',context!)
    };

    getTypeName() => "SyncMembersResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class SyncCompanyCustomerMembers implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * Should we delete emails that do not exist in BokaMera.
    */
    // @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    bool? DeleteNonExisting;

    /**
    * Should we target only subscribed to newsletter customers.
    */
    // @ApiMember(Description="Should we target only subscribed to newsletter customers.")
    bool? OnlySubscribed;

    /**
    * Determines if it is a test user
    */
    // @ApiMember(Description="Determines if it is a test user")
    bool? Test;

    SyncCompanyCustomerMembers({this.CompanyId,this.DeleteNonExisting,this.OnlySubscribed,this.Test});
    SyncCompanyCustomerMembers.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        DeleteNonExisting = json['DeleteNonExisting'];
        OnlySubscribed = json['OnlySubscribed'];
        Test = json['Test'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'DeleteNonExisting': DeleteNonExisting,
        'OnlySubscribed': OnlySubscribed,
        'Test': Test
    };

    getTypeName() => "SyncCompanyCustomerMembers";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'MemberTag': TypeInfo(TypeOf.Class, create:() => MemberTag()),
    'MemberResponse': TypeInfo(TypeOf.Class, create:() => MemberResponse()),
    'List<MemberTag>': TypeInfo(TypeOf.Class, create:() => <MemberTag>[]),
    'SyncMembersResponse': TypeInfo(TypeOf.Class, create:() => SyncMembersResponse()),
    'List<MemberResponse>': TypeInfo(TypeOf.Class, create:() => <MemberResponse>[]),
    'SyncCompanyCustomerMembers': TypeInfo(TypeOf.Class, create:() => SyncCompanyCustomerMembers()),
});

Dart SyncCompanyCustomerMembers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SyncCompanyCustomerMembers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DeleteNonExisting>false</DeleteNonExisting>
  <OnlySubscribed>false</OnlySubscribed>
  <Test>false</Test>
</SyncCompanyCustomerMembers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SyncMembersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <FailedSyncedMembers>
    <MemberResponse>
      <EmailAddress>String</EmailAddress>
      <FullName>String</FullName>
      <Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/MailChimp.Net.Models">
        <d4p1:MemberTag>
          <d4p1:DateAdded>0001-01-01T00:00:00</d4p1:DateAdded>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Status>String</d4p1:Status>
        </d4p1:MemberTag>
      </Tags>
    </MemberResponse>
  </FailedSyncedMembers>
  <SuccessSyncedMembers>
    <MemberResponse>
      <EmailAddress>String</EmailAddress>
      <FullName>String</FullName>
      <Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/MailChimp.Net.Models">
        <d4p1:MemberTag>
          <d4p1:DateAdded>0001-01-01T00:00:00</d4p1:DateAdded>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Status>String</d4p1:Status>
        </d4p1:MemberTag>
      </Tags>
    </MemberResponse>
  </SuccessSyncedMembers>
</SyncMembersResponse>