onesignal 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b822e8ac691cee158cc2ea0d95286eaae7d13eba0c01a3920a499948d1bc238
-  data.tar.gz: 0ee3fb8b53514f2f03c125d0088556f058fd299df668d2b708066b5ad7842004
+  metadata.gz: 6e2a0e4d30e7deb7aa557bb055f0584d97c2fe1acce3c091635f364862fe7abf
+  data.tar.gz: 7a34c0144039ac9132079a3a1d2ad611a62cc450dace4044db9a98a8b684f960
 SHA512:
-  metadata.gz: 81302a5cd1d63aec33b5014e637c716916506e593d442bed11d97f87fb59bcef9e8636a1609106de791cf5ebbf180202b3ac297dff8f6fac0abcc2f177592632
-  data.tar.gz: '08301126ffffc8eeed569ea66ccf7b4a881c366c3e80d9d7c21fe2b3c982bff076aced450e146d4ab2cdad3ddf04ae386c708ac761146aee38b7da726b31710f'
+  metadata.gz: a7d44e55b919b92325a5106037e73a7a5d276a2f47cc55eb8931e4c95912a7b2eba424728fde9b8fffdd9aae12b6d7c6ed81cb4ac1cea1b9e0c3a99997d1b4c1
+  data.tar.gz: cd6a2e8b60ddc1c376024a4ee5620032a07b97b42ee04fbd98c45ce71a88f9532dc161d9d7983dd1eeb0d8cba0561311ed48f094bddd11c60b71650c549542f5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [5.5.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.4.0...v5.5.0) (2026-05-08)
+
+### Features
+
+* add `email_bcc` and `bcc_sent` to Notification and Template models ([#84](https://github.com/OneSignal/onesignal-ruby-api/issues/84)) ([9cb235f](https://github.com/OneSignal/onesignal-ruby-api/commit/9cb235fcfd299fa58877733108eba660c86fc4ba))
+
 ## [5.4.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.3.0...v5.4.0) (2026-04-17)
 
 ### Features

data/README.md

@@ -4,15 +4,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.4.0
-- Package version: 5.4.0
+- API version: 5.5.0
+- Package version: 5.5.0
 
 ## Installation
 
 Add to your `Gemfile`:
 
 ```ruby
-gem 'onesignal', '~> 5.4.0'
+gem 'onesignal', '~> 5.5.0'
 ```
 
 Then run `bundle install`.

data/docs/BasicNotification.md

@@ -15,7 +15,7 @@
 | **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] |
+| **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** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **value** | **Integer** |  | [optional][readonly] |
@@ -32,7 +32,7 @@
 | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  |  |
-| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting.  [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **idempotency_key** | **String** | 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  | [optional] |
 | **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
 | **headings** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
@@ -109,6 +109,7 @@
 | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null.  | [optional] |
 | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
 | **include_unsubscribed** | **Boolean** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional] |
+| **email_bcc** | **Array<String>** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.  | [optional] |
 | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  | [optional] |
 | **sms_media_urls** | **Array<String>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.  | [optional] |
 | **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
@@ -230,6 +231,7 @@ instance = OneSignal::BasicNotification.new(
   email_preheader: null,
   disable_email_click_tracking: null,
   include_unsubscribed: null,
+  email_bcc: null,
   sms_from: null,
   sms_media_urls: null,
   filters: null,

data/docs/BasicNotificationAllOf.md

@@ -19,7 +19,7 @@
 | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  | [optional] |
-| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting.  [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **idempotency_key** | **String** | 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  | [optional] |
 | **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
 | **headings** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
@@ -96,6 +96,7 @@
 | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null.  | [optional] |
 | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
 | **include_unsubscribed** | **Boolean** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional] |
+| **email_bcc** | **Array<String>** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.  | [optional] |
 | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  | [optional] |
 | **sms_media_urls** | **Array<String>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.  | [optional] |
 | **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
@@ -204,6 +205,7 @@ instance = OneSignal::BasicNotificationAllOf.new(
   email_preheader: null,
   disable_email_click_tracking: null,
   include_unsubscribed: null,
+  email_bcc: null,
   sms_from: null,
   sms_media_urls: null,
   filters: null,

data/docs/CreateNotificationSuccessResponse.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **external_id** | **String** |  | [optional] |
-| **errors** | **Object** | Errors include the identifiers that are invalid, or that there are no subscribers. | [optional] |
+| **id** | **String** | Notification identifier when the request created a notification. An empty string means no notification was created; read `errors` for details (HTTP may still be 200). | [optional] |
+| **external_id** | **String** | Optional correlation / idempotency-related value from the API response. This is not the end-user External ID used for targeting recipients (that lives under `include_aliases.external_id`). | [optional] |
+| **errors** | **Object** | Polymorphic field: may be an array of human-readable strings and/or an object (for example with `invalid_aliases`, `invalid_external_user_ids`, or `invalid_player_ids`) depending on the API response; HTTP may still be 200 with partial success. Typed SDKs model this loosely so both shapes deserialize. | [optional] |
 
 ## Example
 

data/docs/CreateTemplateRequest.md

@@ -12,6 +12,7 @@
 | **is_email** | **Boolean** | Set true for an Email template. | [optional] |
 | **email_subject** | **String** | Subject of the email. | [optional] |
 | **email_body** | **String** | Body of the email (HTML supported). | [optional] |
+| **email_bcc** | **Array<String>** | BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional] |
 | **is_sms** | **Boolean** | Set true for an SMS template. | [optional] |
 | **dynamic_content** | **String** | JSON string for dynamic content personalization. | [optional] |
 
@@ -29,6 +30,7 @@ instance = OneSignal::CreateTemplateRequest.new(
   is_email: null,
   email_subject: null,
   email_body: null,
+  email_bcc: null,
   is_sms: null,
   dynamic_content: null
 )

data/docs/DefaultApi.md

@@ -559,7 +559,7 @@ end
 
 Create notification
 
-Sends notifications to your users 
+Sends notifications to your users.  **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase).  **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients.  **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request. 
 
 ### Examples
 
@@ -573,7 +573,11 @@ OneSignal.configure do |config|
 end
 
 api_instance = OneSignal::DefaultApi.new
-notification = OneSignal::Notification.new({app_id: 'app_id_example'}) # Notification | 
+notification = OneSignal::Notification.new
+notification.app_id = 'YOUR_APP_ID'
+notification.contents = OneSignal::LanguageStringMap.new({ en: 'Hello from OneSignal!' })
+notification.include_aliases = { 'external_id' => ['YOUR_USER_EXTERNAL_ID'] }
+notification.target_channel = 'push'
 
 begin
   # Create notification

data/docs/Notification.md

@@ -15,7 +15,7 @@
 | **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] |
