onesignal 1.0.1 → 2.2.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 (219) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +74 -0
  3. data/README.md +112 -88
  4. data/docs/App.md +9 -1
  5. data/docs/BasicNotification.md +230 -0
  6. data/docs/BasicNotificationAllOf.md +202 -0
  7. data/docs/{NotificationAllOfAndroidBackgroundLayout.md → BasicNotificationAllOfAndroidBackgroundLayout.md} +2 -2
  8. data/docs/BeginLiveActivityRequest.md +20 -0
  9. data/docs/CancelNotificationSuccessResponse.md +18 -0
  10. data/docs/CreateNotificationSuccessResponse.md +24 -0
  11. data/docs/{InlineResponse2005.md → CreatePlayerSuccessResponse.md} +2 -2
  12. data/docs/{InlineResponse4002.md → CreateSegmentConflictResponse.md} +2 -2
  13. data/docs/CreateSegmentSuccessResponse.md +20 -0
  14. data/docs/CreateSubscriptionRequestBody.md +20 -0
  15. data/docs/CreateUserConflictResponse.md +18 -0
  16. data/docs/CreateUserConflictResponseErrorsInner.md +22 -0
  17. data/docs/CreateUserConflictResponseErrorsItemsMeta.md +18 -0
  18. data/docs/DefaultApi.md +1591 -266
  19. data/docs/DeletePlayerNotFoundResponse.md +18 -0
  20. data/docs/{InlineResponse2001.md → DeletePlayerSuccessResponse.md} +2 -2
  21. data/docs/DeleteSegmentNotFoundResponse.md +18 -0
  22. data/docs/DeleteSegmentSuccessResponse.md +18 -0
  23. data/docs/DeliveryData.md +5 -5
  24. data/docs/{InlineResponse2008.md → ExportEventsSuccessResponse.md} +2 -2
  25. data/docs/ExportPlayersRequestBody.md +2 -2
  26. data/docs/ExportPlayersSuccessResponse.md +18 -0
  27. data/docs/Filter.md +1 -1
  28. data/docs/FilterExpressions.md +1 -1
  29. data/docs/GenericError.md +18 -0
  30. data/docs/GenericErrorErrorsInner.md +20 -0
  31. data/docs/InlineResponse200.md +2 -8
  32. data/docs/InlineResponse2003.md +18 -0
  33. data/docs/InlineResponse201.md +2 -4
  34. data/docs/InlineResponse202.md +18 -0
  35. data/docs/Notification.md +22 -30
  36. data/docs/NotificationAllOf.md +1 -175
  37. data/docs/{InlineResponse2002.md → NotificationHistorySuccessResponse.md} +2 -2
  38. data/docs/NotificationTarget.md +5 -25
  39. data/docs/NotificationWithMeta.md +21 -29
  40. data/docs/PlatformDeliveryData.md +5 -1
  41. data/docs/PlatformDeliveryDataEmailAllOf.md +30 -0
  42. data/docs/PlatformDeliveryDataSmsAllOf.md +22 -0
  43. data/docs/Player.md +1 -1
  44. data/docs/PlayerNotificationTarget.md +5 -1
  45. data/docs/PlayerNotificationTargetIncludeAliases.md +18 -0
  46. data/docs/PropertiesDeltas.md +22 -0
  47. data/docs/PropertiesObject.md +38 -0
  48. data/docs/Purchase.md +4 -2
  49. data/docs/RateLimiterError.md +18 -0
  50. data/docs/SubscriptionObject.md +50 -0
  51. data/docs/TransferSubscriptionRequestBody.md +18 -0
  52. data/docs/UpdateLiveActivityRequest.md +24 -0
  53. data/docs/UpdateLiveActivitySuccessResponse.md +20 -0
  54. data/docs/{InlineResponse2007.md → UpdatePlayerSuccessResponse.md} +3 -3
  55. data/docs/UpdatePlayerTagsSuccessResponse.md +18 -0
  56. data/docs/UpdateSubscriptionRequestBody.md +18 -0
  57. data/docs/UpdateUserRequest.md +22 -0
  58. data/docs/User.md +24 -0
  59. data/docs/UserIdentityRequestBody.md +18 -0
  60. data/docs/UserIdentityResponse.md +18 -0
  61. data/docs/UserSubscriptionOptions.md +18 -0
  62. data/lib/onesignal/api/default_api.rb +1583 -221
  63. data/lib/onesignal/api_client.rb +2 -2
  64. data/lib/onesignal/api_error.rb +1 -1
  65. data/lib/onesignal/configuration.rb +6 -6
  66. data/lib/onesignal/models/app.rb +57 -7
  67. data/lib/onesignal/models/basic_notification.rb +1442 -0
  68. data/lib/onesignal/models/basic_notification_all_of.rb +1252 -0
  69. data/lib/onesignal/models/{notification_all_of_android_background_layout.rb → basic_notification_all_of_android_background_layout.rb} +4 -4
  70. data/lib/onesignal/models/begin_live_activity_request.rb +238 -0
  71. data/lib/onesignal/models/button.rb +1 -1
  72. data/lib/onesignal/models/cancel_notification_success_response.rb +219 -0
  73. data/lib/onesignal/models/create_notification_success_response.rb +248 -0
  74. data/lib/onesignal/models/{inline_response2005.rb → create_player_success_response.rb} +4 -4
  75. data/lib/onesignal/models/{inline_response4002.rb → create_segment_conflict_response.rb} +4 -4
  76. data/lib/onesignal/models/create_segment_success_response.rb +229 -0
  77. data/lib/onesignal/models/create_subscription_request_body.rb +228 -0
  78. data/lib/onesignal/models/{inline_response4001.rb → create_user_conflict_response.rb} +6 -15
  79. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +237 -0
  80. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +219 -0
  81. data/lib/onesignal/models/delete_player_not_found_response.rb +219 -0
  82. data/lib/onesignal/models/{inline_response2001.rb → delete_player_success_response.rb} +4 -4
  83. data/lib/onesignal/models/delete_segment_not_found_response.rb +219 -0
  84. data/lib/onesignal/models/delete_segment_success_response.rb +219 -0
  85. data/lib/onesignal/models/delivery_data.rb +6 -1
  86. data/lib/onesignal/models/{inline_response2008.rb → export_events_success_response.rb} +4 -4
  87. data/lib/onesignal/models/export_players_request_body.rb +3 -3
  88. data/lib/onesignal/models/export_players_success_response.rb +219 -0
  89. data/lib/onesignal/models/filter.rb +2 -2
  90. data/lib/onesignal/models/filter_expressions.rb +2 -2
  91. data/lib/onesignal/models/{inline_response400.rb → generic_error.rb} +5 -5
  92. data/lib/onesignal/models/generic_error_errors_inner.rb +228 -0
  93. data/lib/onesignal/models/get_notification_request_body.rb +1 -1
  94. data/lib/onesignal/models/inline_response200.rb +10 -46
  95. data/lib/onesignal/models/{inline_response4003.rb → inline_response2003.rb} +12 -12
  96. data/lib/onesignal/models/inline_response201.rb +8 -18
  97. data/lib/onesignal/models/inline_response202.rb +219 -0
  98. data/lib/onesignal/models/invalid_identifier_error.rb +1 -1
  99. data/lib/onesignal/models/notification.rb +173 -141
  100. data/lib/onesignal/models/notification200_errors.rb +1 -1
  101. data/lib/onesignal/models/notification_all_of.rb +6 -929
  102. data/lib/onesignal/models/{inline_response2002.rb → notification_history_success_response.rb} +4 -4
  103. data/lib/onesignal/models/notification_slice.rb +1 -1
  104. data/lib/onesignal/models/notification_target.rb +60 -126
  105. data/lib/onesignal/models/notification_with_meta.rb +168 -137
  106. data/lib/onesignal/models/notification_with_meta_all_of.rb +2 -1
  107. data/lib/onesignal/models/operator.rb +1 -1
  108. data/lib/onesignal/models/outcome_data.rb +1 -1
  109. data/lib/onesignal/models/outcomes_data.rb +1 -1
  110. data/lib/onesignal/models/platform_delivery_data.rb +25 -5
  111. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +287 -0
  112. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +243 -0
  113. data/lib/onesignal/models/player.rb +9 -6
  114. data/lib/onesignal/models/player_notification_target.rb +60 -5
  115. data/lib/onesignal/models/player_notification_target_include_aliases.rb +221 -0
  116. data/lib/onesignal/models/player_slice.rb +1 -1
  117. data/lib/onesignal/models/properties_deltas.rb +239 -0
  118. data/lib/onesignal/models/properties_object.rb +313 -0
  119. data/lib/onesignal/models/purchase.rb +15 -6
  120. data/lib/onesignal/models/rate_limiter_error.rb +221 -0
  121. data/lib/onesignal/models/segment.rb +1 -1
  122. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  123. data/lib/onesignal/models/string_map.rb +1 -1
  124. data/lib/onesignal/models/{filter_notification_target.rb → subscription_object.rb} +145 -78
  125. data/lib/onesignal/models/transfer_subscription_request_body.rb +221 -0
  126. data/lib/onesignal/models/update_live_activity_request.rb +309 -0
  127. data/lib/onesignal/models/update_live_activity_success_response.rb +228 -0
  128. data/lib/onesignal/models/{inline_response2007.rb → update_player_success_response.rb} +5 -5
  129. data/lib/onesignal/models/update_player_tags_request_body.rb +1 -1
  130. data/lib/onesignal/models/update_player_tags_success_response.rb +219 -0
  131. data/lib/onesignal/models/update_subscription_request_body.rb +219 -0
  132. data/lib/onesignal/models/update_user_request.rb +239 -0
  133. data/lib/onesignal/models/user.rb +250 -0
  134. data/lib/onesignal/models/user_identity_request_body.rb +221 -0
  135. data/lib/onesignal/models/user_identity_response.rb +221 -0
  136. data/lib/onesignal/models/user_subscription_options.rb +219 -0
  137. data/lib/onesignal/version.rb +2 -2
  138. data/lib/onesignal.rb +43 -12
  139. data/onesignal.gemspec +1 -1
  140. data/spec/api/default_api_spec.rb +249 -12
  141. data/spec/api_client_spec.rb +1 -1
  142. data/spec/configuration_spec.rb +4 -4
  143. data/spec/models/app_spec.rb +25 -1
  144. data/spec/models/{notification_all_of_android_background_layout_spec.rb → basic_notification_all_of_android_background_layout_spec.rb} +7 -7
  145. data/spec/models/basic_notification_all_of_spec.rb +590 -0
  146. data/spec/models/basic_notification_spec.rb +678 -0
  147. data/spec/models/begin_live_activity_request_spec.rb +40 -0
  148. data/spec/models/button_spec.rb +1 -1
  149. data/spec/models/cancel_notification_success_response_spec.rb +34 -0
  150. data/spec/models/create_notification_success_response_spec.rb +52 -0
  151. data/spec/models/{inline_response2005_spec.rb → create_player_success_response_spec.rb} +7 -7
  152. data/spec/models/{inline_response4001_spec.rb → create_segment_conflict_response_spec.rb} +7 -7
  153. data/spec/models/{inline_response4002_spec.rb → create_segment_success_response_spec.rb} +8 -8
  154. data/spec/models/create_subscription_request_body_spec.rb +40 -0
  155. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +46 -0
  156. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +34 -0
  157. data/spec/models/create_user_conflict_response_spec.rb +34 -0
  158. data/spec/models/delete_player_not_found_response_spec.rb +34 -0
  159. data/spec/models/{inline_response2001_spec.rb → delete_player_success_response_spec.rb} +7 -7
  160. data/spec/models/delete_segment_not_found_response_spec.rb +34 -0
  161. data/spec/models/delete_segment_success_response_spec.rb +34 -0
  162. data/spec/models/delivery_data_spec.rb +1 -1
  163. data/spec/models/{inline_response2008_spec.rb → export_events_success_response_spec.rb} +7 -7
  164. data/spec/models/export_players_request_body_spec.rb +1 -1
  165. data/spec/models/export_players_success_response_spec.rb +34 -0
  166. data/spec/models/filter_expressions_spec.rb +1 -1
  167. data/spec/models/filter_spec.rb +1 -1
  168. data/spec/models/generic_error_errors_inner_spec.rb +40 -0
  169. data/spec/models/{inline_response4003_spec.rb → generic_error_spec.rb} +8 -8
  170. data/spec/models/get_notification_request_body_spec.rb +1 -1
  171. data/spec/models/{inline_response2007_spec.rb → inline_response2003_spec.rb} +8 -8
  172. data/spec/models/inline_response200_spec.rb +2 -20
  173. data/spec/models/inline_response201_spec.rb +2 -8
  174. data/spec/models/{inline_response400_spec.rb → inline_response202_spec.rb} +8 -8
  175. data/spec/models/invalid_identifier_error_spec.rb +1 -1
  176. data/spec/models/notification200_errors_spec.rb +1 -1
  177. data/spec/models/notification_all_of_spec.rb +1 -527
  178. data/spec/models/{inline_response2002_spec.rb → notification_history_success_response_spec.rb} +7 -7
  179. data/spec/models/notification_slice_spec.rb +1 -1
  180. data/spec/models/notification_spec.rb +56 -76
  181. data/spec/models/notification_target_spec.rb +17 -73
  182. data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
  183. data/spec/models/notification_with_meta_spec.rb +56 -76
  184. data/spec/models/operator_spec.rb +1 -1
  185. data/spec/models/outcome_data_spec.rb +1 -1
  186. data/spec/models/outcomes_data_spec.rb +1 -1
  187. data/spec/models/platform_delivery_data_email_all_of_spec.rb +70 -0
  188. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +46 -0
  189. data/spec/models/platform_delivery_data_spec.rb +13 -1
  190. data/spec/models/player_notification_target_include_aliases_spec.rb +34 -0
  191. data/spec/models/player_notification_target_spec.rb +17 -1
  192. data/spec/models/player_slice_spec.rb +1 -1
  193. data/spec/models/player_spec.rb +1 -1
  194. data/spec/models/properties_deltas_spec.rb +46 -0
  195. data/spec/models/{filter_notification_target_spec.rb → properties_object_spec.rb} +18 -24
  196. data/spec/models/purchase_spec.rb +7 -1
  197. data/spec/models/rate_limiter_error_spec.rb +34 -0
  198. data/spec/models/segment_notification_target_spec.rb +1 -1
  199. data/spec/models/segment_spec.rb +1 -1
  200. data/spec/models/string_map_spec.rb +1 -1
  201. data/spec/models/subscription_object_spec.rb +134 -0
  202. data/spec/models/transfer_subscription_request_body_spec.rb +34 -0
  203. data/spec/models/update_live_activity_request_spec.rb +60 -0
  204. data/spec/models/update_live_activity_success_response_spec.rb +40 -0
  205. data/spec/models/update_player_success_response_spec.rb +34 -0
  206. data/spec/models/update_player_tags_request_body_spec.rb +1 -1
  207. data/spec/models/update_player_tags_success_response_spec.rb +34 -0
  208. data/spec/models/update_subscription_request_body_spec.rb +34 -0
  209. data/spec/models/update_user_request_spec.rb +46 -0
  210. data/spec/models/user_identity_request_body_spec.rb +34 -0
  211. data/spec/models/user_identity_response_spec.rb +34 -0
  212. data/spec/models/user_spec.rb +52 -0
  213. data/spec/models/user_subscription_options_spec.rb +34 -0
  214. data/spec/spec_helper.rb +1 -1
  215. metadata +178 -53
  216. data/docs/FilterNotificationTarget.md +0 -40
  217. data/docs/InlineResponse400.md +0 -18
  218. data/docs/InlineResponse4001.md +0 -20
  219. data/docs/InlineResponse4003.md +0 -18
