README
@commitdev/zero-notification-service-client
NotificationService - JavaScript client for @commitdev/zero-notification-service-client No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: v0.0.12
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Fornpm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install @commitdev/zero-notification-service-client --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 @commitdev/zero-notification-service-client 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 NotificationService = require('@commitdev/zero-notification-service-client');
var api = new NotificationService.EmailApi()
var sendBulkMailRequest = new NotificationService.SendBulkMailRequest(); // {SendBulkMailRequest} Parameters of the messages to send
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.sendBulk(sendBulkMailRequest, callback);
Documentation for API Endpoints
All URIs are relative to http://zero-notification-service.notification-service/v1
Class | Method | HTTP request | Description |
---|---|---|---|
NotificationService.EmailApi | sendBulk | POST /email/sendBulk | Send a batch of multiple emails to individual recipients with the same content. Note that if cc or bcc address are provided, each email sent will also be sent to any addresses in these lists. Note that it is possible for only a subset of these to fail |
NotificationService.EmailApi | sendEmail | POST /email/send | Send a single email. Note that if multiple to addresses are provided it will still only send a single email with multiple addresses in the to field. To send multiple emails to individual addresses, see the sendBulk endpoint. |
NotificationService.HealthApi | readyCheck | GET /status/ready | Readiness check - the service is ready to handle work |
NotificationService.NotificationApi | sendSlackNotification | POST /notification/slack/send | Send a Slack message |
NotificationService.SmsApi | sendSMS | POST /sms/send | Send an SMS |
Documentation for Models
- NotificationService.EmailRecipient
- NotificationService.EmailSender
- NotificationService.Error
- NotificationService.MailMessage
- NotificationService.SendBulkMailRequest
- NotificationService.SendBulkMailResponse
- NotificationService.SendBulkMailResponseFailed
- NotificationService.SendBulkMailResponseSuccessful
- NotificationService.SendMailRequest
- NotificationService.SendMailResponse
- NotificationService.SendSMSRequest
- NotificationService.SendSMSResponse
- NotificationService.SendSlackMessageRequest
- NotificationService.SendSlackMessageResponse
- NotificationService.SlackMessage
- NotificationService.SlackRecipient
Documentation for Authorization
All endpoints do not require authorization.