Welcome to @onesignal/node-onesignal 👋

> OpenAPI client for node-onesignal

$3

Node Client SDK

The OneSignal Node client is a server OneSignal SDK for NodeJS. Integrate OneSignal with your backend events, data, and
more.

Install

``sh

`yarn`


yarn add @onesignal/node-onesignal
npm

npm install @onesignal/node-onesignal --save


Usage

js
const OneSignal = require('@onesignal/node-onesignal');

js
import * as OneSignal from '@onesignal/node-onesignal';


Creating a client

$3

We can configure the client using the

createConfiguration

 function. You can find more info on each configuration 
parameter here.

`js const configuration = OneSignal.createConfiguration(configParams);`

`$3`

js
const client = new OneSignal.DefaultApi(configuration);


$3

You can configure auth parameters passing them like this:

`js const configuration = OneSignal.createConfiguration({ organizationApiKey: '', // Organization key is only required for creating new apps and other top-level endpoints restApiKey: '', // App REST API key required for most endpoints });

const client = new OneSignal.DefaultApi(configuration);`

#### Advanced Usage: Creating a brand-new app If creating a new app via the client, the response will return the app's API key via thebasic_auth_keyresponse parameter. You can then use this to modify your configuration object and create a new client that will have both user-level and app-level authentication set up.

`js const response = await client.createApp(newapp);

const configuration = OneSignal.createConfiguration({ organizationApiKey: '', // Organization key is only required for creating new apps and other top-level endpoints restApiKey: response.basic_auth_key, });

const client = new OneSignal.DefaultApi(configuration);`

---

`API Reference`

> See the full list of API Endpoints.

To make stateful changes requests should take on the following pattern: 1. create or get an object 2. make changes to that object 3. pass the object to the request function to make the changes

Examples of important OneSignal objects include App, Notification, Player, and Segment.

For example, see the section below on creating an app. First an app object is created via the instantiation of the Appclass. Then, the app instance is modified directly. Finally, we use theclient to create the app via a remote request.

`$3`


Creates a new OneSignal app.

Example`js const app = new OneSignal.App();

// configure your application app.name = 'app_name'; app.gcm_key = ''; app.android_gcm_sender_id = '';

const response = await client.createApp(app);`

`$3`


View the details of a single OneSignal app.

Example`js const app = await client.getApp('');`

`$3`


View apps.

Example`js const apps = await client.getApps();`

`$3`


Updates the name or configuration settings of an existing OneSignal app.

Example`js const app = new OneSignal.App(); app.name = 'modified_app_name';

const udpateAppResponse = await client.updateApp('', app);`

`$3`


Sends a notification to your users.

Example`js const notification = new OneSignal.Notification(); notification.app_id = app.id; // Name property may be required in some case, for instance when sending an SMS. notification.name = "test_notification_name"; notification.contents = { en: "Gig'em Ags" }

// required for Huawei notification.headings = { en: "Gig'em Ags" } const notification = await client.createNotification(notification);`

`$3`


Sends a notification to your users filtered by specific criteria.

Example`js const notification = new OneSignal.Notification(); notification.app_id = app.id;

notification.contents = { en: "Gig'em Ags" }

// required for Huawei notification.headings = { en: "Gig'em Ags" }

// Find all the users that have not spent any amount in USD on IAP. // https://documentation.onesignal.com/reference/create-notification#send-to-users-based-on-filters notification.filters = [ { field: 'amount_spent', relation: '=', value: "0" }, ];

const notification = await client.createNotification(notification);`

`$3`


Stop a scheduled or currently outgoing notification.
Example

`js const cancelNotificationResponse = await client.cancelNotification('', '');`

`$3`


View the details of a single notification and outcomes associated with it.

Example`js await client.getNotification('', '');`

`$3`


View the details of multiple notifications.

