onesignal 5.13.0 → 5.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 12484b4b8625118acab9f635ca17136c8826bef48db62697df3ce53f0b85f604
4
- data.tar.gz: 7b7f879c398aa7b241b8a8804c1cf95347ab6bbbafccb2bd5fc91248ad64a8ca
3
+ metadata.gz: 84ff3d0dedcffdf89af4a61638585fa1d6ff83421d03f9b5bb450a9882ef410e
4
+ data.tar.gz: df75bc81b8b50e7e28c5166b927deb30fb9c070a758ea354e7a665d0278d011c
5
5
  SHA512:
6
- metadata.gz: b0de961cf9d2f5dbe09758b5224ba2a1c2890d5893e5af4642c03886beca7c697b23fb9adcd249cb6a10ae455dd0bb56905e415183f85c5e210e8a239a6292bd
7
- data.tar.gz: 4ff0128dabbd88b0d6a1daf59edd3951596df235a99ca1549e699ecc9338db0c20152d909a2655161732f89003d96f8624831b78eba303826ce7b039c907f821
6
+ metadata.gz: 3860a8c07dcb703d00a125df24af63ece484f905e91bca97bc841542f58e716064700324c371a2475b946d5c821cc539be3d669ce8ab888734654a37141c7002
7
+ data.tar.gz: 8b3a8dfac3cf9f6fd300bb624e15272855b9319b6b6b6a815cb5de57d9618865ed84155fcd167dfaf53fc2b520ea0949e6abffdf912a946eecfc6b1ceb3b2e40
data/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## [5.13.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.12.0...v5.13.0) (2026-08-25)
4
+
5
+ ### Features
6
+
7
+ * add v5.13.0 package updates ([#124](https://github.com/OneSignal/onesignal-ruby-api/issues/124)) ([ad773c7](https://github.com/OneSignal/onesignal-ruby-api/commit/ad773c7ac6083eb23355b80a1a225734811f4c52))
8
+
3
9
  ## [5.12.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.11.2...v5.12.0) (2026-08-20)
4
10
 
5
11
  ### Features
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- onesignal (5.13.0)
4
+ onesignal (5.14.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -6,15 +6,15 @@ OneSignal - the Ruby gem for OneSignal
6
6
 
7
7
  A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
8
8
 
9
- - API version: 5.13.0
10
- - Package version: 5.13.0
9
+ - API version: 5.14.0
10
+ - Package version: 5.14.0
11
11
 
12
12
  ## Installation
13
13
 
14
14
  Add to your `Gemfile`:
15
15
 
16
16
  ```ruby
17
- gem 'onesignal', '~> 5.13.0'
17
+ gem 'onesignal', '~> 5.14.0'
18
18
  ```
19
19
 
20
20
  Then run `bundle install`.
@@ -103,7 +103,7 @@
103
103
  | **summary_arg_count** | **Integer** | Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\" | [optional] |
104
104
  | **ios_relevance_score** | **Float** | Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1. | [optional] |
105
105
  | **ios_interruption_level** | **String** | Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active. | [optional] |
106
- | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
106
+ | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
107
107
  | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional] |
108
108
  | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional] |
109
109
  | **email_from_address** | **String** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings. | [optional] |
@@ -113,6 +113,8 @@
113
113
  | **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] |
114
114
  | **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] |
115
115
  | **email_sender_domain** | **String** | Channel: Email Sender domain to use for the email message. Overrides the default sender domain configured for the app. Only supported when the email service provider is OneSignal Email. | [optional] |
116
+ | **kind** | **String** | Channel: Email Set to \"warmup\" to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. When set, `email_warm_up` is required and describes the campaign's stages and (optionally) its scheduling strategy. `send_after` cannot be combined with `kind: \"warmup\"`. The campaign will be scheduled to begin at its first stage's `start` time. Only supported for Email notifications. | [optional] |
117
+ | **email_warm_up** | [**EmailWarmUpRequest**](EmailWarmUpRequest.md) | | [optional] |
116
118
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
117
119
  | **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] |