@@ -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: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -21,42 +21,6 @@ module OneSignal
21
21
  # Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"]
22
22
  attr_accessor :excluded_segments
23
23
 
24
- # relation = \">\" or \"<\" hours_ago = number of hours before or after the users last session. Example: \"1.1\"
25
- attr_accessor :last_session
26
-
27
- # relation = \">\" or \"<\" hours_ago = number of hours before or after the users first session. Example: \"1.1\"
28
- attr_accessor :first_session
29
-
30
- # relation = \">\", \"<\", \"=\" or \"!=\" value = number sessions. Example: \"1\"
31
- attr_accessor :session_count
32
-
33
- # relation = \">\", \"<\", \"=\" or \"!=\" value = Time in seconds the user has been in your app. Example: \"3600\"
34
- attr_accessor :session_time
35
-
36
- # relation = \">\", \"<\", or \"=\" value = Amount in USD a user has spent on IAP (In App Purchases). Example: \"0.99\"
37
- attr_accessor :amount_spent
38
-
39
- # relation = \">\", \"<\" or \"=\" key = SKU purchased in your app as an IAP (In App Purchases). Example: \"com.domain.100coinpack\" value = value of SKU to compare to. Example: \"0.99\"
40
- attr_accessor :bought_sku
41
-
42
- # relation = \">\", \"<\", \"=\", \"!=\", \"exists\", \"not_exists\", \"time_elapsed_gt\" (paid plan only) or \"time_elapsed_lt\" (paid plan only) See Time Operators key = Tag key to compare. value = Tag value to compare. Not required for \"exists\" or \"not_exists\". Example: See Formatting Filters
43
- attr_accessor :tag
44
-
45
- # relation = \"=\" or \"!=\" value = 2 character language code. Example: \"en\". For a list of all language codes see Language & Localization.
46
- attr_accessor :language
47
-
48
- # relation = \">\", \"<\", \"=\" or \"!=\" value = app version. Example: \"1.0.0\"
49
- attr_accessor :app_version
50
-
51
- # radius = in meters lat = latitude long = longitude
52
- attr_accessor :location
53
-
54
- # value = email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter
55
- attr_accessor :email
56
-
57
- # relation = \"=\" value = 2-digit Country code Example: \"field\": \"country\", \"relation\": \"=\", \"value\", \"US\"
58
- attr_accessor :country
59
-
60
24
  # Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call
