fuc-new/vendor/mailchimp/transactional/lib/Api/IpsApi.php
hellcat 1fe8673f62 1
2025-10-01 13:34:29 +08:00

159 lines
4.4 KiB
PHP
Executable File

<?php
/**
* IpsApi
* 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;
/**
* IpsApi Class Doc Comment
*
* @category Class
* @package MailchimpTransactional
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
class IpsApi
{
protected $config;
public function __construct(Configuration $config = null)
{
$this->config = $config ?: new Configuration();
}
/**
* Cancel ip warmup
* Cancels the warmup process for a dedicated IP.
*/
public function cancelWarmup($body = [])
{
return $this->config->post('/ips/cancel-warmup', $body);
}
/**
* Test custom dns
* Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
*/
public function checkCustomDns($body = [])
{
return $this->config->post('/ips/check-custom-dns', $body);
}
/**
* Add ip pool
* Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
*/
public function createPool($body = [])
{
return $this->config->post('/ips/create-pool', $body);
}
/**
* Delete ip address
* Deletes a dedicated IP. This is permanent and cannot be undone.
*/
public function delete($body = [])
{
return $this->config->post('/ips/delete', $body);
}
/**
* Delete ip pool
* Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
*/
public function deletePool($body = [])
{
return $this->config->post('/ips/delete-pool', $body);
}
/**
* Get ip info
* Retrieves information about a single dedicated IP.
*/
public function info($body = [])
{
return $this->config->post('/ips/info', $body);
}
/**
* List ip addresses
* Lists your dedicated IPs.
*/
public function list($body = [])
{
return $this->config->post('/ips/list', $body);
}
/**
* List ip pools
* Lists your dedicated IP pools.
*/
public function listPools($body = [])
{
return $this->config->post('/ips/list-pools', $body);
}
/**
* Get ip pool info
* Describes a single dedicated IP pool.
*/
public function poolInfo($body = [])
{
return $this->config->post('/ips/pool-info', $body);
}
/**
* Request additional ip
* Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
*/
public function provision($body = [])
{
return $this->config->post('/ips/provision', $body);
}
/**
* Set custom dns
* Configures the custom DNS name for a dedicated IP.
*/
public function setCustomDns($body = [])
{
return $this->config->post('/ips/set-custom-dns', $body);
}
/**
* Move ip to different pool
* Moves a dedicated IP to a different pool.
*/
public function setPool($body = [])
{
return $this->config->post('/ips/set-pool', $body);
}
/**
* Start ip warmup
* Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
*/
public function startWarmup($body = [])
{
return $this->config->post('/ips/start-warmup', $body);
}
}