@onesignal/node-onesignal 5.3.0-beta1 → 5.4.0-beta1

package/models/SegmentData.ts

@@ -1,94 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { HttpFile } from '../http/http';
-
-export class SegmentData {
-    /**
-    * The segment ID
-    */
-    'id'?: string;
-    /**
-    * The segment name
-    */
-    'name'?: string;
-    /**
-    * Date segment created
-    */
-    'created_at'?: string;
-    /**
-    * Date segment last updated
-    */
-    'updated_at'?: string;
-    /**
-    * The app id
-    */
-    'app_id'?: string;
-    /**
-    * Is the segment read only?
-    */
-    'read_only'?: boolean;
-    /**
-    * Is the segment active?
-    */
-    'is_active'?: boolean;
-
-    static readonly discriminator: string | undefined = undefined;
-
-    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
-        {
-            "name": "id",
-            "baseName": "id",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "name",
-            "baseName": "name",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "created_at",
-            "baseName": "created_at",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "updated_at",
-            "baseName": "updated_at",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "app_id",
-            "baseName": "app_id",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "read_only",
-            "baseName": "read_only",
-            "type": "boolean",
-            "format": ""
-        },
-        {
-            "name": "is_active",
-            "baseName": "is_active",
-            "type": "boolean",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return SegmentData.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-

package/models/SegmentNotificationTarget.ts

@@ -1,44 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { HttpFile } from '../http/http';
-
-export class SegmentNotificationTarget {
-    /**
-    * The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\"Active Users\", \"Inactive Users\"] 
-    */
-    'included_segments'?: Array<string>;
-    /**
-    * Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"] 
-    */
-    'excluded_segments'?: Array<string>;
-
-    static readonly discriminator: string | undefined = undefined;
-
-    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
-        {
-            "name": "included_segments",
-            "baseName": "included_segments",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "excluded_segments",
-            "baseName": "excluded_segments",
-            "type": "Array<string>",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return SegmentNotificationTarget.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-

package/models/StartLiveActivityRequest.ts

@@ -1,177 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { FilterExpression } from './FilterExpression';
-import { LanguageStringMap } from './LanguageStringMap';
-import { HttpFile } from '../http/http';
-
-export class StartLiveActivityRequest {
-    /**
-    * An internal name to assist with your campaign organization. This does not get displayed in the message itself.
-    */
-    'name': string;
-    'event': StartLiveActivityRequestEventEnum;
-    /**
-    * Set a unique activity_id to track and manage the Live Activity.
-    */
-    'activity_id': string;
-    /**
-    * Default/static data to initialize the Live Activity upon start.
-    */
-    'event_attributes': object;
-    /**
-    * Dynamic content used to update the running Live Activity at start. Must match the ContentState interface defined in your app.
-    */
-    'event_updates': object;
-    'contents': LanguageStringMap;
-    'headings': LanguageStringMap;
-    /**
-    * 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.
-    */
-    'stale_date'?: number;
-    /**
-    * Delivery priority through 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.
-    */
-    'priority'?: number;
-    /**
-    * iOS 15+. A score to indicate how a notification should be displayed when grouped. Use a float between 0-1.
-    */
-    'ios_relevance_score'?: number;
-    /**
-    * Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it\'s important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again.   See Idempotent Notification Requests for more details writeOnly: true 
-    */
-    'idempotency_key'?: string;
-    /**
-    * 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>; };
-    /**
-    * Specific subscription ids to target. Not compatible with other targeting parameters.
-    */
-    'include_subscription_ids'?: Array<string>;
-    /**
-    * Segment names to include. Only compatible with excluded_segments.
-    */
-    'included_segments'?: Array<string>;
-    /**
-    * Segment names to exclude. Only compatible with included_segments.
-    */
-    'excluded_segments'?: Array<string>;
-    'filters'?: Array<FilterExpression>;
-
-    static readonly discriminator: string | undefined = undefined;
-
-    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
-        {
-            "name": "name",
-            "baseName": "name",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "event",
-            "baseName": "event",
-            "type": "StartLiveActivityRequestEventEnum",
-            "format": ""
-        },
-        {
-            "name": "activity_id",
-            "baseName": "activity_id",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "event_attributes",
-            "baseName": "event_attributes",
-            "type": "object",
-            "format": ""
-        },
-        {
-            "name": "event_updates",
-            "baseName": "event_updates",
-            "type": "object",
-            "format": ""
-        },
-        {
-            "name": "contents",
-            "baseName": "contents",
-            "type": "LanguageStringMap",
-            "format": ""
-        },
-        {
-            "name": "headings",
-            "baseName": "headings",
-            "type": "LanguageStringMap",
-            "format": ""
-        },
-        {
-            "name": "stale_date",
-            "baseName": "stale_date",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "priority",
-            "baseName": "priority",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "ios_relevance_score",
-            "baseName": "ios_relevance_score",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "idempotency_key",
-            "baseName": "idempotency_key",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "include_aliases",
-            "baseName": "include_aliases",
-            "type": "{ [key: string]: Array<string>; }",
-            "format": ""
-        },
-        {
-            "name": "include_subscription_ids",
-            "baseName": "include_subscription_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "included_segments",
-            "baseName": "included_segments",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "excluded_segments",
-            "baseName": "excluded_segments",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "filters",
-            "baseName": "filters",
-            "type": "Array<FilterExpression>",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return StartLiveActivityRequest.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-
-
-export type StartLiveActivityRequestEventEnum = "start" ;
-

package/models/StartLiveActivitySuccessResponse.ts

@@ -1,31 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { HttpFile } from '../http/http';
-
-export class StartLiveActivitySuccessResponse {
-    'notification_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",
-            "type": "string",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return StartLiveActivitySuccessResponse.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-

package/models/Subscription.ts

@@ -1,146 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { HttpFile } from '../http/http';
-
-export class Subscription {
-    'id'?: string;
-    'type'?: SubscriptionTypeEnum;
-    'token'?: string;
-    'enabled'?: boolean;
-    'notification_types'?: number;
-    'session_time'?: number;
-    'session_count'?: number;
-    'sdk'?: string;
-    'device_model'?: string;
-    'device_os'?: string;
-    'rooted'?: boolean;
-    'test_type'?: number;
-    'app_version'?: string;
-    'net_type'?: number;
-    'carrier'?: string;
-    'web_auth'?: string;
-    'web_p256'?: string;
-
-    static readonly discriminator: string | undefined = undefined;
-
-    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
-        {
-            "name": "id",
-            "baseName": "id",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "type",
-            "baseName": "type",
-            "type": "SubscriptionTypeEnum",
-            "format": ""
-        },
-        {
-            "name": "token",
-            "baseName": "token",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "enabled",
-            "baseName": "enabled",
-            "type": "boolean",
-            "format": ""
-        },
-        {
-            "name": "notification_types",
-            "baseName": "notification_types",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "session_time",
-            "baseName": "session_time",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "session_count",
-            "baseName": "session_count",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "sdk",
-            "baseName": "sdk",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "device_model",
-            "baseName": "device_model",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "device_os",
-            "baseName": "device_os",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "rooted",
-            "baseName": "rooted",
-            "type": "boolean",
-            "format": ""
-        },
-        {
-            "name": "test_type",
-            "baseName": "test_type",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "app_version",
-            "baseName": "app_version",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "net_type",
-            "baseName": "net_type",
-            "type": "number",
-            "format": ""
-        },
-        {
-            "name": "carrier",
-            "baseName": "carrier",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "web_auth",
-            "baseName": "web_auth",
-            "type": "string",
-            "format": ""
-        },
-        {
-            "name": "web_p256",
-            "baseName": "web_p256",
-            "type": "string",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return Subscription.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-
-
-export type SubscriptionTypeEnum = "iOSPush" | "AndroidPush" | "FireOSPush" | "ChromeExtensionPush" | "ChromePush" | "WindowsPush" | "SafariLegacyPush" | "FirefoxPush" | "macOSPush" | "HuaweiPush" | "SafariPush" | "Email" | "SMS" ;
-

package/models/SubscriptionBody.ts

@@ -1,32 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { Subscription } from './Subscription';
-import { HttpFile } from '../http/http';
-
-export class SubscriptionBody {
-    'subscription'?: Subscription;
-
-    static readonly discriminator: string | undefined = undefined;
-
-    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
-        {
-            "name": "subscription",
-            "baseName": "subscription",
-            "type": "Subscription",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return SubscriptionBody.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-

package/models/SubscriptionNotificationTarget.ts

@@ -1,134 +0,0 @@
-/**
- * OneSignal
- * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
- *
- * API Version: 5.3.0
- * Contact: devrel@onesignal.com
- */
-
-import { HttpFile } from '../http/http';
-
-export class SubscriptionNotificationTarget {
-    /**
-    * 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_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 
-    */
-    'include_email_tokens'?: Array<string>;
-    /**
-    * Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call 
-    */
-    'include_phone_numbers'?: Array<string>;
-    /**
-    * 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_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_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_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_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_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>;
-    /**
-    * 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_subscription_ids",
-            "baseName": "include_subscription_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_email_tokens",
-            "baseName": "include_email_tokens",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_phone_numbers",
-            "baseName": "include_phone_numbers",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_ios_tokens",
-            "baseName": "include_ios_tokens",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_wp_wns_uris",
-            "baseName": "include_wp_wns_uris",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_amazon_reg_ids",
-            "baseName": "include_amazon_reg_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_chrome_reg_ids",
-            "baseName": "include_chrome_reg_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_chrome_web_reg_ids",
-            "baseName": "include_chrome_web_reg_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_android_reg_ids",
-            "baseName": "include_android_reg_ids",
-            "type": "Array<string>",
-            "format": ""
-        },
-        {
-            "name": "include_aliases",
-            "baseName": "include_aliases",
-            "type": "{ [key: string]: Array<string>; }",
-            "format": ""
-        },
-        {
-            "name": "target_channel",
-            "baseName": "target_channel",
-            "type": "SubscriptionNotificationTargetTargetChannelEnum",
-            "format": ""
-        }    ];
-
-    static getAttributeTypeMap() {
-        return SubscriptionNotificationTarget.attributeTypeMap;
-    }
-
-    public constructor() {
-    }
-}
-
-
-export type SubscriptionNotificationTargetTargetChannelEnum = "push" | "email" | "sms" ;
-