onesignal 2.2.1 → 5.1.0.pre.beta1

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 (210) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -67
  3. data/docs/BasicNotification.md +18 -18
  4. data/docs/BasicNotificationAllOf.md +9 -7
  5. data/docs/CreateNotificationSuccessResponse.md +1 -3
  6. data/docs/DefaultApi.md +364 -948
  7. data/docs/{ExportPlayersRequestBody.md → ExportSubscriptionsRequestBody.md} +2 -2
  8. data/docs/{ExportPlayersSuccessResponse.md → ExportSubscriptionsSuccessResponse.md} +2 -2
  9. data/docs/Filter.md +10 -2
  10. data/docs/{Notification200Errors.md → FilterExpression.md} +9 -9
  11. data/docs/GenericError.md +6 -2
  12. data/docs/{DeletePlayerSuccessResponse.md → GenericSuccessBoolResponse.md} +2 -2
  13. data/docs/{GetNotificationRequestBody.md → GetNotificationHistoryRequestBody.md} +2 -2
  14. data/docs/GetSegmentsSuccessResponse.md +24 -0
  15. data/docs/{StringMap.md → LanguageStringMap.md} +2 -2
  16. data/docs/Notification.md +18 -18
  17. data/docs/NotificationTarget.md +9 -11
  18. data/docs/NotificationWithMeta.md +18 -18
  19. data/docs/{InlineResponse202.md → PropertiesBody.md} +2 -2
  20. data/docs/PropertiesDeltas.md +2 -2
  21. data/docs/PropertiesObject.md +2 -2
  22. data/docs/Purchase.md +1 -1
  23. data/docs/RateLimitError.md +20 -0
  24. data/docs/Segment.md +1 -1
  25. data/docs/SegmentData.md +30 -0
  26. data/docs/{SubscriptionObject.md → Subscription.md} +6 -6
  27. data/docs/SubscriptionBody.md +18 -0
  28. data/docs/SubscriptionNotificationTarget.md +38 -0
  29. data/docs/TransferSubscriptionRequestBody.md +1 -1
  30. data/docs/UpdateLiveActivityRequest.md +14 -4
  31. data/docs/UpdateLiveActivitySuccessResponse.md +2 -4
  32. data/docs/User.md +3 -5
  33. data/docs/{InlineResponse200.md → UserIdentityBody.md} +3 -3
  34. data/docs/WebButton.md +24 -0
  35. data/lib/onesignal/api/default_api.rb +382 -890
  36. data/lib/onesignal/api_client.rb +2 -2
  37. data/lib/onesignal/api_error.rb +1 -1
  38. data/lib/onesignal/configuration.rb +5 -5
  39. data/lib/onesignal/models/app.rb +1 -1
  40. data/lib/onesignal/models/basic_notification.rb +49 -47
  41. data/lib/onesignal/models/basic_notification_all_of.rb +29 -17
  42. data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +1 -1
  43. data/lib/onesignal/models/button.rb +1 -1
  44. data/lib/onesignal/models/create_notification_success_response.rb +5 -13
  45. data/lib/onesignal/models/create_segment_conflict_response.rb +1 -1
  46. data/lib/onesignal/models/create_segment_success_response.rb +1 -1
  47. data/lib/onesignal/models/create_user_conflict_response.rb +1 -1
  48. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +1 -1
  49. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +1 -1
  50. data/lib/onesignal/models/delivery_data.rb +1 -1
  51. data/lib/onesignal/models/export_events_success_response.rb +1 -1
  52. data/lib/onesignal/models/{export_players_request_body.rb → export_subscriptions_request_body.rb} +4 -4
  53. data/lib/onesignal/models/{export_players_success_response.rb → export_subscriptions_success_response.rb} +4 -4
  54. data/lib/onesignal/models/filter.rb +44 -14
  55. data/lib/onesignal/models/{notification200_errors.rb → filter_expression.rb} +4 -4
  56. data/lib/onesignal/models/generic_error.rb +26 -8
  57. data/lib/onesignal/models/{update_player_success_response.rb → generic_success_bool_response.rb} +4 -4
  58. data/lib/onesignal/models/{get_notification_request_body.rb → get_notification_history_request_body.rb} +4 -4
  59. data/lib/onesignal/models/{player_slice.rb → get_segments_success_response.rb} +16 -12
  60. data/lib/onesignal/models/{string_map.rb → language_string_map.rb} +4 -4
  61. data/lib/onesignal/models/notification.rb +49 -47
  62. data/lib/onesignal/models/notification_all_of.rb +1 -1
  63. data/lib/onesignal/models/notification_history_success_response.rb +1 -1
  64. data/lib/onesignal/models/notification_slice.rb +1 -1
  65. data/lib/onesignal/models/notification_target.rb +24 -34
  66. data/lib/onesignal/models/notification_with_meta.rb +49 -47
  67. data/lib/onesignal/models/notification_with_meta_all_of.rb +1 -1
  68. data/lib/onesignal/models/operator.rb +1 -1
  69. data/lib/onesignal/models/outcome_data.rb +1 -1
  70. data/lib/onesignal/models/outcomes_data.rb +1 -1
  71. data/lib/onesignal/models/platform_delivery_data.rb +1 -1
  72. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +1 -1
  73. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +1 -1
  74. data/lib/onesignal/models/{inline_response202.rb → properties_body.rb} +4 -4
  75. data/lib/onesignal/models/properties_deltas.rb +3 -3
  76. data/lib/onesignal/models/properties_object.rb +3 -3
  77. data/lib/onesignal/models/purchase.rb +2 -2
  78. data/lib/onesignal/models/{rate_limiter_error.rb → rate_limit_error.rb} +17 -8
  79. data/lib/onesignal/models/segment.rb +2 -2
  80. data/lib/onesignal/models/{begin_live_activity_request.rb → segment_data.rb} +69 -27
  81. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  82. data/lib/onesignal/models/{subscription_object.rb → subscription.rb} +8 -8
  83. data/lib/onesignal/models/{inline_response201.rb → subscription_body.rb} +5 -5
  84. data/lib/onesignal/models/{player_notification_target.rb → subscription_notification_target.rb} +25 -35
  85. data/lib/onesignal/models/transfer_subscription_request_body.rb +26 -2
  86. data/lib/onesignal/models/update_live_activity_request.rb +59 -22
  87. data/lib/onesignal/models/update_live_activity_success_response.rb +8 -17
  88. data/lib/onesignal/models/update_user_request.rb +1 -1
  89. data/lib/onesignal/models/user.rb +6 -15
  90. data/lib/onesignal/models/{inline_response200.rb → user_identity_body.rb} +5 -5
  91. data/lib/onesignal/models/{create_player_success_response.rb → web_button.rb} +40 -17
  92. data/lib/onesignal/version.rb +2 -2
  93. data/lib/onesignal.rb +16 -34
  94. data/onesignal.gemspec +1 -1
  95. data/spec/api/default_api_spec.rb +82 -174
  96. data/spec/api_client_spec.rb +1 -1
  97. data/spec/configuration_spec.rb +1 -1
  98. data/spec/models/app_spec.rb +1 -1
  99. data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +1 -1
  100. data/spec/models/basic_notification_all_of_spec.rb +13 -7
  101. data/spec/models/basic_notification_spec.rb +14 -14
  102. data/spec/models/button_spec.rb +1 -1
  103. data/spec/models/create_notification_success_response_spec.rb +1 -7
  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_user_conflict_response_errors_inner_spec.rb +1 -1
  107. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +1 -1
  108. data/spec/models/create_user_conflict_response_spec.rb +1 -1
  109. data/spec/models/delivery_data_spec.rb +1 -1
  110. data/spec/models/export_events_success_response_spec.rb +1 -1
  111. data/spec/models/{export_players_request_body_spec.rb → export_subscriptions_request_body_spec.rb} +7 -7
  112. data/spec/models/{export_players_success_response_spec.rb → export_subscriptions_success_response_spec.rb} +7 -7
  113. data/spec/models/{notification200_errors_spec.rb → filter_expression_spec.rb} +3 -3
  114. data/spec/models/filter_spec.rb +25 -1
  115. data/spec/models/generic_error_spec.rb +13 -1
  116. data/spec/models/{delete_player_success_response_spec.rb → generic_success_bool_response_spec.rb} +7 -7
  117. data/spec/models/{get_notification_request_body_spec.rb → get_notification_history_request_body_spec.rb} +7 -7
  118. data/spec/models/{player_slice_spec.rb → get_segments_success_response_spec.rb} +8 -8
  119. data/spec/models/{string_map_spec.rb → language_string_map_spec.rb} +7 -7
  120. data/spec/models/notification_all_of_spec.rb +1 -1
  121. data/spec/models/notification_history_success_response_spec.rb +1 -1
  122. data/spec/models/notification_slice_spec.rb +1 -1
  123. data/spec/models/notification_spec.rb +14 -14
  124. data/spec/models/notification_target_spec.rb +2 -8
  125. data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
  126. data/spec/models/notification_with_meta_spec.rb +14 -14
  127. data/spec/models/operator_spec.rb +1 -1
  128. data/spec/models/outcome_data_spec.rb +1 -1
  129. data/spec/models/outcomes_data_spec.rb +1 -1
  130. data/spec/models/platform_delivery_data_email_all_of_spec.rb +1 -1
  131. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +1 -1
  132. data/spec/models/platform_delivery_data_spec.rb +1 -1
  133. data/spec/models/{inline_response202_spec.rb → properties_body_spec.rb} +7 -7
  134. data/spec/models/properties_deltas_spec.rb +1 -1
  135. data/spec/models/properties_object_spec.rb +1 -1
  136. data/spec/models/purchase_spec.rb +1 -1
  137. data/spec/models/{generic_error_errors_inner_spec.rb → rate_limit_error_spec.rb} +9 -9
  138. data/spec/models/{filter_expressions_spec.rb → segment_data_spec.rb} +24 -20
  139. data/spec/models/segment_notification_target_spec.rb +1 -1
  140. data/spec/models/segment_spec.rb +1 -1
  141. data/spec/models/{inline_response201_spec.rb → subscription_body_spec.rb} +7 -7
  142. data/spec/models/{player_notification_target_spec.rb → subscription_notification_target_spec.rb} +8 -14
  143. data/spec/models/{subscription_object_spec.rb → subscription_spec.rb} +7 -7
  144. data/spec/models/transfer_subscription_request_body_spec.rb +1 -1
  145. data/spec/models/update_live_activity_request_spec.rb +32 -6
  146. data/spec/models/update_live_activity_success_response_spec.rb +2 -8
  147. data/spec/models/update_user_request_spec.rb +1 -1
  148. data/spec/models/{user_identity_response_spec.rb → user_identity_body_spec.rb} +7 -7
  149. data/spec/models/user_spec.rb +1 -7
  150. data/spec/models/{create_player_success_response_spec.rb → web_button_spec.rb} +21 -9
  151. data/spec/spec_helper.rb +1 -1
  152. metadata +61 -131
  153. data/docs/BeginLiveActivityRequest.md +0 -20
  154. data/docs/CancelNotificationSuccessResponse.md +0 -18
  155. data/docs/CreatePlayerSuccessResponse.md +0 -20
  156. data/docs/CreateSubscriptionRequestBody.md +0 -20
  157. data/docs/DeletePlayerNotFoundResponse.md +0 -18
  158. data/docs/DeleteSegmentNotFoundResponse.md +0 -18
  159. data/docs/DeleteSegmentSuccessResponse.md +0 -18
  160. data/docs/FilterExpressions.md +0 -26
  161. data/docs/InlineResponse2003.md +0 -18
  162. data/docs/InlineResponse201.md +0 -18
  163. data/docs/InvalidIdentifierError.md +0 -20
  164. data/docs/Player.md +0 -70
  165. data/docs/PlayerNotificationTarget.md +0 -40
  166. data/docs/PlayerNotificationTargetIncludeAliases.md +0 -18
  167. data/docs/PlayerSlice.md +0 -24
  168. data/docs/UpdatePlayerSuccessResponse.md +0 -18
  169. data/docs/UpdatePlayerTagsRequestBody.md +0 -18
  170. data/docs/UpdatePlayerTagsSuccessResponse.md +0 -18
  171. data/docs/UpdateSubscriptionRequestBody.md +0 -18
  172. data/docs/UserIdentityRequestBody.md +0 -18
  173. data/docs/UserIdentityResponse.md +0 -18
  174. data/docs/UserSubscriptionOptions.md +0 -18
  175. data/lib/onesignal/models/cancel_notification_success_response.rb +0 -219
  176. data/lib/onesignal/models/create_subscription_request_body.rb +0 -228
  177. data/lib/onesignal/models/delete_player_not_found_response.rb +0 -219
  178. data/lib/onesignal/models/delete_player_success_response.rb +0 -219
  179. data/lib/onesignal/models/delete_segment_not_found_response.rb +0 -219
  180. data/lib/onesignal/models/delete_segment_success_response.rb +0 -219
  181. data/lib/onesignal/models/filter_expressions.rb +0 -336
  182. data/lib/onesignal/models/generic_error_errors_inner.rb +0 -228
  183. data/lib/onesignal/models/inline_response2003.rb +0 -221
  184. data/lib/onesignal/models/invalid_identifier_error.rb +0 -234
  185. data/lib/onesignal/models/player.rb +0 -494
  186. data/lib/onesignal/models/player_notification_target_include_aliases.rb +0 -221
  187. data/lib/onesignal/models/update_player_tags_request_body.rb +0 -220
  188. data/lib/onesignal/models/update_player_tags_success_response.rb +0 -219
  189. data/lib/onesignal/models/update_subscription_request_body.rb +0 -219
  190. data/lib/onesignal/models/user_identity_request_body.rb +0 -221
  191. data/lib/onesignal/models/user_identity_response.rb +0 -221
  192. data/lib/onesignal/models/user_subscription_options.rb +0 -219
  193. data/spec/models/begin_live_activity_request_spec.rb +0 -40
  194. data/spec/models/cancel_notification_success_response_spec.rb +0 -34
  195. data/spec/models/create_subscription_request_body_spec.rb +0 -40
  196. data/spec/models/delete_player_not_found_response_spec.rb +0 -34
  197. data/spec/models/delete_segment_not_found_response_spec.rb +0 -34
  198. data/spec/models/delete_segment_success_response_spec.rb +0 -34
  199. data/spec/models/inline_response2003_spec.rb +0 -34
  200. data/spec/models/inline_response200_spec.rb +0 -34
  201. data/spec/models/invalid_identifier_error_spec.rb +0 -40
  202. data/spec/models/player_notification_target_include_aliases_spec.rb +0 -34
  203. data/spec/models/player_spec.rb +0 -190
  204. data/spec/models/rate_limiter_error_spec.rb +0 -34
  205. data/spec/models/update_player_success_response_spec.rb +0 -34
  206. data/spec/models/update_player_tags_request_body_spec.rb +0 -34
  207. data/spec/models/update_player_tags_success_response_spec.rb +0 -34
  208. data/spec/models/update_subscription_request_body_spec.rb +0 -34
  209. data/spec/models/user_identity_request_body_spec.rb +0 -34
  210. data/spec/models/user_subscription_options_spec.rb +0 -34
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 997f117ec5b13d053b2b7a16d2185b9fe3eb68ff2fe9fc4be7b60a9664557c70
4
- data.tar.gz: c3ef726d22548453024965021e2a3df1b9d17251f6eca697f1861e0b688dabda
3
+ metadata.gz: 30a44e91c0c5fc15a57d4bb8961ec55515d9a354256e05d9c6f7729f405267c1
4
+ data.tar.gz: acfb01d7b382422a6aca3d1a052660fa6768a94652d026686e6f9e3bafb99fe5
5
5
  SHA512:
