onesignal 5.4.0 → 5.5.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.
Files changed (161) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/README.md +3 -3
  4. data/docs/BasicNotification.md +4 -2
  5. data/docs/BasicNotificationAllOf.md +3 -1
  6. data/docs/CreateNotificationSuccessResponse.md +3 -3
  7. data/docs/CreateTemplateRequest.md +2 -0
  8. data/docs/DefaultApi.md +6 -2
  9. data/docs/Notification.md +4 -2
  10. data/docs/NotificationTarget.md +1 -1
  11. data/docs/NotificationWithMeta.md +7 -3
  12. data/docs/NotificationWithMetaAllOf.md +5 -1
  13. data/docs/StartLiveActivityRequest.md +1 -1
  14. data/docs/SubscriptionNotificationTarget.md +1 -1
  15. data/docs/UpdateTemplateRequest.md +2 -0
  16. data/lib/onesignal/api/default_api.rb +3 -3
  17. data/lib/onesignal/api_client.rb +2 -2
  18. data/lib/onesignal/api_error.rb +1 -1
  19. data/lib/onesignal/configuration.rb +1 -1
  20. data/lib/onesignal/models/api_key_token.rb +1 -1
  21. data/lib/onesignal/models/api_key_tokens_list_response.rb +1 -1
  22. data/lib/onesignal/models/app.rb +1 -1
  23. data/lib/onesignal/models/basic_notification.rb +32 -4
  24. data/lib/onesignal/models/basic_notification_all_of.rb +31 -3
  25. data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +1 -1
  26. data/lib/onesignal/models/button.rb +1 -1
  27. data/lib/onesignal/models/copy_template_request.rb +1 -1
  28. data/lib/onesignal/models/create_api_key_request.rb +1 -1
  29. data/lib/onesignal/models/create_api_key_response.rb +1 -1
  30. data/lib/onesignal/models/create_notification_success_response.rb +4 -2
  31. data/lib/onesignal/models/create_segment_conflict_response.rb +1 -1
  32. data/lib/onesignal/models/create_segment_success_response.rb +1 -1
  33. data/lib/onesignal/models/create_template_request.rb +30 -2
  34. data/lib/onesignal/models/create_user_conflict_response.rb +1 -1
  35. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +1 -1
  36. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +1 -1
  37. data/lib/onesignal/models/custom_event.rb +1 -1
  38. data/lib/onesignal/models/custom_events_request.rb +1 -1
  39. data/lib/onesignal/models/delivery_data.rb +1 -1
  40. data/lib/onesignal/models/export_events_success_response.rb +1 -1
  41. data/lib/onesignal/models/export_subscriptions_request_body.rb +1 -1
  42. data/lib/onesignal/models/export_subscriptions_success_response.rb +1 -1
  43. data/lib/onesignal/models/filter.rb +1 -1
  44. data/lib/onesignal/models/filter_expression.rb +1 -1
  45. data/lib/onesignal/models/generic_error.rb +1 -1
  46. data/lib/onesignal/models/generic_success_bool_response.rb +1 -1
  47. data/lib/onesignal/models/get_notification_history_request_body.rb +1 -1
  48. data/lib/onesignal/models/get_segments_success_response.rb +1 -1
  49. data/lib/onesignal/models/language_string_map.rb +1 -1
  50. data/lib/onesignal/models/notification.rb +32 -4
  51. data/lib/onesignal/models/notification_all_of.rb +1 -1
  52. data/lib/onesignal/models/notification_history_success_response.rb +1 -1
  53. data/lib/onesignal/models/notification_slice.rb +1 -1
  54. data/lib/onesignal/models/notification_target.rb +2 -2
  55. data/lib/onesignal/models/notification_with_meta.rb +31 -7
  56. data/lib/onesignal/models/notification_with_meta_all_of.rb +29 -5
  57. data/lib/onesignal/models/operator.rb +1 -1
  58. data/lib/onesignal/models/outcome_data.rb +1 -1
  59. data/lib/onesignal/models/outcomes_data.rb +1 -1
  60. data/lib/onesignal/models/platform_delivery_data.rb +1 -1
  61. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +1 -1
  62. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +1 -1
  63. data/lib/onesignal/models/properties_body.rb +1 -1
  64. data/lib/onesignal/models/properties_deltas.rb +1 -1
  65. data/lib/onesignal/models/properties_object.rb +1 -1
  66. data/lib/onesignal/models/purchase.rb +1 -1
  67. data/lib/onesignal/models/rate_limit_error.rb +1 -1
  68. data/lib/onesignal/models/segment.rb +1 -1
  69. data/lib/onesignal/models/segment_data.rb +1 -1
  70. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  71. data/lib/onesignal/models/start_live_activity_request.rb +2 -2
  72. data/lib/onesignal/models/start_live_activity_success_response.rb +1 -1
  73. data/lib/onesignal/models/subscription.rb +1 -1
  74. data/lib/onesignal/models/subscription_body.rb +1 -1
  75. data/lib/onesignal/models/subscription_notification_target.rb +2 -2
  76. data/lib/onesignal/models/template_resource.rb +1 -1
  77. data/lib/onesignal/models/templates_list_response.rb +1 -1
  78. data/lib/onesignal/models/transfer_subscription_request_body.rb +1 -1
  79. data/lib/onesignal/models/update_api_key_request.rb +1 -1
  80. data/lib/onesignal/models/update_live_activity_request.rb +1 -1
  81. data/lib/onesignal/models/update_live_activity_success_response.rb +1 -1
  82. data/lib/onesignal/models/update_template_request.rb +30 -2
  83. data/lib/onesignal/models/update_user_request.rb +1 -1
  84. data/lib/onesignal/models/user.rb +1 -1
  85. data/lib/onesignal/models/user_identity_body.rb +1 -1
  86. data/lib/onesignal/models/web_button.rb +1 -1
  87. data/lib/onesignal/version.rb +2 -2
  88. data/lib/onesignal.rb +1 -1
  89. data/onesignal.gemspec +1 -1
  90. data/spec/api/default_api_spec.rb +2 -2
  91. data/spec/api_client_spec.rb +1 -1
  92. data/spec/configuration_spec.rb +1 -1
  93. data/spec/models/api_key_token_spec.rb +1 -1
  94. data/spec/models/api_key_tokens_list_response_spec.rb +1 -1
  95. data/spec/models/app_spec.rb +1 -1
  96. data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +1 -1
  97. data/spec/models/basic_notification_all_of_spec.rb +7 -1
  98. data/spec/models/basic_notification_spec.rb +7 -1
  99. data/spec/models/button_spec.rb +1 -1
  100. data/spec/models/copy_template_request_spec.rb +1 -1
  101. data/spec/models/create_api_key_request_spec.rb +1 -1
  102. data/spec/models/create_api_key_response_spec.rb +1 -1
  103. data/spec/models/create_notification_success_response_spec.rb +1 -1
  104. data/spec/models/create_segment_conflict_response_spec.rb +1 -1
  105. data/spec/models/create_segment_success_response_spec.rb +1 -1
  106. data/spec/models/create_template_request_spec.rb +7 -1
  107. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +1 -1
  108. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +1 -1
  109. data/spec/models/create_user_conflict_response_spec.rb +1 -1
  110. data/spec/models/custom_event_spec.rb +1 -1
  111. data/spec/models/custom_events_request_spec.rb +1 -1
  112. data/spec/models/delivery_data_spec.rb +1 -1
  113. data/spec/models/export_events_success_response_spec.rb +1 -1
  114. data/spec/models/export_subscriptions_request_body_spec.rb +1 -1
  115. data/spec/models/export_subscriptions_success_response_spec.rb +1 -1
  116. data/spec/models/filter_expression_spec.rb +1 -1
  117. data/spec/models/filter_spec.rb +1 -1
  118. data/spec/models/generic_error_spec.rb +1 -1
  119. data/spec/models/generic_success_bool_response_spec.rb +1 -1
  120. data/spec/models/get_notification_history_request_body_spec.rb +1 -1
  121. data/spec/models/get_segments_success_response_spec.rb +1 -1
  122. data/spec/models/language_string_map_spec.rb +1 -1
  123. data/spec/models/notification_all_of_spec.rb +1 -1
  124. data/spec/models/notification_history_success_response_spec.rb +1 -1
  125. data/spec/models/notification_slice_spec.rb +1 -1
  126. data/spec/models/notification_spec.rb +7 -1
  127. data/spec/models/notification_target_spec.rb +1 -1
  128. data/spec/models/notification_with_meta_all_of_spec.rb +13 -1
  129. data/spec/models/notification_with_meta_spec.rb +13 -1
  130. data/spec/models/operator_spec.rb +1 -1
  131. data/spec/models/outcome_data_spec.rb +1 -1
  132. data/spec/models/outcomes_data_spec.rb +1 -1
  133. data/spec/models/platform_delivery_data_email_all_of_spec.rb +1 -1
  134. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +1 -1
  135. data/spec/models/platform_delivery_data_spec.rb +1 -1
  136. data/spec/models/properties_body_spec.rb +1 -1
  137. data/spec/models/properties_deltas_spec.rb +1 -1
  138. data/spec/models/properties_object_spec.rb +1 -1
  139. data/spec/models/purchase_spec.rb +1 -1
  140. data/spec/models/rate_limit_error_spec.rb +1 -1
  141. data/spec/models/segment_data_spec.rb +1 -1
  142. data/spec/models/segment_notification_target_spec.rb +1 -1
  143. data/spec/models/segment_spec.rb +1 -1
  144. data/spec/models/start_live_activity_request_spec.rb +1 -1
  145. data/spec/models/start_live_activity_success_response_spec.rb +1 -1
  146. data/spec/models/subscription_body_spec.rb +1 -1
  147. data/spec/models/subscription_notification_target_spec.rb +1 -1
  148. data/spec/models/subscription_spec.rb +1 -1
  149. data/spec/models/template_resource_spec.rb +1 -1
  150. data/spec/models/templates_list_response_spec.rb +1 -1
  151. data/spec/models/transfer_subscription_request_body_spec.rb +1 -1
  152. data/spec/models/update_api_key_request_spec.rb +1 -1
  153. data/spec/models/update_live_activity_request_spec.rb +1 -1
  154. data/spec/models/update_live_activity_success_response_spec.rb +1 -1
  155. data/spec/models/update_template_request_spec.rb +7 -1
  156. data/spec/models/update_user_request_spec.rb +1 -1
  157. data/spec/models/user_identity_body_spec.rb +1 -1
  158. data/spec/models/user_spec.rb +1 -1
  159. data/spec/models/web_button_spec.rb +1 -1
  160. data/spec/spec_helper.rb +1 -1
  161. metadata +1 -1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -48,7 +48,7 @@ module OneSignal
