Skip to content

Commit fe3bf2d

Browse files
authored
Merge pull request #81 from OneSignal/api
Update README.md for 5.0.0-alpha-01
2 parents c5c1f5a + 4548798 commit fe3bf2d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ You can configure auth parameters passing them like this:
6161

6262
```js
6363
const configuration = OneSignal.createConfiguration({
64-
userKey: '<YOUR_USER_KEY_TOKEN>',
65-
appKey: '<YOUR_APP_KEY_TOKEN>',
64+
userAuthKey: '<YOUR_USER_AUTH_KEY>',
65+
restApiKey: '<YOUR_REST_API_KEY>',
6666
});
6767

6868
const client = new OneSignal.DefaultApi(configuration);
@@ -76,8 +76,8 @@ parameter. You can then use this to modify your configuration object and create
7676
const response = await client.createApp(newapp);
7777

7878
const configuration = OneSignal.createConfiguration({
79-
userKey: '<YOUR_USER_KEY_TOKEN>',
80-
appKey: response.basic_auth_key,
79+
userAuthKey: '<YOUR_USER_KEY_TOKEN>',
80+
restApiKey: response.basic_auth_key,
8181
});
8282

8383
const client = new OneSignal.DefaultApi(configuration);
@@ -86,14 +86,14 @@ const client = new OneSignal.DefaultApi(configuration);
8686
---
8787
## API Reference
8888

89-
> See the full list of [API Endpoints](DefaultApi.MD).
89+
> See the full list of [API Endpoints](DefaultApi.md).
9090
9191
To make stateful changes requests should take on the following pattern:
9292
1. create or get an object
9393
2. make changes to that object
9494
3. pass the object to the request function to make the changes
9595

96-
Examples of important OneSignal objects include `App`, `Notification`, `Player`, and `Segment`.
96+
Examples of important OneSignal objects include `App`, `Notification`, `User`, and `Segment`.
9797

9898
For example, see the section below on creating an app. First an app object is created via the instantiation of the `App`
9999
class. Then, the app instance is modified directly. Finally, we use the `client` to create the app via a remote request.

0 commit comments

Comments
 (0)