onesignal 2.2.1 → 5.1.0.pre.beta1

data/docs/{SubscriptionObject.md → Subscription.md}

@@ -1,4 +1,4 @@
-# OneSignal::SubscriptionObject
+# OneSignal::Subscription
 
 ## Properties
 
@@ -9,15 +9,15 @@
 | **token** | **String** |  | [optional] |
 | **enabled** | **Boolean** |  | [optional] |
 | **notification_types** | **Integer** |  | [optional] |
-| **session_time** | **Float** |  | [optional] |
-| **session_count** | **Float** |  | [optional] |
+| **session_time** | **Integer** |  | [optional] |
+| **session_count** | **Integer** |  | [optional] |
 | **sdk** | **String** |  | [optional] |
 | **device_model** | **String** |  | [optional] |
 | **device_os** | **String** |  | [optional] |
 | **rooted** | **Boolean** |  | [optional] |
-| **test_type** | **Float** |  | [optional] |
+| **test_type** | **Integer** |  | [optional] |
 | **app_version** | **String** |  | [optional] |
-| **net_type** | **Float** |  | [optional] |
+| **net_type** | **Integer** |  | [optional] |
 | **carrier** | **String** |  | [optional] |
 | **web_auth** | **String** |  | [optional] |
 | **web_p256** | **String** |  | [optional] |
@@ -27,7 +27,7 @@
 ```ruby
 require 'onesignal'
 
-instance = OneSignal::SubscriptionObject.new(
+instance = OneSignal::Subscription.new(
   id: null,
   type: null,
   token: null,

data/docs/SubscriptionBody.md

@@ -0,0 +1,18 @@
+# OneSignal::SubscriptionBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription** | [**Subscription**](Subscription.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::SubscriptionBody.new(
+  subscription: null
+)
+```
+

data/docs/SubscriptionNotificationTarget.md

@@ -0,0 +1,38 @@
+# OneSignal::SubscriptionNotificationTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_subscription_ids** | **Array<String>** | 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  | [optional] |
+| **include_email_tokens** | **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  | [optional] |
+| **include_phone_numbers** | **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  | [optional] |
+| **include_ios_tokens** | **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  | [optional] |
+| **include_wp_wns_uris** | **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  | [optional] |
+| **include_amazon_reg_ids** | **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  | [optional] |
+| **include_chrome_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  | [optional] |
+| **include_chrome_web_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  | [optional] |
+| **include_android_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  | [optional] |
+| **include_aliases** | **Hash<String, 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. | [optional] |
+| **target_channel** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::SubscriptionNotificationTarget.new(
+  include_subscription_ids: null,
+  include_email_tokens: null,
+  include_phone_numbers: null,
+  include_ios_tokens: null,
+  include_wp_wns_uris: null,
+  include_amazon_reg_ids: null,
+  include_chrome_reg_ids: null,
+  include_chrome_web_reg_ids: null,
+  include_android_reg_ids: null,
+  include_aliases: null,
+  target_channel: null
+)
+```
+

data/docs/TransferSubscriptionRequestBody.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **identity** | **Hash<String, Object>** |  | [optional] |
+| **identity** | **Hash<String, String>** |  | [optional] |
 
 ## Example
 

data/docs/UpdateLiveActivityRequest.md

@@ -4,10 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Type of live activity |  |
+| **name** | **String** | An internal name to assist with your campaign organization. This does not get displayed in the message itself. |  |
 | **event** | **String** |  |  |
-| **event_updates** | **Object** |  |  |
-| **dismiss_at** | **Float** | Timestamp; only allowed if event is \"end\" | [optional] |
+| **event_updates** | **Object** | This must match the ContentState interface you have defined within your Live Activity in your app. |  |
+| **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
+| **headings** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
+| **sound** | **String** | 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. | [optional] |
+| **stale_date** | **Integer** | 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. | [optional] |
+| **dismissal_date** | **Integer** | Accepts Unix timestamp in seconds; only allowed if event is \"end\" | [optional] |
+| **priority** | **Integer** | 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. | [optional] |
 
 ## Example
 
@@ -18,7 +23,12 @@ instance = OneSignal::UpdateLiveActivityRequest.new(
   name: null,
   event: null,
   event_updates: null,
-  dismiss_at: null
+  contents: null,
+  headings: null,
+  sound: null,
+  stale_date: null,
+  dismissal_date: null,
+  priority: null
 )
 ```
 

data/docs/UpdateLiveActivitySuccessResponse.md

@@ -4,8 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **notification_id** | **String** |  | [optional] |
-| **errors** | [**Notification200Errors**](Notification200Errors.md) |  | [optional] |
+| **id** | **String** |  | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'onesignal'
 
 instance = OneSignal::UpdateLiveActivitySuccessResponse.new(
-  notification_id: null,
-  errors: null
+  id: null
 )
 ```
 

data/docs/User.md

@@ -5,9 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **properties** | [**PropertiesObject**](PropertiesObject.md) |  | [optional] |
-| **identity** | **Hash<String, Object>** |  | [optional] |
-| **subscriptions** | [**Array<SubscriptionObject>**](SubscriptionObject.md) |  | [optional] |
-| **subscription_options** | [**UserSubscriptionOptions**](UserSubscriptionOptions.md) |  | [optional] |
+| **identity** | **Hash<String, String>** |  | [optional] |
+| **subscriptions** | [**Array<Subscription>**](Subscription.md) |  | [optional] |
 
 ## Example
 
@@ -17,8 +16,7 @@ require 'onesignal'
 instance = OneSignal::User.new(
   properties: null,
   identity: null,
-  subscriptions: null,
-  subscription_options: null
+  subscriptions: null
 )
 ```
 

data/docs/{InlineResponse200.md → UserIdentityBody.md}

@@ -1,17 +1,17 @@
-# OneSignal::InlineResponse200
+# OneSignal::UserIdentityBody
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **identity** | **Hash<String, Object>** |  | [optional] |
+| **identity** | **Hash<String, String>** |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'onesignal'
 
-instance = OneSignal::InlineResponse200.new(
+instance = OneSignal::UserIdentityBody.new(
   identity: null
 )
 ```

data/docs/WebButton.md

@@ -0,0 +1,24 @@
+# OneSignal::WebButton
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **text** | **String** |  | [optional] |
+| **icon** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::WebButton.new(
+  id: null,
+  text: null,
+  icon: null,
+  url: null
+)
+```
+