61
25
  attr_accessor :include_player_ids
62
26
 
@@ -87,10 +51,17 @@ module OneSignal
87
51
  # Not Recommended: Please consider using include_player_ids or include_external_user_ids 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
88
52
  attr_accessor :include_android_reg_ids
89
53
 
54
+ attr_accessor :include_aliases
55
+
56
+ attr_accessor :target_channel
57
+
90
58
  attr_accessor :id
91
59
 
92
60
  attr_accessor :value
93
61
 
62
+ # Required for SMS Messages. An identifier for tracking message within the OneSignal dashboard or export analytics. Not shown to end user.
63
+ attr_accessor :name
64
+
94
65
  attr_accessor :aggregation
95
66
 
96
67
  # Indicates whether to send to all devices registered under your app's Apple iOS platform.
@@ -129,9 +100,12 @@ module OneSignal
129
100
  # 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.
130
101
  attr_accessor :app_id
131
102
 
132
- # 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
103
+ # [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
133
104
  attr_accessor :external_id
134
105
 
106
+ # 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
107
+ attr_accessor :idempotency_key
108
+
135
109
  attr_accessor :contents
136
110
 
137
111
  attr_accessor :headings
@@ -284,9 +258,6 @@ module OneSignal
284
258
  # Channel: Push Notifications Platform: iOS 10+ iOS can localize push notification messages on the client using special parameters such as loc-key. When using the Create Notification endpoint, you must include these parameters inside of a field called apns_alert. Please see Apple's guide on localizing push notifications to learn more.
