1.0.0 • Published 1 year ago

listmonk-nodejs-api v1.0.0

Weekly downloads
-
License
AGPL-3.0 license
Repository
-
Last release
1 year ago

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

ClassMethodHTTP requestDescription
Listmonk.AdminApiadminReloadPostPOST /admin/reload
Listmonk.BouncesApibouncesDeleteDELETE /bounces
Listmonk.BouncesApibouncesGetGET /bounces
Listmonk.BouncesApibouncesIdDeleteDELETE /bounces/{id}
Listmonk.BouncesApibouncesIdGetGET /bounces/{id}
Listmonk.CampaignsApicampaignsCampaignIdContentPostPOST /campaigns/{campaign_id}/content
Listmonk.CampaignsApicampaignsCampaignIdDeleteDELETE /campaigns/{campaign_id}
Listmonk.CampaignsApicampaignsCampaignIdGetGET /campaigns/{campaign_id}
Listmonk.CampaignsApicampaignsCampaignIdPreviewGetGET /campaigns/{campaign_id}/preview
Listmonk.CampaignsApicampaignsCampaignIdPutPUT /campaigns/{campaign_id}
Listmonk.CampaignsApicampaignsCampaignIdStatusPutPUT /campaigns/{campaign_id}/status
Listmonk.CampaignsApicampaignsCampaignIdTestPostPOST /campaigns/{campaign_id}/test
Listmonk.CampaignsApicampaignsCampaignIdTextGetGET /campaigns/{campaign_id}/text
Listmonk.CampaignsApicampaignsGetGET /campaigns
Listmonk.CampaignsApicampaignsPostPOST /campaigns
Listmonk.CampaignsApicampaignsRunningStatsGetGET /campaigns/running/stats
Listmonk.ImportApiimportSubscribersDeleteDELETE /import/subscribers
Listmonk.ImportApiimportSubscribersGetGET /import/subscribers
Listmonk.ImportApiimportSubscribersLogsGetGET /import/subscribers/logs
Listmonk.ImportApiimportSubscribersPostPOST /import/subscribers
Listmonk.ListsApilistsGetGET /lists
Listmonk.ListsApilistsListIdDeleteDELETE /lists/{list_id}
Listmonk.ListsApilistsListIdGetGET /lists/{list_id}
Listmonk.ListsApilistsListIdPutPUT /lists/{list_id}
Listmonk.ListsApilistsPostPOST /lists
Listmonk.LogsApilogsGetGET /logs
Listmonk.MaintenanceApimaintenanceAnalyticsTypeDeleteDELETE /maintenance/analytics/{type}
Listmonk.MaintenanceApimaintenanceSubscribersTypeDeleteDELETE /maintenance/subscribers/{type}
Listmonk.MaintenanceApimaintenanceSubscriptionsUnconfirmedDeleteDELETE /maintenance/subscriptions/unconfirmed
Listmonk.MediaApimediaGetGET /media
Listmonk.MediaApimediaMediaIdDeleteDELETE /media/{media_id}
Listmonk.MediaApimediaMediaIdGetGET /media/{media_id}
Listmonk.MediaApimediaPostPOST /media
Listmonk.MiscellaneousApiconfigGetGET /config
Listmonk.MiscellaneousApidashboardChartsGetGET /dashboard/charts
Listmonk.MiscellaneousApidashboardCountsGetGET /dashboard/counts
Listmonk.MiscellaneousApihealthGetGET /health
Listmonk.MiscellaneousApilangLangGetGET /lang/{lang}
Listmonk.PublicApipublicListsGetGET /public/lists
Listmonk.PublicApipublicSubscriptionPostPOST /public/subscription
Listmonk.SettingsApisettingsGetGET /settings
Listmonk.SettingsApisettingsPutPUT /settings
Listmonk.SettingsApisettingsSmtpTestPostPOST /settings/smtp/test
Listmonk.SubscribersApisubscribersGetGET /subscribers
Listmonk.SubscribersApisubscribersIdBlocklistPutPUT /subscribers/{id}/blocklist
Listmonk.SubscribersApisubscribersIdBouncesDeleteDELETE /subscribers/{id}/bounces
Listmonk.SubscribersApisubscribersIdBouncesGetGET /subscribers/{id}/bounces
Listmonk.SubscribersApisubscribersIdDeleteDELETE /subscribers/{id}
Listmonk.SubscribersApisubscribersIdExportGetGET /subscribers/{id}/export
Listmonk.SubscribersApisubscribersIdOptinPostPOST /subscribers/{id}/optin
Listmonk.SubscribersApisubscribersListsPutPUT /subscribers/lists
Listmonk.SubscribersApisubscribersPostPOST /subscribers
Listmonk.SubscribersApisubscribersQueryBlocklistPutPUT /subscribers/query/blocklist
Listmonk.SubscribersApisubscribersQueryDeletePostPOST /subscribers/query/delete
Listmonk.SubscribersApisubscribersQueryListsPutPUT /subscribers/query/lists
Listmonk.SubscribersApisubscribersSubscriberIdGetGET /subscribers/{subscriberId}
Listmonk.TemplatesApitemplatesGetGET /templates
Listmonk.TemplatesApitemplatesTemplateIdDefaultPutPUT /templates/{template_id}/default
Listmonk.TemplatesApitemplatesTemplateIdDeleteDELETE /templates/{template_id}
Listmonk.TemplatesApitemplatesTemplateIdGetGET /templates/{template_id}
Listmonk.TemplatesApitemplatesTemplateIdPreviewGetGET /templates/{template_id}/preview
Listmonk.TransactionalApitransactionalPostPOST /transactional

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

1.0.0

1 year ago