NAME

ElasticEmail::Role - a Moose role for the Elastic Email REST API

This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.

Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.

The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.

To start using this API, you will need your Access Token (available here). Remember to keep it safe. Required access levels are listed in the given request’s description.

Downloadable library clients can be found in our Github repository here

VERSION

Automatically generated by the OpenAPI Generator project:

API version: 4.0.0
Package version: 4.0.26
Generator version: 7.5.0
Build package: org.openapitools.codegen.languages.PerlClientCodegen

A note on Moose

This role is the only component of the library that uses Moose. See ElasticEmail::ApiFactory for non-Moosey usage.

SYNOPSIS

The Perl Generator in the OpenAPI Generator project builds a library of Perl modules to interact with a web service defined by a OpenAPI Specification. See below for how to build the library.

This module provides an interface to the generated library. All the classes, objects, and methods (well, not quite *all*, see below) are flattened into this role.

    package MyApp;
    use Moose;
    with 'ElasticEmail::Role';

    package main;

    my $api = MyApp->new({ tokens => $tokens });

    my $pet = $api->get_pet_by_id(pet_id => $pet_id);

Structure of the library

The library consists of a set of API classes, one for each endpoint. These APIs implement the method calls available on each endpoint.

Additionally, there is a set of "object" classes, which represent the objects returned by and sent to the methods on the endpoints.

An API factory class is provided, which builds instances of each endpoint API.

This Moose role flattens all the methods from the endpoint APIs onto the consuming class. It also provides methods to retrieve the endpoint API objects, and the API factory object, should you need it.

For documentation of all these methods, see AUTOMATIC DOCUMENTATION below.

Configuring authentication

In the normal case, the OpenAPI Spec will describe what parameters are required and where to put them. You just need to supply the tokens.

my $tokens = {
    # basic
    username => $username,
    password => $password,

    # oauth
    access_token => $oauth_token,

    # keys
    $some_key => { token => $token,
                   prefix => $prefix,
                   in => $in,             # 'head||query',
                   },

    $another => { token => $token,
                  prefix => $prefix,
                  in => $in,              # 'head||query',
                  },
    ...,

    };

    my $api = MyApp->new({ tokens => $tokens });

Note these are all optional, as are prefix and in, and depend on the API you are accessing. Usually prefix and in will be determined by the code generator from the spec and you will not need to set them at run time. If not, in will default to 'head' and prefix to the empty string.

The tokens will be placed in a LElasticEmail::Configuration instance as follows, but you don't need to know about this.

$cfg->{username}

String. The username for basic auth.
$cfg->{password}

String. The password for basic auth.

$cfg->{api_key}

Hashref. Keyed on the name of each key (there can be multiple tokens).

      $cfg->{api_key} = {
              secretKey => 'aaaabbbbccccdddd',
              anotherKey => '1111222233334444',
              };

$cfg->{api_key_prefix}

Hashref. Keyed on the name of each key (there can be multiple tokens). Note not all api keys require a prefix.

      $cfg->{api_key_prefix} = {
              secretKey => 'string',
              anotherKey => 'same or some other string',
              };

$cfg->{access_token}

String. The OAuth access token.

METHODS

`base_url`

The generated code has the base_url already set as a default value. This method returns the current value of base_url.

`api_factory`

Returns an API factory object. You probably won't need to call this directly.

    $self->api_factory('Pet'); # returns a ElasticEmail::PetApi instance

    $self->pet_api;            # the same

MISSING METHODS

