https://github.com/jonathangomz/onesignal-client
Client for OneSignal API
https://github.com/jonathangomz/onesignal-client
client-api nodejs npm npm-package onesignal onesignal-api
Last synced: about 1 month ago
JSON representation
Client for OneSignal API
- Host: GitHub
- URL: https://github.com/jonathangomz/onesignal-client
- Owner: jonathangomz
- Created: 2020-10-09T01:15:35.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-29T22:14:40.000Z (over 5 years ago)
- Last Synced: 2025-09-02T07:37:26.191Z (7 months ago)
- Topics: client-api, nodejs, npm, npm-package, onesignal, onesignal-api
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@jonathangomz/onesignal-client
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OneSignal Client for Nodejs
A OneSignal client that implement some of the endpoints from the OneSignal API
## Docs
**Note: The responses are the direct responses from the provider so you can see the examples on his documentation ([See ref](#ref)).**
### `constructor({ authKey, restApiKey, appId })`
Creates a new OneSignal client.
```js
const client = new OneSignal({
authKey: process.env.AUTH_KEY,
restApiKey: process.env.REST_API_KEY,
appId: process.env.APP_ID,
});
```
### `isValid(): Promise`
Validate that the app exist in the provider.
```js
client.isValid()
```
### `getApp(): Promise`
View the details of a single OneSignal app.
[_See more_][1]
**Usage example:**
```js
client.getApp()
```
### `sendNotification(message, options?): Promise`
Sends notifications to your users. \
_If attribute `included_segments` not provided will send to "Test" segment by default_.
[_See more_][2]
**Usage example:**
```js
const message = {
heading: {
en: 'Example Explicit Segment',
es: 'Ejemplo Segmento Explicito',
},
content: {
en: 'This is an example for Test segment explicitly',
es: 'Este es un ejemplo para el segmento Test de forma explícita',
}
}
const opt = {
targets: {
to: {
type: 'external',
value: ['1130745'],
}
}
}
client.sendNotification(message, opt);
```
### `cancelNotification(notification_id): Promise`
Stop a scheduled or currently outgoing notification.
[_See more_][3]
**Usage example:**
```js
client.cancelNotification('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');
```
### `viewNotifications(options?): Promise`
View the details of multiple notifications.
[_See more_][4]
**Usage example:**
```js
client.viewNotifications({ limit: 5 });
```
### `viewNotification(notification_id): Promise`
View the details of a single notification and outcomes associated with it.
[_See more_][5]
**Usage example:**
```js
client.viewNotification('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');
```
### `viewDevices(options?): Promise`
View the details of multiple devices in your app.
[_See more_][6]
**Usage example:**
```js
client.viewDevices({ limit: 2 });
```
### `viewDevice(player_id): Promise`
View the details of an existing device in your OneSignal apps.
[_See more_][7]
**Usage example:**
```js
client.viewDevice('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');
```
## Ref:
https://documentation.onesignal.com/reference
[1]:https://documentation.onesignal.com/reference/view-an-app
[2]:https://documentation.onesignal.com/reference/create-notification
[3]:https://documentation.onesignal.com/reference/cancel-notification
[4]:https://documentation.onesignal.com/reference/view-notifications
[5]:https://documentation.onesignal.com/reference/view-notification
[6]:https://documentation.onesignal.com/reference/view-devices
[7]:https://documentation.onesignal.com/reference/view-device