48
48
  # 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
49
49
  attr_accessor :include_android_reg_ids
50
50
 
51
- # 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.
51
+ # 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.
52
52
  attr_accessor :include_aliases
53
53
 
54
54
  attr_accessor :target_channel
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -48,7 +48,7 @@ module OneSignal
48
48
  # 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
49
49
  attr_accessor :include_android_reg_ids
50
50
 
51
- # 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.
51
+ # 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.
52
52
  attr_accessor :include_aliases
53
53
 
54
54
  attr_accessor :target_channel
@@ -95,7 +95,7 @@ module OneSignal
95
95
  # 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.
96
96
  attr_accessor :app_id
97
97
 
98
- # [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
98
+ # 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
99
99
  attr_accessor :external_id
100
100
 
101
101
  # 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
322
322
  # 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.
323
323
  attr_accessor :include_unsubscribed
324
324
 
325
+ # BCC recipients that were set on this email notification.
326
+ attr_accessor :email_bcc
327
+
325
328
  # Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.
326
329
  attr_accessor :sms_from
327
330
 
@@ -382,6 +385,9 @@ module OneSignal
382
385
  # Indicates whether the notification was canceled before it could be sent.
383
386
  attr_accessor :canceled
384
387
 
388
+ # Number of BCC copies successfully sent for this notification.
389
+ attr_accessor :bcc_sent
390
+
385
391
  class EnumAttributeValidator