Most of the methods on the API are delegated to individual endpoint API objects (e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the same method name (e.g. new()), these methods can't be delegated. So you need to call $api->pet_api->new().

In principle, every API is susceptible to the presence of a few, random, undelegatable method names. In practice, because of the way method names are constructed, it's unlikely in general that any methods will be undelegatable, except for:

    new()
    class_documentation()
    method_documentation()

To call these methods, you need to get a handle on the relevant object, either by calling $api->foo_api or by retrieving an object, e.g. $api->get_pet_by_id(pet_id => $pet_id). They are class methods, so you could also call them on class names.

BUILDING YOUR LIBRARY

See the homepage https://openapi-generator.tech for full details. But briefly, clone the git repository, build the codegen codebase, set up your build config file, then run the API build script. You will need git, Java 7 or 8 and Apache maven 3.0.3 or better already installed.

The config file should specify the project name for the generated library:

    {"moduleName":"WWW::MyProjectName"}

Your library files will be built under WWW::MyProjectName.

      $ git clone https://github.com/openapitools/openapi-generator
      $ cd openapi-generator
      $ mvn package
      $ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
-i [URL or file path to JSON OpenAPI API spec] \
-g perl \
-c /path/to/config/file.json \
-o /path/to/output/folder

Bang, all done. Run the autodoc script in the bin directory to see the API you just built.

AUTOMATIC DOCUMENTATION

You can print out a summary of the generated API by running the included autodoc script in the bin directory of your generated library. A few output formats are supported:

      Usage: autodoc [OPTION]

-w           wide format (default)
-n           narrow format
-p           POD format
-H           HTML format
-m           Markdown format
-h           print this help message
-c           your application class

The -c option allows you to load and inspect your own application. A dummy namespace is used if you don't supply your own class.

DOCUMENTATION FROM THE OpenAPI Spec

Additional documentation for each class and method may be provided by the OpenAPI spec. If so, this is available via the class_documentation() and method_documentation() methods on each generated object class, and the method_documentation() method on the endpoint API classes:

    my $cmdoc = $api->pet_api->method_documentation->{$method_name};

    my $odoc = $api->get_pet_by_id->(pet_id => $pet_id)->class_documentation;
    my $omdoc = $api->get_pet_by_id->(pet_id => $pet_id)->method_documentation->{method_name};

Each of these calls returns a hashref with various useful pieces of information.

Installation Prerequisites

Use cpanm to install the module dependencies:

cpanm --local-lib=~/perl5 local::lib && eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)
cpanm --quiet --no-interactive Class::Accessor Test::Exception Test::More Log::Any LWP::UserAgent URI::Query Module::Runtime DateTime Module::Find Moose::Role JSON

LOAD THE MODULES

To load the API packages:

use ElasticEmail::CampaignsApi;
use ElasticEmail::ContactsApi;
use ElasticEmail::DomainsApi;
use ElasticEmail::EmailsApi;
use ElasticEmail::EventsApi;
use ElasticEmail::FilesApi;
use ElasticEmail::InboundRouteApi;
use ElasticEmail::ListsApi;
use ElasticEmail::SecurityApi;
use ElasticEmail::SegmentsApi;
use ElasticEmail::StatisticsApi;
use ElasticEmail::SubAccountsApi;
use ElasticEmail::SuppressionsApi;
use ElasticEmail::TemplatesApi;
use ElasticEmail::VerificationsApi;

To load the models:

