Moosend_api NPM

moosend_api

MoosendApi - JavaScript client for moosend_api TODO: Add a description This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0
Package version: 1.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 moosend_api --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 moosend_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('moosend_api') 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 MoosendApi = require('moosend_api');

var api = new MoosendApi.CampaignsApi()

var format = "format_example"; // {String} 

var apikey = "apikey_example"; // {String} You may find your API Key or generate a new one in your account settings.

var campaignID = "campaignID_example"; // {String} The ID of the requested AB test campaign


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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
MoosendApi.CampaignsApi	aBTestCampaignSummary	GET /campaigns/{CampaignID}/view_ab_summary.{Format}	AB Test Campaign Summary
MoosendApi.CampaignsApi	activityByLocation	GET /campaigns/{CampaignID}/stats/countries.{Format}	Activity By Location
MoosendApi.CampaignsApi	campaignSummary	GET /campaigns/{CampaignID}/view_summary.{Format}	Campaign Summary
MoosendApi.CampaignsApi	cloningAnExistingCampaign	POST /campaigns/{CampaignID}/clone.{Format}	Cloning An Existing Campaign
MoosendApi.CampaignsApi	creatingADraftCampaign	POST /campaigns/create.{Format}	Creating A Draft Campaign
MoosendApi.CampaignsApi	deletingACampaign	DELETE /campaigns/{CampaignID}/delete.{Format}	Deleting A Campaign
MoosendApi.CampaignsApi	getAllCampaigns	GET /campaigns.{Format}	Get All Campaigns
MoosendApi.CampaignsApi	getCampaignStatisticsWithPagingFiltered	GET /campaigns/{CampaignID}/stats/{Type}.{Format}	Get Campaign Statistics With Paging & Filtered
MoosendApi.CampaignsApi	getCampaignsByPage	GET /campaigns/{Page}.{Format}	Get Campaigns By Page
MoosendApi.CampaignsApi	getCampaignsByPageAndPagesize	GET /campaigns/{Page}/{PageSize}.{Format}	Get Campaigns By Page And Pagesize
MoosendApi.CampaignsApi	gettingAllYourSenders	GET /senders/find_all.{Format}	Getting All Your Senders
MoosendApi.CampaignsApi	gettingCampaignDetails	GET /campaigns/{CampaignID}/view.{Format}	Getting Campaign Details
MoosendApi.CampaignsApi	gettingSenderDetails	GET /senders/find_one.{Format}	Getting Sender Details
MoosendApi.CampaignsApi	linkActivity	GET /campaigns/{CampaignID}/stats/links.{Format}	Link Activity
MoosendApi.CampaignsApi	schedulingACampaign	POST /campaigns/{CampaignID}/schedule.{Format}	Scheduling A Campaign
MoosendApi.CampaignsApi	sendingACampaign	POST /campaigns/{CampaignID}/send.{Format}	Sending a campaign
MoosendApi.CampaignsApi	testingACampaign	POST /campaigns/{CampaignID}/send_test.{Format}	Testing a campaign
MoosendApi.CampaignsApi	unschedulingACampaign	POST /campaigns/{CampaignID}/unschedule.{Format}	Unscheduling a campaign
MoosendApi.CampaignsApi	updatingADraftCampaign	POST /campaigns/{CampaignID}/update.{Format}	Updating A Draft Campaign
MoosendApi.MailingListsApi	creatingACustomField	POST /lists/{MailingListID}/customfields/create.{Format}	Creating a custom field
MoosendApi.MailingListsApi	creatingAMailingList	POST /lists/create.{Format}	Creating a mailing list
MoosendApi.MailingListsApi	deletingAMailingList	DELETE /lists/{MailingListID}/delete.{Format}	Deleting a mailing list
MoosendApi.MailingListsApi	gettingAllActiveMailingLists	GET /lists.{Format}	Getting all active mailing lists
MoosendApi.MailingListsApi	gettingAllActiveMailingListsWithPaging	GET /lists/{Page}/{PageSize}.{Format}	Getting all active mailing lists with paging
MoosendApi.MailingListsApi	gettingMailingListDetails	GET /lists/{MailingListID}/details.{Format}	Getting mailing list details
MoosendApi.MailingListsApi	removingACustomField	DELETE /lists/{MailingListID}/customfields/{CustomFieldID}/delete.{Format}	Removing a custom field
MoosendApi.MailingListsApi	updatingACustomField	POST /lists/{MailingListID}/customfields/{CustomFieldID}/update.{Format}	Updating a custom field
MoosendApi.MailingListsApi	updatingAMailingList	POST /lists/{MailingListID}/update.{Format}	Updating a mailing list
MoosendApi.SegmentsApi	addingCriteriaToSegments	POST /lists/{MailingListID}/segments/{SegmentID}/criteria/add.{Format}	Adding criteria to segments
MoosendApi.SegmentsApi	creatingANewSegment	POST /lists/{MailingListID}/segments/create.{Format}	Creating a new segment
MoosendApi.SegmentsApi	deletingASegment	DELETE /lists/{MailingListID}/segments/{SegmentID}/delete.{Format}	Deleting A Segment
MoosendApi.SegmentsApi	gettingSegmentDetails	GET /lists/{MailingListID}/segments/{SegmentID}/details.{Format}	Getting segment details
MoosendApi.SegmentsApi	gettingSegmentSubscribers	GET /lists/{MailingListID}/segments/{SegmentID}/members.{Format}	Getting segment subscribers
MoosendApi.SegmentsApi	gettingSegments	GET /lists/{MailingListID}/segments.{Format}	Getting segments
MoosendApi.SegmentsApi	updatingASegment	POST /lists/{MailingListID}/segments/{SegmentID}/update.{Format}	Updating a segment
MoosendApi.SegmentsApi	updatingSegmentCriteria	POST /lists/{MailingListID}/segments/{SegmentID}/criteria/{CriteriaID}/update.{Format}	Updating segment criteria
MoosendApi.SubscribersApi	addingMultipleSubscribers	POST /subscribers/{MailingListID}/subscribe_many.{Format}	Adding multiple subscribers
MoosendApi.SubscribersApi	addingSubscribers	POST /subscribers/{MailingListID}/subscribe.{Format}	Adding subscribers
MoosendApi.SubscribersApi	getSubscriberByEmailAddress	GET /subscribers/{MailingListID}/view.{Format}	Get subscriber by email address
MoosendApi.SubscribersApi	getSubscriberById	GET /subscribers/{MailingListID}/find/{SubscriberID}.{Format}	Get subscriber by id
MoosendApi.SubscribersApi	gettingSubscribers	GET /lists/{MailingListID}/subscribers/{Status}.{Format}	Getting subscribers
MoosendApi.SubscribersApi	removingASubscriber	POST /subscribers/{MailingListID}/remove.{Format}	Removing a subscriber
MoosendApi.SubscribersApi	removingMultipleSubscribers	POST /subscribers/{MailingListID}/remove_many.{Format}	Removing multiple subscribers
MoosendApi.SubscribersApi	unsubscribingSubscribersFromAccount	POST /subscribers/unsubscribe.{Format}	Unsubscribing subscribers from account
MoosendApi.SubscribersApi	unsubscribingSubscribersFromMailingList	POST /subscribers/{MailingListID}/unsubscribe.{Format}	Unsubscribing subscribers from mailing list
MoosendApi.SubscribersApi	unsubscribingSubscribersFromMailingListAndASpecifiedCampaign	POST /subscribers/{MailingListID}/{CampaignID}/unsubscribe.{Format}	Unsubscribing subscribers from mailing list and a specified campaign
MoosendApi.SubscribersApi	updatingASubscriber	POST /subscribers/{MailingListID}/update/{SubscriberID}.{Format}	Updating a subscriber

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

@infinitebrahmanuniverse/nolb-moo @everything-registry/sub-chunk-2203 @zalastax/nolb-moo

1.0.0

7 years ago