| Param | Type | Description | |--------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | app_id | string | The OneSignal App ID for your app. Available in Keys & IDs. | | limit | string | How many notifications to return. Max is 50. Default is 50. | | offset | number | Page offset. Default is 0. Results are sorted by queued_at in descending order.queued_atis a representation of the time that the notification was queued at. | | kind | number | Kind of notifications returned: unset - All notification types (default)0 - Dashboard only 1 - API only 3 - Automated only |

Example`js const notifications = await client.getNotifications('', '50', 0, 1);`

`$3`


View the devices sent a message - OneSignal Paid Plan Required
This method will return all devices that were sent the given

notification_id

 of an Email or Push Notification if used 
within 7 days of the date sent.

Example`js const notificationHistory = await client.getNotificationHistory('');`

`$3`


Create segments visible and usable in the dashboard and API - Required: OneSignal Paid Plan

Example`js const segment = new OneSignal.Segment();

segment.filters = [ { field: 'session_count', relation: '>', value: '1' }, { field: 'tag', key: 'my_tag', relation: 'exists' } ]

const segment = await client.createSegments(app.id, segment);`

`$3`


Delete segments (not user devices) - Required: OneSignal Paid Plan
You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header 
that has admin access on the app.
The

segment_id can be found in the URL of the segment when viewing it in the dashboard.

Example`js const deleteSegmentsResponse = await client.deleteSegments('', '');`

`$3`


Add a device.

Example`js const player = new OneSignal.Player(); player.device_type = 1; player.app_id = app_id; player.identifier = ''; const player = await client.createPlayer(player);`

`$3`


View the details of an existing device in one of your OneSignal apps.
The email and the hash is only required if you have enabled Identity Verification and

device_type is email.

Example`js const player = await client.getPlayer('', '', '');`

`$3`


View the details of multiple devices in one of your OneSignal apps. 
⚠️ Unavailable for Apps Over 80,000 Users.
| Param  | Type   | Description                                                      |
|--------|--------|------------------------------------------------------------------|
| app_id | string | The OneSignal App ID for your app.  Available in Keys & IDs. |
| limit  | string | How many devices to return. Max is 300. Default is 300           |
| offset | number | Result offset. Default is 0. Results are sorted by id;           |

Example`js const players = await client.getPlayers('', '300', 0);`

`$3`


Generate a compressed CSV export of all of your current user data. This method can be used to generate a compressed CSV
export of all of your existing user data and is a better alternative to retrieving this data using the /players API endpoint.
See full CSV Export Reference

Example`js const exportPlayerResponse = await client.exportPlayer('', { extra_fields: ['location', 'external_user_id'], last_active_since: 1469392779, segment_name: "Subscribed Users" });`

`$3`


Update an existing device in one of your OneSignal apps.

Example`js const updatePlayerResponse = await client.updatePlayer('', player);`

`$3`


Update an existing device's tags in one of your OneSignal apps using the External User ID.

`js const playerToUpdate = new OneSignal.Player();

player.app_id = APP_ID; player.device_type = 1;

playerToUpdate.external_user_id = 'your_player_external_id'; // setting the same external_user_id as before const updatePlayerTagsRequestBody = new OneSignal.UpdatePlayerTagsRequestBody(); updatePlayerTagsRequestBody.tags = {'typescript_test_tag': 1}; const updatePlayerResponse = await api.updatePlayerTags(APP_ID, PLAYER_EXTERNAL_USER_ID, updatePlayerTagsRequestBody);`#### Deleting Tags To delete a tag, include its key and set its value to blank (""). Omitting a key/value will not delete it.

For example, if you wanted to delete two existing tags rank and category while simultaneously adding a new tag class, the tags JSON would look like the following:

Example`json "tags": { "rank": "", "category": "", "class": "my_new_value" }`

`$3`


Deletes a user record.

Example`js const deletePlayerResponse = await client.deletePlayer(app.id, '')`

`$3`


