listmonk

Listmonk - JavaScript client for listmonk The API collection for listmonk This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.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 listmonk --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your listmonk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 Listmonk = require('listmonk');


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

Documentation for API Endpoints

All URIs are relative to http://localhost:9000/api

Class	Method	HTTP request	Description
Listmonk.AdminApi	adminReloadPost	POST /admin/reload
Listmonk.BouncesApi	bouncesDelete	DELETE /bounces
Listmonk.BouncesApi	bouncesGet	GET /bounces
Listmonk.BouncesApi	bouncesIdDelete	DELETE /bounces/{id}
Listmonk.BouncesApi	bouncesIdGet	GET /bounces/{id}
Listmonk.CampaignsApi	campaignsCampaignIdContentPost	POST /campaigns/{campaign_id}/content
Listmonk.CampaignsApi	campaignsCampaignIdDelete	DELETE /campaigns/{campaign_id}
Listmonk.CampaignsApi	campaignsCampaignIdGet	GET /campaigns/{campaign_id}
Listmonk.CampaignsApi	campaignsCampaignIdPreviewGet	GET /campaigns/{campaign_id}/preview
Listmonk.CampaignsApi	campaignsCampaignIdPut	PUT /campaigns/{campaign_id}
Listmonk.CampaignsApi	campaignsCampaignIdStatusPut	PUT /campaigns/{campaign_id}/status
Listmonk.CampaignsApi	campaignsCampaignIdTestPost	POST /campaigns/{campaign_id}/test
Listmonk.CampaignsApi	campaignsCampaignIdTextGet	GET /campaigns/{campaign_id}/text
Listmonk.CampaignsApi	campaignsGet	GET /campaigns
Listmonk.CampaignsApi	campaignsPost	POST /campaigns
Listmonk.CampaignsApi	campaignsRunningStatsGet	GET /campaigns/running/stats
Listmonk.ImportApi	importSubscribersDelete	DELETE /import/subscribers
Listmonk.ImportApi	importSubscribersGet	GET /import/subscribers
Listmonk.ImportApi	importSubscribersLogsGet	GET /import/subscribers/logs
Listmonk.ImportApi	importSubscribersPost	POST /import/subscribers
Listmonk.ListsApi	listsGet	GET /lists
Listmonk.ListsApi	listsListIdDelete	DELETE /lists/{list_id}
Listmonk.ListsApi	listsListIdGet	GET /lists/{list_id}
Listmonk.ListsApi	listsListIdPut	PUT /lists/{list_id}
Listmonk.ListsApi	listsPost	POST /lists
Listmonk.LogsApi	logsGet	GET /logs
Listmonk.MaintenanceApi	maintenanceAnalyticsTypeDelete	DELETE /maintenance/analytics/{type}
Listmonk.MaintenanceApi	maintenanceSubscribersTypeDelete	DELETE /maintenance/subscribers/{type}
Listmonk.MaintenanceApi	maintenanceSubscriptionsUnconfirmedDelete	DELETE /maintenance/subscriptions/unconfirmed
Listmonk.MediaApi	mediaGet	GET /media
Listmonk.MediaApi	mediaMediaIdDelete	DELETE /media/{media_id}
Listmonk.MediaApi	mediaMediaIdGet	GET /media/{media_id}
Listmonk.MediaApi	mediaPost	POST /media
Listmonk.MiscellaneousApi	configGet	GET /config
Listmonk.MiscellaneousApi	dashboardChartsGet	GET /dashboard/charts
Listmonk.MiscellaneousApi	dashboardCountsGet	GET /dashboard/counts
Listmonk.MiscellaneousApi	healthGet	GET /health
Listmonk.MiscellaneousApi	langLangGet	GET /lang/{lang}
Listmonk.PublicApi	publicListsGet	GET /public/lists
Listmonk.PublicApi	publicSubscriptionPost	POST /public/subscription
Listmonk.SettingsApi	settingsGet	GET /settings
Listmonk.SettingsApi	settingsPut	PUT /settings
Listmonk.SettingsApi	settingsSmtpTestPost	POST /settings/smtp/test
Listmonk.SubscribersApi	subscribersGet	GET /subscribers
Listmonk.SubscribersApi	subscribersIdBlocklistPut	PUT /subscribers/{id}/blocklist
Listmonk.SubscribersApi	subscribersIdBouncesDelete	DELETE /subscribers/{id}/bounces
Listmonk.SubscribersApi	subscribersIdBouncesGet	GET /subscribers/{id}/bounces
Listmonk.SubscribersApi	subscribersIdDelete	DELETE /subscribers/{id}
Listmonk.SubscribersApi	subscribersIdExportGet	GET /subscribers/{id}/export
Listmonk.SubscribersApi	subscribersIdOptinPost	POST /subscribers/{id}/optin
Listmonk.SubscribersApi	subscribersListsPut	PUT /subscribers/lists
Listmonk.SubscribersApi	subscribersPost	POST /subscribers
Listmonk.SubscribersApi	subscribersQueryBlocklistPut	PUT /subscribers/query/blocklist
Listmonk.SubscribersApi	subscribersQueryDeletePost	POST /subscribers/query/delete
Listmonk.SubscribersApi	subscribersQueryListsPut	PUT /subscribers/query/lists
Listmonk.SubscribersApi	subscribersSubscriberIdGet	GET /subscribers/{subscriberId}
Listmonk.TemplatesApi	templatesGet	GET /templates
Listmonk.TemplatesApi	templatesTemplateIdDefaultPut	PUT /templates/{template_id}/default
Listmonk.TemplatesApi	templatesTemplateIdDelete	DELETE /templates/{template_id}
Listmonk.TemplatesApi	templatesTemplateIdGet	GET /templates/{template_id}
Listmonk.TemplatesApi	templatesTemplateIdPreviewGet	GET /templates/{template_id}/preview
Listmonk.TransactionalApi	transactionalPost	POST /transactional

