MailChimpWrapper 0.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package MailChimpWrapper --version 0.0.1
                    
NuGet\Install-Package MailChimpWrapper -Version 0.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MailChimpWrapper" Version="0.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MailChimpWrapper" Version="0.0.1" />
                    
Directory.Packages.props
<PackageReference Include="MailChimpWrapper" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MailChimpWrapper --version 0.0.1
                    
#r "nuget: MailChimpWrapper, 0.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MailChimpWrapper@0.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MailChimpWrapper&version=0.0.1
                    
Install as a Cake Addin
#tool nuget:?package=MailChimpWrapper&version=0.0.1
                    
Install as a Cake Tool

MailChimpWrapper

This project wraps around the basic MailChimp API, and gives you an easier and more readable solution for requesting data.

Usage

Initialize the client:

MailChimpWrapper.MailChimpClient client = new MailChimpWrapper.MailChimpClient("APIKEY", "SERVER");

Ping

PingResponse pingResult = await client.GetRequest<PingResponse>(Endpoints.Ping);

Root

RootResponse rootresp = await client.GetRequest<RootResponse>(Endpoints.Root);

Lists (Audiences)

Get multiple
ListsResponse listsResult = await client.GetRequest<ListsResponse>(Endpoints.Lists);
Get by id
ListResponse listResult = await client.Request<ListGetRequest, ListResponse>(new ListGetRequest("ID"));

List Members

Post
var listMembers = new List<Member>() { new Member(){
            EmailAddress="emailaddress",
            EmailClient="Outlook",
            Language="En",
            Status="subscribed",
            EmailType="html"
        }
    };
ListMembersResponse listMembersResponse = await client.Request<ListMembersPostRequest, ListMembersResponse>(new ListMembersPostRequest("listId", listMembers));

Member Tags

Get
MemberTagsResponse memberTagsResponse = await client.Request<MemberTagsGetRequest, MemberTagsResponse>(new MemberTagsGetRequest("listId", "emailaddress"));
Add tag to member in list

Note: Because the Api doesn't return any content there is no response.

await client.Request(new MemberTagsPostRequest("listId", "emailaddress", new List<Tag>() { new Tag() { Name = "tagName", Status = "active/inactive" } }));

Campaigns

Get all
var listCampaigns = await client.GetRequest<CampaignsResponse>(Endpoints.Campaigns);
Get by id
CampaignResponse campaign = await client.Request<CampaignGetRequest, CampaignResponse>(new CampaignGetRequest("campaignId"));
Post new
var newCampaign = await client.Request<CampaignNewPostRequest, CampaignResponse>(new CampaignNewPostRequest(CampaignType.regular));
Send/Resend
await client.Request(new CampaignSendRequest(campaign.Id));
await client.Request(new CampaignResendRequest(campaign.Id));
Delete campaign
await client.Request(new CampaignDeleteRequest(campaign.Id));

<b> Guide add List(Audience) to campaign </b>

This guide will explain how to edit a campaign and add you existing audience to it.

  1. Get the campaign by id:
CampaignResponse campaign = await client.Request<CampaignGetRequest, CampaignResponse>(new CampaignGetRequest("campaignId"));
  1. Edit their Recipients:
Recipients recipients = campaign.Recipients;
recipients.ListId = "listId";
  1. Create a campaign edit request, inside the new request add the new recipients:
CampaignEditRequest campaignEditRequest = new CampaignEditRequest(campaign.Id) { Recipients = recipients };
  1. Now request the edit of the campaign using the client:
CampaignResponse updatedCampaign = await client.Request<CampaignEditRequest, CampaignResponse>(campaignEditRequest);

Error handling:

try
{
    //request
}
catch (ResponseException responseException)
{
    var message = responseException.ErrorResponse.Detail;
}
catch (UnknownResponseException unknownException)
{
    var response = unknownException.ResponseMessage;
}

Note: This project is in a very early stage!

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETCoreApp 3.1

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.0.9 538 1/11/2021
0.0.8 479 1/9/2021
0.0.7 484 1/9/2021
0.0.6 496 1/9/2021
0.0.5 510 1/9/2021
0.0.4 520 12/18/2020
0.0.3 494 12/18/2020
0.0.2 527 12/17/2020
0.0.1 564 11/4/2020