elastic_email_api__beta_test v2.42.0

elastic_email_api__beta

ElasticEmailApiBeta - JavaScript client for elastic_email_api__beta Send your e-mails with ElasticEmail API This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.42.0
• Package version: 2.42.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install elastic_email_api__beta --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your elastic_email_api__beta from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('elastic_email_api__beta') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ElasticEmailApiBeta = require('elastic_email_api__beta');

var defaultClient = ElasticEmailApiBeta.ApiClient.instance;

// Configure API key authorization: apikey
var apikey = defaultClient.authentications['apikey'];
apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apikey.apiKeyPrefix['X-ElasticEmail-ApiKey'] = "Token"

var api = new ElasticEmailApiBeta.AccountsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountsGet(callback);

Documentation for API Endpoints

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

Documentation for Models

• ElasticEmailApiBeta.AccessToken
• ElasticEmailApiBeta.Account
• ElasticEmailApiBeta.AccountCore
• ElasticEmailApiBeta.AccountOverview
• ElasticEmailApiBeta.AdvancedOptions
• ElasticEmailApiBeta.Automated
• ElasticEmailApiBeta.Body
• ElasticEmailApiBeta.BodyPart
• ElasticEmailApiBeta.BouncedCategorySummary
• ElasticEmailApiBeta.Campaign
• ElasticEmailApiBeta.CampaignBody
• ElasticEmailApiBeta.CampaignListPayload
• ElasticEmailApiBeta.CampaignOptions
• ElasticEmailApiBeta.CampaignRecipient
• ElasticEmailApiBeta.CampaignTemplate
• ElasticEmailApiBeta.Channel
• ElasticEmailApiBeta.Contact
• ElasticEmailApiBeta.ContactHistory
• ElasticEmailApiBeta.ContactPayload
• ElasticEmailApiBeta.ContactStats
• ElasticEmailApiBeta.ContactUnsubscribeReasonCounts
• ElasticEmailApiBeta.ContactUpdatePayload
• ElasticEmailApiBeta.DailyLogStatusSummary
• ElasticEmailApiBeta.DomainDetail
• ElasticEmailApiBeta.DomainPayload
• ElasticEmailApiBeta.Email
• ElasticEmailApiBeta.EmailCredits
• ElasticEmailApiBeta.EmailJobFailedStatus
• ElasticEmailApiBeta.EmailJobStatus
• ElasticEmailApiBeta.EmailMergeMessage
• ElasticEmailApiBeta.EmailSend
• ElasticEmailApiBeta.EmailStatus
• ElasticEmailApiBeta.EmailTransactionalMessage
• ElasticEmailApiBeta.EmailView
• ElasticEmailApiBeta.EmailsPayload
• ElasticEmailApiBeta.EncodingSettings
• ElasticEmailApiBeta.EventLog
• ElasticEmailApiBeta.ExportLink
• ElasticEmailApiBeta.File
• ElasticEmailApiBeta.InboundOptions
• ElasticEmailApiBeta.List
• ElasticEmailApiBeta.ListPayload
• ElasticEmailApiBeta.ListUpdatePayload
• ElasticEmailApiBeta.Log
• ElasticEmailApiBeta.LogStatusSummary
• ElasticEmailApiBeta.LogSummary
• ElasticEmailApiBeta.LoginPayload
• ElasticEmailApiBeta.LoginResponse
• ElasticEmailApiBeta.MergeRecipient
• ElasticEmailApiBeta.MessageAttachment
• ElasticEmailApiBeta.ModelExport
• ElasticEmailApiBeta.MoveToListPayload
• ElasticEmailApiBeta.NameTypeCampaign
• ElasticEmailApiBeta.Options
• ElasticEmailApiBeta.Payment
• ElasticEmailApiBeta.Profile
• ElasticEmailApiBeta.QuickAddPayload
• ElasticEmailApiBeta.RandomListPayload
• ElasticEmailApiBeta.Recipient
• ElasticEmailApiBeta.RecipientEvent
• ElasticEmailApiBeta.Referral
• ElasticEmailApiBeta.ReputationDetail
• ElasticEmailApiBeta.ReputationHistory
• ElasticEmailApiBeta.ReputationImpact
• ElasticEmailApiBeta.SMS
• ElasticEmailApiBeta.Segment
• ElasticEmailApiBeta.SegmentHistory
• ElasticEmailApiBeta.SegmentPayload
• ElasticEmailApiBeta.Sender
• ElasticEmailApiBeta.SpamCheck
• ElasticEmailApiBeta.SpamRule
• ElasticEmailApiBeta.SplitCampaign
• ElasticEmailApiBeta.SplitOptions
• ElasticEmailApiBeta.SubAccount
• ElasticEmailApiBeta.SubAccountSettings
• ElasticEmailApiBeta.SubaccountCreditsPayload
• ElasticEmailApiBeta.SubaccountPayload
• ElasticEmailApiBeta.Template
• ElasticEmailApiBeta.TrackingOptions
• ElasticEmailApiBeta.TransactionalRecipient
• ElasticEmailApiBeta.TriggerData
• ElasticEmailApiBeta.TriggerOptions
• ElasticEmailApiBeta.UsageData
• ElasticEmailApiBeta.UtmTracking
• ElasticEmailApiBeta.Webhook
• ElasticEmailApiBeta.WebhookPayload

Documentation for Authorization

apikey

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