@onesignal/node-onesignal 2.0.1-beta2 → 5.0.0-alpha-01

package/models/{InlineResponse201.ts → SubscriptionBody.ts}

@@ -2,15 +2,15 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
-import { SubscriptionObject } from './SubscriptionObject';
+import { Subscription } from './Subscription';
 import { HttpFile } from '../http/http';
 
-export class InlineResponse201 {
-    'subscription'?: SubscriptionObject;
+export class SubscriptionBody {
+    'subscription'?: Subscription;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -18,12 +18,12 @@ export class InlineResponse201 {
         {
             "name": "subscription",
             "baseName": "subscription",
-            "type": "SubscriptionObject",
+            "type": "Subscription",
             "format": ""
         }    ];
 
     static getAttributeTypeMap() {
-        return InlineResponse201.attributeTypeMap;
+        return SubscriptionBody.attributeTypeMap;
     }
 
     public constructor() {

package/models/{PlayerNotificationTarget.ts → SubscriptionNotificationTarget.ts}

@@ -2,22 +2,17 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
-import { PlayerNotificationTargetIncludeAliases } from './PlayerNotificationTargetIncludeAliases';
 import { HttpFile } from '../http/http';
 
-export class PlayerNotificationTarget {
+export class SubscriptionNotificationTarget {
     /**
-    * 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 
+    * Specific subscription ids to send your notification to. _Does not require API Auth Key._ 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>;
-    /**
-    * Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\"custom-id-assigned-by-api\"] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms. 
-    */
-    'include_external_user_ids'?: Array<string>;
+    'include_subscription_ids'?: Array<string>;
     /**
     * Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call 
     */
@@ -27,44 +22,41 @@ export class PlayerNotificationTarget {
     */
     'include_phone_numbers'?: Array<string>;
     /**
-    * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call 
+    * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call 
     */
     'include_ios_tokens'?: Array<string>;
     /**
-    * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call 
+    * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call 
     */
     'include_wp_wns_uris'?: Array<string>;
     /**
-    * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call 
+    * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call 
     */
     'include_amazon_reg_ids'?: Array<string>;
     /**
-    * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call 
+    * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call 
     */
     'include_chrome_reg_ids'?: Array<string>;
     /**
-    * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call 
+    * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call 
     */
     'include_chrome_web_reg_ids'?: Array<string>;
     /**
-    * Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call 
+    * Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call 
     */
     'include_android_reg_ids'?: Array<string>;
-    'include_aliases'?: PlayerNotificationTargetIncludeAliases;
-    'target_channel'?: PlayerNotificationTargetTargetChannelEnum;
+    /**
+    * Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms.
+    */
+    'include_aliases'?: { [key: string]: Array<string>; };
+    'target_channel'?: SubscriptionNotificationTargetTargetChannelEnum;
 
     static readonly discriminator: string | undefined = undefined;
 
     static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
         {
-            "name": "include_player_ids",
-            "baseName": "include_player_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_external_user_ids",
-            "baseName": "include_external_user_ids",
+            "name": "include_subscription_ids",
+            "baseName": "include_subscription_ids",
             "type": "Array<string>",
             "format": ""
         },
@@ -119,18 +111,18 @@ export class PlayerNotificationTarget {
         {
             "name": "include_aliases",
             "baseName": "include_aliases",
-            "type": "PlayerNotificationTargetIncludeAliases",
+            "type": "{ [key: string]: Array<string>; }",
             "format": ""
         },
         {
             "name": "target_channel",
             "baseName": "target_channel",
-            "type": "PlayerNotificationTargetTargetChannelEnum",
+            "type": "SubscriptionNotificationTargetTargetChannelEnum",
             "format": ""
         }    ];
 
     static getAttributeTypeMap() {
-        return PlayerNotificationTarget.attributeTypeMap;
+        return SubscriptionNotificationTarget.attributeTypeMap;
     }
 
     public constructor() {
@@ -138,5 +130,5 @@ export class PlayerNotificationTarget {
 }
 
 
-export type PlayerNotificationTargetTargetChannelEnum = "push" | "email" | "sms" ;
+export type SubscriptionNotificationTargetTargetChannelEnum = "push" | "email" | "sms" ;
 

package/models/TransferSubscriptionRequestBody.ts

@@ -2,14 +2,14 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
 import { HttpFile } from '../http/http';
 
 export class TransferSubscriptionRequestBody {
-    'identity'?: { [key: string]: any; };
+    'identity'?: { [key: string]: string; };
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -17,7 +17,7 @@ export class TransferSubscriptionRequestBody {
         {
             "name": "identity",
             "baseName": "identity",
-            "type": "{ [key: string]: any; }",
+            "type": "{ [key: string]: string; }",
             "format": ""
         }    ];
 

package/models/UpdateLiveActivityRequest.ts

@@ -2,23 +2,41 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
+import { LanguageStringMap } from './LanguageStringMap';
 import { HttpFile } from '../http/http';
 
 export class UpdateLiveActivityRequest {
     /**
-    * Type of live activity
+    * An internal name to assist with your campaign organization. This does not get displayed in the message itself.
     */
-    'name': UpdateLiveActivityRequestNameEnum;
+    'name': string;
     'event': UpdateLiveActivityRequestEventEnum;
+    /**
+    * This must match the ContentState interface you have defined within your Live Activity in your app.
+    */
     'event_updates': object;
+    'contents'?: LanguageStringMap;
+    'headings'?: LanguageStringMap;
+    /**
+    * Sound file that is included in your app to play instead of the default device notification sound. Omit to disable vibration and sound for the notification.
+    */
+    'sound'?: string;
     /**
-    * Timestamp; only allowed if event is \"end\"
+    * Accepts Unix timestamp in seconds. When time reaches the configured stale date, the system considers the Live Activity out of date, and the ActivityState of the Live Activity changes to ActivityState.stale.
     */
-    'dismiss_at'?: number;
+    'stale_date'?: number;
+    /**
+    * Accepts Unix timestamp in seconds; only allowed if event is \"end\"
+    */
+    'dismissal_date'?: number;
+    /**
+    * Delivery priority through the the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user\'s device. If not set, defaults to 10. Some providers (APNs) allow for a limited budget of high priority notifications per hour, and if that budget is exceeded, the provider may throttle notification delivery.
+    */
+    'priority'?: number;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -26,7 +44,7 @@ export class UpdateLiveActivityRequest {
         {
             "name": "name",
             "baseName": "name",
-            "type": "UpdateLiveActivityRequestNameEnum",
+            "type": "string",
             "format": ""
         },
         {
@@ -42,8 +60,38 @@ export class UpdateLiveActivityRequest {
             "format": ""
         },
         {
-            "name": "dismiss_at",
-            "baseName": "dismiss_at",
+            "name": "contents",
+            "baseName": "contents",
+            "type": "LanguageStringMap",
+            "format": ""
+        },
+        {
+            "name": "headings",
+            "baseName": "headings",
+            "type": "LanguageStringMap",
+            "format": ""
+        },
+        {
+            "name": "sound",
+            "baseName": "sound",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "stale_date",
+            "baseName": "stale_date",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "dismissal_date",
+            "baseName": "dismissal_date",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "priority",
+            "baseName": "priority",
             "type": "number",
             "format": ""
         }    ];
@@ -57,6 +105,5 @@ export class UpdateLiveActivityRequest {
 }
 
 
-export type UpdateLiveActivityRequestNameEnum = "headings" | "contents" | "ios_sound" | "priority_level" ;
 export type UpdateLiveActivityRequestEventEnum = "update" | "end" ;
 

package/models/UpdateLiveActivitySuccessResponse.ts

@@ -2,31 +2,23 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
-import { Notification200Errors } from './Notification200Errors';
 import { HttpFile } from '../http/http';
 
 export class UpdateLiveActivitySuccessResponse {
-    'notification_id'?: string;
-    'errors'?: Notification200Errors;
+    'id'?: string;
 
     static readonly discriminator: string | undefined = undefined;
 
     static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
         {
-            "name": "notification_id",
-            "baseName": "notification_id",
+            "name": "id",
+            "baseName": "id",
             "type": "string",
             "format": ""
-        },
-        {
-            "name": "errors",
-            "baseName": "errors",
-            "type": "Notification200Errors",
-            "format": ""
         }    ];
 
     static getAttributeTypeMap() {

package/models/UpdateUserRequest.ts

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 

package/models/User.ts

@@ -2,20 +2,18 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
 import { PropertiesObject } from './PropertiesObject';
-import { SubscriptionObject } from './SubscriptionObject';
-import { UserSubscriptionOptions } from './UserSubscriptionOptions';
+import { Subscription } from './Subscription';
 import { HttpFile } from '../http/http';
 
 export class User {
     'properties'?: PropertiesObject;
-    'identity'?: { [key: string]: any; };
-    'subscriptions'?: Array<SubscriptionObject>;
-    'subscription_options'?: UserSubscriptionOptions;
+    'identity'?: { [key: string]: string; };
+    'subscriptions'?: Array<Subscription>;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -29,19 +27,13 @@ export class User {
         {
             "name": "identity",
             "baseName": "identity",
-            "type": "{ [key: string]: any; }",
+            "type": "{ [key: string]: string; }",
             "format": ""
         },
         {
             "name": "subscriptions",
             "baseName": "subscriptions",
-            "type": "Array<SubscriptionObject>",
-            "format": ""
-        },
-        {
-            "name": "subscription_options",
-            "baseName": "subscription_options",
-            "type": "UserSubscriptionOptions",
+            "type": "Array<Subscription>",
             "format": ""
         }    ];
 

package/models/{InlineResponse200.ts → UserIdentityBody.ts}

@@ -2,14 +2,14 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
 import { HttpFile } from '../http/http';
 
-export class InlineResponse200 {
-    'identity'?: { [key: string]: any; };
+export class UserIdentityBody {
+    'identity'?: { [key: string]: string; };
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -17,12 +17,12 @@ export class InlineResponse200 {
         {
             "name": "identity",
             "baseName": "identity",
-            "type": "{ [key: string]: any; }",
+            "type": "{ [key: string]: string; }",
             "format": ""
         }    ];
 
     static getAttributeTypeMap() {
-        return InlineResponse200.attributeTypeMap;
+        return UserIdentityBody.attributeTypeMap;
     }
 
     public constructor() {

package/models/{BeginLiveActivityRequest.ts → WebButton.ts}

@@ -2,34 +2,48 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * API Version: 1.2.2
+ * API Version: 5.0.0-alpha-01
  * Contact: devrel@onesignal.com
  */
 
 import { HttpFile } from '../http/http';
 
-export class BeginLiveActivityRequest {
-    'push_token': string;
-    'subscription_id': string;
+export class WebButton {
+    'id': string;
+    'text'?: string;
+    'icon'?: string;
+    'url'?: string;
 
     static readonly discriminator: string | undefined = undefined;
 
     static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
         {
-            "name": "push_token",
-            "baseName": "push_token",
+            "name": "id",
+            "baseName": "id",
             "type": "string",
             "format": ""
         },
         {
-            "name": "subscription_id",
-            "baseName": "subscription_id",
+            "name": "text",
+            "baseName": "text",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "icon",
+            "baseName": "icon",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "url",
+            "baseName": "url",
             "type": "string",
             "format": ""
         }    ];
 
     static getAttributeTypeMap() {
-        return BeginLiveActivityRequest.attributeTypeMap;
+        return WebButton.attributeTypeMap;
     }
 
     public constructor() {

package/models/all.ts

@@ -2,37 +2,26 @@ export * from './App'
 export * from './BasicNotification'
 export * from './BasicNotificationAllOf'
 export * from './BasicNotificationAllOfAndroidBackgroundLayout'
-export * from './BeginLiveActivityRequest'
 export * from './Button'
-export * from './CancelNotificationSuccessResponse'
 export * from './CreateNotificationSuccessResponse'
-export * from './CreatePlayerSuccessResponse'
 export * from './CreateSegmentConflictResponse'
 export * from './CreateSegmentSuccessResponse'
-export * from './CreateSubscriptionRequestBody'
 export * from './CreateUserConflictResponse'
 export * from './CreateUserConflictResponseErrorsInner'
 export * from './CreateUserConflictResponseErrorsItemsMeta'
-export * from './DeletePlayerNotFoundResponse'
-export * from './DeletePlayerSuccessResponse'
-export * from './DeleteSegmentNotFoundResponse'
-export * from './DeleteSegmentSuccessResponse'
 export * from './DeliveryData'
 export * from './ExportEventsSuccessResponse'
-export * from './ExportPlayersRequestBody'
-export * from './ExportPlayersSuccessResponse'
+export * from './ExportSubscriptionsRequestBody'
+export * from './ExportSubscriptionsSuccessResponse'
 export * from './Filter'
-export * from './FilterExpressions'
+export * from './FilterExpression'
 export * from './GenericError'
-export * from './GenericErrorErrorsInner'
-export * from './GetNotificationRequestBody'
-export * from './InlineResponse200'
-export * from './InlineResponse2003'
-export * from './InlineResponse201'
-export * from './InlineResponse202'
+export * from './GenericSuccessBoolResponse'
+export * from './GetNotificationHistoryRequestBody'
+export * from './GetSegmentsSuccessResponse'
 export * from './InvalidIdentifierError'
+export * from './LanguageStringMap'
 export * from './Notification'
-export * from './Notification200Errors'
 export * from './NotificationAllOf'
 export * from './NotificationHistorySuccessResponse'
 export * from './NotificationSlice'
@@ -45,27 +34,21 @@ export * from './OutcomesData'
 export * from './PlatformDeliveryData'
 export * from './PlatformDeliveryDataEmailAllOf'
 export * from './PlatformDeliveryDataSmsAllOf'
-export * from './Player'
-export * from './PlayerNotificationTarget'
-export * from './PlayerNotificationTargetIncludeAliases'
-export * from './PlayerSlice'
+export * from './PropertiesBody'
 export * from './PropertiesDeltas'
 export * from './PropertiesObject'
 export * from './Purchase'
-export * from './RateLimiterError'
+export * from './RateLimitError'
 export * from './Segment'
+export * from './SegmentData'
 export * from './SegmentNotificationTarget'
-export * from './StringMap'
-export * from './SubscriptionObject'
+export * from './Subscription'
+export * from './SubscriptionBody'
+export * from './SubscriptionNotificationTarget'
 export * from './TransferSubscriptionRequestBody'
 export * from './UpdateLiveActivityRequest'
 export * from './UpdateLiveActivitySuccessResponse'
-export * from './UpdatePlayerSuccessResponse'
-export * from './UpdatePlayerTagsRequestBody'
-export * from './UpdatePlayerTagsSuccessResponse'
-export * from './UpdateSubscriptionRequestBody'
 export * from './UpdateUserRequest'
 export * from './User'
-export * from './UserIdentityRequestBody'
-export * from './UserIdentityResponse'
-export * from './UserSubscriptionOptions'
+export * from './UserIdentityBody'
+export * from './WebButton'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onesignal/node-onesignal",
-  "version": "2.0.1-beta2",
+  "version": "5.0.0-alpha-01",
   "description": "OpenAPI client for @onesignal/node-onesignal",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -21,7 +21,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "@types/node": "^20.4.5",
+    "@types/node": "^20.12.8",
     "@types/node-fetch": "^2.5.7",
     "btoa": "^1.2.1",
     "es6-promise": "^4.2.4",

package/servers.ts

@@ -48,6 +48,6 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
     }
 }
 
-export const server1 = new ServerConfiguration<{  }>("https://onesignal.com/api/v1", {  })
+export const server1 = new ServerConfiguration<{  }>("https://api.onesignal.com", {  })
 
 export const servers = [server1];