Skip to content

Add v5.0.0-alpha-02 package updates #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add v5.0.0-alpha-02 package updates #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ You can configure auth parameters passing them like this:

```js
const configuration = OneSignal.createConfiguration({
userAuthKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
restApiKey: '<YOUR_REST_API_KEY>', // App rest api key required for most endpoints
userKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
appKey: '<YOUR_REST_API_KEY>', // App REST API key required for most endpoints
Comment on lines -64 to +65
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect references to auth config keys here

});

const client = new OneSignal.DefaultApi(configuration);
Expand All @@ -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({
userAuthKey: '<YOUR_ORGANIZATION_API_KEY>',
restApiKey: response.basic_auth_key,
userKey: '<YOUR_ORGANIZATION_API_KEY>', // Organization key is only required for creating new apps and other top-level endpoints
appKey: response.basic_auth_key,
});

const client = new OneSignal.DefaultApi(configuration);
Expand All @@ -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`, `User`, and `Segment`.
Examples of important OneSignal objects include `App`, `Notification`, `Player`, and `Segment`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrectly overwriting User here


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.
Expand Down
60 changes: 30 additions & 30 deletions apis/DefaultApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export class DefaultApiRequestFactory extends BaseAPIRequestFactory {
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8")

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

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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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

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

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


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

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


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

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


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

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


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

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


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

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

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

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


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

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

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

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

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

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

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

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


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

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


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

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

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

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


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

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


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

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


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

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


// Body Params
Expand Down
4 changes: 2 additions & 2 deletions auth/auth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export class RestApiKeyAuthentication implements SecurityAuthentication {
}

public async applySecurityAuthentication(context: RequestContext) {
context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
}
}

Expand All @@ -60,7 +60,7 @@ export class UserAuthKeyAuthentication implements SecurityAuthentication {
}

public async applySecurityAuthentication(context: RequestContext) {
context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
}
}

Expand Down
Loading