118
120
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
@@ -238,6 +240,8 @@ instance = OneSignal::BasicNotification.new(
238
240
  include_unsubscribed: nil,
239
241
  email_bcc: nil,
240
242
  email_sender_domain: nil,
243
+ kind: nil,
244
+ email_warm_up: nil,
241
245
  sms_from: nil,
242
246
  sms_media_urls: nil,
243
247
  filters: nil,
@@ -89,7 +89,7 @@
89
89
  | **summary_arg_count** | **Integer** | Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\" | [optional] |
90
90
  | **ios_relevance_score** | **Float** | Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1. | [optional] |
91
91
  | **ios_interruption_level** | **String** | Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active. | [optional] |
92
- | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
92
+ | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
93
93
  | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional] |
94
94
  | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional] |
95
95
  | **email_from_address** | **String** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings. | [optional] |
@@ -99,6 +99,8 @@
99
99
  | **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] |
100
100
  | **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] |
101
101
  | **email_sender_domain** | **String** | Channel: Email Sender domain to use for the email message. Overrides the default sender domain configured for the app. Only supported when the email service provider is OneSignal Email. | [optional] |
102
+ | **kind** | **String** | Channel: Email Set to \"warmup\" to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. When set, `email_warm_up` is required and describes the campaign's stages and (optionally) its scheduling strategy. `send_after` cannot be combined with `kind: \"warmup\"`. The campaign will be scheduled to begin at its first stage's `start` time. Only supported for Email notifications. | [optional] |
103
+ | **email_warm_up** | [**EmailWarmUpRequest**](EmailWarmUpRequest.md) | | [optional] |
102
104
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
103
105
  | **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] |
104
106
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
@@ -210,6 +212,8 @@ instance = OneSignal::BasicNotificationAllOf.new(
210
212
  include_unsubscribed: nil,
211
213
  email_bcc: nil,
212
214
  email_sender_domain: nil,
215
+ kind: nil,
216
+ email_warm_up: nil,
213
217
  sms_from: nil,
214
218
  sms_media_urls: nil,
215
219
  filters: nil,
@@ -0,0 +1,24 @@
1
+ # OneSignal::EmailWarmUp
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **stages** | [**Array<EmailWarmUpStage>**](EmailWarmUpStage.md) | The campaign's sending schedule, stage by stage. | [optional] |
8
+ | **strategy** | **String** | How the stage schedule was produced: * `recommended` - OneSignal generated (and may still adjust) the schedule based on past delivery volumes, scheduled Auto Warm Up emails, and the size of the current audience. * `custom` - The stages were provided as-is in the create request. | [optional] |
9
+ | **status** | **String** | Current status of the campaign: * `initializing` - The stages have been submitted and the schedule is being set up. * `draft` - The campaign has been created but has not started sending. * `active` - The campaign is currently working through its stages. * `finished` - All stages have completed. * `canceled` - The campaign was canceled before finishing. | [optional] |
10
+ | **is_live** | **Boolean** | Whether the campaign is currently live (actively sending). | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'onesignal'
16
+
17
+ instance = OneSignal::EmailWarmUp.new(
18
+ stages: nil,
19
+ strategy: nil,
20
+ status: nil,
21
+ is_live: nil
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # OneSignal::EmailWarmUpRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **stages** | [**Array<EmailWarmUpStage>**](EmailWarmUpStage.md) | Required. The ordered stages that make up the campaign's sending schedule. | |
8
+ | **strategy** | **String** | How the stage schedule should be treated: * `recommended` - (Default) OneSignal may adjust the provided stages based on past delivery volumes, scheduled Auto Warm Up emails, and the size of the current audience. * `custom` - The stages provided are sent as-is. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'onesignal'
14
+
15
+ instance = OneSignal::EmailWarmUpRequest.new(
16
+ stages: nil,
17
+ strategy: nil
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # OneSignal::EmailWarmUpStage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **start** | **Time** | ISO 8601 timestamp for the start of this stage. Sending for this stage will not begin before this time. | |
8
+ | **_end** | **Time** | ISO 8601 timestamp for the end of this stage. This stage's quota is expected to be sent by this time. | |
9
+ | **quota** | **Integer** | Number of emails to send during this stage. | |
10
+ | **acked** | **Boolean** | Whether this stage has been picked up and acknowledged by the warm-up scheduler. Not accepted on create. This is only present when reading back a campaign. | [optional][readonly] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'onesignal'
16
+
17
+ instance = OneSignal::EmailWarmUpStage.new(
18
+ start: nil,
19
+ _end: nil,
20
+ quota: nil,
21
+ acked: nil
22
+ )
23
+ ```
24
+
data/docs/Notification.md CHANGED
@@ -103,7 +103,7 @@
103
103
  | **summary_arg_count** | **Integer** | Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\" | [optional] |
104
104
  | **ios_relevance_score** | **Float** | Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1. | [optional] |
105
105
  | **ios_interruption_level** | **String** | Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active. | [optional] |
106
- | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
106
+ | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
107
107
  | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional] |
108
108
  | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional] |
109
109
  | **email_from_address** | **String** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings. | [optional] |
@@ -113,6 +113,8 @@
113
113
  | **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] |
114
114
  | **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] |
115
115
  | **email_sender_domain** | **String** | Channel: Email Sender domain to use for the email message. Overrides the default sender domain configured for the app. Only supported when the email service provider is OneSignal Email. | [optional] |
116
+ | **kind** | **String** | Channel: Email Set to \"warmup\" to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. When set, `email_warm_up` is required and describes the campaign's stages and (optionally) its scheduling strategy. `send_after` cannot be combined with `kind: \"warmup\"`. The campaign will be scheduled to begin at its first stage's `start` time. Only supported for Email notifications. | [optional] |
117
+ | **email_warm_up** | [**EmailWarmUpRequest**](EmailWarmUpRequest.md) | | [optional] |
116
118
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
117
119
  | **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] |
118
120
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
@@ -239,6 +241,8 @@ instance = OneSignal::Notification.new(
239
241
  include_unsubscribed: nil,
240
242
  email_bcc: nil,
241
243
  email_sender_domain: nil,
244
+ kind: nil,
245
+ email_warm_up: nil,
242
246
  sms_from: nil,
243
247
  sms_media_urls: nil,
244
248
  filters: nil,
@@ -103,7 +103,7 @@
103
103
  | **summary_arg_count** | **Integer** | Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\" | [optional] |
104
104
  | **ios_relevance_score** | **Float** | Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1. | [optional] |
105
105
  | **ios_interruption_level** | **String** | Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active. | [optional] |
106
- | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
106
+ | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
107
107
  | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional] |
108
108
  | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional] |
109
109
  | **email_from_address** | **String** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings. | [optional] |
@@ -113,6 +113,8 @@
113
113
  | **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] |
