Merge pull request #31 from OneSignal/api

Dependency Update

Author: kesheshyan

.github/workflows/npm_deploy.yml

@@ -0,0 +1,20 @@
+name: NPM Publish
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 19
+      - name: Publish package
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM }}

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## January 2022
+
+### `1.0.0-beta4` - 02/25/2022
+#### Added
+- .npmignore file
+
+#### Fixed
+- Missing `dist` directory since npm was ignoring it due to lack of .npmignore
+
+### `1.0.0-beta5` - 10/1/2022
+#### Api Changes
+- Configuration setup has been simplified and streamlined. Now it looks like this:
+  ```js
+    const configuration = OneSignal.createConfiguration({
+        userKey: USER_KEY_TOKEN,
+        appKey: APP_KEY_TOKEN,
+    });
+  ```
+- Player ID is no longer required when creating a player
+
+#### Fixed
+- Bug in the OpenAPI schema not allowing users to use filters when creating a notification.
+- Bug in the OpenAPI schema not allowing to set the notification name.

README.md

@@ -163,6 +163,25 @@ const udpateAppResponse = await client.updateApp('<existing_app_id>', app);
 ### Creating a notification
 Sends a notification to your users.
 
+**Example**
+```js
+const notification = new OneSignal.Notification();
+notification.app_id = app.id;
+// Name property may be required in some case, for instance when sending an SMS.
+notification.name = "test_notification_name";
+notification.contents = {
+  en: "Gig'em Ags"
+}
+
+// required for Huawei
+notification.headings = {
+  en: "Gig'em Ags"
+}
+const notification = await client.createNotification(notification);
+```
+### Creating a notification using Filters
+Sends a notification to your users filtered by specific criteria.
+
 **Example**
 ```js
 const notification = new OneSignal.Notification();
@@ -176,6 +195,17 @@ notification.contents = {
 notification.headings = {
   en: "Gig'em Ags"
 }
+
+// Find all the users that have not spent any amount in USD on IAP.
+// https://documentation.onesignal.com/reference/create-notification#send-to-users-based-on-filters
+notification.filters = [
+    {
+        field: 'amount_spent',
+        relation: '=',
+        value: "0"
+    },
+];
+
 const notification = await client.createNotification(notification);
 ```
 
@@ -313,19 +343,18 @@ const updatePlayerResponse = await client.updatePlayer('<player id>', player);
 
 ### Updating player tags
 Update an existing device's tags in one of your OneSignal apps using the External User ID.
-#### ⚠️ Android SDK Data Synchronization
-Tags added through the Android SDK tagging methods may not update if using the API to change or update the same tag.
-For example, if you use SDK method sendTag("key", "value1") then update the tag value to "value2" with this API endpoint.
-You will not be able to set the value back to "value1" through the SDK, you will need to change it to something different 
-through the SDK to be reset.
 
-Recommendations if using this Endpoint on Android Mobile Apps:
-1. Do not use the same tag keys for SDK and API updates
-2. If you want to use the same key for both SDK and API updates, call the SDK getTags method first to update the 
-device's tags.
+```js
+const playerToUpdate = new OneSignal.Player();
 
-⚠️ This is only applicable on the Android Mobile App SDKs.
+player.app_id = APP_ID;
+player.device_type = 1;
 
+playerToUpdate.external_user_id = 'your_player_external_id'; // setting the same external_user_id as before
+const updatePlayerTagsRequestBody = new OneSignal.UpdatePlayerTagsRequestBody();
+updatePlayerTagsRequestBody.tags = {'typescript_test_tag': 1};
+const updatePlayerResponse = await api.updatePlayerTags(APP_ID, PLAYER_EXTERNAL_USER_ID, updatePlayerTagsRequestBody);
+```
 #### Deleting Tags
 To delete a tag, include its key and set its value to blank (""). Omitting a key/value will not delete it.
 

models/App.ts