View the details of all the outcomes associated with your app.
🚧  Requires your OneSignal App's REST API Key, available in Keys & IDs 🚧
Outcome data are accessible for 30 days before being deleted from our servers. You can export this data monthly if you need it for a more extended period.

| Param | Type | Description | |---------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | app_id | string | The OneSignal App ID for your app. Available in Keys & IDs. | | outcome_names | string | Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the “os” prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum | | outcome_names2 | string | If outcome names contain any commas, then please specify only one value at a time. Example:outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.countwhere “Sales, Purchase” is the custom outcomes with a comma in the name. | | outcome_time_range | string | Optional Time range for the returned data. The values can be1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo(for the last 1 month data). Default is 1h if the parameter is omitted. | | outcome_platforms | string | Optional Platform id. Refer device's platform ids for values. Example:outcome_platform=0 for iOS outcome_platform=7, 8for Safari and Firefox Default is data from all platforms if the parameter is omitted. | | outcome_attribution | string | Optional Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: outcome_attribution=direct Default is total (returns direct+influenced+unattributed) if the parameter is omitted. |

Example`js const outcomes = await client.getOutcomes(app.id, 'os__click.count,os_session_duration.count,my_outcome.sum');`

`$3`


Starts a Live Activity event

js
// Create a player first
const player = new OneSignal.Player();
player.device_type = 0;
player.app_id = '';
const playerResponse = await api.createPlayer(player);
// Prepare a request
const beginLiveActivityRequest: BeginLiveActivityRequest = {
    push_token: '',
    subscription_id: playerResponse.id!,
};
const activityId = ''; // any string

// Begin activity await api.beginLiveActivity('', activityId, beginLiveActivityRequest);`

`$3`


Updates a Live Activity event

js
const updateLiveActivityRequest: UpdateLiveActivityRequest = {
    event_updates: {
        data: 'test'
    },
    event: "update",
    name: "contents"
};

await api.updateLiveActivity('', '', updateLiveActivityRequest);`

`$3`


Stops a Live Activity event

js
const subscriptionId = ''; // player id
await api.endLiveActivity('', '', subscriptionId);


$3

* iOSPush
* AndroidPush
* FireOSPush
* ChromeExtensionPush
* ChromePush
* WindowsPush
* SafariLegacyPush
* FirefoxPush
* macOSPush
* HuaweiPush
* SafariPush
* Email
* SMS
Users

$3

js
const user = new OneSignal.User();
const aliasLabel = '';
const aliasId = '';
const subscriptionToken = '';
user.identity = {
    [aliasLabel]: aliasId,
};
user.subscriptions = [
  {
    type: "iOSPush",
    token: subscriptionToken,
  }
];

const createdUser = await api.createUser('', user); assert(createdUser.identity!['onesignal_id'] != null);`

`$3`

js
const oneisgnalAliasLabel = "onesignal_id";
const onesignalAliasId = createdUser.identity!['onesignal_id'];

const fetchedUser = await api.fetchUser('', oneisgnalAliasLabel, onesignalAliasId);`

`$3`

js
const fetchedUser = await api.fetchUser('', alias_label, alias_id);

$3

js
const updateUserRequest: UpdateUserRequest = {
    properties: {
        language: 'fr'
    }
};

const updatedUser = await api.updateUser('', aliasLabel, aliasId, updateUserRequest);`

`$3`

js
await api.deleteUser('', aliasLabel, aliasId);


Subscriptions

$3

js
const createSubscriptionRequestBody: CreateSubscriptionRequestBody = {
    subscription: {
        type: "AndroidPush",
        token: '',
    }
};

const response = await api.createSubscription('', '', '', createSubscriptionRequestBody);`

`$3`

js
const updateSubscriptionRequestBody: UpdateSubscriptionRequestBody = {
    subscription: {
        type: "iOSPush",
        token: '',
    }
};

await api.updateSubscription('', '', updateSubscriptionRequestBody);`

`$3`

js
await api.deleteSubscription('', '');


$3

Transfers the subscription from one user to another.