use ElasticEmail::Object::AccessLevel;
use ElasticEmail::Object::AccountStatusEnum;
use ElasticEmail::Object::ApiKey;
use ElasticEmail::Object::ApiKeyPayload;
use ElasticEmail::Object::BodyContentType;
use ElasticEmail::Object::BodyPart;
use ElasticEmail::Object::Campaign;
use ElasticEmail::Object::CampaignOptions;
use ElasticEmail::Object::CampaignRecipient;
use ElasticEmail::Object::CampaignStatus;
use ElasticEmail::Object::CampaignTemplate;
use ElasticEmail::Object::CertificateValidationStatus;
use ElasticEmail::Object::ChannelLogStatusSummary;
use ElasticEmail::Object::CompressionFormat;
use ElasticEmail::Object::ConsentData;
use ElasticEmail::Object::ConsentTracking;
use ElasticEmail::Object::Contact;
use ElasticEmail::Object::ContactActivity;
use ElasticEmail::Object::ContactPayload;
use ElasticEmail::Object::ContactSource;
use ElasticEmail::Object::ContactStatus;
use ElasticEmail::Object::ContactUpdatePayload;
use ElasticEmail::Object::ContactsList;
use ElasticEmail::Object::DeliveryOptimizationType;
use ElasticEmail::Object::DomainData;
use ElasticEmail::Object::DomainDetail;
use ElasticEmail::Object::DomainOwner;
use ElasticEmail::Object::DomainPayload;
use ElasticEmail::Object::DomainUpdatePayload;
use ElasticEmail::Object::EmailContent;
use ElasticEmail::Object::EmailData;
use ElasticEmail::Object::EmailJobFailedStatus;
use ElasticEmail::Object::EmailJobStatus;
use ElasticEmail::Object::EmailMessageData;
use ElasticEmail::Object::EmailPredictedValidationStatus;
use ElasticEmail::Object::EmailRecipient;
use ElasticEmail::Object::EmailSend;
use ElasticEmail::Object::EmailStatus;
use ElasticEmail::Object::EmailTransactionalMessageData;
use ElasticEmail::Object::EmailValidationResult;
use ElasticEmail::Object::EmailValidationStatus;
use ElasticEmail::Object::EmailView;
use ElasticEmail::Object::EmailsPayload;
use ElasticEmail::Object::EncodingType;
use ElasticEmail::Object::EventType;
use ElasticEmail::Object::EventsOrderBy;
use ElasticEmail::Object::ExportFileFormats;
use ElasticEmail::Object::ExportLink;
use ElasticEmail::Object::ExportStatus;
use ElasticEmail::Object::FileInfo;
use ElasticEmail::Object::FilePayload;
use ElasticEmail::Object::FileUploadResult;
use ElasticEmail::Object::InboundPayload;
use ElasticEmail::Object::InboundRoute;
use ElasticEmail::Object::InboundRouteActionType;
use ElasticEmail::Object::InboundRouteFilterType;
use ElasticEmail::Object::ListPayload;
use ElasticEmail::Object::ListUpdatePayload;
use ElasticEmail::Object::LogJobStatus;
use ElasticEmail::Object::LogStatusSummary;
use ElasticEmail::Object::MergeEmailPayload;
use ElasticEmail::Object::MessageAttachment;
use ElasticEmail::Object::MessageCategory;
use ElasticEmail::Object::MessageCategoryEnum;
use ElasticEmail::Object::NewApiKey;
use ElasticEmail::Object::NewSmtpCredentials;
use ElasticEmail::Object::Options;
use ElasticEmail::Object::RecipientEvent;
use ElasticEmail::Object::Segment;
use ElasticEmail::Object::SegmentPayload;
use ElasticEmail::Object::SmtpCredentials;
use ElasticEmail::Object::SmtpCredentialsPayload;
use ElasticEmail::Object::SortOrderItem;
use ElasticEmail::Object::SplitOptimizationType;
use ElasticEmail::Object::SplitOptions;
use ElasticEmail::Object::SubAccountInfo;
use ElasticEmail::Object::SubaccountEmailCreditsPayload;
use ElasticEmail::Object::SubaccountEmailSettings;
use ElasticEmail::Object::SubaccountEmailSettingsPayload;
use ElasticEmail::Object::SubaccountPayload;
use ElasticEmail::Object::SubaccountSettingsInfo;
use ElasticEmail::Object::SubaccountSettingsInfoPayload;
use ElasticEmail::Object::Suppression;
use ElasticEmail::Object::Template;
use ElasticEmail::Object::TemplatePayload;
use ElasticEmail::Object::TemplateScope;
use ElasticEmail::Object::TemplateType;
use ElasticEmail::Object::TrackingType;
use ElasticEmail::Object::TrackingValidationStatus;
use ElasticEmail::Object::TransactionalRecipient;
use ElasticEmail::Object::Utm;
use ElasticEmail::Object::VerificationFileResult;
use ElasticEmail::Object::VerificationFileResultDetails;
use ElasticEmail::Object::VerificationStatus;

GETTING STARTED

Put the Perl SDK under the 'lib' folder in your project directory, then run the following

#!/usr/bin/perl
use lib 'lib';
use strict;
use warnings;
# load the API package
use ElasticEmail::CampaignsApi;
use ElasticEmail::ContactsApi;
use ElasticEmail::DomainsApi;
use ElasticEmail::EmailsApi;
use ElasticEmail::EventsApi;
use ElasticEmail::FilesApi;
use ElasticEmail::InboundRouteApi;
use ElasticEmail::ListsApi;
use ElasticEmail::SecurityApi;
use ElasticEmail::SegmentsApi;
use ElasticEmail::StatisticsApi;
use ElasticEmail::SubAccountsApi;
use ElasticEmail::SuppressionsApi;
use ElasticEmail::TemplatesApi;
use ElasticEmail::VerificationsApi;

