# moosend_api MoosendApi - JavaScript client for moosend_api TODO: Add a description This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0 - Package version: 1.0 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your moosend_api from, and run: ```shell npm link /path/to/ ``` 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: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/CampaignsApi.md#aBTestCampaignSummary) | **GET** /campaigns/{CampaignID}/view_ab_summary.{Format} | AB Test Campaign Summary *MoosendApi.CampaignsApi* | [**activityByLocation**](docs/CampaignsApi.md#activityByLocation) | **GET** /campaigns/{CampaignID}/stats/countries.{Format} | Activity By Location *MoosendApi.CampaignsApi* | [**campaignSummary**](docs/CampaignsApi.md#campaignSummary) | **GET** /campaigns/{CampaignID}/view_summary.{Format} | Campaign Summary *MoosendApi.CampaignsApi* | [**cloningAnExistingCampaign**](docs/CampaignsApi.md#cloningAnExistingCampaign) | **POST** /campaigns/{CampaignID}/clone.{Format} | Cloning An Existing Campaign *MoosendApi.CampaignsApi* | [**creatingADraftCampaign**](docs/CampaignsApi.md#creatingADraftCampaign) | **POST** /campaigns/create.{Format} | Creating A Draft Campaign *MoosendApi.CampaignsApi* | [**deletingACampaign**](docs/CampaignsApi.md#deletingACampaign) | **DELETE** /campaigns/{CampaignID}/delete.{Format} | Deleting A Campaign *MoosendApi.CampaignsApi* | [**getAllCampaigns**](docs/CampaignsApi.md#getAllCampaigns) | **GET** /campaigns.{Format} | Get All Campaigns *MoosendApi.CampaignsApi* | [**getCampaignStatisticsWithPagingFiltered**](docs/CampaignsApi.md#getCampaignStatisticsWithPagingFiltered) | **GET** /campaigns/{CampaignID}/stats/{Type}.{Format} | Get Campaign Statistics With Paging & Filtered *MoosendApi.CampaignsApi* | [**getCampaignsByPage**](docs/CampaignsApi.md#getCampaignsByPage) | **GET** /campaigns/{Page}.{Format} | Get Campaigns By Page *MoosendApi.CampaignsApi* | [**getCampaignsByPageAndPagesize**](docs/CampaignsApi.md#getCampaignsByPageAndPagesize) | **GET** /campaigns/{Page}/{PageSize}.{Format} | Get Campaigns By Page And Pagesize *MoosendApi.CampaignsApi* | [**gettingAllYourSenders**](docs/CampaignsApi.md#gettingAllYourSenders) | **GET** /senders/find_all.{Format} | Getting All Your Senders *MoosendApi.CampaignsApi* | [**gettingCampaignDetails**](docs/CampaignsApi.md#gettingCampaignDetails) | **GET** /campaigns/{CampaignID}/view.{Format} | Getting Campaign Details *MoosendApi.CampaignsApi* | [**gettingSenderDetails**](docs/CampaignsApi.md#gettingSenderDetails) | **GET** /senders/find_one.{Format} | Getting Sender Details *MoosendApi.CampaignsApi* | [**linkActivity**](docs/CampaignsApi.md#linkActivity) | **GET** /campaigns/{CampaignID}/stats/links.{Format} | Link Activity *MoosendApi.CampaignsApi* | [**schedulingACampaign**](docs/CampaignsApi.md#schedulingACampaign) | **POST** /campaigns/{CampaignID}/schedule.{Format} | Scheduling A Campaign *MoosendApi.CampaignsApi* | [**sendingACampaign**](docs/CampaignsApi.md#sendingACampaign) | **POST** /campaigns/{CampaignID}/send.{Format} | Sending a campaign *MoosendApi.CampaignsApi* | [**testingACampaign**](docs/CampaignsApi.md#testingACampaign) | **POST** /campaigns/{CampaignID}/send_test.{Format} | Testing a campaign *MoosendApi.CampaignsApi* | [**unschedulingACampaign**](docs/CampaignsApi.md#unschedulingACampaign) | **POST** /campaigns/{CampaignID}/unschedule.{Format} | Unscheduling a campaign *MoosendApi.CampaignsApi* | [**updatingADraftCampaign**](docs/CampaignsApi.md#updatingADraftCampaign) | **POST** /campaigns/{CampaignID}/update.{Format} | Updating A Draft Campaign *MoosendApi.MailingListsApi* | [**creatingACustomField**](docs/MailingListsApi.md#creatingACustomField) | **POST** /lists/{MailingListID}/customfields/create.{Format} | Creating a custom field *MoosendApi.MailingListsApi* | [**creatingAMailingList**](docs/MailingListsApi.md#creatingAMailingList) | **POST** /lists/create.{Format} | Creating a mailing list *MoosendApi.MailingListsApi* | [**deletingAMailingList**](docs/MailingListsApi.md#deletingAMailingList) | **DELETE** /lists/{MailingListID}/delete.{Format} | Deleting a mailing list *MoosendApi.MailingListsApi* | [**gettingAllActiveMailingLists**](docs/MailingListsApi.md#gettingAllActiveMailingLists) | **GET** /lists.{Format} | Getting all active mailing lists *MoosendApi.MailingListsApi* | [**gettingAllActiveMailingListsWithPaging**](docs/MailingListsApi.md#gettingAllActiveMailingListsWithPaging) | **GET** /lists/{Page}/{PageSize}.{Format} | Getting all active mailing lists with paging *MoosendApi.MailingListsApi* | [**gettingMailingListDetails**](docs/MailingListsApi.md#gettingMailingListDetails) | **GET** /lists/{MailingListID}/details.{Format} | Getting mailing list details *MoosendApi.MailingListsApi* | [**removingACustomField**](docs/MailingListsApi.md#removingACustomField) | **DELETE** /lists/{MailingListID}/customfields/{CustomFieldID}/delete.{Format} | Removing a custom field *MoosendApi.MailingListsApi* | [**updatingACustomField**](docs/MailingListsApi.md#updatingACustomField) | **POST** /lists/{MailingListID}/customfields/{CustomFieldID}/update.{Format} | Updating a custom field *MoosendApi.MailingListsApi* | [**updatingAMailingList**](docs/MailingListsApi.md#updatingAMailingList) | **POST** /lists/{MailingListID}/update.{Format} | Updating a mailing list *MoosendApi.SegmentsApi* | [**addingCriteriaToSegments**](docs/SegmentsApi.md#addingCriteriaToSegments) | **POST** /lists/{MailingListID}/segments/{SegmentID}/criteria/add.{Format} | Adding criteria to segments *MoosendApi.SegmentsApi* | [**creatingANewSegment**](docs/SegmentsApi.md#creatingANewSegment) | **POST** /lists/{MailingListID}/segments/create.{Format} | Creating a new segment *MoosendApi.SegmentsApi* | [**deletingASegment**](docs/SegmentsApi.md#deletingASegment) | **DELETE** /lists/{MailingListID}/segments/{SegmentID}/delete.{Format} | Deleting A Segment *MoosendApi.SegmentsApi* | [**gettingSegmentDetails**](docs/SegmentsApi.md#gettingSegmentDetails) | **GET** /lists/{MailingListID}/segments/{SegmentID}/details.{Format} | Getting segment details *MoosendApi.SegmentsApi* | [**gettingSegmentSubscribers**](docs/SegmentsApi.md#gettingSegmentSubscribers) | **GET** /lists/{MailingListID}/segments/{SegmentID}/members.{Format} | Getting segment subscribers *MoosendApi.SegmentsApi* | [**gettingSegments**](docs/SegmentsApi.md#gettingSegments) | **GET** /lists/{MailingListID}/segments.{Format} | Getting segments *MoosendApi.SegmentsApi* | [**updatingASegment**](docs/SegmentsApi.md#updatingASegment) | **POST** /lists/{MailingListID}/segments/{SegmentID}/update.{Format} | Updating a segment *MoosendApi.SegmentsApi* | [**updatingSegmentCriteria**](docs/SegmentsApi.md#updatingSegmentCriteria) | **POST** /lists/{MailingListID}/segments/{SegmentID}/criteria/{CriteriaID}/update.{Format} | Updating segment criteria *MoosendApi.SubscribersApi* | [**addingMultipleSubscribers**](docs/SubscribersApi.md#addingMultipleSubscribers) | **POST** /subscribers/{MailingListID}/subscribe_many.{Format} | Adding multiple subscribers *MoosendApi.SubscribersApi* | [**addingSubscribers**](docs/SubscribersApi.md#addingSubscribers) | **POST** /subscribers/{MailingListID}/subscribe.{Format} | Adding subscribers *MoosendApi.SubscribersApi* | [**getSubscriberByEmailAddress**](docs/SubscribersApi.md#getSubscriberByEmailAddress) | **GET** /subscribers/{MailingListID}/view.{Format} | Get subscriber by email address *MoosendApi.SubscribersApi* | [**getSubscriberById**](docs/SubscribersApi.md#getSubscriberById) | **GET** /subscribers/{MailingListID}/find/{SubscriberID}.{Format} | Get subscriber by id *MoosendApi.SubscribersApi* | [**gettingSubscribers**](docs/SubscribersApi.md#gettingSubscribers) | **GET** /lists/{MailingListID}/subscribers/{Status}.{Format} | Getting subscribers *MoosendApi.SubscribersApi* | [**removingASubscriber**](docs/SubscribersApi.md#removingASubscriber) | **POST** /subscribers/{MailingListID}/remove.{Format} | Removing a subscriber *MoosendApi.SubscribersApi* | [**removingMultipleSubscribers**](docs/SubscribersApi.md#removingMultipleSubscribers) | **POST** /subscribers/{MailingListID}/remove_many.{Format} | Removing multiple subscribers *MoosendApi.SubscribersApi* | [**unsubscribingSubscribersFromAccount**](docs/SubscribersApi.md#unsubscribingSubscribersFromAccount) | **POST** /subscribers/unsubscribe.{Format} | Unsubscribing subscribers from account *MoosendApi.SubscribersApi* | [**unsubscribingSubscribersFromMailingList**](docs/SubscribersApi.md#unsubscribingSubscribersFromMailingList) | **POST** /subscribers/{MailingListID}/unsubscribe.{Format} | Unsubscribing subscribers from mailing list *MoosendApi.SubscribersApi* | [**unsubscribingSubscribersFromMailingListAndASpecifiedCampaign**](docs/SubscribersApi.md#unsubscribingSubscribersFromMailingListAndASpecifiedCampaign) | **POST** /subscribers/{MailingListID}/{CampaignID}/unsubscribe.{Format} | Unsubscribing subscribers from mailing list and a specified campaign *MoosendApi.SubscribersApi* | [**updatingASubscriber**](docs/SubscribersApi.md#updatingASubscriber) | **POST** /subscribers/{MailingListID}/update/{SubscriberID}.{Format} | Updating a subscriber ## Documentation for Models - [MoosendApi.A](docs/A.md) - [MoosendApi.ABCampaignData](docs/ABCampaignData.md) - [MoosendApi.AbTestCampaignSummaryResponse](docs/AbTestCampaignSummaryResponse.md) - [MoosendApi.ActivityByLocationResponse](docs/ActivityByLocationResponse.md) - [MoosendApi.AddingCriteriaToSegmentsRequest](docs/AddingCriteriaToSegmentsRequest.md) - [MoosendApi.AddingCriteriaToSegmentsResponse](docs/AddingCriteriaToSegmentsResponse.md) - [MoosendApi.AddingMultipleSubscribersRequest](docs/AddingMultipleSubscribersRequest.md) - [MoosendApi.AddingMultipleSubscribersResponse](docs/AddingMultipleSubscribersResponse.md) - [MoosendApi.AddingSubscribersRequest](docs/AddingSubscribersRequest.md) - [MoosendApi.AddingSubscribersResponse](docs/AddingSubscribersResponse.md) - [MoosendApi.Analytic](docs/Analytic.md) - [MoosendApi.B](docs/B.md) - [MoosendApi.Campaign](docs/Campaign.md) - [MoosendApi.CampaignSummaryResponse](docs/CampaignSummaryResponse.md) - [MoosendApi.CloningAnExistingCampaignResponse](docs/CloningAnExistingCampaignResponse.md) - [MoosendApi.Context](docs/Context.md) - [MoosendApi.Context110](docs/Context110.md) - [MoosendApi.Context118](docs/Context118.md) - [MoosendApi.Context132](docs/Context132.md) - [MoosendApi.Context140](docs/Context140.md) - [MoosendApi.Context145](docs/Context145.md) - [MoosendApi.Context148](docs/Context148.md) - [MoosendApi.Context17](docs/Context17.md) - [MoosendApi.Context32](docs/Context32.md) - [MoosendApi.Context37](docs/Context37.md) - [MoosendApi.Context52](docs/Context52.md) - [MoosendApi.Context64](docs/Context64.md) - [MoosendApi.Context66](docs/Context66.md) - [MoosendApi.Context72](docs/Context72.md) - [MoosendApi.Context84](docs/Context84.md) - [MoosendApi.Context89](docs/Context89.md) - [MoosendApi.Context93](docs/Context93.md) - [MoosendApi.CreatingACustomFieldRequest](docs/CreatingACustomFieldRequest.md) - [MoosendApi.CreatingACustomFieldResponse](docs/CreatingACustomFieldResponse.md) - [MoosendApi.CreatingADraftCampaignRequest](docs/CreatingADraftCampaignRequest.md) - [MoosendApi.CreatingADraftCampaignResponse](docs/CreatingADraftCampaignResponse.md) - [MoosendApi.CreatingAMailingListRequest](docs/CreatingAMailingListRequest.md) - [MoosendApi.CreatingAMailingListResponse](docs/CreatingAMailingListResponse.md) - [MoosendApi.CreatingANewSegmentRequest](docs/CreatingANewSegmentRequest.md) - [MoosendApi.CreatingANewSegmentResponse](docs/CreatingANewSegmentResponse.md) - [MoosendApi.Criterion](docs/Criterion.md) - [MoosendApi.CustomField](docs/CustomField.md) - [MoosendApi.CustomField53](docs/CustomField53.md) - [MoosendApi.CustomFieldsDefinition](docs/CustomFieldsDefinition.md) - [MoosendApi.DeletingACampaignResponse](docs/DeletingACampaignResponse.md) - [MoosendApi.DeletingAMailingListResponse](docs/DeletingAMailingListResponse.md) - [MoosendApi.DeletingASegmentResponse](docs/DeletingASegmentResponse.md) - [MoosendApi.Format](docs/Format.md) - [MoosendApi.GetAllCampaignsResponse](docs/GetAllCampaignsResponse.md) - [MoosendApi.GetCampaignStatisticsResponse](docs/GetCampaignStatisticsResponse.md) - [MoosendApi.GetCampaignStatisticsWithPagingFilteredResponse](docs/GetCampaignStatisticsWithPagingFilteredResponse.md) - [MoosendApi.GetCampaignsByPageAndPagesizeResponse](docs/GetCampaignsByPageAndPagesizeResponse.md) - [MoosendApi.GetCampaignsByPageResponse](docs/GetCampaignsByPageResponse.md) - [MoosendApi.GetSubscriberByEmailAddressResponse](docs/GetSubscriberByEmailAddressResponse.md) - [MoosendApi.GetSubscriberByIdResponse](docs/GetSubscriberByIdResponse.md) - [MoosendApi.GettingAllActiveMailingListsResponse](docs/GettingAllActiveMailingListsResponse.md) - [MoosendApi.GettingAllActiveMailingListsWithPagingResponse](docs/GettingAllActiveMailingListsWithPagingResponse.md) - [MoosendApi.GettingAllYourSendersResponse](docs/GettingAllYourSendersResponse.md) - [MoosendApi.GettingCampaignDetailsResponse](docs/GettingCampaignDetailsResponse.md) - [MoosendApi.GettingMailingListDetailsResponse](docs/GettingMailingListDetailsResponse.md) - [MoosendApi.GettingSegmentDetailsResponse](docs/GettingSegmentDetailsResponse.md) - [MoosendApi.GettingSegmentSubscribersResponse](docs/GettingSegmentSubscribersResponse.md) - [MoosendApi.GettingSegmentsResponse](docs/GettingSegmentsResponse.md) - [MoosendApi.GettingSenderDetailsResponse](docs/GettingSenderDetailsResponse.md) - [MoosendApi.GettingSubscribersResponse](docs/GettingSubscribersResponse.md) - [MoosendApi.ImportOperation](docs/ImportOperation.md) - [MoosendApi.ImportOperation19](docs/ImportOperation19.md) - [MoosendApi.LinkActivityResponse](docs/LinkActivityResponse.md) - [MoosendApi.MailingList](docs/MailingList.md) - [MoosendApi.MailingList68](docs/MailingList68.md) - [MoosendApi.MailingList69](docs/MailingList69.md) - [MoosendApi.MailingList85](docs/MailingList85.md) - [MoosendApi.MailingLists](docs/MailingLists.md) - [MoosendApi.MailingLists119](docs/MailingLists119.md) - [MoosendApi.MailingLists134](docs/MailingLists134.md) - [MoosendApi.Paging](docs/Paging.md) - [MoosendApi.Paging76](docs/Paging76.md) - [MoosendApi.RemovingACustomFieldResponse](docs/RemovingACustomFieldResponse.md) - [MoosendApi.RemovingASubscriberRequest](docs/RemovingASubscriberRequest.md) - [MoosendApi.RemovingASubscriberResponse](docs/RemovingASubscriberResponse.md) - [MoosendApi.RemovingMultipleSubscribersRequest](docs/RemovingMultipleSubscribersRequest.md) - [MoosendApi.RemovingMultipleSubscribersResponse](docs/RemovingMultipleSubscribersResponse.md) - [MoosendApi.ReplyToEmail](docs/ReplyToEmail.md) - [MoosendApi.SchedulingACampaignRequest](docs/SchedulingACampaignRequest.md) - [MoosendApi.SchedulingACampaignResponse](docs/SchedulingACampaignResponse.md) - [MoosendApi.Segment](docs/Segment.md) - [MoosendApi.Sender](docs/Sender.md) - [MoosendApi.SendingACampaignResponse](docs/SendingACampaignResponse.md) - [MoosendApi.ShortBy](docs/ShortBy.md) - [MoosendApi.SortMethod](docs/SortMethod.md) - [MoosendApi.Status](docs/Status.md) - [MoosendApi.Subscriber](docs/Subscriber.md) - [MoosendApi.Subscribers](docs/Subscribers.md) - [MoosendApi.Subscribers150](docs/Subscribers150.md) - [MoosendApi.TestingACampaignRequest](docs/TestingACampaignRequest.md) - [MoosendApi.TestingACampaignResponse](docs/TestingACampaignResponse.md) - [MoosendApi.Type](docs/Type.md) - [MoosendApi.UnschedulingACampaignResponse](docs/UnschedulingACampaignResponse.md) - [MoosendApi.UnsubscribingSubscribersFromAccountRequest](docs/UnsubscribingSubscribersFromAccountRequest.md) - [MoosendApi.UnsubscribingSubscribersFromAccountResponse](docs/UnsubscribingSubscribersFromAccountResponse.md) - [MoosendApi.UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest](docs/UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest.md) - [MoosendApi.UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse](docs/UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse.md) - [MoosendApi.UnsubscribingSubscribersFromMailingListRequest](docs/UnsubscribingSubscribersFromMailingListRequest.md) - [MoosendApi.UnsubscribingSubscribersFromMailingListResponse](docs/UnsubscribingSubscribersFromMailingListResponse.md) - [MoosendApi.UpdatingACustomFieldRequest](docs/UpdatingACustomFieldRequest.md) - [MoosendApi.UpdatingACustomFieldResponse](docs/UpdatingACustomFieldResponse.md) - [MoosendApi.UpdatingADraftCampaignRequest](docs/UpdatingADraftCampaignRequest.md) - [MoosendApi.UpdatingADraftCampaignResponse](docs/UpdatingADraftCampaignResponse.md) - [MoosendApi.UpdatingAMailingListRequest](docs/UpdatingAMailingListRequest.md) - [MoosendApi.UpdatingAMailingListResponse](docs/UpdatingAMailingListResponse.md) - [MoosendApi.UpdatingASegmentRequest](docs/UpdatingASegmentRequest.md) - [MoosendApi.UpdatingASegmentResponse](docs/UpdatingASegmentResponse.md) - [MoosendApi.UpdatingASubscriberRequest](docs/UpdatingASubscriberRequest.md) - [MoosendApi.UpdatingASubscriberResponse](docs/UpdatingASubscriberResponse.md) - [MoosendApi.UpdatingSegmentCriteriaRequest](docs/UpdatingSegmentCriteriaRequest.md) - [MoosendApi.UpdatingSegmentCriteriaResponse](docs/UpdatingSegmentCriteriaResponse.md) - [MoosendApi.WithStatistics](docs/WithStatistics.md) ## Documentation for Authorization All endpoints do not require authorization.