285
259
  attr_accessor :apns_alert
286
260
 
287
- # Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter.
288
- attr_accessor :send_after
289
-
290
261
  # Channel: All Possible values are: timezone (Deliver at a specific time-of-day in each users own timezone) last-active Same as Intelligent Delivery . (Deliver at the same time of day as each user last used your app). If send_after is used, this takes effect after the send_after time has elapsed.
291
262
  attr_accessor :delayed_option
292
263
 
@@ -338,12 +309,26 @@ module OneSignal
338
309
  # Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings.
339
310
  attr_accessor :email_from_address
340
311
 
312
+ # 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.
313
+ attr_accessor :email_preheader
314
+
315
+ # 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.
316
+ attr_accessor :include_unsubscribed
317
+
341
318
  # Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format.
342
319
  attr_accessor :sms_from
343
320
 
344
321
  # 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.
345
322
  attr_accessor :sms_media_urls
346
323
 
324
+ attr_accessor :filters
325
+
326
+ # Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {\"order_id\": 123, \"currency\": \"USD\", \"amount\": 25}
327
+ attr_accessor :custom_data
328
+
329
+ # Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter.
330
+ attr_accessor :send_after
331
+
347
332
  class EnumAttributeValidator
348
333
  attr_reader :datatype
349
334
  attr_reader :allowable_values
