{"_id":"@abilaker/listmonk","name":"@abilaker/listmonk","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@abilaker/listmonk","version":"1.0.0","description":"The API collection for listmonk","license":"AGPL-3.0 license","main":"dist/index.js","scripts":{"build":"babel src -d dist","prepare":"npm run build","test":"mocha --require @babel/register --recursive"},"browser":{"fs":false},"dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"devDependencies":{"@babel/core":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/register":"^7.0.0","expect.js":"^0.3.1","mocha":"^8.0.1","sinon":"^7.2.0"},"_id":"@abilaker/listmonk@1.0.0","gitHead":"2d6b65b8dbb051065a11c5f0a1103ad9b7e7d343","_nodeVersion":"18.20.4","_npmVersion":"10.9.0","dist":{"integrity":"sha512-kLNeimgAYOw+PKwHVC5Cab/JY5l6HVRLW177bMawM59y/0bmY8u/f7PMT8OSpxZwIKuQlDX0YnzY3K63Aol8eQ==","shasum":"8145d0985f32ad66ed7ae200020d4abe23c3385e","tarball":"https://registry.npmjs.org/@abilaker/listmonk/-/listmonk-1.0.0.tgz","fileCount":85,"unpackedSize":1378943,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCID3yKbcTRfmmaOocua2ik30vuykWSxV1OjMMzazw7HDzAiAtdIh0LrBxbzeO1uhKKjZq5FcnnxoygBytSbgfAEtt3Q=="}]},"_npmUser":{"name":"abilaker","email":"abilak@gmail.com"},"directories":{},"maintainers":[{"name":"abilaker","email":"abilak@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/listmonk_1.0.0_1744324603759_0.8071281241929438"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-10T22:36:43.649Z","1.0.0":"2025-04-10T22:36:43.976Z","modified":"2025-04-10T22:36:44.273Z"},"maintainers":[{"name":"abilaker","email":"abilak@gmail.com"}],"description":"The API collection for listmonk","license":"AGPL-3.0 license","readme":"# listmonk\n\nListmonk - JavaScript client for listmonk\nThe API collection for listmonk\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo 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).\n\nThen install it via:\n\n```shell\nnpm install listmonk --save\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n##### Local development\n\nTo 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:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nTo use the link you just defined in your project, switch to the directory you want to use your listmonk from, and run:\n\n```shell\nnpm link /path/to/<JAVASCRIPT_CLIENT_DIR>\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n#### git\n\nIf the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID\nthen install it via:\n\n```shell\n    npm install GIT_USER_ID/GIT_REPO_ID --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file):\n\n```shell\nbrowserify main.js > bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar Listmonk = require('listmonk');\n\n\nvar api = new Listmonk.AdminApi()\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.adminReloadPost(callback);\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:9000/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Listmonk.AdminApi* | [**adminReloadPost**](docs/AdminApi.md#adminReloadPost) | **POST** /admin/reload | \n*Listmonk.BouncesApi* | [**bouncesDelete**](docs/BouncesApi.md#bouncesDelete) | **DELETE** /bounces | \n*Listmonk.BouncesApi* | [**bouncesGet**](docs/BouncesApi.md#bouncesGet) | **GET** /bounces | \n*Listmonk.BouncesApi* | [**bouncesIdDelete**](docs/BouncesApi.md#bouncesIdDelete) | **DELETE** /bounces/{id} | \n*Listmonk.BouncesApi* | [**bouncesIdGet**](docs/BouncesApi.md#bouncesIdGet) | **GET** /bounces/{id} | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdContentPost**](docs/CampaignsApi.md#campaignsCampaignIdContentPost) | **POST** /campaigns/{campaign_id}/content | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdDelete**](docs/CampaignsApi.md#campaignsCampaignIdDelete) | **DELETE** /campaigns/{campaign_id} | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdGet**](docs/CampaignsApi.md#campaignsCampaignIdGet) | **GET** /campaigns/{campaign_id} | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdPreviewGet**](docs/CampaignsApi.md#campaignsCampaignIdPreviewGet) | **GET** /campaigns/{campaign_id}/preview | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdPut**](docs/CampaignsApi.md#campaignsCampaignIdPut) | **PUT** /campaigns/{campaign_id} | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdStatusPut**](docs/CampaignsApi.md#campaignsCampaignIdStatusPut) | **PUT** /campaigns/{campaign_id}/status | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdTestPost**](docs/CampaignsApi.md#campaignsCampaignIdTestPost) | **POST** /campaigns/{campaign_id}/test | \n*Listmonk.CampaignsApi* | [**campaignsCampaignIdTextGet**](docs/CampaignsApi.md#campaignsCampaignIdTextGet) | **GET** /campaigns/{campaign_id}/text | \n*Listmonk.CampaignsApi* | [**campaignsGet**](docs/CampaignsApi.md#campaignsGet) | **GET** /campaigns | \n*Listmonk.CampaignsApi* | [**campaignsPost**](docs/CampaignsApi.md#campaignsPost) | **POST** /campaigns | \n*Listmonk.CampaignsApi* | [**campaignsRunningStatsGet**](docs/CampaignsApi.md#campaignsRunningStatsGet) | **GET** /campaigns/running/stats | \n*Listmonk.ImportApi* | [**importSubscribersDelete**](docs/ImportApi.md#importSubscribersDelete) | **DELETE** /import/subscribers | \n*Listmonk.ImportApi* | [**importSubscribersGet**](docs/ImportApi.md#importSubscribersGet) | **GET** /import/subscribers | \n*Listmonk.ImportApi* | [**importSubscribersLogsGet**](docs/ImportApi.md#importSubscribersLogsGet) | **GET** /import/subscribers/logs | \n*Listmonk.ImportApi* | [**importSubscribersPost**](docs/ImportApi.md#importSubscribersPost) | **POST** /import/subscribers | \n*Listmonk.ListsApi* | [**listsGet**](docs/ListsApi.md#listsGet) | **GET** /lists | \n*Listmonk.ListsApi* | [**listsListIdDelete**](docs/ListsApi.md#listsListIdDelete) | **DELETE** /lists/{list_id} | \n*Listmonk.ListsApi* | [**listsListIdGet**](docs/ListsApi.md#listsListIdGet) | **GET** /lists/{list_id} | \n*Listmonk.ListsApi* | [**listsListIdPut**](docs/ListsApi.md#listsListIdPut) | **PUT** /lists/{list_id} | \n*Listmonk.ListsApi* | [**listsPost**](docs/ListsApi.md#listsPost) | **POST** /lists | \n*Listmonk.LogsApi* | [**logsGet**](docs/LogsApi.md#logsGet) | **GET** /logs | \n*Listmonk.MaintenanceApi* | [**maintenanceAnalyticsTypeDelete**](docs/MaintenanceApi.md#maintenanceAnalyticsTypeDelete) | **DELETE** /maintenance/analytics/{type} | \n*Listmonk.MaintenanceApi* | [**maintenanceSubscribersTypeDelete**](docs/MaintenanceApi.md#maintenanceSubscribersTypeDelete) | **DELETE** /maintenance/subscribers/{type} | \n*Listmonk.MaintenanceApi* | [**maintenanceSubscriptionsUnconfirmedDelete**](docs/MaintenanceApi.md#maintenanceSubscriptionsUnconfirmedDelete) | **DELETE** /maintenance/subscriptions/unconfirmed | \n*Listmonk.MediaApi* | [**mediaGet**](docs/MediaApi.md#mediaGet) | **GET** /media | \n*Listmonk.MediaApi* | [**mediaMediaIdDelete**](docs/MediaApi.md#mediaMediaIdDelete) | **DELETE** /media/{media_id} | \n*Listmonk.MediaApi* | [**mediaMediaIdGet**](docs/MediaApi.md#mediaMediaIdGet) | **GET** /media/{media_id} | \n*Listmonk.MediaApi* | [**mediaPost**](docs/MediaApi.md#mediaPost) | **POST** /media | \n*Listmonk.MiscellaneousApi* | [**configGet**](docs/MiscellaneousApi.md#configGet) | **GET** /config | \n*Listmonk.MiscellaneousApi* | [**dashboardChartsGet**](docs/MiscellaneousApi.md#dashboardChartsGet) | **GET** /dashboard/charts | \n*Listmonk.MiscellaneousApi* | [**dashboardCountsGet**](docs/MiscellaneousApi.md#dashboardCountsGet) | **GET** /dashboard/counts | \n*Listmonk.MiscellaneousApi* | [**healthGet**](docs/MiscellaneousApi.md#healthGet) | **GET** /health | \n*Listmonk.MiscellaneousApi* | [**langLangGet**](docs/MiscellaneousApi.md#langLangGet) | **GET** /lang/{lang} | \n*Listmonk.PublicApi* | [**publicListsGet**](docs/PublicApi.md#publicListsGet) | **GET** /public/lists | \n*Listmonk.PublicApi* | [**publicSubscriptionPost**](docs/PublicApi.md#publicSubscriptionPost) | **POST** /public/subscription | \n*Listmonk.SettingsApi* | [**settingsGet**](docs/SettingsApi.md#settingsGet) | **GET** /settings | \n*Listmonk.SettingsApi* | [**settingsPut**](docs/SettingsApi.md#settingsPut) | **PUT** /settings | \n*Listmonk.SettingsApi* | [**settingsSmtpTestPost**](docs/SettingsApi.md#settingsSmtpTestPost) | **POST** /settings/smtp/test | \n*Listmonk.SubscribersApi* | [**subscribersGet**](docs/SubscribersApi.md#subscribersGet) | **GET** /subscribers | \n*Listmonk.SubscribersApi* | [**subscribersIdBlocklistPut**](docs/SubscribersApi.md#subscribersIdBlocklistPut) | **PUT** /subscribers/{id}/blocklist | \n*Listmonk.SubscribersApi* | [**subscribersIdBouncesDelete**](docs/SubscribersApi.md#subscribersIdBouncesDelete) | **DELETE** /subscribers/{id}/bounces | \n*Listmonk.SubscribersApi* | [**subscribersIdBouncesGet**](docs/SubscribersApi.md#subscribersIdBouncesGet) | **GET** /subscribers/{id}/bounces | \n*Listmonk.SubscribersApi* | [**subscribersIdDelete**](docs/SubscribersApi.md#subscribersIdDelete) | **DELETE** /subscribers/{id} | \n*Listmonk.SubscribersApi* | [**subscribersIdExportGet**](docs/SubscribersApi.md#subscribersIdExportGet) | **GET** /subscribers/{id}/export | \n*Listmonk.SubscribersApi* | [**subscribersIdOptinPost**](docs/SubscribersApi.md#subscribersIdOptinPost) | **POST** /subscribers/{id}/optin | \n*Listmonk.SubscribersApi* | [**subscribersListsPut**](docs/SubscribersApi.md#subscribersListsPut) | **PUT** /subscribers/lists | \n*Listmonk.SubscribersApi* | [**subscribersPost**](docs/SubscribersApi.md#subscribersPost) | **POST** /subscribers | \n*Listmonk.SubscribersApi* | [**subscribersQueryBlocklistPut**](docs/SubscribersApi.md#subscribersQueryBlocklistPut) | **PUT** /subscribers/query/blocklist | \n*Listmonk.SubscribersApi* | [**subscribersQueryDeletePost**](docs/SubscribersApi.md#subscribersQueryDeletePost) | **POST** /subscribers/query/delete | \n*Listmonk.SubscribersApi* | [**subscribersQueryListsPut**](docs/SubscribersApi.md#subscribersQueryListsPut) | **PUT** /subscribers/query/lists | \n*Listmonk.SubscribersApi* | [**subscribersSubscriberIdGet**](docs/SubscribersApi.md#subscribersSubscriberIdGet) | **GET** /subscribers/{subscriberId} | \n*Listmonk.TemplatesApi* | [**templatesGet**](docs/TemplatesApi.md#templatesGet) | **GET** /templates | \n*Listmonk.TemplatesApi* | [**templatesTemplateIdDefaultPut**](docs/TemplatesApi.md#templatesTemplateIdDefaultPut) | **PUT** /templates/{template_id}/default | \n*Listmonk.TemplatesApi* | [**templatesTemplateIdDelete**](docs/TemplatesApi.md#templatesTemplateIdDelete) | **DELETE** /templates/{template_id} | \n*Listmonk.TemplatesApi* | [**templatesTemplateIdGet**](docs/TemplatesApi.md#templatesTemplateIdGet) | **GET** /templates/{template_id} | \n*Listmonk.TemplatesApi* | [**templatesTemplateIdPreviewGet**](docs/TemplatesApi.md#templatesTemplateIdPreviewGet) | **GET** /templates/{template_id}/preview | \n*Listmonk.TransactionalApi* | [**transactionalPost**](docs/TransactionalApi.md#transactionalPost) | **POST** /transactional | \n\n\n## Documentation for Models\n\n - [Listmonk.Bounce](docs/Bounce.md)\n - [Listmonk.BounceData](docs/BounceData.md)\n - [Listmonk.BounceDataResultsInner](docs/BounceDataResultsInner.md)\n - [Listmonk.BounceDataResultsInnerCampaign](docs/BounceDataResultsInnerCampaign.md)\n - [Listmonk.BouncesGet200Response](docs/BouncesGet200Response.md)\n - [Listmonk.BouncesGet200ResponseData](docs/BouncesGet200ResponseData.md)\n - [Listmonk.Campaign](docs/Campaign.md)\n - [Listmonk.CampaignData](docs/CampaignData.md)\n - [Listmonk.CampaignRegistrationInfo](docs/CampaignRegistrationInfo.md)\n - [Listmonk.CampaignUpdate](docs/CampaignUpdate.md)\n - [Listmonk.CampaignsCampaignIdStatusPutRequest](docs/CampaignsCampaignIdStatusPutRequest.md)\n - [Listmonk.CampaignsGet200Response](docs/CampaignsGet200Response.md)\n - [Listmonk.CampaignsGet200ResponseData](docs/CampaignsGet200ResponseData.md)\n - [Listmonk.DashboardChartsGet200Response](docs/DashboardChartsGet200Response.md)\n - [Listmonk.DashboardChartsGet200ResponseData](docs/DashboardChartsGet200ResponseData.md)\n - [Listmonk.DashboardChartsGet200ResponseDataLinkClicksInner](docs/DashboardChartsGet200ResponseDataLinkClicksInner.md)\n - [Listmonk.DashboardCount](docs/DashboardCount.md)\n - [Listmonk.DashboardCountData](docs/DashboardCountData.md)\n - [Listmonk.DashboardCountDataCampaigns](docs/DashboardCountDataCampaigns.md)\n - [Listmonk.DashboardCountDataCampaignsByStatus](docs/DashboardCountDataCampaignsByStatus.md)\n - [Listmonk.DashboardCountDataLists](docs/DashboardCountDataLists.md)\n - [Listmonk.DashboardCountDataSubscribers](docs/DashboardCountDataSubscribers.md)\n - [Listmonk.HealthGet200Response](docs/HealthGet200Response.md)\n - [Listmonk.ImportStatus](docs/ImportStatus.md)\n - [Listmonk.ImportStatusData](docs/ImportStatusData.md)\n - [Listmonk.ImportSubscribersLogsGet200Response](docs/ImportSubscribersLogsGet200Response.md)\n - [Listmonk.ImportSubscribersPostRequest](docs/ImportSubscribersPostRequest.md)\n - [Listmonk.LanguagePack](docs/LanguagePack.md)\n - [Listmonk.LanguagePackData](docs/LanguagePackData.md)\n - [Listmonk.List](docs/List.md)\n - [Listmonk.ListRegistrationInfo](docs/ListRegistrationInfo.md)\n - [Listmonk.ListsGet200Response](docs/ListsGet200Response.md)\n - [Listmonk.ListsGet200ResponseData](docs/ListsGet200ResponseData.md)\n - [Listmonk.ListsListIdPutRequest](docs/ListsListIdPutRequest.md)\n - [Listmonk.LogsGet200Response](docs/LogsGet200Response.md)\n - [Listmonk.MailBoxBounces](docs/MailBoxBounces.md)\n - [Listmonk.MaintenanceSubscribersTypeDelete200Response](docs/MaintenanceSubscribersTypeDelete200Response.md)\n - [Listmonk.MaintenanceSubscribersTypeDelete200ResponseData](docs/MaintenanceSubscribersTypeDelete200ResponseData.md)\n - [Listmonk.MediaFileObject](docs/MediaFileObject.md)\n - [Listmonk.MediaGet200Response](docs/MediaGet200Response.md)\n - [Listmonk.NewCampaign](docs/NewCampaign.md)\n - [Listmonk.NewCampaignData](docs/NewCampaignData.md)\n - [Listmonk.PublicListsGet200ResponseInner](docs/PublicListsGet200ResponseInner.md)\n - [Listmonk.PublicSubscriptionPost200Response](docs/PublicSubscriptionPost200Response.md)\n - [Listmonk.SMTPSettings](docs/SMTPSettings.md)\n - [Listmonk.SMTPTest](docs/SMTPTest.md)\n - [Listmonk.ServerConfig](docs/ServerConfig.md)\n - [Listmonk.ServerConfigData](docs/ServerConfigData.md)\n - [Listmonk.ServerConfigDataLangsInner](docs/ServerConfigDataLangsInner.md)\n - [Listmonk.Settings](docs/Settings.md)\n - [Listmonk.SettingsData](docs/SettingsData.md)\n - [Listmonk.Subscriber](docs/Subscriber.md)\n - [Listmonk.SubscriberData](docs/SubscriberData.md)\n - [Listmonk.SubscriberListsInner](docs/SubscriberListsInner.md)\n - [Listmonk.SubscriberProfile](docs/SubscriberProfile.md)\n - [Listmonk.SubscriberProfileAttribs](docs/SubscriberProfileAttribs.md)\n - [Listmonk.SubscriberRegistrationInfo](docs/SubscriberRegistrationInfo.md)\n - [Listmonk.SubscriberRegistrationInfoAttribs](docs/SubscriberRegistrationInfoAttribs.md)\n - [Listmonk.SubscriberRegistrationInfoAttribsStack](docs/SubscriberRegistrationInfoAttribsStack.md)\n - [Listmonk.SubscribersGet200Response](docs/SubscribersGet200Response.md)\n - [Listmonk.SubscribersGet200ResponseData](docs/SubscribersGet200ResponseData.md)\n - [Listmonk.SubscribersIdBouncesGet200Response](docs/SubscribersIdBouncesGet200Response.md)\n - [Listmonk.SubscribersListsPutRequest](docs/SubscribersListsPutRequest.md)\n - [Listmonk.Subscriptions](docs/Subscriptions.md)\n - [Listmonk.Template](docs/Template.md)\n - [Listmonk.TemplatesGet200Response](docs/TemplatesGet200Response.md)\n - [Listmonk.TransactionalMessage](docs/TransactionalMessage.md)\n\n\n## Documentation for Authorization\n\nAll endpoints do not require authorization.\n","readmeFilename":"README.md","_rev":"1-2725741c3f6016c5600fc6c4618a5794"}