onesignal 5.14.0 → 5.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84ff3d0dedcffdf89af4a61638585fa1d6ff83421d03f9b5bb450a9882ef410e
-  data.tar.gz: df75bc81b8b50e7e28c5166b927deb30fb9c070a758ea354e7a665d0278d011c
+  metadata.gz: ec6437db60463bed7b865d5ac5059a48bd9352d83634200102457c5bad51cb1c
+  data.tar.gz: db39d74d08c633d7546b1686be1ca8bbb2d750d5296b5d2d8f47edba1f9ec4f6
 SHA512:
-  metadata.gz: 3860a8c07dcb703d00a125df24af63ece484f905e91bca97bc841542f58e716064700324c371a2475b946d5c821cc539be3d669ce8ab888734654a37141c7002
-  data.tar.gz: 8b3a8dfac3cf9f6fd300bb624e15272855b9319b6b6b6a815cb5de57d9618865ed84155fcd167dfaf53fc2b520ea0949e6abffdf912a946eecfc6b1ceb3b2e40
+  metadata.gz: e32af171e6615a73118e0fd1ac82a15912b8314d33e550e597d130d8db305230d1f25864b564933bd9f3e2a7f9f30a9a3ac3fd1a7b3f02f6ffc1016d7f30ff6f
+  data.tar.gz: 559f6275009040ad7b539bb7dfa140f2315561f09908c1e8b34d0e350661c16d143d718c21adc53f6359c306c8ff516f0d23a51cc3cfd0cef86d6b9cb0be5458

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [5.15.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.14.0...v5.15.0) (2026-08-31)
+
+### Features
+
+* add v5.15.0 package updates ([0d7db86](https://github.com/OneSignal/onesignal-ruby-api/commit/0d7db869ab72f1a7d32eb9ff1d35af94b5c0f705))
+* add v5.15.0 package updates ([#128](https://github.com/OneSignal/onesignal-ruby-api/issues/128)) ([eca3f92](https://github.com/OneSignal/onesignal-ruby-api/commit/eca3f92f539d3dbb7833bff193ff7430177a32f2)), closes [OneSignal/api-client-libraries#459](https://github.com/OneSignal/api-client-libraries/issues/459)
+
+## [5.14.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.13.0...v5.14.0) (2026-08-28)
+
+### Features
+
+* add v5.14.0 package updates ([f5bef49](https://github.com/OneSignal/onesignal-ruby-api/commit/f5bef49250856e178d685c0844c92b1f236dec09))
+* add v5.14.0 package updates ([#126](https://github.com/OneSignal/onesignal-ruby-api/issues/126)) ([a65294e](https://github.com/OneSignal/onesignal-ruby-api/commit/a65294ef20e67e16116d27dadb87111ed2a33c1c)), closes [OneSignal/api-client-libraries#452](https://github.com/OneSignal/api-client-libraries/issues/452)
+
 ## [5.13.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.12.0...v5.13.0) (2026-08-25)
 
 ### Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onesignal (5.14.0)
+    onesignal (5.16.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -6,15 +6,15 @@ OneSignal - the Ruby gem for OneSignal
 
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-- API version: 5.14.0
-- Package version: 5.14.0
+- API version: 5.16.0
+- Package version: 5.16.0
 
 ## Installation
 
 Add to your `Gemfile`:
 
 ```ruby
-gem 'onesignal', '~> 5.14.0'
+gem 'onesignal', '~> 5.16.0'
 ```
 
 Then run `bundle install`.

data/docs/BasicNotification.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **included_segments** | **Array<String>** | 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\"]  | [optional] |
+| **included_segments** | **Array<String>** | 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup.  | [optional] |
 | **excluded_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\"]  | [optional] |
 | **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>** | Deprecated alias for `email_to`. 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. Prefer `email_to` in new integrations.  | [optional] |

data/docs/DefaultApi.md

@@ -24,12 +24,14 @@ All URIs are relative to *https://api.onesignal.com*
 | [**delete_subscription**](DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |  |
 | [**delete_template**](DefaultApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete template |
 | [**delete_user**](DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |  |
+| [**estimate_notification_recipients**](DefaultApi.md#estimate_notification_recipients) | **POST** /notifications/count-unsaved | Estimate notification recipients |
 | [**export_events**](DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events | Export CSV of Events |
 | [**export_subscriptions**](DefaultApi.md#export_subscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions |
 | [**get_aliases**](DefaultApi.md#get_aliases) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |  |
 | [**get_aliases_by_subscription**](DefaultApi.md#get_aliases_by_subscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |  |
 | [**get_app**](DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app |
 | [**get_apps**](DefaultApi.md#get_apps) | **GET** /apps | View apps |
+| [**get_email_reputation**](DefaultApi.md#get_email_reputation) | **GET** /apps/{app_id}/email_analytics/delivery_metrics | Get email reputation statistics |
 | [**get_notification**](DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification |
 | [**get_notification_history**](DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History |
 | [**get_notifications**](DefaultApi.md#get_notifications) | **GET** /notifications | View notifications |
@@ -1737,6 +1739,82 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## estimate_notification_recipients
+
+> <EstimateNotificationRecipientsSuccessResponse> estimate_notification_recipients(estimate_notification_recipients_request)
+
+Estimate notification recipients
+
+Returns the estimated number of recipients for a notification's targeting, without creating or sending anything. The returned `count` reflects the same audience-size estimate you would see under \"Choose your target audience\" when composing a message. It is based on the user targeting method you've set and the specific platforms the message is targeted to send to. This endpoint only supports a subset of targeting parameters: `included_segments` is required (its `\"All\"` shorthand targets every subscriber), and `excluded_segments`, `filters`, `include_aliases`, and `target_channel` narrow that audience further. Use `target_channel` to select platforms. `include_subscription_ids` and the other raw subscription id/token fields, and the individual `isIos` / `isAndroid` / etc. platform flags, are not supported. All other notification fields (content, delivery options, and so on) are accepted, but ignored. 
+
+### Examples
+
+```ruby
+require 'onesignal'
+# setup authorization
+OneSignal.configure do |config|
+  # Configure Bearer authorization: rest_api_key
+  config.rest_api_key = 'YOUR_REST_API_KEY'
+
+end
+
+api_instance = OneSignal::DefaultApi.new
+estimate_notification_recipients_request = OneSignal::EstimateNotificationRecipientsRequest.new({app_id: 'app_id_example'}) # EstimateNotificationRecipientsRequest | 
+
+begin
+  # Estimate notification recipients
+  result = api_instance.estimate_notification_recipients(estimate_notification_recipients_request)
+  p result
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->estimate_notification_recipients: #{e}"
+  puts "Status Code: #{e.code}"
+  # `e.error_messages` flattens any error-envelope shape to an Array<String>;
+  # the raw body remains on `e.response_body`.
+  puts "Error Messages: #{e.error_messages}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+#### Using the estimate_notification_recipients_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EstimateNotificationRecipientsSuccessResponse>, Integer, Hash)> estimate_notification_recipients_with_http_info(estimate_notification_recipients_request)
+
+```ruby
+begin
+  # Estimate notification recipients
+  data, status_code, headers = api_instance.estimate_notification_recipients_with_http_info(estimate_notification_recipients_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EstimateNotificationRecipientsSuccessResponse>
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->estimate_notification_recipients_with_http_info: #{e}"
+  puts "Status Code: #{e.code}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **estimate_notification_recipients_request** | [**EstimateNotificationRecipientsRequest**](EstimateNotificationRecipientsRequest.md) |  |  |
+
+### Return type
+
+[**EstimateNotificationRecipientsSuccessResponse**](EstimateNotificationRecipientsSuccessResponse.md)
+
+### Authorization
+
+[rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## export_events
 
 > <ExportEventsSuccessResponse> export_events(notification_id, app_id)
@@ -2202,6 +2280,82 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_email_reputation
+
+> <EmailReputationResponse> get_email_reputation(app_id)
+
+Get email reputation statistics
+
+The email bounce and spam complaint rates received for the app over the last 24 hours, 7 days, and 30 days. Rates are expressed as fractions of successfully delivered emails (for example, `0.02` means 2%). A window reports `0` for both rates when the app has not successfully delivered any email in that period. 
+
+### Examples
+
+```ruby
+require 'onesignal'
+# setup authorization
+OneSignal.configure do |config|
+  # Configure Bearer authorization: rest_api_key
+  config.rest_api_key = 'YOUR_REST_API_KEY'
+
+end
+
+api_instance = OneSignal::DefaultApi.new
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
+
+begin
+  # Get email reputation statistics
+  result = api_instance.get_email_reputation(app_id)
+  p result
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->get_email_reputation: #{e}"
+  puts "Status Code: #{e.code}"
+  # `e.error_messages` flattens any error-envelope shape to an Array<String>;
+  # the raw body remains on `e.response_body`.
+  puts "Error Messages: #{e.error_messages}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+#### Using the get_email_reputation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailReputationResponse>, Integer, Hash)> get_email_reputation_with_http_info(app_id)
+
+```ruby
+begin
+  # Get email reputation statistics
+  data, status_code, headers = api_instance.get_email_reputation_with_http_info(app_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailReputationResponse>
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->get_email_reputation_with_http_info: #{e}"
+  puts "Status Code: #{e.code}"
+  puts "Response Body: #{e.response_body}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | Your OneSignal App ID in UUID v4 format. |  |
+
+### Return type
+
+[**EmailReputationResponse**](EmailReputationResponse.md)
+
+### Authorization
+
+[rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_notification
 
 > <NotificationWithMeta> get_notification(app_id, notification_id)

data/docs/EmailReputationResponse.md

@@ -0,0 +1,22 @@
+# OneSignal::EmailReputationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_24_hours** | [**EmailReputationWindow**](EmailReputationWindow.md) |  | [optional] |
+| **last_7_days** | [**EmailReputationWindow**](EmailReputationWindow.md) |  | [optional] |
+| **last_30_days** | [**EmailReputationWindow**](EmailReputationWindow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailReputationResponse.new(
+  last_24_hours: nil,
+  last_7_days: nil,
+  last_30_days: nil
+)
+```
+

data/docs/EmailReputationWindow.md

@@ -0,0 +1,20 @@
+# OneSignal::EmailReputationWindow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bounce_rate** | **Float** | The fraction of successfully delivered emails that hard or soft bounced during the window. | [optional] |
+| **complaint_rate** | **Float** | The fraction of successfully delivered emails that recipients reported as spam during the window. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EmailReputationWindow.new(
+  bounce_rate: 0.02,
+  complaint_rate: 0.001
+)
+```
+

data/docs/EstimateNotificationRecipientsRequest.md

@@ -0,0 +1,28 @@
+# OneSignal::EstimateNotificationRecipientsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **included_segments** | **Array<String>** | 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup.  | [optional] |
+| **excluded_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\"]  | [optional] |
+| **app_id** | **String** | The OneSignal App ID for your app, which can be found in Keys & IDs. |  |
+| **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [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\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). 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** | Which platforms to count recipients for. Selects the same default platforms Create notification would use for the channel. Individual platform flags (`isIos`, `isAndroid`, etc.) are not supported by this endpoint. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EstimateNotificationRecipientsRequest.new(
+  included_segments: nil,
+  excluded_segments: nil,
+  app_id: nil,
+  filters: nil,
+  include_aliases: nil,
+  target_channel: nil
+)
+```
+

data/docs/EstimateNotificationRecipientsRequestAllOf.md

@@ -0,0 +1,24 @@
+# OneSignal::EstimateNotificationRecipientsRequestAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The OneSignal App ID for your app, which can be found in Keys & IDs. | [optional] |
+| **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [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\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). 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** | Which platforms to count recipients for. Selects the same default platforms Create notification would use for the channel. Individual platform flags (`isIos`, `isAndroid`, etc.) are not supported by this endpoint. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EstimateNotificationRecipientsRequestAllOf.new(
+  app_id: nil,
+  filters: nil,
+  include_aliases: nil,
+  target_channel: nil
+)
+```
+

data/docs/EstimateNotificationRecipientsSuccessResponse.md

@@ -0,0 +1,26 @@
+# OneSignal::EstimateNotificationRecipientsSuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | The estimated audience size based on the user targeting method you've set on the message, and the specific platforms the message is targeted to send to. | [optional] |
+| **uncapped_count** | **Integer** | The estimated audience size before the plan's web push subscriber cap is applied. Present only when `cap_applied` is `true`; `null` otherwise. | [optional] |
+| **cap_applied** | **Boolean** | Whether `count` was reduced because the app is on a plan that caps the number of web push subscribers it can send to. | [optional] |
+| **mobile_suppressed** | **Boolean** | The mobile equivalent of `cap_applied`. Whether mobile push deliveries will be dropped for this send because the org is over its plan's mobile push subscriber cap. `false` when the notification doesn't target any mobile push platforms. | [optional] |
+| **mobile_excluded_count** | **Integer** | How many mobile push recipients the `count` excludes due to the plan's mobile push subscriber cap. `0` when `mobile_suppressed` is `false`. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::EstimateNotificationRecipientsSuccessResponse.new(
+  count: nil,
+  uncapped_count: nil,
+  cap_applied: nil,
+  mobile_suppressed: nil,
+  mobile_excluded_count: nil
+)
+```
+

data/docs/Notification.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **included_segments** | **Array<String>** | 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\"]  | [optional] |
+| **included_segments** | **Array<String>** | 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup.  | [optional] |
 | **excluded_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\"]  | [optional] |
 | **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>** | Deprecated alias for `email_to`. 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. Prefer `email_to` in new integrations.  | [optional] |

data/docs/NotificationTarget.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **included_segments** | **Array<String>** | 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\"]  | [optional] |
+| **included_segments** | **Array<String>** | 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup.  | [optional] |
 | **excluded_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\"]  | [optional] |
 | **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>** | Deprecated alias for `email_to`. 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. Prefer `email_to` in new integrations.  | [optional] |

data/docs/NotificationWithMeta.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **included_segments** | **Array<String>** | 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\"]  | [optional] |
+| **included_segments** | **Array<String>** | 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup.  | [optional] |
 | **excluded_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\"]  | [optional] |
 | **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>** | Deprecated alias for `email_to`. 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. Prefer `email_to` in new integrations.  | [optional] |

data/docs/SegmentNotificationTarget.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **included_segments** | **Array<String>** | 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\"]  | [optional] |
+| **included_segments** | **Array<String>** | 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup.  | [optional] |
 | **excluded_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\"]  | [optional] |
 
 ## Example

data/lib/onesignal/api/default_api.rb

@@ -1479,6 +1479,74 @@ module OneSignal
       return data, status_code, headers
     end
 
+    # Estimate notification recipients
+    # Returns the estimated number of recipients for a notification's targeting, without creating or sending anything. The returned `count` reflects the same audience-size estimate you would see under \"Choose your target audience\" when composing a message. It is based on the user targeting method you've set and the specific platforms the message is targeted to send to. This endpoint only supports a subset of targeting parameters: `included_segments` is required (its `\"All\"` shorthand targets every subscriber), and `excluded_segments`, `filters`, `include_aliases`, and `target_channel` narrow that audience further. Use `target_channel` to select platforms. `include_subscription_ids` and the other raw subscription id/token fields, and the individual `isIos` / `isAndroid` / etc. platform flags, are not supported. All other notification fields (content, delivery options, and so on) are accepted, but ignored. 
+    # @param estimate_notification_recipients_request [EstimateNotificationRecipientsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateNotificationRecipientsSuccessResponse]
+    def estimate_notification_recipients(estimate_notification_recipients_request, opts = {})
+      data, _status_code, _headers = estimate_notification_recipients_with_http_info(estimate_notification_recipients_request, opts)
+      data
+    end
+
+    # Estimate notification recipients
+    # Returns the estimated number of recipients for a notification's targeting, without creating or sending anything. The returned `count` reflects the same audience-size estimate you would see under \"Choose your target audience\" when composing a message. It is based on the user targeting method you've set and the specific platforms the message is targeted to send to. This endpoint only supports a subset of targeting parameters: `included_segments` is required (its `\"All\"` shorthand targets every subscriber), and `excluded_segments`, `filters`, `include_aliases`, and `target_channel` narrow that audience further. Use `target_channel` to select platforms. `include_subscription_ids` and the other raw subscription id/token fields, and the individual `isIos` / `isAndroid` / etc. platform flags, are not supported. All other notification fields (content, delivery options, and so on) are accepted, but ignored. 
+    # @param estimate_notification_recipients_request [EstimateNotificationRecipientsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateNotificationRecipientsSuccessResponse, Integer, Hash)>] EstimateNotificationRecipientsSuccessResponse data, response status code and response headers
+    def estimate_notification_recipients_with_http_info(estimate_notification_recipients_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.estimate_notification_recipients ...'
+      end
+      # verify the required parameter 'estimate_notification_recipients_request' is set
+      if @api_client.config.client_side_validation && estimate_notification_recipients_request.nil?
+        fail ArgumentError, "Missing the required parameter 'estimate_notification_recipients_request' when calling DefaultApi.estimate_notification_recipients"
+      end
+      # resource path
+      local_var_path = '/notifications/count-unsaved'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(estimate_notification_recipients_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EstimateNotificationRecipientsSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['rest_api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.estimate_notification_recipients",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#estimate_notification_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Export CSV of Events
     # Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.
     # @param notification_id [String] The ID of the notification to export events from.
@@ -1879,6 +1947,69 @@ module OneSignal
       return data, status_code, headers
     end
 
+    # Get email reputation statistics
+    # The email bounce and spam complaint rates received for the app over the last 24 hours, 7 days, and 30 days. Rates are expressed as fractions of successfully delivered emails (for example, `0.02` means 2%). A window reports `0` for both rates when the app has not successfully delivered any email in that period. 
+    # @param app_id [String] Your OneSignal App ID in UUID v4 format.
+    # @param [Hash] opts the optional parameters
+    # @return [EmailReputationResponse]
+    def get_email_reputation(app_id, opts = {})
+      data, _status_code, _headers = get_email_reputation_with_http_info(app_id, opts)
+      data
+    end
+
+    # Get email reputation statistics
+    # The email bounce and spam complaint rates received for the app over the last 24 hours, 7 days, and 30 days. Rates are expressed as fractions of successfully delivered emails (for example, &#x60;0.02&#x60; means 2%). A window reports &#x60;0&#x60; for both rates when the app has not successfully delivered any email in that period. 
+    # @param app_id [String] Your OneSignal App ID in UUID v4 format.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailReputationResponse, Integer, Hash)>] EmailReputationResponse data, response status code and response headers
+    def get_email_reputation_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_email_reputation ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling DefaultApi.get_email_reputation"
+      end
+      # resource path
+      local_var_path = '/apps/{app_id}/email_analytics/delivery_metrics'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailReputationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['rest_api_key']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_email_reputation",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_email_reputation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # View notification
     # View the details of a single notification and outcomes associated with it
     # @param app_id [String] 

data/lib/onesignal/api_client.rb

@@ -89,7 +89,7 @@ module OneSignal
       url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
-      opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.14.0'
+      opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.16.0'
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}

data/lib/onesignal/models/basic_notification.rb

@@ -14,7 +14,7 @@ require 'time'
 
 module OneSignal
   class BasicNotification
-    # 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\"] 
+    # 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\"] `\"All\"` is a shorthand for every subscribed user: if the array includes the string `\"All\"` and the app has no segment actually named `All`, it targets all subscribers instead of a literal segment lookup. 
     attr_accessor :included_segments
 
     # 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\"]