@@ -371,18 +356,6 @@ module OneSignal
371
356
  {
372
357
  :'included_segments' => :'included_segments',
373
358
  :'excluded_segments' => :'excluded_segments',
374
- :'last_session' => :'last_session',
375
- :'first_session' => :'first_session',
376
- :'session_count' => :'session_count',
377
- :'session_time' => :'session_time',
378
- :'amount_spent' => :'amount_spent',
379
- :'bought_sku' => :'bought_sku',
380
- :'tag' => :'tag',
381
- :'language' => :'language',
382
- :'app_version' => :'app_version',
383
- :'location' => :'location',
384
- :'email' => :'email',
385
- :'country' => :'country',
386
359
  :'include_player_ids' => :'include_player_ids',
387
360
  :'include_external_user_ids' => :'include_external_user_ids',
388
361
  :'include_email_tokens' => :'include_email_tokens',
@@ -393,8 +366,11 @@ module OneSignal
393
366
  :'include_chrome_reg_ids' => :'include_chrome_reg_ids',
394
367
  :'include_chrome_web_reg_ids' => :'include_chrome_web_reg_ids',
395
368
  :'include_android_reg_ids' => :'include_android_reg_ids',
369
+ :'include_aliases' => :'include_aliases',
370
+ :'target_channel' => :'target_channel',
396
371
  :'id' => :'id',
397
372
  :'value' => :'value',
373
+ :'name' => :'name',
398
374
  :'aggregation' => :'aggregation',
399
375
  :'is_ios' => :'isIos',
400
376
  :'is_android' => :'isAndroid',
@@ -409,6 +385,7 @@ module OneSignal
409
385
  :'channel_for_external_user_ids' => :'channel_for_external_user_ids',
410
386
  :'app_id' => :'app_id',
411
387
  :'external_id' => :'external_id',
388
+ :'idempotency_key' => :'idempotency_key',
412
389
  :'contents' => :'contents',
413
390
  :'headings' => :'headings',
414
391
  :'subtitle' => :'subtitle',
@@ -461,7 +438,6 @@ module OneSignal
461
438
  :'collapse_id' => :'collapse_id',
462
439
  :'web_push_topic' => :'web_push_topic',
463
440
  :'apns_alert' => :'apns_alert',
464
- :'send_after' => :'send_after',
465
441
  :'delayed_option' => :'delayed_option',
466
442
  :'delivery_time_of_day' => :'delivery_time_of_day',
467
443
  :'ttl' => :'ttl',
@@ -479,8 +455,13 @@ module OneSignal
479
455
  :'email_body' => :'email_body',
480
456
  :'email_from_name' => :'email_from_name',
481
457
  :'email_from_address' => :'email_from_address',
458
+ :'email_preheader' => :'email_preheader',
459
+ :'include_unsubscribed' => :'include_unsubscribed',
482
460
  :'sms_from' => :'sms_from',
483
- :'sms_media_urls' => :'sms_media_urls'
461
+ :'sms_media_urls' => :'sms_media_urls',
462
+ :'filters' => :'filters',
463
+ :'custom_data' => :'custom_data',
464
+ :'send_after' => :'send_after'
484
465
  }
485
466
  end
486
467
 