6
- metadata.gz: 846708566dfe100ccf7ec812089806cc62b6d9ee3a02bee4eb991c369efa8d492480135b78568742dc6e6398c1bb88fbffe33cde60844a4c461fed9d534d4e07
7
- data.tar.gz: '09e8a977df94b04f41801addb07a1ca2275177585fdfa3c4c61f5be9c6b0dc993aba3310970f75ddda7c36a8892cbb613b5496f14f7d3bcad776bccbc0121cbc'
6
+ metadata.gz: 6d98702e56c7dff1e00c41247a266b4b49ff288f2648f38e0bb87fc8290da62f891bd49bb06d1c295f73fa9f815dde79d52087101bf23b1d311139334c0533d9
7
+ data.tar.gz: e4a7910b982bba009d520b6811148bd0bd03945fec767b4687f99c50e7b4464d4b06e77e002cbe53f85e540bac0f9d47ddf9662fa2ece8e02d5a26aaee645916
data/README.md CHANGED
@@ -6,8 +6,8 @@ A powerful way to send personalized messages at scale and build effective custom
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 1.4.1
10
- - Package version: 2.2.1
9
+ - API version: 5.1.0
10
+ - Package version: 5.1.0-beta1
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://onesignal.com](https://onesignal.com)
13
13
 