Documentation for Models

• Listmonk.Bounce
• Listmonk.BounceData
• Listmonk.BounceDataResultsInner
• Listmonk.BounceDataResultsInnerCampaign
• Listmonk.BouncesGet200Response
• Listmonk.BouncesGet200ResponseData
• Listmonk.Campaign
• Listmonk.CampaignData
• Listmonk.CampaignRegistrationInfo
• Listmonk.CampaignUpdate
• Listmonk.CampaignsCampaignIdStatusPutRequest
• Listmonk.CampaignsGet200Response
• Listmonk.CampaignsGet200ResponseData
• Listmonk.DashboardChartsGet200Response
• Listmonk.DashboardChartsGet200ResponseData
• Listmonk.DashboardChartsGet200ResponseDataLinkClicksInner
• Listmonk.DashboardCount
• Listmonk.DashboardCountData
• Listmonk.DashboardCountDataCampaigns
• Listmonk.DashboardCountDataCampaignsByStatus
• Listmonk.DashboardCountDataLists
• Listmonk.DashboardCountDataSubscribers
• Listmonk.HealthGet200Response
• Listmonk.ImportStatus
• Listmonk.ImportStatusData
• Listmonk.ImportSubscribersLogsGet200Response
• Listmonk.ImportSubscribersPostRequest
• Listmonk.LanguagePack
• Listmonk.LanguagePackData
• Listmonk.List
• Listmonk.ListRegistrationInfo
• Listmonk.ListsGet200Response
• Listmonk.ListsGet200ResponseData
• Listmonk.ListsListIdPutRequest
• Listmonk.LogsGet200Response
• Listmonk.MailBoxBounces
• Listmonk.MaintenanceSubscribersTypeDelete200Response
• Listmonk.MaintenanceSubscribersTypeDelete200ResponseData
• Listmonk.MediaFileObject
• Listmonk.MediaGet200Response
• Listmonk.NewCampaign
• Listmonk.NewCampaignData
• Listmonk.PublicListsGet200ResponseInner
• Listmonk.PublicSubscriptionPost200Response
• Listmonk.SMTPSettings
• Listmonk.SMTPTest
• Listmonk.ServerConfig
• Listmonk.ServerConfigData
• Listmonk.ServerConfigDataLangsInner
• Listmonk.Settings
• Listmonk.SettingsData
• Listmonk.Subscriber
• Listmonk.SubscriberData
• Listmonk.SubscriberListsInner
• Listmonk.SubscriberProfile
• Listmonk.SubscriberProfileAttribs
• Listmonk.SubscriberRegistrationInfo
• Listmonk.SubscriberRegistrationInfoAttribs
• Listmonk.SubscriberRegistrationInfoAttribsStack
• Listmonk.SubscribersGet200Response
• Listmonk.SubscribersGet200ResponseData
• Listmonk.SubscribersIdBouncesGet200Response
• Listmonk.SubscribersListsPutRequest
• Listmonk.Subscriptions
• Listmonk.Template
• Listmonk.TemplatesGet200Response
• Listmonk.TransactionalMessage

Documentation for Authorization

All endpoints do not require authorization.