103 lines
3.6 KiB
PHP
Executable File
103 lines
3.6 KiB
PHP
Executable File
<?php
|
|
|
|
/**
|
|
* ExportsApi
|
|
* PHP version 5
|
|
*
|
|
* @category Class
|
|
* @package MailchimpTransactional
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
|
|
/**
|
|
* Mailchimp Transactional API
|
|
*
|
|
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
*
|
|
* OpenAPI spec version: 1.0.59
|
|
* Contact: apihelp@mailchimp.com
|
|
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
* Swagger Codegen version: 2.4.12
|
|
*/
|
|
|
|
/**
|
|
* NOTE: This class is auto generated by the swagger code generator program.
|
|
* https://github.com/swagger-api/swagger-codegen
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
namespace MailchimpTransactional\Api;
|
|
|
|
use MailchimpTransactional\ApiException;
|
|
use MailchimpTransactional\Configuration;
|
|
use MailchimpTransactional\HeaderSelector;
|
|
use MailchimpTransactional\ObjectSerializer;
|
|
|
|
/**
|
|
* ExportsApi Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package MailchimpTransactional
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class ExportsApi
|
|
{
|
|
protected $config;
|
|
|
|
public function __construct(Configuration $config = null)
|
|
{
|
|
$this->config = $config ?: new Configuration();
|
|
}
|
|
|
|
/**
|
|
* Export activity history
|
|
* Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
|
|
*/
|
|
public function activity($body = [])
|
|
{
|
|
return $this->config->post('/exports/activity', $body);
|
|
}
|
|
/**
|
|
* Export Allowlist
|
|
* Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at.
|
|
*/
|
|
public function allowlist($body = [])
|
|
{
|
|
return $this->config->post('/exports/allowlist', $body);
|
|
}
|
|
/**
|
|
* View export info
|
|
* Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
|
|
*/
|
|
public function info($body = [])
|
|
{
|
|
return $this->config->post('/exports/info', $body);
|
|
}
|
|
/**
|
|
* List exports
|
|
* Returns a list of your exports.
|
|
*/
|
|
public function list($body = [])
|
|
{
|
|
return $this->config->post('/exports/list', $body);
|
|
}
|
|
/**
|
|
* Export denylist
|
|
* Begins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.
|
|
*/
|
|
public function rejects($body = [])
|
|
{
|
|
return $this->config->post('/exports/rejects', $body);
|
|
}
|
|
/**
|
|
* Export Allowlist
|
|
* Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at.
|
|
*/
|
|
public function whitelist($body = [])
|
|
{
|
|
return $this->config->post('/exports/whitelist', $body);
|
|
}
|
|
}
|