386
392
  attr_reader :datatype
387
393
  attr_reader :allowable_values
@@ -512,6 +518,7 @@ module OneSignal
512
518
  :'email_preheader' => :'email_preheader',
513
519
  :'disable_email_click_tracking' => :'disable_email_click_tracking',
514
520
  :'include_unsubscribed' => :'include_unsubscribed',
521
+ :'email_bcc' => :'email_bcc',
515
522
  :'sms_from' => :'sms_from',
516
523
  :'sms_media_urls' => :'sms_media_urls',
517
524
  :'filters' => :'filters',
@@ -532,7 +539,8 @@ module OneSignal
532
539
  :'send_after' => :'send_after',
533
540
  :'completed_at' => :'completed_at',
534
541
  :'platform_delivery_stats' => :'platform_delivery_stats',
535
- :'canceled' => :'canceled'
542
+ :'canceled' => :'canceled',
543
+ :'bcc_sent' => :'bcc_sent'
536
544
  }
537
545
  end
538
546
 
@@ -649,6 +657,7 @@ module OneSignal
649
657
  :'email_preheader' => :'String',
650
658
  :'disable_email_click_tracking' => :'Boolean',
651
659
  :'include_unsubscribed' => :'Boolean',
660
+ :'email_bcc' => :'Array<String>',
652
661
  :'sms_from' => :'String',
