@onesignal/node-onesignal 2.1.0-beta1 → 5.0.0-alpha-02

package/README.md

@@ -61,8 +61,8 @@ You can configure auth parameters passing them like this:
 
 ```js
 const configuration = OneSignal.createConfiguration({
-    userKey: '<YOUR_USER_KEY_TOKEN>',
-    appKey: '<YOUR_APP_KEY_TOKEN>',
+    userAuthKey: '<YOUR_USER_AUTH_KEY>',
+    restApiKey: '<YOUR_REST_API_KEY>',
 });
 
 const client = new OneSignal.DefaultApi(configuration);
@@ -76,8 +76,8 @@ parameter. You can then use this to modify your configuration object and create
 const response = await client.createApp(newapp);
 
 const configuration = OneSignal.createConfiguration({
-    userKey: '<YOUR_USER_KEY_TOKEN>',
-    appKey: response.basic_auth_key,
+    userAuthKey: '<YOUR_USER_KEY_TOKEN>',
+    restApiKey: response.basic_auth_key,
 });
 
 const client = new OneSignal.DefaultApi(configuration);
@@ -86,14 +86,14 @@ const client = new OneSignal.DefaultApi(configuration);
 ---
 ## API Reference
 
-> See the full list of [API Endpoints](DefaultApi.MD).
+> See the full list of [API Endpoints](DefaultApi.md).
 
 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`.
+Examples of important OneSignal objects include `App`, `Notification`, `User`, and `Segment`.
 
 For example, see the section below on creating an app. First an app object is created via the instantiation of the `App`
 class. Then, the app instance is modified directly. Finally, we use the `client` to create the app via a remote request.
@@ -586,4 +586,4 @@ Give a ⭐️ if this project helped you!
 
 Copyright © 2023 [OneSignal](https://github.com/OneSignal).
 
-This project is [MIT](https://github.com/OneSignal/node-onesignal/blob/main/LICENSE) licensed.
+This project is [MIT](https://github.com/OneSignal/node-onesignal/blob/main/LICENSE) licensed.