js
// Setting the user for transfering the subscription to. User is identyfied by an IdentityObject.
const transferSubscriptionRequestBody: TransferSubscriptionRequestBody = {
    identity: otherUserIdentityObject
};

const transferResponse = await api.transferSubscription('', '', transferSubscriptionRequestBody);`

`Aliases`

$3

js
const fetchResponse = await api.fetchAliases('', '');

$3

js
const fetchResponse = await api.fetchUserIdentity('', '', '');

$3

js
const userIdentityRequestBody: UserIdentityRequestBody = {
    identity: {
        ['']: ''
    }
};

const identifyResponse = await api.identifyUserByAlias('', '', '', userIdentityRequestBody);`

`$3`

js
const userIdentityRequestBody: UserIdentityRequestBody = {
    identity: {
        ['']: ''
    }
};

const identifyResponse = await api.identifyUserBySubscriptionId('', '', userIdentityRequestBody);`

`$3`

js
await api.deleteAlias('', '', '', '');

Author

* Website: https://onesignal.com
* Twitter: @onesignal
* Github: @OneSignal

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

Welcome to @onesignal/node-onesignal 👋

> OpenAPI client for node-onesignal

$3

Node Client SDK

The OneSignal Node client is a server OneSignal SDK for NodeJS. Integrate OneSignal with your backend events, data, and
more.

Install

``sh

`yarn`


yarn add @onesignal/node-onesignal
npm

npm install @onesignal/node-onesignal --save


Usage

js
const OneSignal = require('@onesignal/node-onesignal');

js
import * as OneSignal from '@onesignal/node-onesignal';


Creating a client

$3

We can configure the client using the

createConfiguration

 function. You can find more info on each configuration 
parameter here.

`js const configuration = OneSignal.createConfiguration(configParams);`

`$3`

js
const client = new OneSignal.DefaultApi(configuration);


$3

You can configure auth parameters passing them like this:

const client = new OneSignal.DefaultApi(configuration);`

`js const response = await client.createApp(newapp);

const client = new OneSignal.DefaultApi(configuration);`

---

`API Reference`

> See the full list of API Endpoints.

To make stateful changes requests should take on the following pattern: 1. create or get an object 2. make changes to that object 3. pass the object to the request function to make the changes

Examples of important OneSignal objects include App, Notification, Player, and Segment.

`$3`


Creates a new OneSignal app.

Example`js const app = new OneSignal.App();

// configure your application app.name = 'app_name'; app.gcm_key = ''; app.android_gcm_sender_id = '';

const response = await client.createApp(app);`

`$3`


View the details of a single OneSignal app.

Example`js const app = await client.getApp('');`

`$3`


View apps.

Example`js const apps = await client.getApps();`

`$3`


Updates the name or configuration settings of an existing OneSignal app.

Example`js const app = new OneSignal.App(); app.name = 'modified_app_name';

const udpateAppResponse = await client.updateApp('', app);`

`$3`


Sends a notification to your users.

// required for Huawei notification.headings = { en: "Gig'em Ags" } const notification = await client.createNotification(notification);`

`$3`


Sends a notification to your users filtered by specific criteria.

Example`js const notification = new OneSignal.Notification(); notification.app_id = app.id;

notification.contents = { en: "Gig'em Ags" }

// required for Huawei notification.headings = { en: "Gig'em Ags" }

const notification = await client.createNotification(notification);`

`$3`


Stop a scheduled or currently outgoing notification.
Example

`js const cancelNotificationResponse = await client.cancelNotification('', '');`

`$3`


View the details of a single notification and outcomes associated with it.

Example`js await client.getNotification('', '');`

`$3`


View the details of multiple notifications.

Example`js const notifications = await client.getNotifications('', '50', 0, 1);`

`$3`


View the devices sent a message - OneSignal Paid Plan Required
This method will return all devices that were sent the given

notification_id

 of an Email or Push Notification if used 