# load the models
use ElasticEmail::Object::AccessLevel;
use ElasticEmail::Object::AccountStatusEnum;
use ElasticEmail::Object::ApiKey;
use ElasticEmail::Object::ApiKeyPayload;
use ElasticEmail::Object::BodyContentType;
use ElasticEmail::Object::BodyPart;
use ElasticEmail::Object::Campaign;
use ElasticEmail::Object::CampaignOptions;
use ElasticEmail::Object::CampaignRecipient;
use ElasticEmail::Object::CampaignStatus;
use ElasticEmail::Object::CampaignTemplate;
use ElasticEmail::Object::CertificateValidationStatus;
use ElasticEmail::Object::ChannelLogStatusSummary;
use ElasticEmail::Object::CompressionFormat;
use ElasticEmail::Object::ConsentData;
use ElasticEmail::Object::ConsentTracking;
use ElasticEmail::Object::Contact;
use ElasticEmail::Object::ContactActivity;
use ElasticEmail::Object::ContactPayload;
use ElasticEmail::Object::ContactSource;
use ElasticEmail::Object::ContactStatus;
use ElasticEmail::Object::ContactUpdatePayload;
use ElasticEmail::Object::ContactsList;
use ElasticEmail::Object::DeliveryOptimizationType;
use ElasticEmail::Object::DomainData;
use ElasticEmail::Object::DomainDetail;
use ElasticEmail::Object::DomainOwner;
use ElasticEmail::Object::DomainPayload;
use ElasticEmail::Object::DomainUpdatePayload;
use ElasticEmail::Object::EmailContent;
use ElasticEmail::Object::EmailData;
use ElasticEmail::Object::EmailJobFailedStatus;
use ElasticEmail::Object::EmailJobStatus;
use ElasticEmail::Object::EmailMessageData;
use ElasticEmail::Object::EmailPredictedValidationStatus;
use ElasticEmail::Object::EmailRecipient;
use ElasticEmail::Object::EmailSend;
use ElasticEmail::Object::EmailStatus;
use ElasticEmail::Object::EmailTransactionalMessageData;
use ElasticEmail::Object::EmailValidationResult;
use ElasticEmail::Object::EmailValidationStatus;
use ElasticEmail::Object::EmailView;
use ElasticEmail::Object::EmailsPayload;
use ElasticEmail::Object::EncodingType;
use ElasticEmail::Object::EventType;
use ElasticEmail::Object::EventsOrderBy;
use ElasticEmail::Object::ExportFileFormats;
use ElasticEmail::Object::ExportLink;
use ElasticEmail::Object::ExportStatus;
use ElasticEmail::Object::FileInfo;
use ElasticEmail::Object::FilePayload;
use ElasticEmail::Object::FileUploadResult;
use ElasticEmail::Object::InboundPayload;
use ElasticEmail::Object::InboundRoute;
use ElasticEmail::Object::InboundRouteActionType;
use ElasticEmail::Object::InboundRouteFilterType;
use ElasticEmail::Object::ListPayload;
use ElasticEmail::Object::ListUpdatePayload;
use ElasticEmail::Object::LogJobStatus;
use ElasticEmail::Object::LogStatusSummary;
use ElasticEmail::Object::MergeEmailPayload;
use ElasticEmail::Object::MessageAttachment;
use ElasticEmail::Object::MessageCategory;
use ElasticEmail::Object::MessageCategoryEnum;
use ElasticEmail::Object::NewApiKey;
use ElasticEmail::Object::NewSmtpCredentials;
use ElasticEmail::Object::Options;
use ElasticEmail::Object::RecipientEvent;
use ElasticEmail::Object::Segment;
use ElasticEmail::Object::SegmentPayload;
use ElasticEmail::Object::SmtpCredentials;
use ElasticEmail::Object::SmtpCredentialsPayload;
use ElasticEmail::Object::SortOrderItem;
use ElasticEmail::Object::SplitOptimizationType;
use ElasticEmail::Object::SplitOptions;
use ElasticEmail::Object::SubAccountInfo;
use ElasticEmail::Object::SubaccountEmailCreditsPayload;
use ElasticEmail::Object::SubaccountEmailSettings;
use ElasticEmail::Object::SubaccountEmailSettingsPayload;
use ElasticEmail::Object::SubaccountPayload;
use ElasticEmail::Object::SubaccountSettingsInfo;
use ElasticEmail::Object::SubaccountSettingsInfoPayload;
use ElasticEmail::Object::Suppression;
use ElasticEmail::Object::Template;
use ElasticEmail::Object::TemplatePayload;
use ElasticEmail::Object::TemplateScope;
use ElasticEmail::Object::TemplateType;
use ElasticEmail::Object::TrackingType;
use ElasticEmail::Object::TrackingValidationStatus;
use ElasticEmail::Object::TransactionalRecipient;
use ElasticEmail::Object::Utm;
use ElasticEmail::Object::VerificationFileResult;
use ElasticEmail::Object::VerificationFileResultDetails;
use ElasticEmail::Object::VerificationStatus;