@@ -24,16 +24,16 @@ gem build onesignal.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./onesignal-2.2.1.gem
27
+ gem install ./onesignal-5.1.0-beta1.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./onesignal-2.2.1.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./onesignal-5.1.0-beta1.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'onesignal', '~> 2.2.1'
36
+ gem 'onesignal', '~> 5.1.0-beta1'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -59,22 +59,22 @@ require 'onesignal'
59
59
 
60
60
  # Setup authorization
61
61
  OneSignal.configure do |config|
62
- # Configure Bearer authorization: user_key
63
- config.user_key = 'ORGANIZATION_API_KEY' # Organization key is only required for creating new apps and other top-level endpoints
64
- # Configure Bearer authorization: app_key
65
- config.app_key = 'REST_API_KEY' # App REST API key required for most endpoints
62
+ # Configure Bearer authorization: organization_api_key
63
+ config.organization_api_key = 'ORGANIZATION_API_KEY' # Organization key is only required for creating new apps and other top-level endpoints
64
+ # Configure Bearer authorization: rest_api_key
65
+ config.rest_api_key = 'REST_API_KEY' # App REST API key required for most endpoints
66
66
  end
67
67
 
68
68
  api_instance = OneSignal::DefaultApi.new
69
- app_id = 'app_id_example' # String | The OneSignal App ID for your app. Available in Keys & IDs.
70
- activity_id = 'activity_id_example' # String | Live Activity record ID
71
- begin_live_activity_request = OneSignal::BeginLiveActivityRequest.new({push_token: 'push_token_example', subscription_id: 'subscription_id_example'}) # BeginLiveActivityRequest |
69
+ app_id = 'app_id_example' # String |
70
+ notification_id = 'notification_id_example' # String |
72
71
 