within 7 days of the date sent.

Example`js const notificationHistory = await client.getNotificationHistory('');`

`$3`


Create segments visible and usable in the dashboard and API - Required: OneSignal Paid Plan

Example`js const segment = new OneSignal.Segment();

segment.filters = [ { field: 'session_count', relation: '>', value: '1' }, { field: 'tag', key: 'my_tag', relation: 'exists' } ]

const segment = await client.createSegments(app.id, segment);`

`$3`


Delete segments (not user devices) - Required: OneSignal Paid Plan
You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header 
that has admin access on the app.
The

segment_id can be found in the URL of the segment when viewing it in the dashboard.

Example`js const deleteSegmentsResponse = await client.deleteSegments('', '');`

`$3`


Add a device.

Example`js const player = new OneSignal.Player(); player.device_type = 1; player.app_id = app_id; player.identifier = ''; const player = await client.createPlayer(player);`

`$3`


View the details of an existing device in one of your OneSignal apps.
The email and the hash is only required if you have enabled Identity Verification and

device_type is email.

Example`js const player = await client.getPlayer('', '', '');`

`$3`


View the details of multiple devices in one of your OneSignal apps. 
⚠️ Unavailable for Apps Over 80,000 Users.
| Param  | Type   | Description                                                      |
|--------|--------|------------------------------------------------------------------|
| app_id | string | The OneSignal App ID for your app.  Available in Keys & IDs. |
| limit  | string | How many devices to return. Max is 300. Default is 300           |
| offset | number | Result offset. Default is 0. Results are sorted by id;           |

Example`js const players = await client.getPlayers('', '300', 0);`

`$3`


Generate a compressed CSV export of all of your current user data. This method can be used to generate a compressed CSV
export of all of your existing user data and is a better alternative to retrieving this data using the /players API endpoint.
See full CSV Export Reference

Example`js const exportPlayerResponse = await client.exportPlayer('', { extra_fields: ['location', 'external_user_id'], last_active_since: 1469392779, segment_name: "Subscribed Users" });`

`$3`


Update an existing device in one of your OneSignal apps.

Example`js const updatePlayerResponse = await client.updatePlayer('', player);`

`$3`


Update an existing device's tags in one of your OneSignal apps using the External User ID.

`js const playerToUpdate = new OneSignal.Player();

player.app_id = APP_ID; player.device_type = 1;

For example, if you wanted to delete two existing tags rank and category while simultaneously adding a new tag class, the tags JSON would look like the following:

Example`json "tags": { "rank": "", "category": "", "class": "my_new_value" }`

`$3`


Deletes a user record.

Example`js const deletePlayerResponse = await client.deletePlayer(app.id, '')`

`$3`


View the details of all the outcomes associated with your app.
🚧  Requires your OneSignal App's REST API Key, available in Keys & IDs 🚧
Outcome data are accessible for 30 days before being deleted from our servers. You can export this data monthly if you need it for a more extended period.

Example`js const outcomes = await client.getOutcomes(app.id, 'os__click.count,os_session_duration.count,my_outcome.sum');`

`$3`


Starts a Live Activity event

js
// Create a player first
const player = new OneSignal.Player();
player.device_type = 0;
player.app_id = '';
const playerResponse = await api.createPlayer(player);
// Prepare a request
const beginLiveActivityRequest: BeginLiveActivityRequest = {
    push_token: '',
    subscription_id: playerResponse.id!,
};
const activityId = ''; // any string

// Begin activity await api.beginLiveActivity('', activityId, beginLiveActivityRequest);`

`$3`


Updates a Live Activity event

js
const updateLiveActivityRequest: UpdateLiveActivityRequest = {
    event_updates: {
        data: 'test'
    },
    event: "update",
    name: "contents"
};

