{"id":26395643,"url":"https://github.com/elasticemail/elasticemail-perl","last_synced_at":"2025-03-17T11:18:52.762Z","repository":{"id":84264471,"uuid":"366327677","full_name":"ElasticEmail/elasticemail-perl","owner":"ElasticEmail","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-05T12:37:28.000Z","size":537,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-05T13:34:10.221Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ElasticEmail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SecurityApi.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-11T09:30:54.000Z","updated_at":"2024-12-05T12:37:32.000Z","dependencies_parsed_at":"2024-07-08T11:42:32.157Z","dependency_job_id":"96dd3f81-ba92-4208-83c6-32b869e1ba7f","html_url":"https://github.com/ElasticEmail/elasticemail-perl","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-perl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-perl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-perl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ElasticEmail%2Felasticemail-perl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ElasticEmail","download_url":"https://codeload.github.com/ElasticEmail/elasticemail-perl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244022684,"owners_count":20385134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-17T11:18:52.312Z","updated_at":"2025-03-17T11:18:52.753Z","avatar_url":"https://github.com/ElasticEmail.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nElasticEmail::Role - a Moose role for the Elastic Email REST API\n\nThis API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.\r\n\r\nEvery API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.\r\n\r\nThe API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.\r\n\r\nTo start using this API, you will need your Access Token (available [here](https://app.elasticemail.com/marketing/settings/new/manage-api)). Remember to keep it safe. Required access levels are listed in the given request’s description.\r\n\r\nDownloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail?tab=repositories\u0026q=%22rest+api%22+in%3Areadme)\n\n# VERSION\n\nAutomatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 4.0.0\n- Package version: 4.0.25\n- Generator version: 7.5.0\n- Build package: org.openapitools.codegen.languages.PerlClientCodegen\n\n## A note on Moose\n\nThis role is the only component of the library that uses Moose. See\nElasticEmail::ApiFactory for non-Moosey usage.\n\n# SYNOPSIS\n\nThe Perl Generator in the OpenAPI Generator project builds a library of Perl modules to interact with\na web service defined by a OpenAPI Specification. See below for how to build the\nlibrary.\n\nThis module provides an interface to the generated library. All the classes,\nobjects, and methods (well, not quite \\*all\\*, see below) are flattened into this\nrole.\n\n        package MyApp;\n        use Moose;\n        with 'ElasticEmail::Role';\n\n        package main;\n\n        my $api = MyApp-\u003enew({ tokens =\u003e $tokens });\n\n        my $pet = $api-\u003eget_pet_by_id(pet_id =\u003e $pet_id);\n\n\n## Structure of the library\n\nThe library consists of a set of API classes, one for each endpoint. These APIs\nimplement the method calls available on each endpoint.\n\nAdditionally, there is a set of \"object\" classes, which represent the objects\nreturned by and sent to the methods on the endpoints.\n\nAn API factory class is provided, which builds instances of each endpoint API.\n\nThis Moose role flattens all the methods from the endpoint APIs onto the consuming\nclass. It also provides methods to retrieve the endpoint API objects, and the API\nfactory object, should you need it.\n\nFor documentation of all these methods, see AUTOMATIC DOCUMENTATION below.\n\n## Configuring authentication\n\nIn the normal case, the OpenAPI Spec will describe what parameters are\nrequired and where to put them. You just need to supply the tokens.\n\n    my $tokens = {\n        # basic\n        username =\u003e $username,\n        password =\u003e $password,\n\n        # oauth\n        access_token =\u003e $oauth_token,\n\n        # keys\n        $some_key =\u003e { token =\u003e $token,\n                       prefix =\u003e $prefix,\n                       in =\u003e $in,             # 'head||query',\n                       },\n\n        $another =\u003e { token =\u003e $token,\n                      prefix =\u003e $prefix,\n                      in =\u003e $in,              # 'head||query',\n                      },\n        ...,\n\n        };\n\n        my $api = MyApp-\u003enew({ tokens =\u003e $tokens });\n\nNote these are all optional, as are `prefix` and `in`, and depend on the API\nyou are accessing. Usually `prefix` and `in` will be determined by the code generator from\nthe spec and you will not need to set them at run time. If not, `in` will\ndefault to 'head' and `prefix` to the empty string.\n\nThe tokens will be placed in a L\u003cElasticEmail::Configuration\u003e instance\nas follows, but you don't need to know about this.\n\n- `$cfg-\u003e{username}`\n\n    String. The username for basic auth.\n\n- `$cfg-\u003e{password}`\n\n    String. The password for basic auth.\n\n- `$cfg-\u003e{api_key}`\n\n    Hashref. Keyed on the name of each key (there can be multiple tokens).\n\n            $cfg-\u003e{api_key} = {\n                    secretKey =\u003e 'aaaabbbbccccdddd',\n                    anotherKey =\u003e '1111222233334444',\n                    };\n\n- `$cfg-\u003e{api_key_prefix}`\n\n    Hashref. Keyed on the name of each key (there can be multiple tokens). Note not\n    all api keys require a prefix.\n\n            $cfg-\u003e{api_key_prefix} = {\n                    secretKey =\u003e 'string',\n                    anotherKey =\u003e 'same or some other string',\n                    };\n\n- `$cfg-\u003e{access_token}`\n\n    String. The OAuth access token.\n\n# METHODS\n\n## `base_url`\n\nThe generated code has the `base_url` already set as a default value. This method\nreturns the current value of `base_url`.\n\n## `api_factory`\n\nReturns an API factory object. You probably won't need to call this directly.\n\n        $self-\u003eapi_factory('Pet'); # returns a ElasticEmail::PetApi instance\n\n        $self-\u003epet_api;            # the same\n\n# MISSING METHODS\n\nMost of the methods on the API are delegated to individual endpoint API objects\n(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the\nsame method name (e.g. `new()`), these methods can't be delegated. So you need\nto call `$api-\u003epet_api-\u003enew()`.\n\nIn principle, every API is susceptible to the presence of a few, random, undelegatable\nmethod names. In practice, because of the way method names are constructed, it's\nunlikely in general that any methods will be undelegatable, except for:\n\n        new()\n        class_documentation()\n        method_documentation()\n\nTo call these methods, you need to get a handle on the relevant object, either\nby calling `$api-\u003efoo_api` or by retrieving an object, e.g.\n`$api-\u003eget_pet_by_id(pet_id =\u003e $pet_id)`. They are class methods, so\nyou could also call them on class names.\n\n# BUILDING YOUR LIBRARY\n\nSee the homepage `https://openapi-generator.tech` for full details.\nBut briefly, clone the git repository, build the codegen codebase, set up your build\nconfig file, then run the API build script. You will need git, Java 7 or 8 and Apache\nmaven 3.0.3 or better already installed.\n\nThe config file should specify the project name for the generated library:\n\n        {\"moduleName\":\"WWW::MyProjectName\"}\n\nYour library files will be built under `WWW::MyProjectName`.\n\n          $ git clone https://github.com/openapitools/openapi-generator\n          $ cd openapi-generator\n          $ mvn package\n          $ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \\\n    -i [URL or file path to JSON OpenAPI API spec] \\\n    -g perl \\\n    -c /path/to/config/file.json \\\n    -o /path/to/output/folder\n\nBang, all done. Run the `autodoc` script in the `bin` directory to see the API\nyou just built.\n\n# AUTOMATIC DOCUMENTATION\n\nYou can print out a summary of the generated API by running the included\n`autodoc` script in the `bin` directory of your generated library. A few\noutput formats are supported:\n\n          Usage: autodoc [OPTION]\n\n    -w           wide format (default)\n    -n           narrow format\n    -p           POD format\n    -H           HTML format\n    -m           Markdown format\n    -h           print this help message\n    -c           your application class\n\n\nThe `-c` option allows you to load and inspect your own application. A dummy\nnamespace is used if you don't supply your own class.\n\n# DOCUMENTATION FROM THE OpenAPI Spec\n\nAdditional documentation for each class and method may be provided by the OpenAPI\nspec. If so, this is available via the `class_documentation()` and\n`method_documentation()` methods on each generated object class, and the\n`method_documentation()` method on the endpoint API classes:\n\n        my $cmdoc = $api-\u003epet_api-\u003emethod_documentation-\u003e{$method_name};\n\n        my $odoc = $api-\u003eget_pet_by_id-\u003e(pet_id =\u003e $pet_id)-\u003eclass_documentation;\n        my $omdoc = $api-\u003eget_pet_by_id-\u003e(pet_id =\u003e $pet_id)-\u003emethod_documentation-\u003e{method_name};\n\n\nEach of these calls returns a hashref with various useful pieces of information.\n\n# Installation Prerequisites\n\nUse [cpanm](https://metacpan.org/pod/distribution/App-cpanminus/bin/cpanm) to install the module dependencies:\n\n```\ncpanm --local-lib=~/perl5 local::lib \u0026\u0026 eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)\ncpanm --quiet --no-interactive Class::Accessor Test::Exception Test::More Log::Any LWP::UserAgent URI::Query Module::Runtime DateTime Module::Find Moose::Role JSON\n```\n\n# LOAD THE MODULES\n\nTo load the API packages:\n```perl\nuse ElasticEmail::CampaignsApi;\nuse ElasticEmail::ContactsApi;\nuse ElasticEmail::DomainsApi;\nuse ElasticEmail::EmailsApi;\nuse ElasticEmail::EventsApi;\nuse ElasticEmail::FilesApi;\nuse ElasticEmail::InboundRouteApi;\nuse ElasticEmail::ListsApi;\nuse ElasticEmail::SecurityApi;\nuse ElasticEmail::SegmentsApi;\nuse ElasticEmail::StatisticsApi;\nuse ElasticEmail::SubAccountsApi;\nuse ElasticEmail::SuppressionsApi;\nuse ElasticEmail::TemplatesApi;\nuse ElasticEmail::VerificationsApi;\n\n```\n\nTo load the models:\n```perl\nuse ElasticEmail::Object::AccessLevel;\nuse ElasticEmail::Object::AccountStatusEnum;\nuse ElasticEmail::Object::ApiKey;\nuse ElasticEmail::Object::ApiKeyPayload;\nuse ElasticEmail::Object::BodyContentType;\nuse ElasticEmail::Object::BodyPart;\nuse ElasticEmail::Object::Campaign;\nuse ElasticEmail::Object::CampaignOptions;\nuse ElasticEmail::Object::CampaignRecipient;\nuse ElasticEmail::Object::CampaignStatus;\nuse ElasticEmail::Object::CampaignTemplate;\nuse ElasticEmail::Object::CertificateValidationStatus;\nuse ElasticEmail::Object::ChannelLogStatusSummary;\nuse ElasticEmail::Object::CompressionFormat;\nuse ElasticEmail::Object::ConsentData;\nuse ElasticEmail::Object::ConsentTracking;\nuse ElasticEmail::Object::Contact;\nuse ElasticEmail::Object::ContactActivity;\nuse ElasticEmail::Object::ContactPayload;\nuse ElasticEmail::Object::ContactSource;\nuse ElasticEmail::Object::ContactStatus;\nuse ElasticEmail::Object::ContactUpdatePayload;\nuse ElasticEmail::Object::ContactsList;\nuse ElasticEmail::Object::DeliveryOptimizationType;\nuse ElasticEmail::Object::DomainData;\nuse ElasticEmail::Object::DomainDetail;\nuse ElasticEmail::Object::DomainOwner;\nuse ElasticEmail::Object::DomainPayload;\nuse ElasticEmail::Object::DomainUpdatePayload;\nuse ElasticEmail::Object::EmailContent;\nuse ElasticEmail::Object::EmailData;\nuse ElasticEmail::Object::EmailJobFailedStatus;\nuse ElasticEmail::Object::EmailJobStatus;\nuse ElasticEmail::Object::EmailMessageData;\nuse ElasticEmail::Object::EmailPredictedValidationStatus;\nuse ElasticEmail::Object::EmailRecipient;\nuse ElasticEmail::Object::EmailSend;\nuse ElasticEmail::Object::EmailStatus;\nuse ElasticEmail::Object::EmailTransactionalMessageData;\nuse ElasticEmail::Object::EmailValidationResult;\nuse ElasticEmail::Object::EmailValidationStatus;\nuse ElasticEmail::Object::EmailView;\nuse ElasticEmail::Object::EmailsPayload;\nuse ElasticEmail::Object::EncodingType;\nuse ElasticEmail::Object::EventType;\nuse ElasticEmail::Object::EventsOrderBy;\nuse ElasticEmail::Object::ExportFileFormats;\nuse ElasticEmail::Object::ExportLink;\nuse ElasticEmail::Object::ExportStatus;\nuse ElasticEmail::Object::FileInfo;\nuse ElasticEmail::Object::FilePayload;\nuse ElasticEmail::Object::FileUploadResult;\nuse ElasticEmail::Object::InboundPayload;\nuse ElasticEmail::Object::InboundRoute;\nuse ElasticEmail::Object::InboundRouteActionType;\nuse ElasticEmail::Object::InboundRouteFilterType;\nuse ElasticEmail::Object::ListPayload;\nuse ElasticEmail::Object::ListUpdatePayload;\nuse ElasticEmail::Object::LogJobStatus;\nuse ElasticEmail::Object::LogStatusSummary;\nuse ElasticEmail::Object::MergeEmailPayload;\nuse ElasticEmail::Object::MessageAttachment;\nuse ElasticEmail::Object::MessageCategory;\nuse ElasticEmail::Object::MessageCategoryEnum;\nuse ElasticEmail::Object::NewApiKey;\nuse ElasticEmail::Object::NewSmtpCredentials;\nuse ElasticEmail::Object::Options;\nuse ElasticEmail::Object::RecipientEvent;\nuse ElasticEmail::Object::Segment;\nuse ElasticEmail::Object::SegmentPayload;\nuse ElasticEmail::Object::SmtpCredentials;\nuse ElasticEmail::Object::SmtpCredentialsPayload;\nuse ElasticEmail::Object::SortOrderItem;\nuse ElasticEmail::Object::SplitOptimizationType;\nuse ElasticEmail::Object::SplitOptions;\nuse ElasticEmail::Object::SubAccountInfo;\nuse ElasticEmail::Object::SubaccountEmailCreditsPayload;\nuse ElasticEmail::Object::SubaccountEmailSettings;\nuse ElasticEmail::Object::SubaccountEmailSettingsPayload;\nuse ElasticEmail::Object::SubaccountPayload;\nuse ElasticEmail::Object::SubaccountSettingsInfo;\nuse ElasticEmail::Object::SubaccountSettingsInfoPayload;\nuse ElasticEmail::Object::Suppression;\nuse ElasticEmail::Object::Template;\nuse ElasticEmail::Object::TemplatePayload;\nuse ElasticEmail::Object::TemplateScope;\nuse ElasticEmail::Object::TemplateType;\nuse ElasticEmail::Object::TrackingType;\nuse ElasticEmail::Object::TrackingValidationStatus;\nuse ElasticEmail::Object::TransactionalRecipient;\nuse ElasticEmail::Object::Utm;\nuse ElasticEmail::Object::VerificationFileResult;\nuse ElasticEmail::Object::VerificationFileResultDetails;\nuse ElasticEmail::Object::VerificationStatus;\n\n````\n\n# GETTING STARTED\nPut the Perl SDK under the 'lib' folder in your project directory, then run the following\n```perl\n#!/usr/bin/perl\nuse lib 'lib';\nuse strict;\nuse warnings;\n# load the API package\nuse ElasticEmail::CampaignsApi;\nuse ElasticEmail::ContactsApi;\nuse ElasticEmail::DomainsApi;\nuse ElasticEmail::EmailsApi;\nuse ElasticEmail::EventsApi;\nuse ElasticEmail::FilesApi;\nuse ElasticEmail::InboundRouteApi;\nuse ElasticEmail::ListsApi;\nuse ElasticEmail::SecurityApi;\nuse ElasticEmail::SegmentsApi;\nuse ElasticEmail::StatisticsApi;\nuse ElasticEmail::SubAccountsApi;\nuse ElasticEmail::SuppressionsApi;\nuse ElasticEmail::TemplatesApi;\nuse ElasticEmail::VerificationsApi;\n\n# load the models\nuse ElasticEmail::Object::AccessLevel;\nuse ElasticEmail::Object::AccountStatusEnum;\nuse ElasticEmail::Object::ApiKey;\nuse ElasticEmail::Object::ApiKeyPayload;\nuse ElasticEmail::Object::BodyContentType;\nuse ElasticEmail::Object::BodyPart;\nuse ElasticEmail::Object::Campaign;\nuse ElasticEmail::Object::CampaignOptions;\nuse ElasticEmail::Object::CampaignRecipient;\nuse ElasticEmail::Object::CampaignStatus;\nuse ElasticEmail::Object::CampaignTemplate;\nuse ElasticEmail::Object::CertificateValidationStatus;\nuse ElasticEmail::Object::ChannelLogStatusSummary;\nuse ElasticEmail::Object::CompressionFormat;\nuse ElasticEmail::Object::ConsentData;\nuse ElasticEmail::Object::ConsentTracking;\nuse ElasticEmail::Object::Contact;\nuse ElasticEmail::Object::ContactActivity;\nuse ElasticEmail::Object::ContactPayload;\nuse ElasticEmail::Object::ContactSource;\nuse ElasticEmail::Object::ContactStatus;\nuse ElasticEmail::Object::ContactUpdatePayload;\nuse ElasticEmail::Object::ContactsList;\nuse ElasticEmail::Object::DeliveryOptimizationType;\nuse ElasticEmail::Object::DomainData;\nuse ElasticEmail::Object::DomainDetail;\nuse ElasticEmail::Object::DomainOwner;\nuse ElasticEmail::Object::DomainPayload;\nuse ElasticEmail::Object::DomainUpdatePayload;\nuse ElasticEmail::Object::EmailContent;\nuse ElasticEmail::Object::EmailData;\nuse ElasticEmail::Object::EmailJobFailedStatus;\nuse ElasticEmail::Object::EmailJobStatus;\nuse ElasticEmail::Object::EmailMessageData;\nuse ElasticEmail::Object::EmailPredictedValidationStatus;\nuse ElasticEmail::Object::EmailRecipient;\nuse ElasticEmail::Object::EmailSend;\nuse ElasticEmail::Object::EmailStatus;\nuse ElasticEmail::Object::EmailTransactionalMessageData;\nuse ElasticEmail::Object::EmailValidationResult;\nuse ElasticEmail::Object::EmailValidationStatus;\nuse ElasticEmail::Object::EmailView;\nuse ElasticEmail::Object::EmailsPayload;\nuse ElasticEmail::Object::EncodingType;\nuse ElasticEmail::Object::EventType;\nuse ElasticEmail::Object::EventsOrderBy;\nuse ElasticEmail::Object::ExportFileFormats;\nuse ElasticEmail::Object::ExportLink;\nuse ElasticEmail::Object::ExportStatus;\nuse ElasticEmail::Object::FileInfo;\nuse ElasticEmail::Object::FilePayload;\nuse ElasticEmail::Object::FileUploadResult;\nuse ElasticEmail::Object::InboundPayload;\nuse ElasticEmail::Object::InboundRoute;\nuse ElasticEmail::Object::InboundRouteActionType;\nuse ElasticEmail::Object::InboundRouteFilterType;\nuse ElasticEmail::Object::ListPayload;\nuse ElasticEmail::Object::ListUpdatePayload;\nuse ElasticEmail::Object::LogJobStatus;\nuse ElasticEmail::Object::LogStatusSummary;\nuse ElasticEmail::Object::MergeEmailPayload;\nuse ElasticEmail::Object::MessageAttachment;\nuse ElasticEmail::Object::MessageCategory;\nuse ElasticEmail::Object::MessageCategoryEnum;\nuse ElasticEmail::Object::NewApiKey;\nuse ElasticEmail::Object::NewSmtpCredentials;\nuse ElasticEmail::Object::Options;\nuse ElasticEmail::Object::RecipientEvent;\nuse ElasticEmail::Object::Segment;\nuse ElasticEmail::Object::SegmentPayload;\nuse ElasticEmail::Object::SmtpCredentials;\nuse ElasticEmail::Object::SmtpCredentialsPayload;\nuse ElasticEmail::Object::SortOrderItem;\nuse ElasticEmail::Object::SplitOptimizationType;\nuse ElasticEmail::Object::SplitOptions;\nuse ElasticEmail::Object::SubAccountInfo;\nuse ElasticEmail::Object::SubaccountEmailCreditsPayload;\nuse ElasticEmail::Object::SubaccountEmailSettings;\nuse ElasticEmail::Object::SubaccountEmailSettingsPayload;\nuse ElasticEmail::Object::SubaccountPayload;\nuse ElasticEmail::Object::SubaccountSettingsInfo;\nuse ElasticEmail::Object::SubaccountSettingsInfoPayload;\nuse ElasticEmail::Object::Suppression;\nuse ElasticEmail::Object::Template;\nuse ElasticEmail::Object::TemplatePayload;\nuse ElasticEmail::Object::TemplateScope;\nuse ElasticEmail::Object::TemplateType;\nuse ElasticEmail::Object::TrackingType;\nuse ElasticEmail::Object::TrackingValidationStatus;\nuse ElasticEmail::Object::TransactionalRecipient;\nuse ElasticEmail::Object::Utm;\nuse ElasticEmail::Object::VerificationFileResult;\nuse ElasticEmail::Object::VerificationFileResultDetails;\nuse ElasticEmail::Object::VerificationStatus;\n\n# for displaying the API response data\nuse Data::Dumper;\n\n\nmy $api_instance = ElasticEmail::CampaignsApi-\u003enew(\n    # Configure API key authorization: apikey\n    api_key =\u003e {'X-ElasticEmail-ApiKey' =\u003e 'YOUR_API_KEY'},\n    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n    #api_key_prefix =\u003e {'X-ElasticEmail-ApiKey' =\u003e 'Bearer'},\n);\n\nmy $name = \"name_example\"; # string | Name of Campaign to delete\n\neval {\n    $api_instance-\u003ecampaigns_by_name_delete(name =\u003e $name);\n};\nif ($@) {\n    warn \"Exception when calling CampaignsApi-\u003ecampaigns_by_name_delete: $@\\n\";\n}\n\n```\n\n\n# EXAMPLES\n\nFunction ||\n------------ | ------------- \n[addCampaign](examples/functions/addCampaign.pl) | [readme](examples/functions/addCampaign.md)\n[addBulkContacts](examples/functions/addBulkContacts.pl) | [readme](examples/functions/addBulkContacts.md)\n[addList](examples/functions/addList.pl) | [readme](examples/functions/addList.md)\n[addSingleContact](examples/functions/addSingleContact.pl) | [readme](examples/functions/addSingleContact.md)\n[addTemplate](examples/functions/addTemplate.pl) | [readme](examples/functions/addTemplate.md)\n[deleteCampaign](examples/functions/deleteCampaign.pl) | [readme](examples/functions/deleteCampaign.md)\n[deleteContacts](examples/functions/deleteContacts.pl) | [readme](examples/functions/deleteContacts.md)\n[deleteList](examples/functions/deleteList.pl) | [readme](examples/functions/deleteList.md)\n[deleteTemplate](examples/functions/deleteTemplate.pl) | [readme](examples/functions/deleteTemplate.md)\n[exportContacts](examples/functions/exportContacts.pl) | [readme](examples/functions/exportContacts.md)\n[loadCampaigns](examples/functions/loadCampaigns.pl) | [readme](examples/functions/loadCampaigns.md)\n[loadCampaignsStats](examples/functions/loadCampaignsStats.pl) | [readme](examples/functions/loadCampaignsStats.md)\n[loadChannelsStats](examples/functions/loadChannelsStats.pl) | [readme](examples/functions/loadChannelsStats.md)\n[loadList](examples/functions/loadList.pl) | [readme](examples/functions/loadList.md)\n[loadStatistics](examples/functions/loadStatistics.pl) | [readme](examples/functions/loadStatistics.md)\n[loadTemplate](examples/functions/loadTemplate.pl) | [readme](examples/functions/loadTemplate.md)\n[sendBulkEmails](examples/functions/sendBulkEmails.pl) | [readme](examples/functions/sendBulkEmails.md)\n[sendTransactionalEmails](examples/functions/sendTransactionalEmails.pl) | [readme](examples/functions/sendTransactionalEmails.md)\n[updateCampaign](examples/functions/updateCampaign.pl) | [readme](examples/functions/updateCampaign.md)\n\n# DOCUMENTATION FOR API ENDPOINTS\n\nAll URIs are relative to *https://api.elasticemail.com/v4*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*CampaignsApi* | [**campaigns_by_name_delete**](docs/CampaignsApi.md#campaigns_by_name_delete) | **DELETE** /campaigns/{name} | Delete Campaign\n*CampaignsApi* | [**campaigns_by_name_get**](docs/CampaignsApi.md#campaigns_by_name_get) | **GET** /campaigns/{name} | Load Campaign\n*CampaignsApi* | [**campaigns_by_name_pause_put**](docs/CampaignsApi.md#campaigns_by_name_pause_put) | **PUT** /campaigns/{name}/pause | Pause Campaign\n*CampaignsApi* | [**campaigns_by_name_put**](docs/CampaignsApi.md#campaigns_by_name_put) | **PUT** /campaigns/{name} | Update Campaign\n*CampaignsApi* | [**campaigns_get**](docs/CampaignsApi.md#campaigns_get) | **GET** /campaigns | Load Campaigns\n*CampaignsApi* | [**campaigns_post**](docs/CampaignsApi.md#campaigns_post) | **POST** /campaigns | Add Campaign\n*ContactsApi* | [**contacts_by_email_delete**](docs/ContactsApi.md#contacts_by_email_delete) | **DELETE** /contacts/{email} | Delete Contact\n*ContactsApi* | [**contacts_by_email_get**](docs/ContactsApi.md#contacts_by_email_get) | **GET** /contacts/{email} | Load Contact\n*ContactsApi* | [**contacts_by_email_put**](docs/ContactsApi.md#contacts_by_email_put) | **PUT** /contacts/{email} | Update Contact\n*ContactsApi* | [**contacts_delete_post**](docs/ContactsApi.md#contacts_delete_post) | **POST** /contacts/delete | Delete Contacts Bulk\n*ContactsApi* | [**contacts_export_by_id_status_get**](docs/ContactsApi.md#contacts_export_by_id_status_get) | **GET** /contacts/export/{id}/status | Check Export Status\n*ContactsApi* | [**contacts_export_post**](docs/ContactsApi.md#contacts_export_post) | **POST** /contacts/export | Export Contacts\n*ContactsApi* | [**contacts_get**](docs/ContactsApi.md#contacts_get) | **GET** /contacts | Load Contacts\n*ContactsApi* | [**contacts_import_post**](docs/ContactsApi.md#contacts_import_post) | **POST** /contacts/import | Upload Contacts\n*ContactsApi* | [**contacts_post**](docs/ContactsApi.md#contacts_post) | **POST** /contacts | Add Contact\n*DomainsApi* | [**domains_by_domain_delete**](docs/DomainsApi.md#domains_by_domain_delete) | **DELETE** /domains/{domain} | Delete Domain\n*DomainsApi* | [**domains_by_domain_get**](docs/DomainsApi.md#domains_by_domain_get) | **GET** /domains/{domain} | Load Domain\n*DomainsApi* | [**domains_by_domain_put**](docs/DomainsApi.md#domains_by_domain_put) | **PUT** /domains/{domain} | Update Domain\n*DomainsApi* | [**domains_by_domain_restricted_get**](docs/DomainsApi.md#domains_by_domain_restricted_get) | **GET** /domains/{domain}/restricted | Check for domain restriction\n*DomainsApi* | [**domains_by_domain_verification_put**](docs/DomainsApi.md#domains_by_domain_verification_put) | **PUT** /domains/{domain}/verification | Verify Domain\n*DomainsApi* | [**domains_by_email_default_patch**](docs/DomainsApi.md#domains_by_email_default_patch) | **PATCH** /domains/{email}/default | Set Default\n*DomainsApi* | [**domains_get**](docs/DomainsApi.md#domains_get) | **GET** /domains | Load Domains\n*DomainsApi* | [**domains_post**](docs/DomainsApi.md#domains_post) | **POST** /domains | Add Domain\n*EmailsApi* | [**emails_by_msgid_view_get**](docs/EmailsApi.md#emails_by_msgid_view_get) | **GET** /emails/{msgid}/view | View Email\n*EmailsApi* | [**emails_by_transactionid_status_get**](docs/EmailsApi.md#emails_by_transactionid_status_get) | **GET** /emails/{transactionid}/status | Get Status\n*EmailsApi* | [**emails_mergefile_post**](docs/EmailsApi.md#emails_mergefile_post) | **POST** /emails/mergefile | Send Bulk Emails CSV\n*EmailsApi* | [**emails_post**](docs/EmailsApi.md#emails_post) | **POST** /emails | Send Bulk Emails\n*EmailsApi* | [**emails_transactional_post**](docs/EmailsApi.md#emails_transactional_post) | **POST** /emails/transactional | Send Transactional Email\n*EventsApi* | [**events_by_transactionid_get**](docs/EventsApi.md#events_by_transactionid_get) | **GET** /events/{transactionid} | Load Email Events\n*EventsApi* | [**events_channels_by_name_export_post**](docs/EventsApi.md#events_channels_by_name_export_post) | **POST** /events/channels/{name}/export | Export Channel Events\n*EventsApi* | [**events_channels_by_name_get**](docs/EventsApi.md#events_channels_by_name_get) | **GET** /events/channels/{name} | Load Channel Events\n*EventsApi* | [**events_channels_export_by_id_status_get**](docs/EventsApi.md#events_channels_export_by_id_status_get) | **GET** /events/channels/export/{id}/status | Check Channel Export Status\n*EventsApi* | [**events_export_by_id_status_get**](docs/EventsApi.md#events_export_by_id_status_get) | **GET** /events/export/{id}/status | Check Export Status\n*EventsApi* | [**events_export_post**](docs/EventsApi.md#events_export_post) | **POST** /events/export | Export Events\n*EventsApi* | [**events_get**](docs/EventsApi.md#events_get) | **GET** /events | Load Events\n*FilesApi* | [**files_by_name_delete**](docs/FilesApi.md#files_by_name_delete) | **DELETE** /files/{name} | Delete File\n*FilesApi* | [**files_by_name_get**](docs/FilesApi.md#files_by_name_get) | **GET** /files/{name} | Download File\n*FilesApi* | [**files_by_name_info_get**](docs/FilesApi.md#files_by_name_info_get) | **GET** /files/{name}/info | Load File Details\n*FilesApi* | [**files_get**](docs/FilesApi.md#files_get) | **GET** /files | List Files\n*FilesApi* | [**files_post**](docs/FilesApi.md#files_post) | **POST** /files | Upload File\n*InboundRouteApi* | [**inboundroute_by_id_delete**](docs/InboundRouteApi.md#inboundroute_by_id_delete) | **DELETE** /inboundroute/{id} | Delete Route\n*InboundRouteApi* | [**inboundroute_by_id_get**](docs/InboundRouteApi.md#inboundroute_by_id_get) | **GET** /inboundroute/{id} | Get Route\n*InboundRouteApi* | [**inboundroute_by_id_put**](docs/InboundRouteApi.md#inboundroute_by_id_put) | **PUT** /inboundroute/{id} | Update Route\n*InboundRouteApi* | [**inboundroute_get**](docs/InboundRouteApi.md#inboundroute_get) | **GET** /inboundroute | Get Routes\n*InboundRouteApi* | [**inboundroute_order_put**](docs/InboundRouteApi.md#inboundroute_order_put) | **PUT** /inboundroute/order | Update Sorting\n*InboundRouteApi* | [**inboundroute_post**](docs/InboundRouteApi.md#inboundroute_post) | **POST** /inboundroute | Create Route\n*ListsApi* | [**lists_by_listname_contacts_get**](docs/ListsApi.md#lists_by_listname_contacts_get) | **GET** /lists/{listname}/contacts | Load Contacts in List\n*ListsApi* | [**lists_by_name_contacts_post**](docs/ListsApi.md#lists_by_name_contacts_post) | **POST** /lists/{name}/contacts | Add Contacts to List\n*ListsApi* | [**lists_by_name_contacts_remove_post**](docs/ListsApi.md#lists_by_name_contacts_remove_post) | **POST** /lists/{name}/contacts/remove | Remove Contacts from List\n*ListsApi* | [**lists_by_name_delete**](docs/ListsApi.md#lists_by_name_delete) | **DELETE** /lists/{name} | Delete List\n*ListsApi* | [**lists_by_name_get**](docs/ListsApi.md#lists_by_name_get) | **GET** /lists/{name} | Load List\n*ListsApi* | [**lists_by_name_put**](docs/ListsApi.md#lists_by_name_put) | **PUT** /lists/{name} | Update List\n*ListsApi* | [**lists_get**](docs/ListsApi.md#lists_get) | **GET** /lists | Load Lists\n*ListsApi* | [**lists_post**](docs/ListsApi.md#lists_post) | **POST** /lists | Add List\n*SecurityApi* | [**security_apikeys_by_name_delete**](docs/SecurityApi.md#security_apikeys_by_name_delete) | **DELETE** /security/apikeys/{name} | Delete ApiKey\n*SecurityApi* | [**security_apikeys_by_name_get**](docs/SecurityApi.md#security_apikeys_by_name_get) | **GET** /security/apikeys/{name} | Load ApiKey\n*SecurityApi* | [**security_apikeys_by_name_put**](docs/SecurityApi.md#security_apikeys_by_name_put) | **PUT** /security/apikeys/{name} | Update ApiKey\n*SecurityApi* | [**security_apikeys_get**](docs/SecurityApi.md#security_apikeys_get) | **GET** /security/apikeys | List ApiKeys\n*SecurityApi* | [**security_apikeys_post**](docs/SecurityApi.md#security_apikeys_post) | **POST** /security/apikeys | Add ApiKey\n*SecurityApi* | [**security_smtp_by_name_delete**](docs/SecurityApi.md#security_smtp_by_name_delete) | **DELETE** /security/smtp/{name} | Delete SMTP Credential\n*SecurityApi* | [**security_smtp_by_name_get**](docs/SecurityApi.md#security_smtp_by_name_get) | **GET** /security/smtp/{name} | Load SMTP Credential\n*SecurityApi* | [**security_smtp_by_name_put**](docs/SecurityApi.md#security_smtp_by_name_put) | **PUT** /security/smtp/{name} | Update SMTP Credential\n*SecurityApi* | [**security_smtp_get**](docs/SecurityApi.md#security_smtp_get) | **GET** /security/smtp | List SMTP Credentials\n*SecurityApi* | [**security_smtp_post**](docs/SecurityApi.md#security_smtp_post) | **POST** /security/smtp | Add SMTP Credential\n*SegmentsApi* | [**segments_by_name_delete**](docs/SegmentsApi.md#segments_by_name_delete) | **DELETE** /segments/{name} | Delete Segment\n*SegmentsApi* | [**segments_by_name_get**](docs/SegmentsApi.md#segments_by_name_get) | **GET** /segments/{name} | Load Segment\n*SegmentsApi* | [**segments_by_name_put**](docs/SegmentsApi.md#segments_by_name_put) | **PUT** /segments/{name} | Update Segment\n*SegmentsApi* | [**segments_get**](docs/SegmentsApi.md#segments_get) | **GET** /segments | Load Segments\n*SegmentsApi* | [**segments_post**](docs/SegmentsApi.md#segments_post) | **POST** /segments | Add Segment\n*StatisticsApi* | [**statistics_campaigns_by_name_get**](docs/StatisticsApi.md#statistics_campaigns_by_name_get) | **GET** /statistics/campaigns/{name} | Load Campaign Stats\n*StatisticsApi* | [**statistics_campaigns_get**](docs/StatisticsApi.md#statistics_campaigns_get) | **GET** /statistics/campaigns | Load Campaigns Stats\n*StatisticsApi* | [**statistics_channels_by_name_get**](docs/StatisticsApi.md#statistics_channels_by_name_get) | **GET** /statistics/channels/{name} | Load Channel Stats\n*StatisticsApi* | [**statistics_channels_get**](docs/StatisticsApi.md#statistics_channels_get) | **GET** /statistics/channels | Load Channels Stats\n*StatisticsApi* | [**statistics_get**](docs/StatisticsApi.md#statistics_get) | **GET** /statistics | Load Statistics\n*SubAccountsApi* | [**subaccounts_by_email_credits_patch**](docs/SubAccountsApi.md#subaccounts_by_email_credits_patch) | **PATCH** /subaccounts/{email}/credits | Add, Subtract Email Credits\n*SubAccountsApi* | [**subaccounts_by_email_delete**](docs/SubAccountsApi.md#subaccounts_by_email_delete) | **DELETE** /subaccounts/{email} | Delete SubAccount\n*SubAccountsApi* | [**subaccounts_by_email_get**](docs/SubAccountsApi.md#subaccounts_by_email_get) | **GET** /subaccounts/{email} | Load SubAccount\n*SubAccountsApi* | [**subaccounts_by_email_settings_email_put**](docs/SubAccountsApi.md#subaccounts_by_email_settings_email_put) | **PUT** /subaccounts/{email}/settings/email | Update SubAccount Email Settings\n*SubAccountsApi* | [**subaccounts_get**](docs/SubAccountsApi.md#subaccounts_get) | **GET** /subaccounts | Load SubAccounts\n*SubAccountsApi* | [**subaccounts_post**](docs/SubAccountsApi.md#subaccounts_post) | **POST** /subaccounts | Add SubAccount\n*SuppressionsApi* | [**suppressions_bounces_get**](docs/SuppressionsApi.md#suppressions_bounces_get) | **GET** /suppressions/bounces | Get Bounce List\n*SuppressionsApi* | [**suppressions_bounces_import_post**](docs/SuppressionsApi.md#suppressions_bounces_import_post) | **POST** /suppressions/bounces/import | Add Bounces Async\n*SuppressionsApi* | [**suppressions_bounces_post**](docs/SuppressionsApi.md#suppressions_bounces_post) | **POST** /suppressions/bounces | Add Bounces\n*SuppressionsApi* | [**suppressions_by_email_delete**](docs/SuppressionsApi.md#suppressions_by_email_delete) | **DELETE** /suppressions/{email} | Delete Suppression\n*SuppressionsApi* | [**suppressions_by_email_get**](docs/SuppressionsApi.md#suppressions_by_email_get) | **GET** /suppressions/{email} | Get Suppression\n*SuppressionsApi* | [**suppressions_complaints_get**](docs/SuppressionsApi.md#suppressions_complaints_get) | **GET** /suppressions/complaints | Get Complaints List\n*SuppressionsApi* | [**suppressions_complaints_import_post**](docs/SuppressionsApi.md#suppressions_complaints_import_post) | **POST** /suppressions/complaints/import | Add Complaints Async\n*SuppressionsApi* | [**suppressions_complaints_post**](docs/SuppressionsApi.md#suppressions_complaints_post) | **POST** /suppressions/complaints | Add Complaints\n*SuppressionsApi* | [**suppressions_get**](docs/SuppressionsApi.md#suppressions_get) | **GET** /suppressions | Get Suppressions\n*SuppressionsApi* | [**suppressions_unsubscribes_get**](docs/SuppressionsApi.md#suppressions_unsubscribes_get) | **GET** /suppressions/unsubscribes | Get Unsubscribes List\n*SuppressionsApi* | [**suppressions_unsubscribes_import_post**](docs/SuppressionsApi.md#suppressions_unsubscribes_import_post) | **POST** /suppressions/unsubscribes/import | Add Unsubscribes Async\n*SuppressionsApi* | [**suppressions_unsubscribes_post**](docs/SuppressionsApi.md#suppressions_unsubscribes_post) | **POST** /suppressions/unsubscribes | Add Unsubscribes\n*TemplatesApi* | [**templates_by_name_delete**](docs/TemplatesApi.md#templates_by_name_delete) | **DELETE** /templates/{name} | Delete Template\n*TemplatesApi* | [**templates_by_name_get**](docs/TemplatesApi.md#templates_by_name_get) | **GET** /templates/{name} | Load Template\n*TemplatesApi* | [**templates_by_name_put**](docs/TemplatesApi.md#templates_by_name_put) | **PUT** /templates/{name} | Update Template\n*TemplatesApi* | [**templates_get**](docs/TemplatesApi.md#templates_get) | **GET** /templates | Load Templates\n*TemplatesApi* | [**templates_post**](docs/TemplatesApi.md#templates_post) | **POST** /templates | Add Template\n*VerificationsApi* | [**verifications_by_email_delete**](docs/VerificationsApi.md#verifications_by_email_delete) | **DELETE** /verifications/{email} | Delete Email Verification Result\n*VerificationsApi* | [**verifications_by_email_get**](docs/VerificationsApi.md#verifications_by_email_get) | **GET** /verifications/{email} | Get Email Verification Result\n*VerificationsApi* | [**verifications_by_email_post**](docs/VerificationsApi.md#verifications_by_email_post) | **POST** /verifications/{email} | Verify Email\n*VerificationsApi* | [**verifications_files_by_id_delete**](docs/VerificationsApi.md#verifications_files_by_id_delete) | **DELETE** /verifications/files/{id} | Delete File Verification Result\n*VerificationsApi* | [**verifications_files_by_id_result_download_get**](docs/VerificationsApi.md#verifications_files_by_id_result_download_get) | **GET** /verifications/files/{id}/result/download | Download File Verification Result\n*VerificationsApi* | [**verifications_files_by_id_result_get**](docs/VerificationsApi.md#verifications_files_by_id_result_get) | **GET** /verifications/files/{id}/result | Get Detailed File Verification Result\n*VerificationsApi* | [**verifications_files_by_id_verification_post**](docs/VerificationsApi.md#verifications_files_by_id_verification_post) | **POST** /verifications/files/{id}/verification | Start verification\n*VerificationsApi* | [**verifications_files_post**](docs/VerificationsApi.md#verifications_files_post) | **POST** /verifications/files | Upload File with Emails\n*VerificationsApi* | [**verifications_files_result_get**](docs/VerificationsApi.md#verifications_files_result_get) | **GET** /verifications/files/result | Get Files Verification Results\n*VerificationsApi* | [**verifications_get**](docs/VerificationsApi.md#verifications_get) | **GET** /verifications | Get Emails Verification Results\n\n\n# DOCUMENTATION FOR MODELS\n - [ElasticEmail::Object::AccessLevel](docs/AccessLevel.md)\n - [ElasticEmail::Object::AccountStatusEnum](docs/AccountStatusEnum.md)\n - [ElasticEmail::Object::ApiKey](docs/ApiKey.md)\n - [ElasticEmail::Object::ApiKeyPayload](docs/ApiKeyPayload.md)\n - [ElasticEmail::Object::BodyContentType](docs/BodyContentType.md)\n - [ElasticEmail::Object::BodyPart](docs/BodyPart.md)\n - [ElasticEmail::Object::Campaign](docs/Campaign.md)\n - [ElasticEmail::Object::CampaignOptions](docs/CampaignOptions.md)\n - [ElasticEmail::Object::CampaignRecipient](docs/CampaignRecipient.md)\n - [ElasticEmail::Object::CampaignStatus](docs/CampaignStatus.md)\n - [ElasticEmail::Object::CampaignTemplate](docs/CampaignTemplate.md)\n - [ElasticEmail::Object::CertificateValidationStatus](docs/CertificateValidationStatus.md)\n - [ElasticEmail::Object::ChannelLogStatusSummary](docs/ChannelLogStatusSummary.md)\n - [ElasticEmail::Object::CompressionFormat](docs/CompressionFormat.md)\n - [ElasticEmail::Object::ConsentData](docs/ConsentData.md)\n - [ElasticEmail::Object::ConsentTracking](docs/ConsentTracking.md)\n - [ElasticEmail::Object::Contact](docs/Contact.md)\n - [ElasticEmail::Object::ContactActivity](docs/ContactActivity.md)\n - [ElasticEmail::Object::ContactPayload](docs/ContactPayload.md)\n - [ElasticEmail::Object::ContactSource](docs/ContactSource.md)\n - [ElasticEmail::Object::ContactStatus](docs/ContactStatus.md)\n - [ElasticEmail::Object::ContactUpdatePayload](docs/ContactUpdatePayload.md)\n - [ElasticEmail::Object::ContactsList](docs/ContactsList.md)\n - [ElasticEmail::Object::DeliveryOptimizationType](docs/DeliveryOptimizationType.md)\n - [ElasticEmail::Object::DomainData](docs/DomainData.md)\n - [ElasticEmail::Object::DomainDetail](docs/DomainDetail.md)\n - [ElasticEmail::Object::DomainOwner](docs/DomainOwner.md)\n - [ElasticEmail::Object::DomainPayload](docs/DomainPayload.md)\n - [ElasticEmail::Object::DomainUpdatePayload](docs/DomainUpdatePayload.md)\n - [ElasticEmail::Object::EmailContent](docs/EmailContent.md)\n - [ElasticEmail::Object::EmailData](docs/EmailData.md)\n - [ElasticEmail::Object::EmailJobFailedStatus](docs/EmailJobFailedStatus.md)\n - [ElasticEmail::Object::EmailJobStatus](docs/EmailJobStatus.md)\n - [ElasticEmail::Object::EmailMessageData](docs/EmailMessageData.md)\n - [ElasticEmail::Object::EmailPredictedValidationStatus](docs/EmailPredictedValidationStatus.md)\n - [ElasticEmail::Object::EmailRecipient](docs/EmailRecipient.md)\n - [ElasticEmail::Object::EmailSend](docs/EmailSend.md)\n - [ElasticEmail::Object::EmailStatus](docs/EmailStatus.md)\n - [ElasticEmail::Object::EmailTransactionalMessageData](docs/EmailTransactionalMessageData.md)\n - [ElasticEmail::Object::EmailValidationResult](docs/EmailValidationResult.md)\n - [ElasticEmail::Object::EmailValidationStatus](docs/EmailValidationStatus.md)\n - [ElasticEmail::Object::EmailView](docs/EmailView.md)\n - [ElasticEmail::Object::EmailsPayload](docs/EmailsPayload.md)\n - [ElasticEmail::Object::EncodingType](docs/EncodingType.md)\n - [ElasticEmail::Object::EventType](docs/EventType.md)\n - [ElasticEmail::Object::EventsOrderBy](docs/EventsOrderBy.md)\n - [ElasticEmail::Object::ExportFileFormats](docs/ExportFileFormats.md)\n - [ElasticEmail::Object::ExportLink](docs/ExportLink.md)\n - [ElasticEmail::Object::ExportStatus](docs/ExportStatus.md)\n - [ElasticEmail::Object::FileInfo](docs/FileInfo.md)\n - [ElasticEmail::Object::FilePayload](docs/FilePayload.md)\n - [ElasticEmail::Object::FileUploadResult](docs/FileUploadResult.md)\n - [ElasticEmail::Object::InboundPayload](docs/InboundPayload.md)\n - [ElasticEmail::Object::InboundRoute](docs/InboundRoute.md)\n - [ElasticEmail::Object::InboundRouteActionType](docs/InboundRouteActionType.md)\n - [ElasticEmail::Object::InboundRouteFilterType](docs/InboundRouteFilterType.md)\n - [ElasticEmail::Object::ListPayload](docs/ListPayload.md)\n - [ElasticEmail::Object::ListUpdatePayload](docs/ListUpdatePayload.md)\n - [ElasticEmail::Object::LogJobStatus](docs/LogJobStatus.md)\n - [ElasticEmail::Object::LogStatusSummary](docs/LogStatusSummary.md)\n - [ElasticEmail::Object::MergeEmailPayload](docs/MergeEmailPayload.md)\n - [ElasticEmail::Object::MessageAttachment](docs/MessageAttachment.md)\n - [ElasticEmail::Object::MessageCategory](docs/MessageCategory.md)\n - [ElasticEmail::Object::MessageCategoryEnum](docs/MessageCategoryEnum.md)\n - [ElasticEmail::Object::NewApiKey](docs/NewApiKey.md)\n - [ElasticEmail::Object::NewSmtpCredentials](docs/NewSmtpCredentials.md)\n - [ElasticEmail::Object::Options](docs/Options.md)\n - [ElasticEmail::Object::RecipientEvent](docs/RecipientEvent.md)\n - [ElasticEmail::Object::Segment](docs/Segment.md)\n - [ElasticEmail::Object::SegmentPayload](docs/SegmentPayload.md)\n - [ElasticEmail::Object::SmtpCredentials](docs/SmtpCredentials.md)\n - [ElasticEmail::Object::SmtpCredentialsPayload](docs/SmtpCredentialsPayload.md)\n - [ElasticEmail::Object::SortOrderItem](docs/SortOrderItem.md)\n - [ElasticEmail::Object::SplitOptimizationType](docs/SplitOptimizationType.md)\n - [ElasticEmail::Object::SplitOptions](docs/SplitOptions.md)\n - [ElasticEmail::Object::SubAccountInfo](docs/SubAccountInfo.md)\n - [ElasticEmail::Object::SubaccountEmailCreditsPayload](docs/SubaccountEmailCreditsPayload.md)\n - [ElasticEmail::Object::SubaccountEmailSettings](docs/SubaccountEmailSettings.md)\n - [ElasticEmail::Object::SubaccountEmailSettingsPayload](docs/SubaccountEmailSettingsPayload.md)\n - [ElasticEmail::Object::SubaccountPayload](docs/SubaccountPayload.md)\n - [ElasticEmail::Object::SubaccountSettingsInfo](docs/SubaccountSettingsInfo.md)\n - [ElasticEmail::Object::SubaccountSettingsInfoPayload](docs/SubaccountSettingsInfoPayload.md)\n - [ElasticEmail::Object::Suppression](docs/Suppression.md)\n - [ElasticEmail::Object::Template](docs/Template.md)\n - [ElasticEmail::Object::TemplatePayload](docs/TemplatePayload.md)\n - [ElasticEmail::Object::TemplateScope](docs/TemplateScope.md)\n - [ElasticEmail::Object::TemplateType](docs/TemplateType.md)\n - [ElasticEmail::Object::TrackingType](docs/TrackingType.md)\n - [ElasticEmail::Object::TrackingValidationStatus](docs/TrackingValidationStatus.md)\n - [ElasticEmail::Object::TransactionalRecipient](docs/TransactionalRecipient.md)\n - [ElasticEmail::Object::Utm](docs/Utm.md)\n - [ElasticEmail::Object::VerificationFileResult](docs/VerificationFileResult.md)\n - [ElasticEmail::Object::VerificationFileResultDetails](docs/VerificationFileResultDetails.md)\n - [ElasticEmail::Object::VerificationStatus](docs/VerificationStatus.md)\n\n\n# DOCUMENTATION FOR AUTHORIZATION\n\nAuthentication schemes defined for the API:\n## apikey\n\n- **Type**: API key\n- **API key parameter name**: X-ElasticEmail-ApiKey\n- **Location**: HTTP header\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felasticemail%2Felasticemail-perl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felasticemail%2Felasticemail-perl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felasticemail%2Felasticemail-perl/lists"}