73
72
  begin
74
- #Start Live Activity
75
- api_instance.begin_live_activity(app_id, activity_id, begin_live_activity_request)
73
+ #Stop a scheduled or currently outgoing notification
74
+ result = api_instance.cancel_notification(app_id, notification_id)
75
+ p result
76
76
  rescue OneSignal::ApiError => e
77
- puts "Exception when calling DefaultApi->begin_live_activity: #{e}"
77
+ puts "Exception when calling DefaultApi->cancel_notification: #{e}"
78
78
  end
79
79
 
80
80
  ```
@@ -85,41 +85,34 @@ All URIs are relative to *https://api.onesignal.com*
85
85
 
86
86
  Class | Method | HTTP request | Description
87
87
  ------------ | ------------- | ------------- | -------------
88
- *OneSignal::DefaultApi* | [**begin_live_activity**](docs/DefaultApi.md#begin_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity
89
88
  *OneSignal::DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
89
+ *OneSignal::DefaultApi* | [**create_alias**](docs/DefaultApi.md#create_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
90
+ *OneSignal::DefaultApi* | [**create_alias_by_subscription**](docs/DefaultApi.md#create_alias_by_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
90
91
  *OneSignal::DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app
91
92
  *OneSignal::DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification
92
- *OneSignal::DefaultApi* | [**create_player**](docs/DefaultApi.md#create_player) | **POST** /players | Add a device
93
- *OneSignal::DefaultApi* | [**create_segments**](docs/DefaultApi.md#create_segments) | **POST** /apps/{app_id}/segments | Create Segments
93
+ *OneSignal::DefaultApi* | [**create_segment**](docs/DefaultApi.md#create_segment) | **POST** /apps/{app_id}/segments | Create Segment
94
94
  *OneSignal::DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
95
95
  *OneSignal::DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users |
96
96
  *OneSignal::DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
97
- *OneSignal::DefaultApi* | [**delete_player**](docs/DefaultApi.md#delete_player) | **DELETE** /players/{player_id} | Delete a user record
98
- *OneSignal::DefaultApi* | [**delete_segments**](docs/DefaultApi.md#delete_segments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
97
+ *OneSignal::DefaultApi* | [**delete_segment**](docs/DefaultApi.md#delete_segment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment
99
98
  *OneSignal::DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
100
99
  *OneSignal::DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
101
- *OneSignal::DefaultApi* | [**end_live_activity**](docs/DefaultApi.md#end_live_activity) | **DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
102
100
  *OneSignal::DefaultApi* | [**export_events**](docs/DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events
103
- *OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Players
104
- *OneSignal::DefaultApi* | [**fetch_aliases**](docs/DefaultApi.md#fetch_aliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
105
- *OneSignal::DefaultApi* | [**fetch_user**](docs/DefaultApi.md#fetch_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
106
- *OneSignal::DefaultApi* | [**fetch_user_identity**](docs/DefaultApi.md#fetch_user_identity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
101
+ *OneSignal::DefaultApi* | [**export_subscriptions**](docs/DefaultApi.md#export_subscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions
102
+ *OneSignal::DefaultApi* | [**get_aliases**](docs/DefaultApi.md#get_aliases) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
103
+ *OneSignal::DefaultApi* | [**get_aliases_by_subscription**](docs/DefaultApi.md#get_aliases_by_subscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
107
104
  *OneSignal::DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app
108
105
  *OneSignal::DefaultApi* | [**get_apps**](docs/DefaultApi.md#get_apps) | **GET** /apps | View apps
109
- *OneSignal::DefaultApi* | [**get_eligible_iams**](docs/DefaultApi.md#get_eligible_iams) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/iams |
110
106
  *OneSignal::DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification
111
107
  *OneSignal::DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History
112
108
  *OneSignal::DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications
113
109
  *OneSignal::DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
114
- *OneSignal::DefaultApi* | [**get_player**](docs/DefaultApi.md#get_player) | **GET** /players/{player_id} | View device
115
- *OneSignal::DefaultApi* | [**get_players**](docs/DefaultApi.md#get_players) | **GET** /players | View devices
116
- *OneSignal::DefaultApi* | [**identify_user_by_alias**](docs/DefaultApi.md#identify_user_by_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
117
- *OneSignal::DefaultApi* | [**identify_user_by_subscription_id**](docs/DefaultApi.md#identify_user_by_subscription_id) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
110
+ *OneSignal::DefaultApi* | [**get_segments**](docs/DefaultApi.md#get_segments) | **GET** /apps/{app_id}/segments | Get Segments
111
+ *OneSignal::DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
118
112
  *OneSignal::DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
113
+ *OneSignal::DefaultApi* | [**unsubscribe_email_with_token**](docs/DefaultApi.md#unsubscribe_email_with_token) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token
119
114
  *OneSignal::DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app
120
115
  *OneSignal::DefaultApi* | [**update_live_activity**](docs/DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
121
- *OneSignal::DefaultApi* | [**update_player**](docs/DefaultApi.md#update_player) | **PUT** /players/{player_id} | Edit device
122
- *OneSignal::DefaultApi* | [**update_player_tags**](docs/DefaultApi.md#update_player_tags) | **PUT** /apps/{app_id}/users/{external_user_id} | Edit tags with external user id
123
116
  *OneSignal::DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
124
117
  *OneSignal::DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
125
118
 
@@ -130,37 +123,25 @@ Class | Method | HTTP request | Description
130
123
  - [OneSignal::BasicNotification](docs/BasicNotification.md)
131
124
  - [OneSignal::BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
132
125
  - [OneSignal::BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
133
- - [OneSignal::BeginLiveActivityRequest](docs/BeginLiveActivityRequest.md)
134
126
  - [OneSignal::Button](docs/Button.md)
135
- - [OneSignal::CancelNotificationSuccessResponse](docs/CancelNotificationSuccessResponse.md)
136
127
  - [OneSignal::CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md)
137
- - [OneSignal::CreatePlayerSuccessResponse](docs/CreatePlayerSuccessResponse.md)
138
128
  - [OneSignal::CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
139
129
  - [OneSignal::CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
140
- - [OneSignal::CreateSubscriptionRequestBody](docs/CreateSubscriptionRequestBody.md)
141
130
  - [OneSignal::CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
142
131
  - [OneSignal::CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
143
132
  - [OneSignal::CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md)
144
- - [OneSignal::DeletePlayerNotFoundResponse](docs/DeletePlayerNotFoundResponse.md)
145
- - [OneSignal::DeletePlayerSuccessResponse](docs/DeletePlayerSuccessResponse.md)
146
- - [OneSignal::DeleteSegmentNotFoundResponse](docs/DeleteSegmentNotFoundResponse.md)
147
- - [OneSignal::DeleteSegmentSuccessResponse](docs/DeleteSegmentSuccessResponse.md)
148
133
  - [OneSignal::DeliveryData](docs/DeliveryData.md)
149
134
  - [OneSignal::ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
150
- - [OneSignal::ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
151
- - [OneSignal::ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
135
+ - [OneSignal::ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md)
136
+ - [OneSignal::ExportSubscriptionsSuccessResponse](docs/ExportSubscriptionsSuccessResponse.md)
152
137
  - [OneSignal::Filter](docs/Filter.md)
153
- - [OneSignal::FilterExpressions](docs/FilterExpressions.md)
138
+ - [OneSignal::FilterExpression](docs/FilterExpression.md)
154
139
  - [OneSignal::GenericError](docs/GenericError.md)
155
- - [OneSignal::GenericErrorErrorsInner](docs/GenericErrorErrorsInner.md)
156
- - [OneSignal::GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
157
- - [OneSignal::InlineResponse200](docs/InlineResponse200.md)
158
- - [OneSignal::InlineResponse2003](docs/InlineResponse2003.md)
159
- - [OneSignal::InlineResponse201](docs/InlineResponse201.md)
160
- - [OneSignal::InlineResponse202](docs/InlineResponse202.md)
161
- - [OneSignal::InvalidIdentifierError](docs/InvalidIdentifierError.md)
140
+ - [OneSignal::GenericSuccessBoolResponse](docs/GenericSuccessBoolResponse.md)
141
+ - [OneSignal::GetNotificationHistoryRequestBody](docs/GetNotificationHistoryRequestBody.md)
142
+ - [OneSignal::GetSegmentsSuccessResponse](docs/GetSegmentsSuccessResponse.md)
143
+ - [OneSignal::LanguageStringMap](docs/LanguageStringMap.md)
162
144
  - [OneSignal::Notification](docs/Notification.md)
163
- - [OneSignal::Notification200Errors](docs/Notification200Errors.md)
164
145
  - [OneSignal::NotificationAllOf](docs/NotificationAllOf.md)
165
146
  - [OneSignal::NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md)
166
147
  - [OneSignal::NotificationSlice](docs/NotificationSlice.md)
@@ -173,40 +154,34 @@ Class | Method | HTTP request | Description
173
154
  - [OneSignal::PlatformDeliveryData](docs/PlatformDeliveryData.md)
174
155
  - [OneSignal::PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md)
175
156
  - [OneSignal::PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md)
176
- - [OneSignal::Player](docs/Player.md)
177
- - [OneSignal::PlayerNotificationTarget](docs/PlayerNotificationTarget.md)
178
- - [OneSignal::PlayerNotificationTargetIncludeAliases](docs/PlayerNotificationTargetIncludeAliases.md)
179
- - [OneSignal::PlayerSlice](docs/PlayerSlice.md)
157
+ - [OneSignal::PropertiesBody](docs/PropertiesBody.md)
180
158
  - [OneSignal::PropertiesDeltas](docs/PropertiesDeltas.md)
181
159
  - [OneSignal::PropertiesObject](docs/PropertiesObject.md)
182
160
  - [OneSignal::Purchase](docs/Purchase.md)
183
- - [OneSignal::RateLimiterError](docs/RateLimiterError.md)
161
+ - [OneSignal::RateLimitError](docs/RateLimitError.md)
184
162
  - [OneSignal::Segment](docs/Segment.md)
163
+ - [OneSignal::SegmentData](docs/SegmentData.md)
185
164
  - [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
186
- - [OneSignal::StringMap](docs/StringMap.md)
187
- - [OneSignal::SubscriptionObject](docs/SubscriptionObject.md)
165
+ - [OneSignal::Subscription](docs/Subscription.md)
166
+ - [OneSignal::SubscriptionBody](docs/SubscriptionBody.md)
167
+ - [OneSignal::SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md)
188
168
  - [OneSignal::TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md)
189
169
  - [OneSignal::UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
190
170
  - [OneSignal::UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
191
- - [OneSignal::UpdatePlayerSuccessResponse](docs/UpdatePlayerSuccessResponse.md)
192
- - [OneSignal::UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
193
- - [OneSignal::UpdatePlayerTagsSuccessResponse](docs/UpdatePlayerTagsSuccessResponse.md)
194
- - [OneSignal::UpdateSubscriptionRequestBody](docs/UpdateSubscriptionRequestBody.md)
195
171
  - [OneSignal::UpdateUserRequest](docs/UpdateUserRequest.md)
196
172
  - [OneSignal::User](docs/User.md)
197
- - [OneSignal::UserIdentityRequestBody](docs/UserIdentityRequestBody.md)
198
- - [OneSignal::UserIdentityResponse](docs/UserIdentityResponse.md)
199
- - [OneSignal::UserSubscriptionOptions](docs/UserSubscriptionOptions.md)
173
+ - [OneSignal::UserIdentityBody](docs/UserIdentityBody.md)
174
+ - [OneSignal::WebButton](docs/WebButton.md)
200
175
 
201
176
 
202
177
  ## Documentation for Authorization
203
178
 
204
179
 
205
- ### app_key
180
+ ### organization_api_key
206
181
 
207
182
  - **Type**: Bearer authentication
208
183
 
209
- ### user_key
184
+ ### rest_api_key
210
185
 
211
186
  - **Type**: Bearer authentication
212
187
 
data/docs/BasicNotification.md CHANGED
@@ -6,17 +6,16 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **included_segments** | **Array<String>** | The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] |
8
8
  | **excluded_segments** | **Array<String>** | 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\"] | [optional] |
9
- | **include_player_ids** | **Array<String>** | 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 | [optional] |
10
- | **include_external_user_ids** | **Array<String>** | Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\"custom-id-assigned-by-api\"] 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 channel_for_external_user_ids to indicate you are sending a push or email or sms. | [optional] |
9
+ | **include_subscription_ids** | **Array<String>** | Specific subscription ids to send your notification to. _Does not require API Auth Key._ Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call | [optional] |
11
10
  | **include_email_tokens** | **Array<String>** | Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call | [optional] |
12
11
  | **include_phone_numbers** | **Array<String>** | Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call | [optional] |
13
- | **include_ios_tokens** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call | [optional] |
14
- | **include_wp_wns_uris** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call | [optional] |
15
- | **include_amazon_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call | [optional] |
16
- | **include_chrome_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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] |
17
- | **include_chrome_web_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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] |
18
- | **include_android_reg_ids** | **Array<String>** | 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 | [optional] |
19
- | **include_aliases** | [**PlayerNotificationTargetIncludeAliases**](PlayerNotificationTargetIncludeAliases.md) | | [optional] |
12
+ | **include_ios_tokens** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call | [optional] |
13
+ | **include_wp_wns_uris** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call | [optional] |
14
+ | **include_amazon_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call | [optional] |
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
+ | **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
+ | **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] |
20
19
  | **target_channel** | **String** | | [optional] |
21
20
  | **id** | **String** | | [optional] |
22
21
  | **value** | **Integer** | | [optional][readonly] |
@@ -32,13 +31,12 @@
32
31
  | **is_wp_wns** | **Boolean** | Indicates whether to send to all devices registered under your app's Windows platform. | [optional] |
33
32
  | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
34
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] |
35
- | **channel_for_external_user_ids** | **String** | Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS. | [optional] |
36
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. | |
37
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] |
38
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] |
39
- | **contents** | [**StringMap**](StringMap.md) | | [optional] |
40
- | **headings** | [**StringMap**](StringMap.md) | | [optional] |
41
- | **subtitle** | [**StringMap**](StringMap.md) | | [optional] |
37
+ | **contents** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
38
+ | **headings** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
39
+ | **subtitle** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
42
40
  | **data** | **Object** | Channel: Push Notifications Platform: Huawei A custom map of data that is passed back to your app. Same as using Additional Data within the dashboard. Can use up to 2048 bytes of data. Example: {\"abc\": 123, \"foo\": \"bar\", \"event_performed\": true, \"amount\": 12.1} | [optional] |
43
41
  | **huawei_msg_type** | **String** | Channel: Push Notifications Platform: Huawei Use \"data\" or \"message\" depending on the type of notification you are sending. More details in Data & Background Notifications. | [optional] |
44
42
  | **url** | **String** | Channel: Push Notifications Platform: All The URL to open in the browser when a user clicks on the notification. Note: iOS needs https or updated NSAppTransportSecurity in plist This field supports inline substitutions. Omit if including web_url or app_url Example: https://onesignal.com | [optional] |
@@ -55,7 +53,7 @@
55
53
  | **chrome_big_picture** | **String** | Channel: Push Notifications Platform: ChromeApp Large picture to display below the notification text. Must be a local URL. | [optional] |
56
54
  | **chrome_web_image** | **String** | Channel: Push Notifications Platform: Chrome 56+ Sets the web push notification's large image to be shown below the notification's title and text. Please see Web Push Notification Icons. | [optional] |
57
55
  | **buttons** | [**Array<Button>**](Button.md) | Channel: Push Notifications Platform: iOS 8.0+, Android 4.1+, and derivatives like Amazon Buttons to add to the notification. Icon only works for Android. Buttons show in reverse order of array position i.e. Last item in array shows as first button on device. Example: [{\"id\": \"id2\", \"text\": \"second button\", \"icon\": \"ic_menu_share\"}, {\"id\": \"id1\", \"text\": \"first button\", \"icon\": \"ic_menu_send\"}] | [optional] |
58
- | **web_buttons** | [**Array<Button>**](Button.md) | Channel: Push Notifications Platform: Chrome 48+ Add action buttons to the notification. The id field is required. Example: [{\"id\": \"like-button\", \"text\": \"Like\", \"icon\": \"http://i.imgur.com/N8SN8ZS.png\", \"url\": \"https://yoursite.com\"}, {\"id\": \"read-more-button\", \"text\": \"Read more\", \"icon\": \"http://i.imgur.com/MIxJp1L.png\", \"url\": \"https://yoursite.com\"}] | [optional] |
56
+ | **web_buttons** | [**Array<WebButton>**](WebButton.md) | Channel: Push Notifications Platform: Chrome 48+ Add action buttons to the notification. The id field is required. Example: [{\"id\": \"like-button\", \"text\": \"Like\", \"icon\": \"http://i.imgur.com/N8SN8ZS.png\", \"url\": \"https://yoursite.com\"}, {\"id\": \"read-more-button\", \"text\": \"Read more\", \"icon\": \"http://i.imgur.com/MIxJp1L.png\", \"url\": \"https://yoursite.com\"}] | [optional] |
59
57
  | **ios_category** | **String** | Channel: Push Notifications Platform: iOS Category APS payload, use with registerUserNotificationSettings:categories in your Objective-C / Swift code. Example: calendar category which contains actions like accept and decline iOS 10+ This will trigger your UNNotificationContentExtension whose ID matches this category. | [optional] |
60
58
  | **android_channel_id** | **String** | Channel: Push Notifications Platform: Android The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. | [optional] |
61
59
  | **huawei_channel_id** | **String** | Channel: Push Notifications Platform: Huawei The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. | [optional] |
@@ -101,6 +99,8 @@
101
99
  | **thread_id** | **String** | Channel: Push Notifications Platform: iOS 12+ This parameter is supported in iOS 12 and above. It allows you to group related notifications together. If two notifications have the same thread-id, they will both be added to the same group. | [optional] |
102
100
  | **summary_arg** | **String** | Channel: Push Notifications Platform: iOS 12+ When using thread_id to create grouped notifications in iOS 12+, you can also control the summary. For example, a grouped notification can say \"12 more notifications from John Doe\". The summary_arg lets you set the name of the person/thing the notifications are coming from, and will show up as \"X more notifications from summary_arg\" | [optional] |
103
101
  | **summary_arg_count** | **Integer** | Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\" | [optional] |
102
+ | **ios_relevance_score** | **Float** | Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1. | [optional] |
103
+ | **ios_interruption_level** | **String** | Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active. | [optional] |
104
104
  | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
105
105
  | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional] |
106
106
  | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional] |
@@ -109,7 +109,7 @@
109
109
  | **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] |
110
110
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
111
111
  | **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] |
112
- | **filters** | [**Array<Filter>**](Filter.md) | | [optional] |
112
+ | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
113
113
  | **custom_data** | **Object** | 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} | [optional] |
114
114
 
115
115
  ## Example
@@ -120,8 +120,7 @@ require 'onesignal'
120
120
  instance = OneSignal::BasicNotification.new(
121
121
  included_segments: null,
122
122
  excluded_segments: null,
123
- include_player_ids: null,
124
- include_external_user_ids: null,
123
+ include_subscription_ids: null,
125
124
  include_email_tokens: null,
126
125
  include_phone_numbers: null,
127
126
  include_ios_tokens: null,
@@ -146,7 +145,6 @@ instance = OneSignal::BasicNotification.new(
146
145
  is_wp_wns: null,
147
146
  is_adm: null,
148
147
  is_chrome: null,
149
- channel_for_external_user_ids: null,
150
148
  app_id: null,
151
149
  external_id: null,
152
150
  idempotency_key: null,
@@ -215,6 +213,8 @@ instance = OneSignal::BasicNotification.new(
215
213
  thread_id: null,
216
214
  summary_arg: null,
217
215
  summary_arg_count: null,
216
+ ios_relevance_score: null,
217
+ ios_interruption_level: null,
218
218
  email_subject: null,
219
219
  email_body: null,
220
220
  email_from_name: null,
data/docs/BasicNotificationAllOf.md CHANGED
@@ -18,13 +18,12 @@
18
18
  | **is_wp_wns** | **Boolean** | Indicates whether to send to all devices registered under your app's Windows platform. | [optional] |
19
19
  | **is_adm** | **Boolean** | Indicates whether to send to all devices registered under your app's Amazon Fire platform. | [optional] |
20
20
  | **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] |
21
- | **channel_for_external_user_ids** | **String** | Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS. | [optional] |
22
21
  | **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. | [optional] |
23
22
  | **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] |
24
23
  | **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] |
25
- | **contents** | [**StringMap**](StringMap.md) | | [optional] |
26
- | **headings** | [**StringMap**](StringMap.md) | | [optional] |
27
- | **subtitle** | [**StringMap**](StringMap.md) | | [optional] |
24
+ | **contents** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
25
+ | **headings** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
26
+ | **subtitle** | [**LanguageStringMap**](LanguageStringMap.md) | | [optional] |
28
27
  | **data** | **Object** | Channel: Push Notifications Platform: Huawei A custom map of data that is passed back to your app. Same as using Additional Data within the dashboard. Can use up to 2048 bytes of data. Example: {\"abc\": 123, \"foo\": \"bar\", \"event_performed\": true, \"amount\": 12.1} | [optional] |
29
28
  | **huawei_msg_type** | **String** | Channel: Push Notifications Platform: Huawei Use \"data\" or \"message\" depending on the type of notification you are sending. More details in Data & Background Notifications. | [optional] |
30
29
  | **url** | **String** | Channel: Push Notifications Platform: All The URL to open in the browser when a user clicks on the notification. Note: iOS needs https or updated NSAppTransportSecurity in plist This field supports inline substitutions. Omit if including web_url or app_url Example: https://onesignal.com | [optional] |
@@ -41,7 +40,7 @@
41
40
  | **chrome_big_picture** | **String** | Channel: Push Notifications Platform: ChromeApp Large picture to display below the notification text. Must be a local URL. | [optional] |
42
41
  | **chrome_web_image** | **String** | Channel: Push Notifications Platform: Chrome 56+ Sets the web push notification's large image to be shown below the notification's title and text. Please see Web Push Notification Icons. | [optional] |
43
42
  | **buttons** | [**Array<Button>**](Button.md) | Channel: Push Notifications Platform: iOS 8.0+, Android 4.1+, and derivatives like Amazon Buttons to add to the notification. Icon only works for Android. Buttons show in reverse order of array position i.e. Last item in array shows as first button on device. Example: [{\"id\": \"id2\", \"text\": \"second button\", \"icon\": \"ic_menu_share\"}, {\"id\": \"id1\", \"text\": \"first button\", \"icon\": \"ic_menu_send\"}] | [optional] |
44
- | **web_buttons** | [**Array<Button>**](Button.md) | Channel: Push Notifications Platform: Chrome 48+ Add action buttons to the notification. The id field is required. Example: [{\"id\": \"like-button\", \"text\": \"Like\", \"icon\": \"http://i.imgur.com/N8SN8ZS.png\", \"url\": \"https://yoursite.com\"}, {\"id\": \"read-more-button\", \"text\": \"Read more\", \"icon\": \"http://i.imgur.com/MIxJp1L.png\", \"url\": \"https://yoursite.com\"}] | [optional] |
43
+ | **web_buttons** | [**Array<WebButton>**](WebButton.md) | Channel: Push Notifications Platform: Chrome 48+ Add action buttons to the notification. The id field is required. Example: [{\"id\": \"like-button\", \"text\": \"Like\", \"icon\": \"http://i.imgur.com/N8SN8ZS.png\", \"url\": \"https://yoursite.com\"}, {\"id\": \"read-more-button\", \"text\": \"Read more\", \"icon\": \"http://i.imgur.com/MIxJp1L.png\", \"url\": \"https://yoursite.com\"}] | [optional] |
45
44
  | **ios_category** | **String** | Channel: Push Notifications Platform: iOS Category APS payload, use with registerUserNotificationSettings:categories in your Objective-C / Swift code. Example: calendar category which contains actions like accept and decline iOS 10+ This will trigger your UNNotificationContentExtension whose ID matches this category. | [optional] |
46
45
  | **android_channel_id** | **String** | Channel: Push Notifications Platform: Android The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. | [optional] |
47
46
  | **huawei_channel_id** | **String** | Channel: Push Notifications Platform: Huawei The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. | [optional] |
@@ -87,6 +86,8 @@
87
86
  | **thread_id** | **String** | Channel: Push Notifications Platform: iOS 12+ This parameter is supported in iOS 12 and above. It allows you to group related notifications together. If two notifications have the same thread-id, they will both be added to the same group. | [optional] |
88
87
  | **summary_arg** | **String** | Channel: Push Notifications Platform: iOS 12+ When using thread_id to create grouped notifications in iOS 12+, you can also control the summary. For example, a grouped notification can say \"12 more notifications from John Doe\". The summary_arg lets you set the name of the person/thing the notifications are coming from, and will show up as \"X more notifications from summary_arg\" | [optional] |
89
88
  | **summary_arg_count** | **Integer** | Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\" | [optional] |
89
+ | **ios_relevance_score** | **Float** | Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1. | [optional] |
90
+ | **ios_interruption_level** | **String** | Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active. | [optional] |
90
91
  | **email_subject** | **String** | Channel: Email Required. The subject of the email. | [optional] |
91
92
  | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional] |
92
93
  | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional] |
@@ -95,7 +96,7 @@
95
96
  | **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] |
96
97
  | **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
97
98
  | **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] |
98
- | **filters** | [**Array<Filter>**](Filter.md) | | [optional] |
99
+ | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
99
100
  | **custom_data** | **Object** | 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} | [optional] |
100
101
 
101
102
  ## Example
@@ -118,7 +119,6 @@ instance = OneSignal::BasicNotificationAllOf.new(
118
119
  is_wp_wns: null,
119
120
  is_adm: null,
120
121
  is_chrome: null,
121
- channel_for_external_user_ids: null,
122
122
  app_id: null,
123
123
  external_id: null,
124
124
  idempotency_key: null,
@@ -187,6 +187,8 @@ instance = OneSignal::BasicNotificationAllOf.new(
187
187
  thread_id: null,
188
188
  summary_arg: null,
189
189
  summary_arg_count: null,
190
+ ios_relevance_score: null,
191
+ ios_interruption_level: null,
190
192
  email_subject: null,
191
193
  email_body: null,
192
194
  email_from_name: null,
data/docs/CreateNotificationSuccessResponse.md CHANGED
@@ -5,9 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **recipients** | **Integer** | Estimated number of subscribers targetted by notification. | [optional] |
9
8
  | **external_id** | **String** | | [optional] |
10
- | **errors** | [**Notification200Errors**](Notification200Errors.md) | | [optional] |
9
+ | **errors** | **Object** | Errors include the identifiers that are invalid, or that there are no subscribers. | [optional] |
11
10
 
12
11
  ## Example
13
12
 
@@ -16,7 +15,6 @@ require 'onesignal'
16
15
 
17
16
  instance = OneSignal::CreateNotificationSuccessResponse.new(
18
17
  id: null,
19
- recipients: null,
20
18
  external_id: null,
21
19
  errors: null
22
20
  )