114
114
  | **email_bcc** | **Array<String>** | BCC recipients that were set on this email notification. | [optional] |
115
115
  | **email_sender_domain** | **String** | Channel: Email Sender domain to use for the email message. Overrides the default sender domain configured for the app. Only supported when the email service provider is OneSignal Email. | [optional] |
116
+ | **kind** | **String** | Channel: Email Set to \"warmup\" to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. When set, `email_warm_up` is required and describes the campaign's stages and (optionally) its scheduling strategy. `send_after` cannot be combined with `kind: \"warmup\"`. The campaign will be scheduled to begin at its first stage's `start` time. Only supported for Email notifications. | [optional] |
117
+ | **email_warm_up** | [**EmailWarmUp**](EmailWarmUp.md) | | [optional] |
116
118
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
117
119
  | **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] |
118
120
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
@@ -251,6 +253,8 @@ instance = OneSignal::NotificationWithMeta.new(
251
253
  include_unsubscribed: nil,
252
254
  email_bcc: nil,
253
255
  email_sender_domain: nil,
256
+ kind: nil,
257
+ email_warm_up: nil,
254
258
  sms_from: nil,
255
259
  sms_media_urls: nil,
256
260
  filters: nil,
@@ -18,6 +18,7 @@
18
18
  | **canceled** | **Boolean** | Indicates whether the notification was canceled before it could be sent. | [optional] |
19
19
  | **email_bcc** | **Array<String>** | BCC recipients that were set on this email notification. | [optional] |
20
20
  | **bcc_sent** | **Integer** | Number of BCC copies successfully sent for this notification. | [optional] |
21
+ | **email_warm_up** | [**EmailWarmUp**](EmailWarmUp.md) | | [optional] |
21
22
 
22
23
  ## Example
23
24
 
@@ -38,7 +39,8 @@ instance = OneSignal::NotificationWithMetaAllOf.new(
38
39
  throttle_rate_per_minute: nil,
39
40
  canceled: nil,
40
41
  email_bcc: nil,
41
- bcc_sent: nil
42
+ bcc_sent: nil,
43
+ email_warm_up: nil
42
44
  )
43
45
  ```
44
46
 
@@ -89,7 +89,7 @@ module OneSignal
89
89
  url = build_request_url(path, opts)
90
90
  http_method = http_method.to_sym.downcase
91
91
 
92
- opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.13.0'
92
+ opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.14.0'
93
93
  header_params = @default_headers.merge(opts[:header_params] || {})
94
94
  query_params = opts[:query_params] || {}
95
95
  form_params = opts[:form_params] || {}
@@ -303,7 +303,7 @@ module OneSignal
303
303
  # Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active.
304
304
  attr_accessor :ios_interruption_level
305
305
 
306
- # Channel: Email Required. The subject of the email.
306
+ # Channel: Email Required. The subject of the email.
307
307
  attr_accessor :email_subject
308
308
 
309
309
  # Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid.
@@ -333,6 +333,11 @@ module OneSignal
333
333
  # Channel: Email Sender domain to use for the email message. Overrides the default sender domain configured for the app. Only supported when the email service provider is OneSignal Email.
334
334
  attr_accessor :email_sender_domain
335
335
 
336
+ # Channel: Email Set to \"warmup\" to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. When set, `email_warm_up` is required and describes the campaign's stages and (optionally) its scheduling strategy. `send_after` cannot be combined with `kind: \"warmup\"`. The campaign will be scheduled to begin at its first stage's `start` time. Only supported for Email notifications.
337
+ attr_accessor :kind
338
+
339
+ attr_accessor :email_warm_up
340
+
336
341
  # Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.
337
342
  attr_accessor :sms_from
338
343
 
@@ -493,6 +498,8 @@ module OneSignal
493
498
  :'include_unsubscribed' => :'include_unsubscribed',
494
499
  :'email_bcc' => :'email_bcc',
495
500
  :'email_sender_domain' => :'email_sender_domain',
501
+ :'kind' => :'kind',
502
+ :'email_warm_up' => :'email_warm_up',
496
503
  :'sms_from' => :'sms_from',
497
504
  :'sms_media_urls' => :'sms_media_urls',
498
505
  :'filters' => :'filters',
@@ -622,6 +629,8 @@ module OneSignal
622
629
  :'include_unsubscribed' => :'Boolean',
623
630
  :'email_bcc' => :'Array<String>',
624
631
  :'email_sender_domain' => :'String',
632
+ :'kind' => :'String',
633
+ :'email_warm_up' => :'EmailWarmUpRequest',
625
634
  :'sms_from' => :'String',
626
635
  :'sms_media_urls' => :'Array<String>',
627
636
  :'filters' => :'Array<FilterExpression>',
@@ -723,6 +732,8 @@ module OneSignal
723
732
  :'include_unsubscribed',
724
733
  :'email_bcc',
725
734
  :'email_sender_domain',
735
+ :'kind',
736
+ :'email_warm_up',
726
737
  :'sms_from',
727
738
  :'sms_media_urls',
728
739
  :'filters',
@@ -1226,6 +1237,14 @@ module OneSignal
1226
1237
  self.email_sender_domain = attributes[:'email_sender_domain']
1227
1238
  end
1228
1239
 
1240
+ if attributes.key?(:'kind')
1241
+ self.kind = attributes[:'kind']
1242
+ end
1243
+
1244
+ if attributes.key?(:'email_warm_up')
1245
+ self.email_warm_up = attributes[:'email_warm_up']
1246
+ end
1247
+
1229
1248
  if attributes.key?(:'sms_from')
1230
1249
  self.sms_from = attributes[:'sms_from']
1231
1250
  end
@@ -1291,6 +1310,8 @@ module OneSignal
1291
1310
  return false unless aggregation_validator.valid?(@aggregation)
1292
1311
  return false if @app_id.nil?
1293
1312
  return false if !@email_bcc.nil? && @email_bcc.length > 5
1313
+ kind_validator = EnumAttributeValidator.new('String', ["warmup"])
1314
+ return false unless kind_validator.valid?(@kind)
1294
1315
  huawei_category_validator = EnumAttributeValidator.new('String', ["IM", "VOIP", "SUBSCRIPTION", "TRAVEL", "HEALTH", "WORK", "ACCOUNT", "EXPRESS", "FINANCE", "DEVICE_REMINDER", "MAIL", "MARKETING"])
1295
1316
  return false unless huawei_category_validator.valid?(@huawei_category)
1296
1317
  true
@@ -1326,6 +1347,16 @@ module OneSignal
1326
1347
  @email_bcc = email_bcc
1327
1348
  end
1328
1349
 
1350
+ # Custom attribute writer method checking allowed values (enum).
1351
+ # @param [Object] kind Object to be assigned
1352
+ def kind=(kind)
1353
+ validator = EnumAttributeValidator.new('String', ["warmup"])
1354
+ unless validator.valid?(kind)
1355
+ fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
1356
+ end
1357
+ @kind = kind
1358
+ end
1359
+
1329
1360
  # Custom attribute writer method checking allowed values (enum).
1330
1361
  # @param [Object] huawei_category Object to be assigned
1331
1362
  def huawei_category=(huawei_category)
@@ -1450,6 +1481,8 @@ module OneSignal
1450
1481
  include_unsubscribed == o.include_unsubscribed &&
1451
1482
  email_bcc == o.email_bcc &&
1452
1483
  email_sender_domain == o.email_sender_domain &&
1484
+ kind == o.kind &&
1485
+ email_warm_up == o.email_warm_up &&
1453
1486
  sms_from == o.sms_from &&
1454
1487
  sms_media_urls == o.sms_media_urls &&
1455
1488
  filters == o.filters &&
@@ -1470,7 +1503,7 @@ module OneSignal
1470
1503
  # Calculates hash code according to all attributes.
1471
1504
  # @return [Integer] Hash code
1472
1505
  def hash
1473
- [included_segments, excluded_segments, include_subscription_ids, include_email_tokens, email_to, 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, global_image, 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, email_sender_domain, 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
1506
+ [included_segments, excluded_segments, include_subscription_ids, include_email_tokens, email_to, 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, global_image, 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, email_sender_domain, kind, email_warm_up, 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
1474
1507
  end
1475
1508
 
1476
1509
  # Builds the object from hash
@@ -262,7 +262,7 @@ module OneSignal
262
262
  # Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active.
263
263
  attr_accessor :ios_interruption_level
264
264
 
265
- # Channel: Email Required. The subject of the email.
265
+ # Channel: Email Required. The subject of the email.
266
266
  attr_accessor :email_subject
267
267
 
268
268
  # Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid.
@@ -292,6 +292,11 @@ module OneSignal
292
292
  # Channel: Email Sender domain to use for the email message. Overrides the default sender domain configured for the app. Only supported when the email service provider is OneSignal Email.
293
293
  attr_accessor :email_sender_domain
294
294
 
295
+ # Channel: Email Set to \"warmup\" to send this as an Auto Warm Up campaign: a single campaign delivered gradually to your audience over several days, so you don't have to pace sends manually. OneSignal generates a sending schedule based on your past delivery volumes, scheduled Auto Warm Up emails, and the size of your current audience. When set, `email_warm_up` is required and describes the campaign's stages and (optionally) its scheduling strategy. `send_after` cannot be combined with `kind: \"warmup\"`. The campaign will be scheduled to begin at its first stage's `start` time. Only supported for Email notifications.
296
+ attr_accessor :kind
297
+
298
+ attr_accessor :email_warm_up
299
+
295
300
  # Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.
296
301
  attr_accessor :sms_from
297
302
 
@@ -438,6 +443,8 @@ module OneSignal
438
443
  :'include_unsubscribed' => :'include_unsubscribed',
439
444
  :'email_bcc' => :'email_bcc',
440
445
  :'email_sender_domain' => :'email_sender_domain',
446
+ :'kind' => :'kind',
447
+ :'email_warm_up' => :'email_warm_up',
441
448
  :'sms_from' => :'sms_from',
442
449
  :'sms_media_urls' => :'sms_media_urls',
443
450
  :'filters' => :'filters',
@@ -553,6 +560,8 @@ module OneSignal
553
560
  :'include_unsubscribed' => :'Boolean',
554
561
  :'email_bcc' => :'Array<String>',
555
562
  :'email_sender_domain' => :'String',
563
+ :'kind' => :'String',
564
+ :'email_warm_up' => :'EmailWarmUpRequest',
556
565
  :'sms_from' => :'String',
557
566
  :'sms_media_urls' => :'Array<String>',
558
567
  :'filters' => :'Array<FilterExpression>',
@@ -652,6 +661,8 @@ module OneSignal
652
661
  :'include_unsubscribed',
653
662
  :'email_bcc',
654
663
  :'email_sender_domain',
664
+ :'kind',
665
+ :'email_warm_up',
655
666
  :'sms_from',
656
667
  :'sms_media_urls',
657
668
  :'filters',
@@ -1065,6 +1076,14 @@ module OneSignal
1065
1076
  self.email_sender_domain = attributes[:'email_sender_domain']
1066
1077
  end
1067
1078
 
1079
+ if attributes.key?(:'kind')
1080
+ self.kind = attributes[:'kind']
1081
+ end
1082
+
1083
+ if attributes.key?(:'email_warm_up')
1084
+ self.email_warm_up = attributes[:'email_warm_up']
1085
+ end
1086
+
1068
1087
  if attributes.key?(:'sms_from')
1069
1088
  self.sms_from = attributes[:'sms_from']
1070
1089
  end
@@ -1123,6 +1142,8 @@ module OneSignal
1123
1142
  aggregation_validator = EnumAttributeValidator.new('String', ["sum", "count"])
1124
1143
  return false unless aggregation_validator.valid?(@aggregation)
1125
1144
  return false if !@email_bcc.nil? && @email_bcc.length > 5
1145
+ kind_validator = EnumAttributeValidator.new('String', ["warmup"])
1146
+ return false unless kind_validator.valid?(@kind)
1126
1147
  huawei_category_validator = EnumAttributeValidator.new('String', ["IM", "VOIP", "SUBSCRIPTION", "TRAVEL", "HEALTH", "WORK", "ACCOUNT", "EXPRESS", "FINANCE", "DEVICE_REMINDER", "MAIL", "MARKETING"])
1127
1148
  return false unless huawei_category_validator.valid?(@huawei_category)
1128
1149
  true
@@ -1148,6 +1169,16 @@ module OneSignal
1148
1169
  @email_bcc = email_bcc
1149
1170
  end
1150
1171
 
1172
+ # Custom attribute writer method checking allowed values (enum).
1173
+ # @param [Object] kind Object to be assigned
1174
+ def kind=(kind)
1175
+ validator = EnumAttributeValidator.new('String', ["warmup"])
1176
+ unless validator.valid?(kind)
1177
+ fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
1178
+ end
1179
+ @kind = kind
1180
+ end
1181
+
1151
1182
  # Custom attribute writer method checking allowed values (enum).
1152
1183
  # @param [Object] huawei_category Object to be assigned
1153
1184
  def huawei_category=(huawei_category)
@@ -1258,6 +1289,8 @@ module OneSignal
1258
1289
  include_unsubscribed == o.include_unsubscribed &&
1259
1290
  email_bcc == o.email_bcc &&
1260
1291
  email_sender_domain == o.email_sender_domain &&
1292
+ kind == o.kind &&
1293
+ email_warm_up == o.email_warm_up &&
1261
1294
  sms_from == o.sms_from &&
1262
1295
  sms_media_urls == o.sms_media_urls &&
1263
1296
  filters == o.filters &&
@@ -1278,7 +1311,7 @@ module OneSignal
1278
1311
  # Calculates hash code according to all attributes.
1279
1312
  # @return [Integer] Hash code
1280
1313
  def hash
1281
- [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, global_image, 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, email_sender_domain, 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
1314
+ [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, global_image, 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, email_sender_domain, kind, email_warm_up, 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
1282
1315
  end
1283
1316
 
1284
1317
  # Builds the object from hash