653
662
  :'sms_media_urls' => :'Array<String>',
654
663
  :'filters' => :'Array<FilterExpression>',
@@ -669,7 +678,8 @@ module OneSignal
669
678
  :'send_after' => :'Integer',
670
679
  :'completed_at' => :'Integer',
671
680
  :'platform_delivery_stats' => :'PlatformDeliveryData',
672
- :'canceled' => :'Boolean'
681
+ :'canceled' => :'Boolean',
682
+ :'bcc_sent' => :'Integer'
673
683
  }
674
684
  end
675
685
 
@@ -758,6 +768,7 @@ module OneSignal
758
768
  :'email_reply_to_address',
759
769
  :'email_preheader',
760
770
  :'disable_email_click_tracking',
771
+ :'email_bcc',
761
772
  :'sms_from',
762
773
  :'sms_media_urls',
763
774
  :'filters',
@@ -770,6 +781,7 @@ module OneSignal
770
781
  :'received',
771
782
  :'send_after',
772
783
  :'completed_at',
784
+ :'bcc_sent'
773
785
  ])
774
786
  end
775
787
 
@@ -1246,6 +1258,12 @@ module OneSignal
1246
1258
  self.include_unsubscribed = attributes[:'include_unsubscribed']
1247
1259
  end
1248
1260
 
1261
+ if attributes.key?(:'email_bcc')
1262
+ if (value = attributes[:'email_bcc']).is_a?(Array)
1263
+ self.email_bcc = value
1264
+ end
1265
+ end
1266
+
1249
1267
  if attributes.key?(:'sms_from')
1250
1268
  self.sms_from = attributes[:'sms_from']
1251
1269
  end
@@ -1335,6 +1353,10 @@ module OneSignal
1335
1353
  if attributes.key?(:'canceled')
1336
1354
  self.canceled = attributes[:'canceled']
1337
1355
  end
1356
+
1357
+ if attributes.key?(:'bcc_sent')
1358
+ self.bcc_sent = attributes[:'bcc_sent']
1359
+ end
1338
1360
  end
1339
1361
 
1340
1362
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -1501,6 +1523,7 @@ module OneSignal
1501
1523
  email_preheader == o.email_preheader &&
1502
1524
  disable_email_click_tracking == o.disable_email_click_tracking &&
1503
1525
  include_unsubscribed == o.include_unsubscribed &&
1526
+ email_bcc == o.email_bcc &&
1504
1527
  sms_from == o.sms_from &&
1505
1528
  sms_media_urls == o.sms_media_urls &&
1506
1529
  filters == o.filters &&
@@ -1521,7 +1544,8 @@ module OneSignal
1521
1544
  send_after == o.send_after &&
1522
1545
  completed_at == o.completed_at &&
1523
1546
  platform_delivery_stats == o.platform_delivery_stats &&
1524
- canceled == o.canceled
1547
+ canceled == o.canceled &&
1548
+ bcc_sent == o.bcc_sent
1525
1549
  end
1526
1550
 
1527
1551
  # @see the `==` method
@@ -1533,7 +1557,7 @@ module OneSignal
1533
1557
  # Calculates hash code according to all attributes.
1534
1558
  # @return [Integer] Hash code
1535
1559
  def hash
1536
- [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, successful, failed, errored, converted, received, outcomes, remaining, queued_at, send_after, completed_at, platform_delivery_stats, canceled].hash
1560
+ [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, successful, failed, errored, converted, received, outcomes, remaining, queued_at, send_after, completed_at, platform_delivery_stats, canceled, bcc_sent].hash
1537
1561
  end