@@ -494,18 +475,6 @@ module OneSignal
494
475
  {
495
476
  :'included_segments' => :'Array<String>',
496
477
  :'excluded_segments' => :'Array<String>',
497
- :'last_session' => :'String',
498
- :'first_session' => :'String',
499
- :'session_count' => :'String',
500
- :'session_time' => :'String',
501
- :'amount_spent' => :'String',
502
- :'bought_sku' => :'String',
503
- :'tag' => :'String',
504
- :'language' => :'String',
505
- :'app_version' => :'String',
506
- :'location' => :'String',
507
- :'email' => :'String',
508
- :'country' => :'String',
509
478
  :'include_player_ids' => :'Array<String>',
510
479
  :'include_external_user_ids' => :'Array<String>',
511
480
  :'include_email_tokens' => :'Array<String>',
@@ -516,8 +485,11 @@ module OneSignal
516
485
  :'include_chrome_reg_ids' => :'Array<String>',
517
486
  :'include_chrome_web_reg_ids' => :'Array<String>',
518
487
  :'include_android_reg_ids' => :'Array<String>',
488
+ :'include_aliases' => :'PlayerNotificationTargetIncludeAliases',
489
+ :'target_channel' => :'String',
519
490
  :'id' => :'String',
520
491
  :'value' => :'Integer',
492
+ :'name' => :'String',
521
493
  :'aggregation' => :'String',
522
494
  :'is_ios' => :'Boolean',
523
495
  :'is_android' => :'Boolean',
@@ -532,6 +504,7 @@ module OneSignal
532
504
  :'channel_for_external_user_ids' => :'String',
533
505
  :'app_id' => :'String',
534
506
  :'external_id' => :'String',
507
+ :'idempotency_key' => :'String',
535
508
  :'contents' => :'StringMap',
536
509
  :'headings' => :'StringMap',
537
510
  :'subtitle' => :'StringMap',
@@ -557,7 +530,7 @@ module OneSignal
557
530
  :'huawei_channel_id' => :'String',
558
531
  :'existing_android_channel_id' => :'String',
559
532
  :'huawei_existing_channel_id' => :'String',
560
- :'android_background_layout' => :'NotificationAllOfAndroidBackgroundLayout',
533
+ :'android_background_layout' => :'BasicNotificationAllOfAndroidBackgroundLayout',
561
534
  :'small_icon' => :'String',
562
535
  :'huawei_small_icon' => :'String',
563
536
  :'large_icon' => :'String',
@@ -584,7 +557,6 @@ module OneSignal
584
557
  :'collapse_id' => :'String',
585
558
  :'web_push_topic' => :'String',
586
559
  :'apns_alert' => :'Object',
587
- :'send_after' => :'Time',
588
560
  :'delayed_option' => :'String',
589
561
  :'delivery_time_of_day' => :'String',
590
562
  :'ttl' => :'Integer',
@@ -602,14 +574,23 @@ module OneSignal
602
574
  :'email_body' => :'String',
603
575
  :'email_from_name' => :'String',
604
576
  :'email_from_address' => :'String',
577
+ :'email_preheader' => :'String',
578
+ :'include_unsubscribed' => :'Boolean',
605
579
  :'sms_from' => :'String',
606
- :'sms_media_urls' => :'Array<String>'
580
+ :'sms_media_urls' => :'Array<String>',
581
+ :'filters' => :'Array<Filter>',
582
+ :'custom_data' => :'Object',
583
+ :'send_after' => :'Time'
607
584
  }
608
585
  end
609
586
 
610
587
  # List of attributes with nullable: true
611
588
  def self.openapi_nullable
612
589
  Set.new([
590
+ :'include_player_ids',
591
+ :'include_external_user_ids',
592
+ :'include_aliases',
593
+ :'name',
613
594
  :'is_ios',
614
595
  :'is_android',
615
596
  :'is_huawei',
@@ -620,23 +601,82 @@ module OneSignal
620
601
  :'is_wp_wns',
621
602
  :'is_adm',
622
603
  :'is_chrome',
604
+ :'external_id',
605
+ :'idempotency_key',
623
606
  :'contents',
624
607
  :'headings',
625
608
  :'subtitle',
609
+ :'data',
610
+ :'huawei_msg_type',
611
+ :'url',
612
+ :'web_url',
613
+ :'app_url',
614
+ :'ios_attachments',
615
+ :'template_id',
626
616
  :'content_available',
617
+ :'target_content_identifier',
618
+ :'big_picture',
619
+ :'huawei_big_picture',
620
+ :'adm_big_picture',
621
+ :'chrome_big_picture',
622
+ :'chrome_web_image',
623
+ :'buttons',
624
+ :'web_buttons',
625
+ :'ios_category',
626
+ :'huawei_channel_id',
627
+ :'huawei_existing_channel_id',
628
+ :'small_icon',
629
+ :'huawei_small_icon',
630
+ :'large_icon',
631
+ :'huawei_large_icon',
632
+ :'adm_small_icon',
633
+ :'adm_large_icon',
634
+ :'chrome_web_icon',
635
+ :'chrome_web_badge',
636
+ :'firefox_icon',
637
+ :'chrome_icon',
638
+ :'ios_sound',
639
+ :'android_sound',
640
+ :'huawei_sound',
641
+ :'adm_sound',
642
+ :'wp_wns_sound',
643
+ :'android_led_color',
644
+ :'huawei_led_color',
645
+ :'android_accent_color',
646
+ :'huawei_accent_color',
627
647
  :'android_visibility',
628
648
  :'huawei_visibility',
649
+ :'ios_badge_type',
629
650
  :'ios_badge_count',
651
+ :'web_push_topic',
652
+ :'apns_alert',
653
+ :'delayed_option',
654
+ :'delivery_time_of_day',
630
655
  :'ttl',
631
656
  :'priority',
657
+ :'throttle_rate_per_minute',
658
+ :'android_group',
659
+ :'android_group_message',
660
+ :'adm_group',
661
+ :'adm_group_message',
662
+ :'thread_id',
663
+ :'email_subject',
664
+ :'email_from_name',
665
+ :'email_from_address',
666
+ :'email_preheader',
667
+ :'sms_from',
668
+ :'sms_media_urls',
669
+ :'filters',
670
+ :'custom_data',
671
+ :'send_after'
632
672
  ])
633
673
  end
634
674
 
635
675
  # List of class defined in allOf (OpenAPI v3)
636
676
  def self.openapi_all_of
637
677
  [
638
- :'NotificationAllOf',
639
- :'NotificationTarget'
678
+ :'BasicNotification',
679
+ :'NotificationAllOf'
640
680
  ]
641
681
  end
642
682
 
@@ -667,54 +707,6 @@ module OneSignal
667
707
  end
668
708
  end
669
709
 
