com.touwolf.mailchimp.api.campaign.Campaign Maven / Gradle / Ivy

Go to download
package com.touwolf.mailchimp.api.campaign;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.touwolf.mailchimp.MailchimpException;
import com.touwolf.mailchimp.data.MailchimpResponse;
import com.touwolf.mailchimp.impl.MailchimpBuilder;
import com.touwolf.mailchimp.impl.MailchimpUtils;
import com.touwolf.mailchimp.model.campaign.*;
import org.apache.commons.lang.StringUtils;
import org.bridje.ioc.Component;

import java.util.List;

/**
 * Campaigns are how you send emails to your MailChimp list. Use the Campaigns API calls to manage campaigns in your MailChimp account.
 */
@Component
public class Campaign {
    private final Gson GSON = new GsonBuilder().setPrettyPrinting().setDateFormat("yyyy-MM-dd HH:mm:ss").create();

    private MailchimpBuilder builder;

    public Campaign builder(MailchimpBuilder builder) {
        this.builder = builder;
        return this;
    }

    /**
     * Create a new campaign
     *
     * @param request Request body parameters
     * @throws MailchimpException
     */
    public MailchimpResponse create(CampaignRequest request) throws MailchimpException {
        String payload = GSON.toJson(request);
        return builder.post("/campaigns", payload, CampaignResponse.class);
    }

    /**
     * Get all campaigns
     *
     * @param request Query string parameters
     * @throws MailchimpException
     */
    public MailchimpResponse read(CampaignReadRequest request) throws MailchimpException {
        String url = "/campaigns";
        url = MailchimpUtils.formatQueryString(url, "fields", request.getFields());
        url = MailchimpUtils.formatQueryString(url, "exclude_fields", request.getExcludeFields());
        url = MailchimpUtils.formatQueryString(url, "count", request.getCount());
        url = MailchimpUtils.formatQueryString(url, "offset", request.getOffset());
        url = MailchimpUtils.formatQueryString(url, "type", request.getType());
        url = MailchimpUtils.formatQueryString(url, "status", request.getStatus());
        url = MailchimpUtils.formatQueryString(url, "before_send_time", request.getBeforeSendTime());
        url = MailchimpUtils.formatQueryString(url, "since_send_time", request.getSinceSendTime());
        url = MailchimpUtils.formatQueryString(url, "before_create_time", request.getBeforeCreateTime());
        url = MailchimpUtils.formatQueryString(url, "since_create_time", request.getSinceCreateTime());
        url = MailchimpUtils.formatQueryString(url, "list_id", request.getListId());

        return builder.get(url, CampaignReadResponse.class);
    }

    /**
     * Get information about a specific campaign
     *
     * @param campaignId The unique id for the campaign.
     * @param request    Query string parameters
     * @throws MailchimpException
     */
    public MailchimpResponse read(String campaignId, CampaignReadRequest request) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId;
        url = MailchimpUtils.formatQueryString(url, "fields", request.getFields());
        url = MailchimpUtils.formatQueryString(url, "exclude_fields", request.getExcludeFields());

        return builder.get(url, CampaignResponse.class);
    }

    /**
     * Update the settings for a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @param request    Request body parameters
     * @throws MailchimpException
     */
    public MailchimpResponse edit(String campaignId, CampaignRequest request) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId;
        String payload = GSON.toJson(request);
        return builder.patch(url, payload, CampaignResponse.class);
    }

    /**
     * Delete a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse delete(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId;
        return builder.delete(url, Void.class);
    }

    /**
     * Cancel a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse cancelSend(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/cancel-send";
        return builder.post(url, Void.class);
    }

    /**
     * Pause an RSS-Driven campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse pause(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/pause";
        return builder.post(url, Void.class);
    }

    /**
     * Replicate a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse replicate(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/replicate";
        return builder.post(url, CampaignResponse.class);
    }

    /**
     * Resume an RSS-Driven campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse resume(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/resume";
        return builder.post(url, Void.class);
    }

    /**
     * Schedule a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @param request    Request body parameters
     * @throws MailchimpException
     */
    public MailchimpResponse schedule(String campaignId, CampaignScheduleRequest request) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/schedule";
        String payload = GSON.toJson(request);
        return builder.post(url, payload, Void.class);
    }

    /**
     * Send a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse send(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/send";
        return builder.post(url, Void.class);
    }

    /**
     * Send a test email
     *
     * @param campaignId The unique id for the campaign.
     * @param testEmails An array of email addresses to send the test email to.
     * @param sendType   Choose the type of test email to send. Possible Values: html, plain_text
     * @throws MailchimpException
     */
    public MailchimpResponse test(String campaignId, List testEmails, CampaignSendTypeEnum sendType) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/test";
        String emails = GSON.toJson(testEmails.toArray());
        String payload = "{test_emails: \"" + emails + "\", send_type: \"" + sendType.name() + "\"}";
        return builder.post(url, payload, Void.class);
    }

    /**
     * Unschedule a campaign
     *
     * @param campaignId The unique id for the campaign.
     * @throws MailchimpException
     */
    public MailchimpResponse unschedule(String campaignId) throws MailchimpException {
        if (StringUtils.isBlank(campaignId)) {
            throw new MailchimpException("The field campaign_id is required");
        }

        String url = "/campaigns/" + campaignId + "/actions/unschedule";
        return builder.post(url, Void.class);
    }
}