report-monitoring
v0.0.1
Published
<dl> <dt><a href="#ReportMonitoring">ReportMonitoring</a></dt> <dd></dd> <dt><a href="#Notifications">Notifications</a></dt> <dd></dd> <dt><a href="#Subscriptions">Subscriptions</a></dt> <dd></dd> </dl>
Readme
Classes
Functions
ReportMonitoring
Kind: global class
Notifications
Kind: global class
Notifications.clear(domain, account)
clear -
Path: report-monitoring/v1/notifications/clear/domain/:domain/account/:account
Kind: static method of Notifications
| Param | Type | | --- | --- | | domain | any | | account | any |
Notifications.read(domain, account)
read -
Path: report-monitoring/v1/notifications/read/domain/:domain/account/:account
Kind: static method of Notifications
| Param | Type | | --- | --- | | domain | any | | account | any |
Notifications.list(domain, account)
list -
Path: report-monitoring/v1/notifications/domain/:domain/account/:account
Kind: static method of Notifications
| Param | Type | | --- | --- | | domain | any | | account | any |
Subscriptions
Kind: global class
Subscriptions.list(domain, account)
list -
Path: report-monitoring/v1/subscriptions/domain/:domain/account/:account
Kind: static method of Subscriptions
| Param | Type | | --- | --- | | domain | any | | account | any |
Subscriptions.unsubscribeAll(domain, account)
unsubscribeAll -
Path: report-monitoring/v1/subscriptions/unsubscribe/all/domain/:domain/account/:account
Kind: static method of Subscriptions
| Param | Type | | --- | --- | | domain | any | | account | any |
Subscriptions.unsubscribe(domain, account, report_code)
unsubscribe -
Path: report-monitoring/v1/subscriptions/unsubscribe/domain/:domain/account/:account/report/:report_code
Kind: static method of Subscriptions
| Param | Type | | --- | --- | | domain | any | | account | any | | report_code | any |
Subscriptions.subscribe(domain, account, report_code)
subscribe -
Path: report-monitoring/v1/subscriptions/domain/:domain/account/:account/report/:report_code
Kind: static method of Subscriptions
| Param | Type | | --- | --- | | domain | any | | account | any | | report_code | any |
SDK(host, opts)
SDK - importing the SDK for use
Kind: global function
| Param | Type | Description | | --- | --- | --- | | host | string | the hostname to the service (example: http://127.0.0.1) | | opts | object | options that will be appened to every request. Fasquest Lib Options (example: {headers: {'API-KEY':'34098hodf'}}) |
Example
init
const { ReportMonitoring } = require('./sdk.js')('http://127.0.0.1');0.0.1
11 September 2023
New Features
- Feature #1 init repo
#1