670
- if attributes.key?(:'last_session')
671
- self.last_session = attributes[:'last_session']
672
- end
673
-
674
- if attributes.key?(:'first_session')
675
- self.first_session = attributes[:'first_session']
676
- end
677
-
678
- if attributes.key?(:'session_count')
679
- self.session_count = attributes[:'session_count']
680
- end
681
-
682
- if attributes.key?(:'session_time')
683
- self.session_time = attributes[:'session_time']
684
- end
685
-
686
- if attributes.key?(:'amount_spent')
687
- self.amount_spent = attributes[:'amount_spent']
688
- end
689
-
690
- if attributes.key?(:'bought_sku')
691
- self.bought_sku = attributes[:'bought_sku']
692
- end
693
-
694
- if attributes.key?(:'tag')
695
- self.tag = attributes[:'tag']
696
- end
697
-
698
- if attributes.key?(:'language')
699
- self.language = attributes[:'language']
700
- end
701
-
702
- if attributes.key?(:'app_version')
703
- self.app_version = attributes[:'app_version']
704
- end
705
-
706
- if attributes.key?(:'location')
707
- self.location = attributes[:'location']
708
- end
709
-
710
- if attributes.key?(:'email')
711
- self.email = attributes[:'email']
712
- end
713
-
714
- if attributes.key?(:'country')
715
- self.country = attributes[:'country']
716
- end
717
-
718
710
  if attributes.key?(:'include_player_ids')
719
711
  if (value = attributes[:'include_player_ids']).is_a?(Array)
720
712
  self.include_player_ids = value
@@ -775,6 +767,14 @@ module OneSignal
775
767
  end
776
768
  end
777
769
 
770
+ if attributes.key?(:'include_aliases')
771
+ self.include_aliases = attributes[:'include_aliases']
772
+ end
773
+
774
+ if attributes.key?(:'target_channel')
775
+ self.target_channel = attributes[:'target_channel']
776
+ end
777
+
778
778
  if attributes.key?(:'id')
779
779
  self.id = attributes[:'id']
780
780
  end
@@ -783,14 +783,16 @@ module OneSignal
783
783
  self.value = attributes[:'value']
784
784
  end
785
785
 
786
+ if attributes.key?(:'name')
787
+ self.name = attributes[:'name']
788
+ end
789
+
786
790
  if attributes.key?(:'aggregation')
787
791
  self.aggregation = attributes[:'aggregation']
788
792
  end
789
793
 
790
794
  if attributes.key?(:'is_ios')
791
795
  self.is_ios = attributes[:'is_ios']
792
- else
793
- self.is_ios = true
794
796
  end
795
797
 
796
798
  if attributes.key?(:'is_android')
@@ -841,6 +843,10 @@ module OneSignal
841
843
  self.external_id = attributes[:'external_id']
842
844
  end
843
845
 
846
+ if attributes.key?(:'idempotency_key')
847
+ self.idempotency_key = attributes[:'idempotency_key']
848
+ end
849
+
844
850
  if attributes.key?(:'contents')
845
851
  self.contents = attributes[:'contents']
846
852
  end
@@ -1053,10 +1059,6 @@ module OneSignal
1053
1059
  self.apns_alert = attributes[:'apns_alert']
1054
1060
  end
1055
1061
 
1056
- if attributes.key?(:'send_after')
1057
- self.send_after = attributes[:'send_after']
1058
- end
1059
-
1060
1062
  if attributes.key?(:'delayed_option')
1061
1063
  self.delayed_option = attributes[:'delayed_option']
1062
1064
  end
@@ -1125,6 +1127,14 @@ module OneSignal
1125
1127
  self.email_from_address = attributes[:'email_from_address']
1126
1128
  end
1127
1129
 
1130
+ if attributes.key?(:'email_preheader')
1131
+ self.email_preheader = attributes[:'email_preheader']
1132
+ end
1133
+
1134
+ if attributes.key?(:'include_unsubscribed')
1135
+ self.include_unsubscribed = attributes[:'include_unsubscribed']
1136
+ end
1137
+
1128
1138
  if attributes.key?(:'sms_from')
1129
1139
  self.sms_from = attributes[:'sms_from']
1130
1140
  end
@@ -1134,6 +1144,20 @@ module OneSignal
1134
1144
  self.sms_media_urls = value
1135
1145
  end
1136
1146
  end
1147
+
1148
+ if attributes.key?(:'filters')
1149
+ if (value = attributes[:'filters']).is_a?(Array)
1150
+ self.filters = value
1151
+ end
1152
+ end
1153
+
1154
+ if attributes.key?(:'custom_data')
1155
+ self.custom_data = attributes[:'custom_data']
1156
+ end
1157
+
1158
+ if attributes.key?(:'send_after')
1159
+ self.send_after = attributes[:'send_after']
1160
+ end
1137
1161
  end
1138
1162
 
1139
1163
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -1150,12 +1174,24 @@ module OneSignal
1150
1174
  # Check to see if the all the properties in the model are valid
1151
1175
  # @return true if the model is valid
1152
1176
  def valid?
1177
+ target_channel_validator = EnumAttributeValidator.new('String', ["push", "email", "sms"])
1178
+ return false unless target_channel_validator.valid?(@target_channel)
1153
1179
  aggregation_validator = EnumAttributeValidator.new('String', ["sum", "count"])