@@ -9,7 +9,7 @@
 import { HttpFile } from '../http/http';
 
 export class App {
-    'id': string;
+    'id'?: string;
     /**
     * The name of your app, as displayed on your apps list on the dashboard.  This can be renamed.
     */

models/BasicNotification.ts

@@ -9,6 +9,7 @@
 import { BasicNotificationAllOf } from './BasicNotificationAllOf';
 import { BasicNotificationAllOfAndroidBackgroundLayout } from './BasicNotificationAllOfAndroidBackgroundLayout';
 import { Button } from './Button';
+import { Filter } from './Filter';
 import { NotificationTarget } from './NotificationTarget';
 import { StringMap } from './StringMap';
 import { HttpFile } from '../http/http';
@@ -23,54 +24,6 @@ export class BasicNotification {
     */
     'excluded_segments'?: Array<string>;
     /**
-    * relation = \">\" or \"<\" hours_ago = number of hours before or after the users last session. Example: \"1.1\" 
-    */
-    'last_session'?: string;
-    /**
-    * relation = \">\" or \"<\" hours_ago = number of hours before or after the users first session. Example: \"1.1\" 
-    */
-    'first_session'?: string;
-    /**
-    * relation = \">\", \"<\", \"=\" or \"!=\" value = number sessions. Example: \"1\" 
-    */
-    'session_count'?: string;
-    /**
-    * relation = \">\", \"<\", \"=\" or \"!=\" value = Time in seconds the user has been in your app. Example: \"3600\" 
-    */
-    'session_time'?: string;
-    /**
-    * relation = \">\", \"<\", or \"=\" value = Amount in USD a user has spent on IAP (In App Purchases). Example: \"0.99\" 
-    */
-    'amount_spent'?: string;
-    /**
-    * relation = \">\", \"<\" or \"=\" key = SKU purchased in your app as an IAP (In App Purchases). Example: \"com.domain.100coinpack\" value = value of SKU to compare to. Example: \"0.99\" 
-    */
-    'bought_sku'?: string;
-    /**
-    * relation = \">\", \"<\", \"=\", \"!=\", \"exists\", \"not_exists\", \"time_elapsed_gt\" (paid plan only) or \"time_elapsed_lt\" (paid plan only) See Time Operators key = Tag key to compare. value = Tag value to compare. Not required for \"exists\" or \"not_exists\". Example: See Formatting Filters 
-    */
-    'tag'?: string;
-    /**
-    * relation = \"=\" or \"!=\" value = 2 character language code. Example: \"en\". For a list of all language codes see Language & Localization. 
-    */
-    'language'?: string;
-    /**
-    * relation = \">\", \"<\", \"=\" or \"!=\" value = app version. Example: \"1.0.0\" 
-    */
-    'app_version'?: string;
-    /**
-    * radius = in meters lat = latitude long = longitude 
-    */
-    'location'?: string;
-    /**
-    * value = email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter 
-    */
-    'email'?: string;
-    /**
-    * relation = \"=\" value = 2-digit Country code Example: \"field\": \"country\", \"relation\": \"=\", \"value\", \"US\" 
-    */
-    'country'?: string;
-    /**
     * Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call 
     */
     'include_player_ids'?: Array<string>;
@@ -441,6 +394,7 @@ export class BasicNotification {
     * Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. 
     */
     'sms_media_urls'?: Array<string>;
+    'filters'?: Array<Filter>;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -457,78 +411,6 @@ export class BasicNotification {
             "type": "Array<string>",
             "format": ""
         },
-        {
-            "name": "last_session",
-            "baseName": "last_session",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "first_session",
-            "baseName": "first_session",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "session_count",
-            "baseName": "session_count",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "session_time",
-            "baseName": "session_time",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "amount_spent",
-            "baseName": "amount_spent",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "bought_sku",
-            "baseName": "bought_sku",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "tag",
-            "baseName": "tag",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "language",
-            "baseName": "language",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "app_version",
-            "baseName": "app_version",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "location",
-            "baseName": "location",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "email",
-            "baseName": "email",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "country",
-            "baseName": "country",
-            "type": "string",
-            "format": ""
-        },
         {
             "name": "include_player_ids",
             "baseName": "include_player_ids",
@@ -1116,6 +998,12 @@ export class BasicNotification {
             "baseName": "sms_media_urls",
             "type": "Array<string>",
             "format": ""
+        },
+        {
+            "name": "filters",
+            "baseName": "filters",
+            "type": "Array<Filter>",
+            "format": ""
         }    ];
 
     static getAttributeTypeMap() {

models/BasicNotificationAllOf.ts

@@ -8,6 +8,7 @@
 
 import { BasicNotificationAllOfAndroidBackgroundLayout } from './BasicNotificationAllOfAndroidBackgroundLayout';
 import { Button } from './Button';
+import { Filter } from './Filter';
 import { StringMap } from './StringMap';
 import { HttpFile } from '../http/http';
 
@@ -343,6 +344,7 @@ export class BasicNotificationAllOf {
     * Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. 
     */
     'sms_media_urls'?: Array<string>;
+    'filters'?: Array<Filter>;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -874,6 +876,12 @@ export class BasicNotificationAllOf {
             "baseName": "sms_media_urls",
             "type": "Array<string>",
             "format": ""
+        },
+        {
+            "name": "filters",
+            "baseName": "filters",
+            "type": "Array<Filter>",
+            "format": ""
         }    ];
 
     static getAttributeTypeMap() {

models/Filter.ts

@@ -18,7 +18,7 @@ export class Filter {
     */
     'key'?: string;
     /**
-    * Constant value to use as the second operand in the filter expression.  This value is *required* when the relation operator is a binary operator.
+    * Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator.
     */
     'value'?: string;
     /**
@@ -63,5 +63,5 @@ export class Filter {
 }
 
 
-export type FilterRelationEnum = ">" | "<" | "=" | "!=" | "exists" | "not_exists" | "time_elapsed_gt" | "time_elapsed_lt" ;
+export type FilterRelationEnum = ">" | "<" | "=" | "!=" | "exists" | "not_exists" | "time_elapsed_gt" | "time_elapsed_lt" ;
 

models/FilterExpressions.ts

@@ -20,7 +20,7 @@ export class FilterExpressions {
     */
     'key'?: string;
     /**
-    * Constant value to use as the second operand in the filter expression.  This value is *required* when the relation operator is a binary operator.
+    * Constant value to use as the second operand in the filter expression. This value is *required* when the relation operator is a binary operator.
     */
     'value'?: string;
     /**
@@ -75,6 +75,6 @@ export class FilterExpressions {
 }
 
 
-export type FilterExpressionsRelationEnum = ">" | "<" | "=" | "!=" | "exists" | "not_exists" | "time_elapsed_gt" | "time_elapsed_lt" ;
+export type FilterExpressionsRelationEnum = ">" | "<" | "=" | "!=" | "exists" | "not_exists" | "time_elapsed_gt" | "time_elapsed_lt" ;
 export type FilterExpressionsOperatorEnum = "OR" | "AND" ;