+| **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** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **value** | **Integer** |  | [optional][readonly] |
@@ -32,7 +32,7 @@
 | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  |  |
-| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting.  [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **idempotency_key** | **String** | 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  | [optional] |
 | **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
 | **headings** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
@@ -109,6 +109,7 @@
 | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null.  | [optional] |
 | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
 | **include_unsubscribed** | **Boolean** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional] |
+| **email_bcc** | **Array<String>** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.  | [optional] |
 | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  | [optional] |
 | **sms_media_urls** | **Array<String>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.  | [optional] |
 | **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
@@ -231,6 +232,7 @@ instance = OneSignal::Notification.new(
   email_preheader: null,
   disable_email_click_tracking: null,
   include_unsubscribed: null,
+  email_bcc: null,
   sms_from: null,
   sms_media_urls: null,
   filters: null,

data/docs/NotificationTarget.md

@@ -15,7 +15,7 @@
 | **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] |
+| **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** |  | [optional] |
 
 ## Example

data/docs/NotificationWithMeta.md

@@ -15,7 +15,7 @@
 | **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] |
+| **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** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **value** | **Integer** |  | [optional][readonly] |
@@ -32,7 +32,7 @@
 | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  |  |
-| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting.  [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **idempotency_key** | **String** | 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  | [optional] |
 | **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
 | **headings** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
@@ -109,6 +109,7 @@
 | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null.  | [optional] |
 | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
 | **include_unsubscribed** | **Boolean** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional] |
+| **email_bcc** | **Array<String>** | BCC recipients that were set on this email notification. | [optional] |
 | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  | [optional] |
 | **sms_media_urls** | **Array<String>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.  | [optional] |
 | **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
@@ -130,6 +131,7 @@
 | **completed_at** | **Integer** | Unix timestamp indicating when notification delivery completed. The delivery duration from start to finish can be calculated with completed_at - send_after. | [optional] |
 | **platform_delivery_stats** | [**PlatformDeliveryData**](PlatformDeliveryData.md) |  | [optional] |
 | **canceled** | **Boolean** | Indicates whether the notification was canceled before it could be sent. | [optional] |