1538
1562
 
1539
1563
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -50,6 +50,12 @@ module OneSignal
50
50
  # Indicates whether the notification was canceled before it could be sent.
51
51
  attr_accessor :canceled
52
52
 
53
+ # BCC recipients that were set on this email notification.
54
+ attr_accessor :email_bcc
55
+
56
+ # Number of BCC copies successfully sent for this notification.
57
+ attr_accessor :bcc_sent
58
+
53
59
  # Attribute mapping from ruby-style variable name to JSON key.
54
60
  def self.attribute_map
55
61
  {
@@ -64,7 +70,9 @@ module OneSignal
64
70
  :'platform_delivery_stats' => :'platform_delivery_stats',
65
71
  :'received' => :'received',
66
72
  :'throttle_rate_per_minute' => :'throttle_rate_per_minute',
67
- :'canceled' => :'canceled'
73
+ :'canceled' => :'canceled',
74
+ :'email_bcc' => :'email_bcc',
75
+ :'bcc_sent' => :'bcc_sent'
68
76
  }
69
77
  end
70
78
 
@@ -87,7 +95,9 @@ module OneSignal
87
95
  :'platform_delivery_stats' => :'PlatformDeliveryData',
88
96
  :'received' => :'Integer',
89
97
  :'throttle_rate_per_minute' => :'Integer',
90
- :'canceled' => :'Boolean'
98
+ :'canceled' => :'Boolean',
99
+ :'email_bcc' => :'Array<String>',
100
+ :'bcc_sent' => :'Integer'
91
101
  }
92
102
  end
93
103
 
@@ -98,6 +108,8 @@ module OneSignal
98
108
  :'completed_at',
99
109
  :'received',
100
110
  :'throttle_rate_per_minute',
111
+ :'email_bcc',
112
+ :'bcc_sent'
101
113
  ])
102
114
  end
103
115
 
@@ -163,6 +175,16 @@ module OneSignal
163
175
  if attributes.key?(:'canceled')
164
176
  self.canceled = attributes[:'canceled']
165
177
  end
178
+
179
+ if attributes.key?(:'email_bcc')
180
+ if (value = attributes[:'email_bcc']).is_a?(Array)
181
+ self.email_bcc = value
182
+ end
183
+ end
184
+
185
+ if attributes.key?(:'bcc_sent')
186
+ self.bcc_sent = attributes[:'bcc_sent']
187
+ end
166
188
  end
167
189
 
168
190
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -194,7 +216,9 @@ module OneSignal
194
216
  platform_delivery_stats == o.platform_delivery_stats &&
195
217
  received == o.received &&
196
218
  throttle_rate_per_minute == o.throttle_rate_per_minute &&
197
- canceled == o.canceled
219
+ canceled == o.canceled &&
220
+ email_bcc == o.email_bcc &&
221
+ bcc_sent == o.bcc_sent
198
222
  end
199
223
 
200
224
  # @see the `==` method
@@ -206,7 +230,7 @@ module OneSignal
206
230
  # Calculates hash code according to all attributes.
207
231
  # @return [Integer] Hash code
208
232
  def hash
209
- [remaining, successful, failed, errored, converted, queued_at, send_after, completed_at, platform_delivery_stats, received, throttle_rate_per_minute, canceled].hash
233
+ [remaining, successful, failed, errored, converted, queued_at, send_after, completed_at, platform_delivery_stats, received, throttle_rate_per_minute, canceled, email_bcc, bcc_sent].hash
210
234
  end
211
235
 
212
236
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -45,7 +45,7 @@ module OneSignal
45
45
  # 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
46
46
  attr_accessor :idempotency_key
47
47
 
48
- # 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.
48
+ # 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.
49
49
  attr_accessor :include_aliases
50
50
 
51
51
  # Specific subscription ids to target. Not compatible with other targeting parameters.
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -42,7 +42,7 @@ module OneSignal
42
42
  # 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
43
43
  attr_accessor :include_android_reg_ids
44
44
 
45
- # 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.
45
+ # 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.
46
46
  attr_accessor :include_aliases
47
47
 
48
48
  attr_accessor :target_channel
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 5.4.0
6
+ The version of the OpenAPI document: 5.5.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT