feat: add email_bcc and bcc_sent to Notification and Template models (#85)

Co-authored-by: OneSignal <noreply@onesignal.com>

Author: onesignal-deploy

.github/workflows/project.yml

@@ -14,4 +14,4 @@ jobs:
         with:
           # SDK Server Project
           project-url: https://github.com/orgs/OneSignal/projects/11
-          github-token: ${{ secrets.GH_PROJECTS_TOKEN }}
+          github-token: ${{ secrets.GH_PUSH_TOKEN }}

README.md

@@ -1,7 +1,7 @@
 # onesignal-java-client
 
 OneSignal
-- API version: 5.4.0
+- API version: 5.5.0
 
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
@@ -19,14 +19,14 @@ Building the API client library requires:
 <dependency>
   <groupId>com.onesignal</groupId>
   <artifactId>onesignal-java-client</artifactId>
-  <version>5.4.0</version>
+  <version>5.5.0</version>
 </dependency>
 ```
 
 ### Gradle
 
 ```groovy
-implementation "com.onesignal:onesignal-java-client:5.4.0"
+implementation "com.onesignal:onesignal-java-client:5.5.0"
 ```
 
 ## Configuration

api/openapi.yaml

@@ -8,7 +8,7 @@ info:
     customer engagement strategies. Learn more at onesignal.com
   termsOfService: https://onesignal.com/tos
   title: OneSignal
-  version: 5.4.0
+  version: 5.5.0
 servers:
 - url: https://api.onesignal.com
 paths:
@@ -3992,6 +3992,12 @@ components:
           tr: tr
         name: name
         isEmail: true
+        email_bcc:
+        - email_bcc
+        - email_bcc
+        - email_bcc
+        - email_bcc
+        - email_bcc
         headings:
           de: de
           hi: hi
@@ -4063,6 +4069,14 @@ components:
           description: Body of the email (HTML supported).
           nullable: true
           type: string
+        email_bcc:
+          description: BCC recipients for the email template. Maximum 5 addresses.
+            Only supported when the email service provider is OneSignal Email.
+          items:
+            type: string
+          maxItems: 5
+          nullable: true
+          type: array
         isSMS:
           description: Set true for an SMS template.
           type: boolean
@@ -4169,6 +4183,12 @@ components:
           tr: tr
         name: name
         isEmail: true
+        email_bcc:
+        - email_bcc
+        - email_bcc
+        - email_bcc
+        - email_bcc
+        - email_bcc
         headings:
           de: de
           hi: hi
@@ -4236,6 +4256,14 @@ components:
           description: Body of the email (HTML supported).
           nullable: true
           type: string
+        email_bcc:
+          description: BCC recipients for the email template. Maximum 5 addresses.
+            Only supported when the email service provider is OneSignal Email.
+          items:
+            type: string
+          maxItems: 5
+          nullable: true
+          type: array
         isSMS:
           description: Set true for an SMS template.
           type: boolean
@@ -5368,6 +5396,15 @@ components:
             \ of unsubscribed emails to be cleared."
           type: boolean
           writeOnly: true
+        email_bcc:
+          description: "Channel: Email\nBCC recipients for the email. Maximum 5 addresses.\
+            \ Only supported when the email service provider is OneSignal Email.\n"
+          items:
+            type: string
+          maxItems: 5
+          nullable: true
+          type: array
+          writeOnly: true
         sms_from:
           description: "Channel: SMS\nPhone Number used to send SMS. Should be a registered\
             \ Twilio phone number in E.164 format.\n"
@@ -5511,6 +5548,16 @@ components:
           description: Indicates whether the notification was canceled before it could
             be sent.
           type: boolean
+        email_bcc:
+          description: BCC recipients that were set on this email notification.
+          items:
+            type: string
+          nullable: true
+          type: array
+        bcc_sent:
+          description: Number of BCC copies successfully sent for this notification.
+          nullable: true
+          type: integer
       type: object
     PlatformDeliveryData_sms_allOf:
       properties:

build.gradle

@@ -5,7 +5,7 @@ apply plugin: 'com.diffplug.spotless'
 apply plugin: 'com.vanniktech.maven.publish'
 
 group = 'com.onesignal'
-version = '5.4.0'
+version = '5.5.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.onesignal",
     name := "onesignal-java-client",
-    version := "5.4.0",
+    version := "5.5.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/BasicNotification.md

@@ -112,6 +112,7 @@
 |**emailPreheader** | **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] |
 |**disableEmailClickTracking** | **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] |
 |**includeUnsubscribed** | **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] |
+|**emailBcc** | **List<String>** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.  |  [optional] |
 |**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  |  [optional] |
 |**smsMediaUrls** | **List<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** | [**List<FilterExpression>**](FilterExpression.md) |  |  [optional] |

docs/BasicNotificationAllOf.md

@@ -99,6 +99,7 @@
 |**emailPreheader** | **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] |
 |**disableEmailClickTracking** | **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] |
 |**includeUnsubscribed** | **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] |
+|**emailBcc** | **List<String>** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.  |  [optional] |
 |**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  |  [optional] |
 |**smsMediaUrls** | **List<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** | [**List<FilterExpression>**](FilterExpression.md) |  |  [optional] |

docs/CreateTemplateRequest.md

@@ -15,6 +15,7 @@
 |**isEmail** | **Boolean** | Set true for an Email template. |  [optional] |
 |**emailSubject** | **String** | Subject of the email. |  [optional] |
 |**emailBody** | **String** | Body of the email (HTML supported). |  [optional] |
+|**emailBcc** | **List<String>** | BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. |  [optional] |
 |**isSMS** | **Boolean** | Set true for an SMS template. |  [optional] |
 |**dynamicContent** | **String** | JSON string for dynamic content personalization. |  [optional] |
 

docs/Notification.md

@@ -112,6 +112,7 @@
 |**emailPreheader** | **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] |
 |**disableEmailClickTracking** | **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] |
 |**includeUnsubscribed** | **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] |
+|**emailBcc** | **List<String>** | Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.  |  [optional] |
 |**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  |  [optional] |
 |**smsMediaUrls** | **List<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** | [**List<FilterExpression>**](FilterExpression.md) |  |  [optional] |

docs/NotificationWithMeta.md

@@ -112,6 +112,7 @@
 |**emailPreheader** | **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] |
 |**disableEmailClickTracking** | **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] |
 |**includeUnsubscribed** | **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] |
+|**emailBcc** | **List<String>** | BCC recipients that were set on this email notification. |  [optional] |
 |**smsFrom** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.  |  [optional] |
 |**smsMediaUrls** | **List<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** | [**List<FilterExpression>**](FilterExpression.md) |  |  [optional] |
@@ -133,6 +134,7 @@
 |**completedAt** | **Long** | Unix timestamp indicating when notification delivery completed. The delivery duration from start to finish can be calculated with completed_at - send_after. |  [optional] |
 |**platformDeliveryStats** | [**PlatformDeliveryData**](PlatformDeliveryData.md) |  |  [optional] |
 |**canceled** | **Boolean** | Indicates whether the notification was canceled before it could be sent. |  [optional] |
+|**bccSent** | **Integer** | Number of BCC copies successfully sent for this notification. |  [optional] |