+| **bcc_sent** | **Integer** | Number of BCC copies successfully sent for this notification. | [optional] |
 
 ## Example
 
@@ -242,6 +244,7 @@ instance = OneSignal::NotificationWithMeta.new(
   email_preheader: null,
   disable_email_click_tracking: null,
   include_unsubscribed: null,
+  email_bcc: null,
   sms_from: null,
   sms_media_urls: null,
   filters: null,
@@ -262,7 +265,8 @@ instance = OneSignal::NotificationWithMeta.new(
   send_after: null,
   completed_at: null,
   platform_delivery_stats: null,
-  canceled: null
+  canceled: null,
+  bcc_sent: null
 )
 ```
 

data/docs/NotificationWithMetaAllOf.md

@@ -16,6 +16,8 @@
 | **received** | **Integer** | Confirmed Deliveries number of devices that received the push notification. Paid Feature Only. Free accounts will see 0. | [optional] |
 | **throttle_rate_per_minute** | **Integer** | number of push notifications sent per minute. Paid Feature Only. If throttling is not enabled for the app or the notification, and for free accounts, null is returned. Refer to Throttling for more details. | [optional] |
 | **canceled** | **Boolean** | Indicates whether the notification was canceled before it could be sent. | [optional] |
+| **email_bcc** | **Array<String>** | BCC recipients that were set on this email notification. | [optional] |
+| **bcc_sent** | **Integer** | Number of BCC copies successfully sent for this notification. | [optional] |
 
 ## Example
 
@@ -34,7 +36,9 @@ instance = OneSignal::NotificationWithMetaAllOf.new(
   platform_delivery_stats: null,
   received: null,
   throttle_rate_per_minute: null,
-  canceled: null
+  canceled: null,
+  email_bcc: null,
+  bcc_sent: null
 )
 ```
 

data/docs/StartLiveActivityRequest.md

@@ -15,7 +15,7 @@
 | **priority** | **Integer** | 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. | [optional] |
 | **ios_relevance_score** | **Float** | iOS 15+. A score to indicate how a notification should be displayed when grouped. Use a float between 0-1. | [optional] |
 | **idempotency_key** | **String** | 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  | [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] |
+| **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] |
 | **include_subscription_ids** | **Array<String>** | Specific subscription ids to target. Not compatible with other targeting parameters. | [optional] |
 | **included_segments** | **Array<String>** | Segment names to include. Only compatible with excluded_segments. | [optional] |
 | **excluded_segments** | **Array<String>** | Segment names to exclude. Only compatible with included_segments. | [optional] |

data/docs/SubscriptionNotificationTarget.md

@@ -13,7 +13,7 @@
 | **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] |
+| **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** |  | [optional] |
 
 ## Example

data/docs/UpdateTemplateRequest.md

@@ -11,6 +11,7 @@
 | **is_email** | **Boolean** | Set true for an Email template. | [optional] |
 | **email_subject** | **String** | Subject of the email. | [optional] |
 | **email_body** | **String** | Body of the email (HTML supported). | [optional] |
+| **email_bcc** | **Array<String>** | BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional] |
 | **is_sms** | **Boolean** | Set true for an SMS template. | [optional] |
 | **dynamic_content** | **String** | JSON string for dynamic content personalization. | [optional] |
 
@@ -27,6 +28,7 @@ instance = OneSignal::UpdateTemplateRequest.new(
   is_email: null,
   email_subject: null,
   email_body: null,
+  email_bcc: null,
   is_sms: null,
   dynamic_content: null
 )

data/lib/onesignal/api/default_api.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -549,7 +549,7 @@ module OneSignal
     end
 
     # Create notification
-    # Sends notifications to your users 
+    # Sends notifications to your users.  **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase).  **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients.  **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request. 
     # @param notification [Notification] 
     # @param [Hash] opts the optional parameters
     # @return [CreateNotificationSuccessResponse]
@@ -559,7 +559,7 @@ module OneSignal
     end
 
     # Create notification
-    # Sends notifications to your users 
+    # Sends notifications to your users.  **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase).  **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients.  **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request. 
     # @param notification [Notification] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateNotificationSuccessResponse, Integer, Hash)>] CreateNotificationSuccessResponse data, response status code and response headers

data/lib/onesignal/api_client.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -90,7 +90,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.4.0'
+      opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.5.0'
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}

data/lib/onesignal/api_error.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

data/lib/onesignal/configuration.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

data/lib/onesignal/models/api_key_token.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

data/lib/onesignal/models/api_key_tokens_list_response.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

data/lib/onesignal/models/app.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

data/lib/onesignal/models/basic_notification.rb

@@ -3,7 +3,7 @@
 
 #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-The version of the OpenAPI document: 5.4.0
+The version of the OpenAPI document: 5.5.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -48,7 +48,7 @@ module OneSignal
     # 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 
     attr_accessor :include_android_reg_ids
 
-    # 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.
+    # 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.
     attr_accessor :include_aliases
 
     attr_accessor :target_channel
@@ -95,7 +95,7 @@ module OneSignal
     # Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434. 
     attr_accessor :app_id
 
-    # [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true 
+    # This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting.  [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. 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 external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true 
     attr_accessor :external_id
 
     # 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 
@@ -322,6 +322,9 @@ module OneSignal
     # Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared.
     attr_accessor :include_unsubscribed
 
+    # Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. 
+    attr_accessor :email_bcc
+
     # Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. 
     attr_accessor :sms_from
 
@@ -478,6 +481,7 @@ module OneSignal
         :'email_preheader' => :'email_preheader',
         :'disable_email_click_tracking' => :'disable_email_click_tracking',
         :'include_unsubscribed' => :'include_unsubscribed',
+        :'email_bcc' => :'email_bcc',
         :'sms_from' => :'sms_from',
         :'sms_media_urls' => :'sms_media_urls',
         :'filters' => :'filters',
@@ -603,6 +607,7 @@ module OneSignal
         :'email_preheader' => :'String',
         :'disable_email_click_tracking' => :'Boolean',
         :'include_unsubscribed' => :'Boolean',
+        :'email_bcc' => :'Array<String>',
         :'sms_from' => :'String',
         :'sms_media_urls' => :'Array<String>',
         :'filters' => :'Array<FilterExpression>',
@@ -700,6 +705,7 @@ module OneSignal
         :'email_reply_to_address',
         :'email_preheader',
         :'disable_email_click_tracking',
+        :'email_bcc',
         :'sms_from',
         :'sms_media_urls',
         :'filters',
@@ -1183,6 +1189,12 @@ module OneSignal
         self.include_unsubscribed = attributes[:'include_unsubscribed']
       end
 
+      if attributes.key?(:'email_bcc')
+        if (value = attributes[:'email_bcc']).is_a?(Array)
+          self.email_bcc = value
+        end
+      end
+
       if attributes.key?(:'sms_from')
         self.sms_from = attributes[:'sms_from']
       end
@@ -1232,6 +1244,10 @@ module OneSignal
         invalid_properties.push('invalid value for "app_id", app_id cannot be nil.')
       end
 
+      if !@email_bcc.nil? && @email_bcc.length > 5
+        invalid_properties.push('invalid value for "email_bcc", number of items must be less than or equal to 5.')
+      end
+
       invalid_properties
     end
 
@@ -1243,6 +1259,7 @@ module OneSignal
       aggregation_validator = EnumAttributeValidator.new('String', ["sum", "count"])
       return false unless aggregation_validator.valid?(@aggregation)
       return false if @app_id.nil?
+      return false if !@email_bcc.nil? && @email_bcc.length > 5
       huawei_category_validator = EnumAttributeValidator.new('String', ["IM", "VOIP", "SUBSCRIPTION", "TRAVEL", "HEALTH", "WORK", "ACCOUNT", "EXPRESS", "FINANCE", "DEVICE_REMINDER", "MAIL", "MARKETING"])
       return false unless huawei_category_validator.valid?(@huawei_category)
       true
@@ -1268,6 +1285,16 @@ module OneSignal
       @aggregation = aggregation
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] email_bcc Value to be assigned
+    def email_bcc=(email_bcc)
+      if !email_bcc.nil? && email_bcc.length > 5
+        fail ArgumentError, 'invalid value for "email_bcc", number of items must be less than or equal to 5.'
+      end
+
+      @email_bcc = email_bcc
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] huawei_category Object to be assigned
     def huawei_category=(huawei_category)
@@ -1388,6 +1415,7 @@ module OneSignal
           email_preheader == o.email_preheader &&
           disable_email_click_tracking == o.disable_email_click_tracking &&
           include_unsubscribed == o.include_unsubscribed &&
+          email_bcc == o.email_bcc &&
           sms_from == o.sms_from &&
           sms_media_urls == o.sms_media_urls &&
           filters == o.filters &&
@@ -1408,7 +1436,7 @@ module OneSignal
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [included_segments, excluded_segments, include_subscription_ids, include_email_tokens, include_phone_numbers, include_ios_tokens, include_wp_wns_uris, include_amazon_reg_ids, include_chrome_reg_ids, include_chrome_web_reg_ids, include_android_reg_ids, include_aliases, target_channel, id, value, name, aggregation, is_ios, is_android, is_huawei, is_any_web, is_chrome_web, is_firefox, is_safari, is_wp_wns, is_adm, is_chrome, app_id, external_id, idempotency_key, contents, headings, subtitle, data, huawei_msg_type, url, web_url, app_url, ios_attachments, template_id, content_available, mutable_content, target_content_identifier, big_picture, huawei_big_picture, adm_big_picture, chrome_big_picture, chrome_web_image, buttons, web_buttons, ios_category, android_channel_id, huawei_channel_id, existing_android_channel_id, huawei_existing_channel_id, android_background_layout, small_icon, huawei_small_icon, large_icon, huawei_large_icon, adm_small_icon, adm_large_icon, chrome_web_icon, chrome_web_badge, firefox_icon, chrome_icon, ios_sound, android_sound, huawei_sound, adm_sound, wp_wns_sound, android_led_color, huawei_led_color, android_accent_color, huawei_accent_color, android_visibility, huawei_visibility, ios_badge_type, ios_badge_count, collapse_id, web_push_topic, apns_alert, delayed_option, delivery_time_of_day, ttl, priority, apns_push_type_override, throttle_rate_per_minute, android_group, android_group_message, adm_group, adm_group_message, thread_id, summary_arg, summary_arg_count, ios_relevance_score, ios_interruption_level, email_subject, email_body, email_from_name, email_from_address, email_reply_to_address, email_preheader, disable_email_click_tracking, include_unsubscribed, sms_from, sms_media_urls, filters, custom_data, huawei_badge_class, huawei_badge_add_num, huawei_badge_set_num, huawei_category, huawei_bi_tag].hash
+      [included_segments, excluded_segments, include_subscription_ids, include_email_tokens, include_phone_numbers, include_ios_tokens, include_wp_wns_uris, include_amazon_reg_ids, include_chrome_reg_ids, include_chrome_web_reg_ids, include_android_reg_ids, include_aliases, target_channel, id, value, name, aggregation, is_ios, is_android, is_huawei, is_any_web, is_chrome_web, is_firefox, is_safari, is_wp_wns, is_adm, is_chrome, app_id, external_id, idempotency_key, contents, headings, subtitle, data, huawei_msg_type, url, web_url, app_url, ios_attachments, template_id, content_available, mutable_content, target_content_identifier, big_picture, huawei_big_picture, adm_big_picture, chrome_big_picture, chrome_web_image, buttons, web_buttons, ios_category, android_channel_id, huawei_channel_id, existing_android_channel_id, huawei_existing_channel_id, android_background_layout, small_icon, huawei_small_icon, large_icon, huawei_large_icon, adm_small_icon, adm_large_icon, chrome_web_icon, chrome_web_badge, firefox_icon, chrome_icon, ios_sound, android_sound, huawei_sound, adm_sound, wp_wns_sound, android_led_color, huawei_led_color, android_accent_color, huawei_accent_color, android_visibility, huawei_visibility, ios_badge_type, ios_badge_count, collapse_id, web_push_topic, apns_alert, delayed_option, delivery_time_of_day, ttl, priority, apns_push_type_override, throttle_rate_per_minute, android_group, android_group_message, adm_group, adm_group_message, thread_id, summary_arg, summary_arg_count, ios_relevance_score, ios_interruption_level, email_subject, email_body, email_from_name, email_from_address, email_reply_to_address, email_preheader, disable_email_click_tracking, include_unsubscribed, email_bcc, sms_from, sms_media_urls, filters, custom_data, huawei_badge_class, huawei_badge_add_num, huawei_badge_set_num, huawei_category, huawei_bi_tag].hash
     end
 
     # Builds the object from hash