await api.updateLiveActivity('', '', updateLiveActivityRequest);`

`$3`


Stops a Live Activity event

js
const subscriptionId = ''; // player id
await api.endLiveActivity('', '', subscriptionId);


$3

* iOSPush
* AndroidPush
* FireOSPush
* ChromeExtensionPush
* ChromePush
* WindowsPush
* SafariLegacyPush
* FirefoxPush
* macOSPush
* HuaweiPush
* SafariPush
* Email
* SMS
Users

$3

js
const user = new OneSignal.User();
const aliasLabel = '';
const aliasId = '';
const subscriptionToken = '';
user.identity = {
    [aliasLabel]: aliasId,
};
user.subscriptions = [
  {
    type: "iOSPush",
    token: subscriptionToken,
  }
];

const createdUser = await api.createUser('', user); assert(createdUser.identity!['onesignal_id'] != null);`

`$3`

js
const oneisgnalAliasLabel = "onesignal_id";
const onesignalAliasId = createdUser.identity!['onesignal_id'];

const fetchedUser = await api.fetchUser('', oneisgnalAliasLabel, onesignalAliasId);`

`$3`

js
const fetchedUser = await api.fetchUser('', alias_label, alias_id);

$3

js
const updateUserRequest: UpdateUserRequest = {
    properties: {
        language: 'fr'
    }
};

const updatedUser = await api.updateUser('', aliasLabel, aliasId, updateUserRequest);`

`$3`

js
await api.deleteUser('', aliasLabel, aliasId);


Subscriptions

$3

js
const createSubscriptionRequestBody: CreateSubscriptionRequestBody = {
    subscription: {
        type: "AndroidPush",
        token: '',
    }
};

const response = await api.createSubscription('', '', '', createSubscriptionRequestBody);`

`$3`

js
const updateSubscriptionRequestBody: UpdateSubscriptionRequestBody = {
    subscription: {
        type: "iOSPush",
        token: '',
    }
};

await api.updateSubscription('', '', updateSubscriptionRequestBody);`

`$3`

js
await api.deleteSubscription('', '');


$3

Transfers the subscription from one user to another.

js
// Setting the user for transfering the subscription to. User is identyfied by an IdentityObject.
const transferSubscriptionRequestBody: TransferSubscriptionRequestBody = {
    identity: otherUserIdentityObject
};

const transferResponse = await api.transferSubscription('', '', transferSubscriptionRequestBody);`

`Aliases`

$3

js
const fetchResponse = await api.fetchAliases('', '');

$3

js
const fetchResponse = await api.fetchUserIdentity('', '', '');

$3

js
const userIdentityRequestBody: UserIdentityRequestBody = {
    identity: {
        ['']: ''
    }
};

const identifyResponse = await api.identifyUserByAlias('', '', '', userIdentityRequestBody);`

`$3`

js
const userIdentityRequestBody: UserIdentityRequestBody = {
    identity: {
        ['']: ''
    }
};

const identifyResponse = await api.identifyUserBySubscriptionId('', '', userIdentityRequestBody);`

`$3`

js
await api.deleteAlias('', '', '', '');

Author

* Website: https://onesignal.com
* Twitter: @onesignal
* Github: @OneSignal

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

@onesignal/node-onesignal

Dist Tags

Welcome to @onesignal/node-onesignal 👋

$3

$3

Node Client SDK

Install

yarn

npm

Usage

Creating a client

$3

$3

$3

API Reference

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Users

$3

$3

$3

$3

$3

Subscriptions

$3

$3

$3

$3

Aliases

$3

$3

$3

$3

$3

Author

🤝 Contributing

Show your support

📝 License

@onesignal/node-onesignal

Dist Tags

Welcome to @onesignal/node-onesignal 👋

$3

$3

Node Client SDK

Install

yarn

npm

Usage

Creating a client

$3

$3

$3

API Reference

$3

$3

$3

$3

$3

`yarn`

`$3`

`API Reference`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Aliases`

`$3`

`$3`

`yarn`

`$3`

`API Reference`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Aliases`

`$3`

`$3`