# for displaying the API response data
use Data::Dumper;


my $api_instance = ElasticEmail::CampaignsApi->new(
    # Configure API key authorization: apikey
    api_key => {'X-ElasticEmail-ApiKey' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'X-ElasticEmail-ApiKey' => 'Bearer'},
);

my $name = "name_example"; # string | Name of Campaign to delete

eval {
    $api_instance->campaigns_by_name_delete(name => $name);
};
if ($@) {
    warn "Exception when calling CampaignsApi->campaigns_by_name_delete: $@\n";
}

EXAMPLES

Function
addCampaign	readme
addBulkContacts	readme
addList	readme
addSingleContact	readme
addTemplate	readme
deleteCampaign	readme
deleteContacts	readme
deleteList	readme
deleteTemplate	readme
exportContacts	readme
loadCampaigns	readme
loadCampaignsStats	readme
loadChannelsStats	readme
loadList	readme
loadStatistics	readme
loadTemplate	readme
sendBulkEmails	readme
sendTransactionalEmails	readme
updateCampaign	readme

DOCUMENTATION FOR API ENDPOINTS

All URIs are relative to https://api.elasticemail.com/v4

Class	Method	HTTP request	Description
CampaignsApi	campaigns_by_name_delete	DELETE /campaigns/{name}	Delete Campaign
CampaignsApi	campaigns_by_name_get	GET /campaigns/{name}	Load Campaign
CampaignsApi	campaigns_by_name_pause_put	PUT /campaigns/{name}/pause	Pause Campaign
CampaignsApi	campaigns_by_name_put	PUT /campaigns/{name}	Update Campaign
CampaignsApi	campaigns_get	GET /campaigns	Load Campaigns
CampaignsApi	campaigns_post	POST /campaigns	Add Campaign
ContactsApi	contacts_by_email_delete	DELETE /contacts/{email}	Delete Contact
ContactsApi	contacts_by_email_get	GET /contacts/{email}	Load Contact
ContactsApi	contacts_by_email_put	PUT /contacts/{email}	Update Contact
ContactsApi	contacts_delete_post	POST /contacts/delete	Delete Contacts Bulk
ContactsApi	contacts_export_by_id_status_get	GET /contacts/export/{id}/status	Check Export Status
ContactsApi	contacts_export_post	POST /contacts/export	Export Contacts
ContactsApi	contacts_get	GET /contacts	Load Contacts
ContactsApi	contacts_import_post	POST /contacts/import	Upload Contacts
ContactsApi	contacts_post	POST /contacts	Add Contact
DomainsApi	domains_by_domain_delete	DELETE /domains/{domain}	Delete Domain
DomainsApi	domains_by_domain_get	GET /domains/{domain}	Load Domain
DomainsApi	domains_by_domain_put	PUT /domains/{domain}	Update Domain
DomainsApi	domains_by_domain_restricted_get	GET /domains/{domain}/restricted	Check for domain restriction
DomainsApi	domains_by_domain_verification_put	PUT /domains/{domain}/verification	Verify Domain
DomainsApi	domains_by_email_default_patch	PATCH /domains/{email}/default	Set Default
DomainsApi	domains_get	GET /domains	Load Domains
DomainsApi	domains_post	POST /domains	Add Domain
EmailsApi	emails_by_msgid_view_get	GET /emails/{msgid}/view	View Email
EmailsApi	emails_by_transactionid_status_get	GET /emails/{transactionid}/status	Get Status
EmailsApi	emails_mergefile_post	POST /emails/mergefile	Send Bulk Emails CSV
EmailsApi	emails_post	POST /emails	Send Bulk Emails
EmailsApi	emails_transactional_post	POST /emails/transactional	Send Transactional Email
EventsApi	events_by_transactionid_get	GET /events/{transactionid}	Load Email Events
EventsApi	events_channels_by_name_export_post	POST /events/channels/{name}/export	Export Channel Events
EventsApi	events_channels_by_name_get	GET /events/channels/{name}	Load Channel Events
EventsApi	events_channels_export_by_id_status_get	GET /events/channels/export/{id}/status	Check Channel Export Status
EventsApi	events_export_by_id_status_get	GET /events/export/{id}/status	Check Export Status
EventsApi	events_export_post	POST /events/export	Export Events
EventsApi	events_get	GET /events	Load Events
FilesApi	files_by_name_delete	DELETE /files/{name}	Delete File
FilesApi	files_by_name_get	GET /files/{name}	Download File
FilesApi	files_by_name_info_get	GET /files/{name}/info	Load File Details
FilesApi	files_get	GET /files	List Files
FilesApi	files_post	POST /files	Upload File
InboundRouteApi	inboundroute_by_id_delete	DELETE /inboundroute/{id}	Delete Route
InboundRouteApi	inboundroute_by_id_get	GET /inboundroute/{id}	Get Route
InboundRouteApi	inboundroute_by_id_put	PUT /inboundroute/{id}	Update Route
InboundRouteApi	inboundroute_get	GET /inboundroute	Get Routes
InboundRouteApi	inboundroute_order_put	PUT /inboundroute/order	Update Sorting
InboundRouteApi	inboundroute_post	POST /inboundroute	Create Route
ListsApi	lists_by_listname_contacts_get	GET /lists/{listname}/contacts	Load Contacts in List
ListsApi	lists_by_name_contacts_post	POST /lists/{name}/contacts	Add Contacts to List
ListsApi	lists_by_name_contacts_remove_post	POST /lists/{name}/contacts/remove	Remove Contacts from List
ListsApi	lists_by_name_delete	DELETE /lists/{name}	Delete List
ListsApi	lists_by_name_get	GET /lists/{name}	Load List
ListsApi	lists_by_name_put	PUT /lists/{name}	Update List
ListsApi	lists_get	GET /lists	Load Lists
ListsApi	lists_post	POST /lists	Add List
SecurityApi	security_apikeys_by_name_delete	DELETE /security/apikeys/{name}	Delete ApiKey
SecurityApi	security_apikeys_by_name_get	GET /security/apikeys/{name}	Load ApiKey
SecurityApi	security_apikeys_by_name_put	PUT /security/apikeys/{name}	Update ApiKey
SecurityApi	security_apikeys_get	GET /security/apikeys	List ApiKeys
SecurityApi	security_apikeys_post	POST /security/apikeys	Add ApiKey
SecurityApi	security_smtp_by_name_delete	DELETE /security/smtp/{name}	Delete SMTP Credential
SecurityApi	security_smtp_by_name_get	GET /security/smtp/{name}	Load SMTP Credential
SecurityApi	security_smtp_by_name_put	PUT /security/smtp/{name}	Update SMTP Credential
SecurityApi	security_smtp_get	GET /security/smtp	List SMTP Credentials
SecurityApi	security_smtp_post	POST /security/smtp	Add SMTP Credential
SegmentsApi	segments_by_name_delete	DELETE /segments/{name}	Delete Segment
SegmentsApi	segments_by_name_get	GET /segments/{name}	Load Segment
SegmentsApi	segments_by_name_put	PUT /segments/{name}	Update Segment
SegmentsApi	segments_get	GET /segments	Load Segments
SegmentsApi	segments_post	POST /segments	Add Segment
StatisticsApi	statistics_campaigns_by_name_get	GET /statistics/campaigns/{name}	Load Campaign Stats
StatisticsApi	statistics_campaigns_get	GET /statistics/campaigns	Load Campaigns Stats
StatisticsApi	statistics_channels_by_name_get	GET /statistics/channels/{name}	Load Channel Stats
StatisticsApi	statistics_channels_get	GET /statistics/channels	Load Channels Stats
StatisticsApi	statistics_get	GET /statistics	Load Statistics
SubAccountsApi	subaccounts_by_email_credits_patch	PATCH /subaccounts/{email}/credits	Add, Subtract Email Credits
SubAccountsApi	subaccounts_by_email_delete	DELETE /subaccounts/{email}	Delete SubAccount
SubAccountsApi	subaccounts_by_email_get	GET /subaccounts/{email}	Load SubAccount
SubAccountsApi	subaccounts_by_email_settings_email_put	PUT /subaccounts/{email}/settings/email	Update SubAccount Email Settings
SubAccountsApi	subaccounts_get	GET /subaccounts	Load SubAccounts
SubAccountsApi	subaccounts_post	POST /subaccounts	Add SubAccount
SuppressionsApi	suppressions_bounces_get	GET /suppressions/bounces	Get Bounce List
SuppressionsApi	suppressions_bounces_import_post	POST /suppressions/bounces/import	Add Bounces Async
SuppressionsApi	suppressions_bounces_post	POST /suppressions/bounces	Add Bounces
SuppressionsApi	suppressions_by_email_delete	DELETE /suppressions/{email}	Delete Suppression
SuppressionsApi	suppressions_by_email_get	GET /suppressions/{email}	Get Suppression
SuppressionsApi	suppressions_complaints_get	GET /suppressions/complaints	Get Complaints List
SuppressionsApi	suppressions_complaints_import_post	POST /suppressions/complaints/import	Add Complaints Async
SuppressionsApi	suppressions_complaints_post	POST /suppressions/complaints	Add Complaints
SuppressionsApi	suppressions_get	GET /suppressions	Get Suppressions
SuppressionsApi	suppressions_unsubscribes_get	GET /suppressions/unsubscribes	Get Unsubscribes List
SuppressionsApi	suppressions_unsubscribes_import_post	POST /suppressions/unsubscribes/import	Add Unsubscribes Async
SuppressionsApi	suppressions_unsubscribes_post	POST /suppressions/unsubscribes	Add Unsubscribes
TemplatesApi	templates_by_name_delete	DELETE /templates/{name}	Delete Template
TemplatesApi	templates_by_name_get	GET /templates/{name}	Load Template
TemplatesApi	templates_by_name_put	PUT /templates/{name}	Update Template
TemplatesApi	templates_get	GET /templates	Load Templates
TemplatesApi	templates_post	POST /templates	Add Template
VerificationsApi	verifications_by_email_delete	DELETE /verifications/{email}	Delete Email Verification Result
VerificationsApi	verifications_by_email_get	GET /verifications/{email}	Get Email Verification Result
VerificationsApi	verifications_by_email_post	POST /verifications/{email}	Verify Email
VerificationsApi	verifications_files_by_id_delete	DELETE /verifications/files/{id}	Delete File Verification Result
VerificationsApi	verifications_files_by_id_result_download_get	GET /verifications/files/{id}/result/download	Download File Verification Result
VerificationsApi	verifications_files_by_id_result_get	GET /verifications/files/{id}/result	Get Detailed File Verification Result
VerificationsApi	verifications_files_by_id_verification_post	POST /verifications/files/{id}/verification	Start verification
VerificationsApi	verifications_files_post	POST /verifications/files	Upload File with Emails
VerificationsApi	verifications_files_result_get	GET /verifications/files/result	Get Files Verification Results
VerificationsApi	verifications_get	GET /verifications	Get Emails Verification Results

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

