onesignal 5.3.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 +12 -0
  3. data/README.md +57 -186
  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 +6 -0
  8. data/docs/DefaultApi.md +50 -46
  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 +6 -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 +4 -5
  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 +34 -4
  24. data/lib/onesignal/models/basic_notification_all_of.rb +33 -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 +48 -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 +34 -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 +33 -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 +48 -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 +19 -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 +19 -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
data/docs/DefaultApi.md CHANGED
@@ -113,7 +113,7 @@ end
113
113
 
114
114
  ### Authorization
115
115
 
116
- [rest_api_key](../README.md#rest_api_key)
116
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
117
117
 
118
118
  ### HTTP request headers
119
119
 
@@ -186,7 +186,7 @@ end
186
186
 
187
187
  ### Authorization
188
188
 
189
- [organization_api_key](../README.md#organization_api_key)
189
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
190
190
 
191
191
  ### HTTP request headers
192
192
 
@@ -261,7 +261,7 @@ end
261
261
 
262
262
  ### Authorization
263
263
 
264
- [rest_api_key](../README.md#rest_api_key)
264
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
265
265
 
266
266
  ### HTTP request headers
267
267
 
@@ -334,7 +334,7 @@ end
334
334
 
335
335
  ### Authorization
336
336
 
337
- [rest_api_key](../README.md#rest_api_key)
337
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
338
338
 
339
339
  ### HTTP request headers
340
340
 
@@ -405,7 +405,7 @@ end
405
405
 
406
406
  ### Authorization
407
407
 
408
- [organization_api_key](../README.md#organization_api_key)
408
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
409
409
 
410
410
  ### HTTP request headers
411
411
 
@@ -474,7 +474,7 @@ end
474
474
 
475
475
  ### Authorization
476
476
 
477
- [organization_api_key](../README.md#organization_api_key)
477
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
478
478
 
479
479
  ### HTTP request headers
480
480
 
@@ -545,7 +545,7 @@ end
545
545
 
546
546
  ### Authorization
547
547
 
548
- [rest_api_key](../README.md#rest_api_key)
548
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
549
549
 
550
550
  ### HTTP request headers
551
551
 
@@ -559,7 +559,7 @@ end
559
559
 
560
560
  Create notification
561
561
 
562
- Sends notifications to your users
562
+ Sends notifications to your users. **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase). **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients. **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request.
563
563
 
564
564
  ### Examples
565
565
 
@@ -573,7 +573,11 @@ OneSignal.configure do |config|
573
573
  end
574
574
 
575
575
  api_instance = OneSignal::DefaultApi.new
576
- notification = OneSignal::Notification.new({app_id: 'app_id_example'}) # Notification |
576
+ notification = OneSignal::Notification.new
577
+ notification.app_id = 'YOUR_APP_ID'
578
+ notification.contents = OneSignal::LanguageStringMap.new({ en: 'Hello from OneSignal!' })
579
+ notification.include_aliases = { 'external_id' => ['YOUR_USER_EXTERNAL_ID'] }
580
+ notification.target_channel = 'push'
577
581
 
578
582
  begin
579
583
  # Create notification
@@ -614,7 +618,7 @@ end
614
618
 
615
619
  ### Authorization
616
620
 
617
- [rest_api_key](../README.md#rest_api_key)
621
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
618
622
 
619
623
  ### HTTP request headers
620
624
 
@@ -687,7 +691,7 @@ end
687
691
 
688
692
  ### Authorization
689
693
 
690
- [rest_api_key](../README.md#rest_api_key)
694
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
691
695
 
692
696
  ### HTTP request headers
693
697
 
@@ -762,7 +766,7 @@ end
762
766
 
763
767
  ### Authorization
764
768
 
765
- [rest_api_key](../README.md#rest_api_key)
769
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
766
770
 
767
771
  ### HTTP request headers
768
772
 
@@ -831,7 +835,7 @@ end
831
835
 
832
836
  ### Authorization
833
837
 
834
- [rest_api_key](../README.md#rest_api_key)
838
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
835
839
 
836
840
  ### HTTP request headers
837
841
 
@@ -902,7 +906,7 @@ end
902
906
 
903
907
  ### Authorization
904
908
 
905
- [rest_api_key](../README.md#rest_api_key)
909
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
906
910
 
907
911
  ### HTTP request headers
908
912
 
@@ -977,7 +981,7 @@ end
977
981
 
978
982
  ### Authorization
979
983
 
980
- [rest_api_key](../README.md#rest_api_key)
984
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
981
985
 
982
986
  ### HTTP request headers
983
987
 
@@ -1048,7 +1052,7 @@ end
1048
1052
 
1049
1053
  ### Authorization
1050
1054
 
1051
- [organization_api_key](../README.md#organization_api_key)
1055
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1052
1056
 
1053
1057
  ### HTTP request headers
1054
1058
 
@@ -1119,7 +1123,7 @@ end
1119
1123
 
1120
1124
  ### Authorization
1121
1125
 
1122
- [rest_api_key](../README.md#rest_api_key)
1126
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1123
1127
 
1124
1128
  ### HTTP request headers
1125
1129
 
@@ -1189,7 +1193,7 @@ nil (empty response body)
1189
1193
 
1190
1194
  ### Authorization
1191
1195
 
1192
- [rest_api_key](../README.md#rest_api_key)
1196
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1193
1197
 
1194
1198
  ### HTTP request headers
1195
1199
 
@@ -1260,7 +1264,7 @@ end
1260
1264
 
1261
1265
  ### Authorization
1262
1266
 
1263
- [rest_api_key](../README.md#rest_api_key)
1267
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1264
1268
 
1265
1269
  ### HTTP request headers
1266
1270
 
@@ -1332,7 +1336,7 @@ nil (empty response body)
1332
1336
 
1333
1337
  ### Authorization
1334
1338
 
1335
- [rest_api_key](../README.md#rest_api_key)
1339
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1336
1340
 
1337
1341
  ### HTTP request headers
1338
1342
 
@@ -1403,7 +1407,7 @@ end
1403
1407
 
1404
1408
  ### Authorization
1405
1409
 
1406
- [rest_api_key](../README.md#rest_api_key)
1410
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1407
1411
 
1408
1412
  ### HTTP request headers
1409
1413
 
@@ -1476,7 +1480,7 @@ end
1476
1480
 
1477
1481
  ### Authorization
1478
1482
 
1479
- [rest_api_key](../README.md#rest_api_key)
1483
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1480
1484
 
1481
1485
  ### HTTP request headers
1482
1486
 
@@ -1549,7 +1553,7 @@ end
1549
1553
 
1550
1554
  ### Authorization
1551
1555
 
1552
- [rest_api_key](../README.md#rest_api_key)
1556
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1553
1557
 
1554
1558
  ### HTTP request headers
1555
1559
 
@@ -1620,7 +1624,7 @@ end
1620
1624
 
1621
1625
  ### Authorization
1622
1626
 
1623
- [rest_api_key](../README.md#rest_api_key)
1627
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1624
1628
 
1625
1629
  ### HTTP request headers
1626
1630
 
@@ -1689,7 +1693,7 @@ end
1689
1693
 
1690
1694
  ### Authorization
1691
1695
 
1692
- [organization_api_key](../README.md#organization_api_key)
1696
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1693
1697
 
1694
1698
  ### HTTP request headers
1695
1699
 
@@ -1755,7 +1759,7 @@ This endpoint does not need any parameter.
1755
1759
 
1756
1760
  ### Authorization
1757
1761
 
1758
- [organization_api_key](../README.md#organization_api_key)
1762
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1759
1763
 
1760
1764
  ### HTTP request headers
1761
1765
 
@@ -1826,7 +1830,7 @@ end
1826
1830
 
1827
1831
  ### Authorization
1828
1832
 
1829
- [rest_api_key](../README.md#rest_api_key)
1833
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1830
1834
 
1831
1835
  ### HTTP request headers
1832
1836
 
@@ -1897,7 +1901,7 @@ end
1897
1901
 
1898
1902
  ### Authorization
1899
1903
 
1900
- [rest_api_key](../README.md#rest_api_key)
1904
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1901
1905
 
1902
1906
  ### HTTP request headers
1903
1907
 
@@ -1974,7 +1978,7 @@ end
1974
1978
 
1975
1979
  ### Authorization
1976
1980
 
1977
- [rest_api_key](../README.md#rest_api_key)
1981
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
1978
1982
 
1979
1983
  ### HTTP request headers
1980
1984
 
@@ -2055,7 +2059,7 @@ end
2055
2059
 
2056
2060
  ### Authorization
2057
2061
 
2058
- [rest_api_key](../README.md#rest_api_key)
2062
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2059
2063
 
2060
2064
  ### HTTP request headers
2061
2065
 
@@ -2130,7 +2134,7 @@ end
2130
2134
 
2131
2135
  ### Authorization
2132
2136
 
2133
- [rest_api_key](../README.md#rest_api_key)
2137
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2134
2138
 
2135
2139
  ### HTTP request headers
2136
2140
 
@@ -2203,7 +2207,7 @@ end
2203
2207
 
2204
2208
  ### Authorization
2205
2209
 
2206
- [rest_api_key](../README.md#rest_api_key)
2210
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2207
2211
 
2208
2212
  ### HTTP request headers
2209
2213
 
@@ -2274,7 +2278,7 @@ end
2274
2278
 
2275
2279
  ### Authorization
2276
2280
 
2277
- [organization_api_key](../README.md#organization_api_key)
2281
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2278
2282
 
2279
2283
  ### HTTP request headers
2280
2284
 
@@ -2347,7 +2351,7 @@ end
2347
2351
 
2348
2352
  ### Authorization
2349
2353
 
2350
- [rest_api_key](../README.md#rest_api_key)
2354
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2351
2355
 
2352
2356
  ### HTTP request headers
2353
2357
 
@@ -2420,7 +2424,7 @@ end
2420
2424
 
2421
2425
  ### Authorization
2422
2426
 
2423
- [rest_api_key](../README.md#rest_api_key)
2427
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2424
2428
 
2425
2429
  ### HTTP request headers
2426
2430
 
@@ -2493,7 +2497,7 @@ end
2493
2497
 
2494
2498
  ### Authorization
2495
2499
 
2496
- [rest_api_key](../README.md#rest_api_key)
2500
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2497
2501
 
2498
2502
  ### HTTP request headers
2499
2503
 
@@ -2566,7 +2570,7 @@ end
2566
2570
 
2567
2571
  ### Authorization
2568
2572
 
2569
- [organization_api_key](../README.md#organization_api_key)
2573
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2570
2574
 
2571
2575
  ### HTTP request headers
2572
2576
 
@@ -2637,7 +2641,7 @@ end
2637
2641
 
2638
2642
  ### Authorization
2639
2643
 
2640
- [organization_api_key](../README.md#organization_api_key)
2644
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2641
2645
 
2642
2646
  ### HTTP request headers
2643
2647
 
@@ -2710,7 +2714,7 @@ end
2710
2714
 
2711
2715
  ### Authorization
2712
2716
 
2713
- [rest_api_key](../README.md#rest_api_key)
2717
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2714
2718
 
2715
2719
  ### HTTP request headers
2716
2720
 
@@ -2782,7 +2786,7 @@ nil (empty response body)
2782
2786
 
2783
2787
  ### Authorization
2784
2788
 
2785
- [rest_api_key](../README.md#rest_api_key)
2789
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2786
2790
 
2787
2791
  ### HTTP request headers
2788
2792
 
@@ -2857,7 +2861,7 @@ end
2857
2861
 
2858
2862
  ### Authorization
2859
2863
 
2860
- [rest_api_key](../README.md#rest_api_key)
2864
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2861
2865
 
2862
2866
  ### HTTP request headers
2863
2867
 
@@ -2930,7 +2934,7 @@ end
2930
2934
 
2931
2935
  ### Authorization
2932
2936
 
2933
- [rest_api_key](../README.md#rest_api_key)
2937
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
2934
2938
 
2935
2939
  ### HTTP request headers
2936
2940
 
@@ -3005,7 +3009,7 @@ end
3005
3009
 
3006
3010
  ### Authorization
3007
3011
 
3008
- [rest_api_key](../README.md#rest_api_key)
3012
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3009
3013
 
3010
3014
  ### HTTP request headers
3011
3015
 
@@ -3074,7 +3078,7 @@ end
3074
3078
 
3075
3079
  ### Authorization
3076
3080
 
3077
- [organization_api_key](../README.md#organization_api_key)
3081
+ [organization_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3078
3082
 
3079
3083
  ### HTTP request headers
3080
3084
 
@@ -3145,7 +3149,7 @@ end
3145
3149
 
3146
3150
  ### Authorization
3147
3151
 
3148
- [rest_api_key](../README.md#rest_api_key)
3152
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3149
3153
 
3150
3154
  ### HTTP request headers
3151
3155
 
@@ -3222,7 +3226,7 @@ end
3222
3226
 
3223
3227
  ### Authorization
3224
3228
 
3225
- [rest_api_key](../README.md#rest_api_key)
3229
+ [rest_api_key](https://github.com/OneSignal/onesignal-ruby-api#configuration)
3226
3230
 
3227
3231
  ### HTTP request headers
3228
3232
 
data/docs/Notification.md CHANGED
@@ -15,7 +15,7 @@
15
15
  | **include_chrome_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
16
16
  | **include_chrome_web_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
17
17
  | **include_android_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
18
- | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
18
+ | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
19
19
  | **target_channel** | **String** | | [optional] |
20
20
  | **id** | **String** | | [optional] |
21
21
  | **value** | **Integer** | | [optional][readonly] |
@@ -32,7 +32,7 @@
32
32
  | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
33
33
  | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform. | [optional] |
34
34
  | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434. | |
35
- | **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
35
+ | **external_id** | **String** | This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting. [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
36
36
  | **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
37
37
  | **contents** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
38
38
  | **headings** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
@@ -109,6 +109,7 @@
109
109
  | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional] |
110
110
  | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
111
111
  | **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] |
112
+ | **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] |
112
113
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
113
114
  | **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] |
114
115
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
@@ -231,6 +232,7 @@ instance = OneSignal::Notification.new(
231
232
  email_preheader: null,
232
233
  disable_email_click_tracking: null,
233
234
  include_unsubscribed: null,
235
+ email_bcc: null,
234
236
  sms_from: null,
235
237
  sms_media_urls: null,
236
238
  filters: null,
data/docs/NotificationTarget.md CHANGED
@@ -15,7 +15,7 @@
15
15
  | **include_chrome_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
16
16
  | **include_chrome_web_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
17
17
  | **include_android_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
18
- | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
18
+ | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
19
19
  | **target_channel** | **String** | | [optional] |
20
20
 
21
21
  ## Example
data/docs/NotificationWithMeta.md CHANGED
@@ -15,7 +15,7 @@
15
15
  | **include_chrome_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
16
16
  | **include_chrome_web_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
17
17
  | **include_android_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
18
- | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
18
+ | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
19
19
  | **target_channel** | **String** | | [optional] |
20
20
  | **id** | **String** | | [optional] |
21
21
  | **value** | **Integer** | | [optional][readonly] |
@@ -32,7 +32,7 @@
32
32
  | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
33
33
  | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform. | [optional] |
34
34
  | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434. | |
35
- | **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
35
+ | **external_id** | **String** | This field does **not** target users by their External ID. To send to External IDs, use `include_aliases` with the label `external_id` plus `target_channel` as documented for alias-based targeting. [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
36
36
  | **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
37
37
  | **contents** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
38
38
  | **headings** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
@@ -109,6 +109,7 @@
109
109
  | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional] |
110
110
  | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
111
111
  | **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] |
112
+ | **email_bcc** | **Array<String>** | BCC recipients that were set on this email notification. | [optional] |
112
113
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
113
114
  | **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] |
114
115
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
@@ -130,6 +131,7 @@
130
131
  | **completed_at** | **Integer** | Unix timestamp indicating when notification delivery completed. The delivery duration from start to finish can be calculated with completed_at - send_after. | [optional] |
131
132
  | **platform_delivery_stats** | [**PlatformDeliveryData**](PlatformDeliveryData.md) | | [optional] |
132
133
  | **canceled** | **Boolean** | Indicates whether the notification was canceled before it could be sent. | [optional] |
134
+ | **bcc_sent** | **Integer** | Number of BCC copies successfully sent for this notification. | [optional] |
133
135
 
134
136
  ## Example
135
137
 
@@ -242,6 +244,7 @@ instance = OneSignal::NotificationWithMeta.new(
242
244
  email_preheader: null,
243
245
  disable_email_click_tracking: null,
244
246
  include_unsubscribed: null,
247
+ email_bcc: null,
245
248
  sms_from: null,
246
249
  sms_media_urls: null,
247
250
  filters: null,
@@ -262,7 +265,8 @@ instance = OneSignal::NotificationWithMeta.new(
262
265
  send_after: null,
263
266
  completed_at: null,
264
267
  platform_delivery_stats: null,
265
- canceled: null
268
+ canceled: null,
269
+ bcc_sent: null
266
270
  )
267
271
  ```
268
272
 
data/docs/NotificationWithMetaAllOf.md CHANGED
@@ -16,6 +16,8 @@
16
16
  | **received** | **Integer** | Confirmed Deliveries number of devices that received the push notification. Paid Feature Only. Free accounts will see 0. | [optional] |
17
17
  | **throttle_rate_per_minute** | **Integer** | number of push notifications sent per minute. Paid Feature Only. If throttling is not enabled for the app or the notification, and for free accounts, null is returned. Refer to Throttling for more details. | [optional] |
18
18
  | **canceled** | **Boolean** | Indicates whether the notification was canceled before it could be sent. | [optional] |
19
+ | **email_bcc** | **Array<String>** | BCC recipients that were set on this email notification. | [optional] |
20
+ | **bcc_sent** | **Integer** | Number of BCC copies successfully sent for this notification. | [optional] |
19
21
 
20
22
  ## Example
21
23
 
@@ -34,7 +36,9 @@ instance = OneSignal::NotificationWithMetaAllOf.new(
34
36
  platform_delivery_stats: null,
35
37
  received: null,
36
38
  throttle_rate_per_minute: null,
37
- canceled: null
39
+ canceled: null,
40
+ email_bcc: null,
41
+ bcc_sent: null
38
42
  )
39
43
  ```
40
44
 
data/docs/StartLiveActivityRequest.md CHANGED
@@ -15,7 +15,7 @@
15
15
  | **priority** | **Integer** | Delivery priority through the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user's device. If not set, defaults to 10. | [optional] |
16
16
  | **ios_relevance_score** | **Float** | iOS 15+. A score to indicate how a notification should be displayed when grouped. Use a float between 0-1. | [optional] |
17
17
  | **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again. See Idempotent Notification Requests for more details writeOnly: true | [optional] |
18
- | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
18
+ | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
19
19
  | **include_subscription_ids** | **Array<String>** | Specific subscription ids to target. Not compatible with other targeting parameters. | [optional] |
20
20
  | **included_segments** | **Array<String>** | Segment names to include. Only compatible with excluded_segments. | [optional] |
21
21
  | **excluded_segments** | **Array<String>** | Segment names to exclude. Only compatible with included_segments. | [optional] |
data/docs/SubscriptionNotificationTarget.md CHANGED
@@ -13,7 +13,7 @@
13
13
  | **include_chrome_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
14
14
  | **include_chrome_web_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
15
15
  | **include_android_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call | [optional] |
16
- | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
16
+ | **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Keys must match API spellings exactly (for example the label for External ID is the string `external_id`; arbitrary keys such as camelCase variants are not aliases and may yield no recipients). Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
17
17
  | **target_channel** | **String** | | [optional] |
18
18
 
19
19
  ## Example
data/docs/UpdateTemplateRequest.md CHANGED
@@ -6,9 +6,12 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Updated name of the template. | [optional] |
8
8
  | **contents** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
9
+ | **headings** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
10
+ | **subtitle** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
9
11
  | **is_email** | **Boolean** | Set true for an Email template. | [optional] |
10
12
  | **email_subject** | **String** | Subject of the email. | [optional] |
11
13
  | **email_body** | **String** | Body of the email (HTML supported). | [optional] |
14
+ | **email_bcc** | **Array<String>** | BCC recipients for the email template. Maximum 5 addresses. Only supported when the email service provider is OneSignal Email. | [optional] |
12
15
  | **is_sms** | **Boolean** | Set true for an SMS template. | [optional] |
13
16
  | **dynamic_content** | **String** | JSON string for dynamic content personalization. | [optional] |
14
17
 
@@ -20,9 +23,12 @@ require 'onesignal'
20
23
  instance = OneSignal::UpdateTemplateRequest.new(
21
24
  name: null,
22
25
  contents: null,
26
+ headings: null,
27
+ subtitle: null,
23
28
  is_email: null,
24
29
  email_subject: null,
25
30
  email_body: null,
31
+ email_bcc: null,
26
32
  is_sms: null,
27
33
  dynamic_content: null
28
34
  )
data/lib/onesignal/api/default_api.rb CHANGED
@@ -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.3.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
@@ -549,7 +549,7 @@ module OneSignal
549
549
  end
550
550
 
551
551
  # Create notification
552
- # Sends notifications to your users
552
+ # Sends notifications to your users. **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase). **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients. **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request.
553
553
  # @param notification [Notification]
554
554
  # @param [Hash] opts the optional parameters
555
555
  # @return [CreateNotificationSuccessResponse]
@@ -559,7 +559,7 @@ module OneSignal
559
559
  end
560
560
 
561
561
  # Create notification
562
- # Sends notifications to your users
562
+ # Sends notifications to your users. **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase). **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients. **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request.
563
563
  # @param notification [Notification]
564
564
  # @param [Hash] opts the optional parameters
565
565
  # @return [Array<(CreateNotificationSuccessResponse, Integer, Hash)>] CreateNotificationSuccessResponse data, response status code and response headers
data/lib/onesignal/api_client.rb CHANGED
@@ -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.3.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
@@ -90,7 +90,7 @@ module OneSignal
90
90
  url = build_request_url(path, opts)
91
91
  http_method = http_method.to_sym.downcase
92
92
 
93
- opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.3.0'
93
+ opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=5.5.0'
94
94
  header_params = @default_headers.merge(opts[:header_params] || {})
95
95
  query_params = opts[:query_params] || {}
96
96
  form_params = opts[:form_params] || {}
data/lib/onesignal/api_error.rb CHANGED
@@ -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.3.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