1154
1180
  return false unless aggregation_validator.valid?(@aggregation)
1155
1181
  return false if @app_id.nil?
1156
1182
  true
1157
1183
  end
1158
1184
 
1185
+ # Custom attribute writer method checking allowed values (enum).
1186
+ # @param [Object] target_channel Object to be assigned
1187
+ def target_channel=(target_channel)
1188
+ validator = EnumAttributeValidator.new('String', ["push", "email", "sms"])
1189
+ unless validator.valid?(target_channel)
1190
+ fail ArgumentError, "invalid value for \"target_channel\", must be one of #{validator.allowable_values}."
1191
+ end
1192
+ @target_channel = target_channel
1193
+ end
1194
+
1159
1195
  # Custom attribute writer method checking allowed values (enum).
1160
1196
  # @param [Object] aggregation Object to be assigned
1161
1197
  def aggregation=(aggregation)
@@ -1173,18 +1209,6 @@ module OneSignal
1173
1209
  self.class == o.class &&
1174
1210
  included_segments == o.included_segments &&
1175
1211
  excluded_segments == o.excluded_segments &&
1176
- last_session == o.last_session &&
1177
- first_session == o.first_session &&
1178
- session_count == o.session_count &&
1179
- session_time == o.session_time &&
1180
- amount_spent == o.amount_spent &&
1181
- bought_sku == o.bought_sku &&
1182
- tag == o.tag &&
1183
- language == o.language &&
1184
- app_version == o.app_version &&
1185
- location == o.location &&
1186
- email == o.email &&
1187
- country == o.country &&
1188
1212
  include_player_ids == o.include_player_ids &&
1189
1213
  include_external_user_ids == o.include_external_user_ids &&
1190
1214
  include_email_tokens == o.include_email_tokens &&
@@ -1195,8 +1219,11 @@ module OneSignal
1195
1219
  include_chrome_reg_ids == o.include_chrome_reg_ids &&
1196
1220
  include_chrome_web_reg_ids == o.include_chrome_web_reg_ids &&
1197
1221
  include_android_reg_ids == o.include_android_reg_ids &&
1222
+ include_aliases == o.include_aliases &&
1223
+ target_channel == o.target_channel &&
1198
1224
  id == o.id &&
1199
1225
  value == o.value &&
1226
+ name == o.name &&
1200
1227
  aggregation == o.aggregation &&
1201
1228
  is_ios == o.is_ios &&
1202
1229
  is_android == o.is_android &&
@@ -1211,6 +1238,7 @@ module OneSignal
1211
1238
  channel_for_external_user_ids == o.channel_for_external_user_ids &&
1212
1239
  app_id == o.app_id &&
1213
1240
  external_id == o.external_id &&
1241
+ idempotency_key == o.idempotency_key &&
1214
1242
  contents == o.contents &&
1215
1243
  headings == o.headings &&
1216
1244
  subtitle == o.subtitle &&
@@ -1263,7 +1291,6 @@ module OneSignal
1263
1291
  collapse_id == o.collapse_id &&
1264
1292
  web_push_topic == o.web_push_topic &&
1265
1293
  apns_alert == o.apns_alert &&
1266
- send_after == o.send_after &&
1267
1294
  delayed_option == o.delayed_option &&
1268
1295
  delivery_time_of_day == o.delivery_time_of_day &&
1269
1296
  ttl == o.ttl &&
@@ -1281,8 +1308,13 @@ module OneSignal
1281
1308
  email_body == o.email_body &&
1282
1309
  email_from_name == o.email_from_name &&
1283
1310
  email_from_address == o.email_from_address &&
1311
+ email_preheader == o.email_preheader &&
1312
+ include_unsubscribed == o.include_unsubscribed &&
1284
1313
  sms_from == o.sms_from &&
1285
- sms_media_urls == o.sms_media_urls
1314
+ sms_media_urls == o.sms_media_urls &&
1315
+ filters == o.filters &&
1316
+ custom_data == o.custom_data &&
1317
+ send_after == o.send_after
1286
1318
  end
1287
1319
 
1288
1320
  # @see the `==` method
@@ -1294,7 +1326,7 @@ module OneSignal
1294
1326
  # Calculates hash code according to all attributes.
1295
1327
  # @return [Integer] Hash code
1296
1328
  def hash
1297
- [included_segments, excluded_segments, last_session, first_session, session_count, session_time, amount_spent, bought_sku, tag, language, app_version, location, email, country, include_player_ids, include_external_user_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, id, value, aggregation, is_ios, is_android, is_huawei, is_any_web, is_chrome_web, is_firefox, is_safari, is_wp_wns, is_adm, is_chrome, channel_for_external_user_ids, app_id, external_id, 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, send_after, 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, email_subject, email_body, email_from_name, email_from_address, sms_from, sms_media_urls].hash
1329
+ [included_segments, excluded_segments, include_player_ids, include_external_user_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, channel_for_external_user_ids, 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, email_subject, email_body, email_from_name, email_from_address, email_preheader, include_unsubscribed, sms_from, sms_media_urls, filters, custom_data, send_after].hash
1298
1330
  end
1299
1331
 
1300
1332
  # 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: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT