Skip to content

Commit cbd4585

Browse files
author
OneSignal
committed
feat: add v5.0.0-alpha-02 package updates
1 parent 2b7b58e commit cbd4585

16 files changed

+210
-149
lines changed

‎README.md

+6-6
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+
userKey: '<YOUR_USER_KEY_TOKEN>',
65+
appKey: '<YOUR_APP_KEY_TOKEN>',
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-
userAuthKey: '<YOUR_ORGANIZATION_API_KEY>',
80-
restApiKey: response.basic_auth_key,
79+
userKey: '<YOUR_USER_KEY_TOKEN>',
80+
appKey: 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`, `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.

‎apis/DefaultApi.ts

+30-30
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
7373
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
7474

7575
// Always add the One Signal telemetry to the request.
76-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
76+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
7777

7878
// Query Params
7979
if (appId !== undefined) {
@@ -141,7 +141,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
141141
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
142142

143143
// Always add the One Signal telemetry to the request.
144-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
144+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
145145

146146

147147
// Body Params
@@ -207,7 +207,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
207207
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
208208

209209
// Always add the One Signal telemetry to the request.
210-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
210+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
211211

212212

213213
// Body Params
@@ -258,7 +258,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
258258
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
259259

260260
// Always add the One Signal telemetry to the request.
261-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
261+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
262262

263263

264264
// Body Params
@@ -309,7 +309,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
309309
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
310310

311311
// Always add the One Signal telemetry to the request.
312-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
312+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
313313

314314

315315
// Body Params
@@ -363,7 +363,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
363363
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
364364

365365
// Always add the One Signal telemetry to the request.
366-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
366+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
367367

368368

369369
// Body Params
@@ -437,7 +437,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
437437
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
438438

439439
// Always add the One Signal telemetry to the request.
440-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
440+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
441441

442442

443443
// Body Params
@@ -495,7 +495,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
495495
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
496496

497497
// Always add the One Signal telemetry to the request.
498-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
498+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
499499

500500

501501
// Body Params
@@ -570,7 +570,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
570570
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
571571

572572
// Always add the One Signal telemetry to the request.
573-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
573+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
574574

575575

576576
let authMethod: SecurityAuthentication | undefined;
@@ -619,7 +619,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
619619
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
620620

621621
// Always add the One Signal telemetry to the request.
622-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
622+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
623623

624624

625625
let authMethod: SecurityAuthentication | undefined;
@@ -667,7 +667,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
667667
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
668668

669669
// Always add the One Signal telemetry to the request.
670-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
670+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
671671

672672

673673
let authMethod: SecurityAuthentication | undefined;
@@ -723,7 +723,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
723723
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
724724

725725
// Always add the One Signal telemetry to the request.
726-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
726+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
727727

728728

729729
let authMethod: SecurityAuthentication | undefined;
@@ -771,7 +771,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
771771
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
772772

773773
// Always add the One Signal telemetry to the request.
774-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
774+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
775775

776776
// Query Params
777777
if (appId !== undefined) {
@@ -819,7 +819,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
819819
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
820820

821821
// Always add the One Signal telemetry to the request.
822-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
822+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
823823

824824

825825
// Body Params
@@ -886,7 +886,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
886886
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
887887

888888
// Always add the One Signal telemetry to the request.
889-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
889+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
890890

891891

892892
let authMethod: SecurityAuthentication | undefined;
@@ -934,7 +934,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
934934
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
935935

936936
// Always add the One Signal telemetry to the request.
937-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
937+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
938938

939939

940940
let authMethod: SecurityAuthentication | undefined;
@@ -975,7 +975,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
975975
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
976976

977977
// Always add the One Signal telemetry to the request.
978-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
978+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
979979

980980

981981
let authMethod: SecurityAuthentication | undefined;
@@ -1008,7 +1008,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
10081008
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
10091009

10101010
// Always add the One Signal telemetry to the request.
1011-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1011+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
10121012

10131013

10141014
let authMethod: SecurityAuthentication | undefined;
@@ -1056,7 +1056,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
10561056
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
10571057

10581058
// Always add the One Signal telemetry to the request.
1059-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1059+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
10601060

10611061
// Query Params
10621062
if (appId !== undefined) {
@@ -1109,7 +1109,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
11091109
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
11101110

11111111
// Always add the One Signal telemetry to the request.
1112-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1112+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
11131113

11141114

11151115
// Body Params
@@ -1166,7 +1166,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
11661166
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
11671167

11681168
// Always add the One Signal telemetry to the request.
1169-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1169+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
11701170

11711171
// Query Params
11721172
if (appId !== undefined) {
@@ -1242,7 +1242,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
12421242
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
12431243

12441244
// Always add the One Signal telemetry to the request.
1245-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1245+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
12461246

12471247
// Query Params
12481248
if (outcomeNames !== undefined) {
@@ -1312,7 +1312,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
13121312
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
13131313

13141314
// Always add the One Signal telemetry to the request.
1315-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1315+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
13161316

13171317
// Query Params
13181318
if (offset !== undefined) {
@@ -1378,7 +1378,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
13781378
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
13791379

13801380
// Always add the One Signal telemetry to the request.
1381-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1381+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
13821382

13831383

13841384
let authMethod: SecurityAuthentication | undefined;
@@ -1433,7 +1433,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
14331433
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
14341434

14351435
// Always add the One Signal telemetry to the request.
1436-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1436+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
14371437

14381438

14391439
// Body Params
@@ -1500,7 +1500,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
15001500
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
15011501

15021502
// Always add the One Signal telemetry to the request.
1503-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1503+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
15041504

15051505
// Query Params
15061506
if (token !== undefined) {
@@ -1553,7 +1553,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
15531553
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
15541554

15551555
// Always add the One Signal telemetry to the request.
1556-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1556+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
15571557

15581558

15591559
// Body Params
@@ -1620,7 +1620,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
16201620
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
16211621

16221622
// Always add the One Signal telemetry to the request.
1623-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1623+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
16241624

16251625

16261626
// Body Params
@@ -1686,7 +1686,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
16861686
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
16871687

16881688
// Always add the One Signal telemetry to the request.
1689-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1689+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
16901690

16911691

16921692
// Body Params
@@ -1760,7 +1760,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
17601760
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")
17611761

17621762
// Always add the One Signal telemetry to the request.
1763-
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.1");
1763+
requestContext.setHeaderParam("OS-Usage-Data", "kind=sdk, sdk-name=onesignal-typescript, version=5.0.0-alpha-02");
17641764

17651765

17661766
// Body Params

‎auth/auth.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export class RestApiKeyAuthentication implements SecurityAuthentication {
4040
}
4141

4242
public async applySecurityAuthentication(context: RequestContext) {
43-
context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
43+
context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
4444
}
4545
}
4646

@@ -60,7 +60,7 @@ export class UserAuthKeyAuthentication implements SecurityAuthentication {
6060
}
6161

6262
public async applySecurityAuthentication(context: RequestContext) {
63-
context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
63+
context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
6464
}
6565
}
6666

0 commit comments

Comments
 (0)