Authentication schemes defined for the API:

apikey

Type: API key
API key parameter name: X-ElasticEmail-ApiKey
Location: HTTP header

ApiKeyAuthCustomBranding

Type: API key
API key parameter name: X-Auth-Token
Location: HTTP header

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
bin		bin
docs		docs
examples		examples
lib/ElasticEmail		lib/ElasticEmail
t		t
.gitignore		.gitignore
.travis.yml		.travis.yml
README.md		README.md
VERSION		VERSION
cpanfile		cpanfile

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

NAME

VERSION

A note on Moose

SYNOPSIS

Structure of the library

Configuring authentication

METHODS

`base_url`

`api_factory`

MISSING METHODS

BUILDING YOUR LIBRARY

AUTOMATIC DOCUMENTATION

DOCUMENTATION FROM THE OpenAPI Spec

Installation Prerequisites

LOAD THE MODULES

GETTING STARTED

EXAMPLES

DOCUMENTATION FOR API ENDPOINTS

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

apikey

ApiKeyAuthCustomBranding

About

Uh oh!

Releases

Packages

Uh oh!

Languages

ElasticEmail/elasticemail-perl

Folders and files

Latest commit

History

Repository files navigation

NAME

VERSION

A note on Moose

SYNOPSIS

Structure of the library

Configuring authentication

METHODS

base_url

api_factory

MISSING METHODS

BUILDING YOUR LIBRARY

AUTOMATIC DOCUMENTATION

DOCUMENTATION FROM THE OpenAPI Spec

Installation Prerequisites

LOAD THE MODULES

GETTING STARTED

EXAMPLES

DOCUMENTATION FOR API ENDPOINTS

DOCUMENTATION FOR MODELS

DOCUMENTATION FOR AUTHORIZATION

apikey

ApiKeyAuthCustomBranding

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

`base_url`

`api_factory`

Packages