Skip to content

Commit 473bc11

Browse files
authored
Merge pull request #110 from OneSignal/user-api-updates
Add v5.1.0-beta1 package updates
2 parents 2b7b58e + 8aee8fb commit 473bc11

File tree

72 files changed

+309
-277
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+309
-277
lines changed

.github/ISSUE_TEMPLATE/ask-question.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 🙋‍♂️ Ask a question
22
description: Tell us what's on your mind
3-
title: "[question]: "
4-
labels: ["triage"]
3+
title: "[Question]: "
4+
labels: ["Question"]
55
body:
66
- type: markdown
77
attributes:
@@ -22,4 +22,4 @@ body:
2222
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
2323
options:
2424
- label: I agree to follow this project's Code of Conduct
25-
required: true
25+
required: true

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 🪳 Bug report
22
description: File a bug report
33
title: "[Bug]: "
4-
labels: ["bug", "triage"]
4+
labels: ["Bug"]
55
body:
66
- type: markdown
77
attributes:
@@ -48,4 +48,4 @@ body:
4848
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
4949
options:
5050
- label: I agree to follow this project's Code of Conduct
51-
required: true
51+
required: true

.github/ISSUE_TEMPLATE/general-feedback.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 📣 General feedback
22
description: Tell us what's on your mind
3-
title: "[Bug]: "
4-
labels: ["triage"]
3+
title: "[Feedback]: "
4+
labels: ["Feedback"]
55
body:
66
- type: markdown
77
attributes:
@@ -22,4 +22,4 @@ body:
2222
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
2323
options:
2424
- label: I agree to follow this project's Code of Conduct
25-
required: true
25+
required: true

.github/workflows/project.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Add issues to project
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
8+
jobs:
9+
add-to-project:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Add issue to project
13+
uses: actions/add-to-project@v1.0.2
14+
with:
15+
# SDK Server Project
16+
project-url: https://github.com/orgs/OneSignal/projects/11
17+
github-token: ${{ secrets.GH_PROJECTS_TOKEN }}

DefaultApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ Name | Type | Description | Notes
296296

297297
### Authorization
298298

299-
[user_auth_key](README.md#user_auth_key)
299+
[organization_api_key](README.md#organization_api_key)
300300

301301
### HTTP request headers
302302

@@ -1167,7 +1167,7 @@ Name | Type | Description | Notes
11671167

11681168
### Authorization
11691169

1170-
[user_auth_key](README.md#user_auth_key)
1170+
[organization_api_key](README.md#organization_api_key)
11711171

11721172
### HTTP request headers
11731173

@@ -1217,7 +1217,7 @@ This endpoint does not need any parameter.
12171217

12181218
### Authorization
12191219

1220-
[user_auth_key](README.md#user_auth_key)
1220+
[organization_api_key](README.md#organization_api_key)
12211221

12221222
### HTTP request headers
12231223

@@ -1813,7 +1813,7 @@ Name | Type | Description | Notes
18131813

18141814
### Authorization
18151815

1816-
[user_auth_key](README.md#user_auth_key)
1816+
[organization_api_key](README.md#organization_api_key)
18171817

18181818
### HTTP request headers
18191819

README.md

Lines changed: 5 additions & 5 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-
userAuthKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
65-
restApiKey: '<YOUR_REST_API_KEY>', // App rest api key required for most endpoints
64+
organizationApiKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
65+
restApiKey: '<YOUR_REST_API_KEY>', // App REST API key required for most endpoints
6666
});
6767

6868
const client = new OneSignal.DefaultApi(configuration);
@@ -76,7 +76,7 @@ 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-
userAuthKey: '<YOUR_ORGANIZATION_API_KEY>',
79+
organizationApiKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
8080
restApiKey: response.basic_auth_key,
8181
});
8282

@@ -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`, `User`, and `Segment`.
96+
Examples of important OneSignal objects include `App`, `Notification`, `Player`, 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)