Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/project.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
47 changes: 47 additions & 0 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/BasicNotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
1 change: 1 addition & 0 deletions docs/BasicNotificationAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
1 change: 1 addition & 0 deletions docs/CreateTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |

Expand Down
1 change: 1 addition & 0 deletions docs/Notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down
2 changes: 2 additions & 0 deletions docs/NotificationWithMeta.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand All @@ -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] |



Expand Down
2 changes: 2 additions & 0 deletions docs/NotificationWithMetaAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
|**received** | **Integer** | Confirmed Deliveries number of devices that received the push notification. Paid Feature Only. Free accounts will see 0. | [optional] |
|**throttleRatePerMinute** | **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] |
|**emailBcc** | **List<String>** | BCC recipients that were set on this email notification. | [optional] |
|**bccSent** | **Integer** | Number of BCC copies successfully sent for this notification. | [optional] |



1 change: 1 addition & 0 deletions docs/UpdateTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,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] |

Expand Down
40 changes: 39 additions & 1 deletion src/main/java/com/onesignal/client/model/BasicNotification.java
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,10 @@ public AggregationEnum read(final JsonReader jsonReader) throws IOException {
@SerializedName(SERIALIZED_NAME_INCLUDE_UNSUBSCRIBED)
private Boolean includeUnsubscribed;

public static final String SERIALIZED_NAME_EMAIL_BCC = "email_bcc";
@SerializedName(SERIALIZED_NAME_EMAIL_BCC)
private List<String> emailBcc = null;

public static final String SERIALIZED_NAME_SMS_FROM = "sms_from";
@SerializedName(SERIALIZED_NAME_SMS_FROM)
private String smsFrom;
Expand Down Expand Up @@ -3208,6 +3212,37 @@ public void setIncludeUnsubscribed(Boolean includeUnsubscribed) {
}


public BasicNotification emailBcc(List<String> emailBcc) {

this.emailBcc = emailBcc;
return this;
}

public BasicNotification addEmailBccItem(String emailBccItem) {
if (this.emailBcc == null) {
this.emailBcc = new ArrayList<>();
}
this.emailBcc.add(emailBccItem);
return this;
}

/**
* Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email.
* @return emailBcc
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Channel: Email BCC recipients for the email. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. ")

public List<String> getEmailBcc() {
return emailBcc;
}


public void setEmailBcc(List<String> emailBcc) {
this.emailBcc = emailBcc;
}


public BasicNotification smsFrom(String smsFrom) {

this.smsFrom = smsFrom;
Expand Down Expand Up @@ -3546,6 +3581,7 @@ public boolean equals(Object o) {
Objects.equals(this.emailPreheader, basicNotification.emailPreheader) &&
Objects.equals(this.disableEmailClickTracking, basicNotification.disableEmailClickTracking) &&
Objects.equals(this.includeUnsubscribed, basicNotification.includeUnsubscribed) &&
Objects.equals(this.emailBcc, basicNotification.emailBcc) &&
Objects.equals(this.smsFrom, basicNotification.smsFrom) &&
Objects.equals(this.smsMediaUrls, basicNotification.smsMediaUrls) &&
Objects.equals(this.filters, basicNotification.filters) &&
Expand All @@ -3563,7 +3599,7 @@ private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b)

@Override
public int hashCode() {
return Objects.hash(includedSegments, excludedSegments, includeSubscriptionIds, includeEmailTokens, includePhoneNumbers, includeIosTokens, includeWpWnsUris, includeAmazonRegIds, includeChromeRegIds, includeChromeWebRegIds, includeAndroidRegIds, includeAliases, targetChannel, id, value, name, aggregation, isIos, isAndroid, isHuawei, isAnyWeb, isChromeWeb, isFirefox, isSafari, isWPWNS, isAdm, isChrome, appId, externalId, idempotencyKey, contents, headings, subtitle, data, huaweiMsgType, url, webUrl, appUrl, iosAttachments, templateId, contentAvailable, mutableContent, targetContentIdentifier, bigPicture, huaweiBigPicture, admBigPicture, chromeBigPicture, chromeWebImage, buttons, webButtons, iosCategory, androidChannelId, huaweiChannelId, existingAndroidChannelId, huaweiExistingChannelId, androidBackgroundLayout, smallIcon, huaweiSmallIcon, largeIcon, huaweiLargeIcon, admSmallIcon, admLargeIcon, chromeWebIcon, chromeWebBadge, firefoxIcon, chromeIcon, iosSound, androidSound, huaweiSound, admSound, wpWnsSound, androidLedColor, huaweiLedColor, androidAccentColor, huaweiAccentColor, androidVisibility, huaweiVisibility, iosBadgeType, iosBadgeCount, collapseId, webPushTopic, apnsAlert, delayedOption, deliveryTimeOfDay, ttl, priority, apnsPushTypeOverride, throttleRatePerMinute, androidGroup, androidGroupMessage, admGroup, admGroupMessage, threadId, summaryArg, summaryArgCount, iosRelevanceScore, iosInterruptionLevel, emailSubject, emailBody, emailFromName, emailFromAddress, emailReplyToAddress, emailPreheader, disableEmailClickTracking, includeUnsubscribed, smsFrom, smsMediaUrls, filters, customData, huaweiBadgeClass, huaweiBadgeAddNum, huaweiBadgeSetNum, huaweiCategory, huaweiBiTag);
return Objects.hash(includedSegments, excludedSegments, includeSubscriptionIds, includeEmailTokens, includePhoneNumbers, includeIosTokens, includeWpWnsUris, includeAmazonRegIds, includeChromeRegIds, includeChromeWebRegIds, includeAndroidRegIds, includeAliases, targetChannel, id, value, name, aggregation, isIos, isAndroid, isHuawei, isAnyWeb, isChromeWeb, isFirefox, isSafari, isWPWNS, isAdm, isChrome, appId, externalId, idempotencyKey, contents, headings, subtitle, data, huaweiMsgType, url, webUrl, appUrl, iosAttachments, templateId, contentAvailable, mutableContent, targetContentIdentifier, bigPicture, huaweiBigPicture, admBigPicture, chromeBigPicture, chromeWebImage, buttons, webButtons, iosCategory, androidChannelId, huaweiChannelId, existingAndroidChannelId, huaweiExistingChannelId, androidBackgroundLayout, smallIcon, huaweiSmallIcon, largeIcon, huaweiLargeIcon, admSmallIcon, admLargeIcon, chromeWebIcon, chromeWebBadge, firefoxIcon, chromeIcon, iosSound, androidSound, huaweiSound, admSound, wpWnsSound, androidLedColor, huaweiLedColor, androidAccentColor, huaweiAccentColor, androidVisibility, huaweiVisibility, iosBadgeType, iosBadgeCount, collapseId, webPushTopic, apnsAlert, delayedOption, deliveryTimeOfDay, ttl, priority, apnsPushTypeOverride, throttleRatePerMinute, androidGroup, androidGroupMessage, admGroup, admGroupMessage, threadId, summaryArg, summaryArgCount, iosRelevanceScore, iosInterruptionLevel, emailSubject, emailBody, emailFromName, emailFromAddress, emailReplyToAddress, emailPreheader, disableEmailClickTracking, includeUnsubscribed, emailBcc, smsFrom, smsMediaUrls, filters, customData, huaweiBadgeClass, huaweiBadgeAddNum, huaweiBadgeSetNum, huaweiCategory, huaweiBiTag);
}

private static <T> int hashCodeNullable(JsonNullable<T> a) {
Expand Down Expand Up @@ -3682,6 +3718,7 @@ public String toString() {
sb.append(" emailPreheader: ").append(toIndentedString(emailPreheader)).append("\n");
sb.append(" disableEmailClickTracking: ").append(toIndentedString(disableEmailClickTracking)).append("\n");
sb.append(" includeUnsubscribed: ").append(toIndentedString(includeUnsubscribed)).append("\n");
sb.append(" emailBcc: ").append(toIndentedString(emailBcc)).append("\n");
sb.append(" smsFrom: ").append(toIndentedString(smsFrom)).append("\n");
sb.append(" smsMediaUrls: ").append(toIndentedString(smsMediaUrls)).append("\n");
sb.append(" filters: ").append(toIndentedString(filters)).append("\n");
Expand Down Expand Up @@ -3818,6 +3855,7 @@ private String toIndentedString(Object o) {
openapiFields.add("email_preheader");
openapiFields.add("disable_email_click_tracking");
openapiFields.add("include_unsubscribed");
openapiFields.add("email_bcc");
openapiFields.add("sms_from");
openapiFields.add("sms_media_urls");
openapiFields.add("filters");
Expand Down
Loading