onesignal 1.0.0.beta1 → 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 (230) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +31 -0
  3. data/Gemfile.lock +74 -0
  4. data/LICENSE +24 -0
  5. data/README.md +77 -23
  6. data/RELEASE_INSTRUCTIONS.md +11 -0
  7. data/docs/App.md +9 -1
  8. data/docs/BasicNotification.md +230 -0
  9. data/docs/BasicNotificationAllOf.md +202 -0
  10. data/docs/{NotificationAllOfAndroidBackgroundLayout.md → BasicNotificationAllOfAndroidBackgroundLayout.md} +2 -2
  11. data/docs/BeginLiveActivityRequest.md +20 -0
  12. data/docs/CancelNotificationSuccessResponse.md +18 -0
  13. data/docs/CreateNotificationSuccessResponse.md +24 -0
  14. data/docs/{InlineResponse2004.md → CreatePlayerSuccessResponse.md} +2 -2
  15. data/docs/{InlineResponse409.md → CreateSegmentConflictResponse.md} +2 -2
  16. data/docs/CreateSegmentSuccessResponse.md +20 -0
  17. data/docs/CreateSubscriptionRequestBody.md +20 -0
  18. data/docs/CreateUserConflictResponse.md +18 -0
  19. data/docs/CreateUserConflictResponseErrorsInner.md +22 -0
  20. data/docs/CreateUserConflictResponseErrorsItemsMeta.md +18 -0
  21. data/docs/DefaultApi.md +1629 -304
  22. data/docs/DeletePlayerNotFoundResponse.md +18 -0
  23. data/docs/{InlineResponse2001.md → DeletePlayerSuccessResponse.md} +3 -3
  24. data/docs/DeleteSegmentNotFoundResponse.md +18 -0
  25. data/docs/DeleteSegmentSuccessResponse.md +18 -0
  26. data/docs/DeliveryData.md +5 -5
  27. data/docs/{InlineResponse2005.md → ExportEventsSuccessResponse.md} +2 -2
  28. data/docs/ExportPlayersRequestBody.md +2 -2
  29. data/docs/ExportPlayersSuccessResponse.md +18 -0
  30. data/docs/Filter.md +1 -1
  31. data/docs/FilterExpressions.md +1 -1
  32. data/docs/GenericError.md +18 -0
  33. data/docs/GenericErrorErrorsInner.md +20 -0
  34. data/docs/InlineResponse200.md +2 -8
  35. data/docs/InlineResponse2003.md +2 -2
  36. data/docs/InlineResponse201.md +2 -4
  37. data/docs/InlineResponse202.md +18 -0
  38. data/docs/InvalidIdentifierError.md +20 -0
  39. data/docs/Notification.md +33 -41
  40. data/docs/Notification200Errors.md +49 -0
  41. data/docs/NotificationAllOf.md +2 -176
  42. data/docs/{InlineResponse2002.md → NotificationHistorySuccessResponse.md} +3 -3
  43. data/docs/NotificationSlice.md +1 -1
  44. data/docs/NotificationTarget.md +6 -26
  45. data/docs/NotificationWithMeta.md +252 -0
  46. data/docs/NotificationWithMetaAllOf.md +38 -0
  47. data/docs/OutcomesData.md +18 -0
  48. data/docs/PlatformDeliveryData.md +5 -1
  49. data/docs/PlatformDeliveryDataEmailAllOf.md +30 -0
  50. data/docs/PlatformDeliveryDataSmsAllOf.md +22 -0
  51. data/docs/Player.md +3 -3
  52. data/docs/PlayerNotificationTarget.md +6 -2
  53. data/docs/PlayerNotificationTargetIncludeAliases.md +18 -0
  54. data/docs/PropertiesDeltas.md +22 -0
  55. data/docs/PropertiesObject.md +38 -0
  56. data/docs/Purchase.md +4 -2
  57. data/docs/RateLimiterError.md +18 -0
  58. data/docs/StringMap.md +1 -1
  59. data/docs/SubscriptionObject.md +50 -0
  60. data/docs/TransferSubscriptionRequestBody.md +18 -0
  61. data/docs/UpdateLiveActivityRequest.md +24 -0
  62. data/docs/UpdateLiveActivitySuccessResponse.md +20 -0
  63. data/docs/UpdatePlayerSuccessResponse.md +18 -0
  64. data/docs/UpdatePlayerTagsSuccessResponse.md +18 -0
  65. data/docs/UpdateSubscriptionRequestBody.md +18 -0
  66. data/docs/UpdateUserRequest.md +22 -0
  67. data/docs/User.md +24 -0
  68. data/docs/UserIdentityRequestBody.md +18 -0
  69. data/docs/UserIdentityResponse.md +18 -0
  70. data/docs/UserSubscriptionOptions.md +18 -0
  71. data/lib/onesignal/api/default_api.rb +1657 -268
  72. data/lib/onesignal/api_client.rb +9 -7
  73. data/lib/onesignal/api_error.rb +2 -2
  74. data/lib/onesignal/configuration.rb +11 -8
  75. data/lib/onesignal/models/app.rb +59 -8
  76. data/lib/onesignal/models/basic_notification.rb +1442 -0
  77. data/lib/onesignal/models/basic_notification_all_of.rb +1252 -0
  78. data/lib/onesignal/models/{notification_all_of_android_background_layout.rb → basic_notification_all_of_android_background_layout.rb} +6 -5
  79. data/lib/onesignal/models/begin_live_activity_request.rb +238 -0
  80. data/lib/onesignal/models/button.rb +3 -2
  81. data/lib/onesignal/models/cancel_notification_success_response.rb +219 -0
  82. data/lib/onesignal/models/create_notification_success_response.rb +248 -0
  83. data/lib/onesignal/models/{inline_response2004.rb → create_player_success_response.rb} +6 -5
  84. data/lib/onesignal/models/{inline_response409.rb → create_segment_conflict_response.rb} +6 -5
  85. data/lib/onesignal/models/create_segment_success_response.rb +229 -0
  86. data/lib/onesignal/models/create_subscription_request_body.rb +228 -0
  87. data/lib/onesignal/models/{inline_response4001.rb → create_user_conflict_response.rb} +8 -16
  88. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +237 -0
  89. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +219 -0
  90. data/lib/onesignal/models/delete_player_not_found_response.rb +219 -0
  91. data/lib/onesignal/models/{inline_response2001.rb → delete_player_success_response.rb} +7 -6
  92. data/lib/onesignal/models/delete_segment_not_found_response.rb +219 -0
  93. data/lib/onesignal/models/delete_segment_success_response.rb +219 -0
  94. data/lib/onesignal/models/delivery_data.rb +13 -2
  95. data/lib/onesignal/models/{inline_response2005.rb → export_events_success_response.rb} +6 -5
  96. data/lib/onesignal/models/export_players_request_body.rb +5 -4
  97. data/lib/onesignal/models/export_players_success_response.rb +219 -0
  98. data/lib/onesignal/models/filter.rb +4 -3
  99. data/lib/onesignal/models/filter_expressions.rb +4 -3
  100. data/lib/onesignal/models/{inline_response400.rb → generic_error.rb} +7 -6
  101. data/lib/onesignal/models/generic_error_errors_inner.rb +228 -0
  102. data/lib/onesignal/models/get_notification_request_body.rb +3 -2
  103. data/lib/onesignal/models/inline_response200.rb +12 -47
  104. data/lib/onesignal/models/inline_response2003.rb +12 -9
  105. data/lib/onesignal/models/inline_response201.rb +10 -19
  106. data/lib/onesignal/models/{inline_response4002.rb → inline_response202.rb} +13 -14
  107. data/lib/onesignal/models/invalid_identifier_error.rb +234 -0
  108. data/lib/onesignal/models/notification.rb +209 -157
  109. data/lib/onesignal/models/notification200_errors.rb +105 -0
  110. data/lib/onesignal/models/notification_all_of.rb +8 -911
  111. data/lib/onesignal/models/{inline_response2002.rb → notification_history_success_response.rb} +7 -6
  112. data/lib/onesignal/models/notification_slice.rb +4 -3
  113. data/lib/onesignal/models/notification_target.rb +63 -128
  114. data/lib/onesignal/models/notification_with_meta.rb +1557 -0
  115. data/lib/onesignal/models/notification_with_meta_all_of.rb +323 -0
  116. data/lib/onesignal/models/operator.rb +3 -2
  117. data/lib/onesignal/models/outcome_data.rb +3 -2
  118. data/lib/onesignal/models/outcomes_data.rb +221 -0
  119. data/lib/onesignal/models/platform_delivery_data.rb +27 -6
  120. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +287 -0
  121. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +243 -0
  122. data/lib/onesignal/models/player.rb +14 -13
  123. data/lib/onesignal/models/player_notification_target.rb +63 -7
  124. data/lib/onesignal/models/player_notification_target_include_aliases.rb +221 -0
  125. data/lib/onesignal/models/player_slice.rb +3 -2
  126. data/lib/onesignal/models/properties_deltas.rb +239 -0
  127. data/lib/onesignal/models/properties_object.rb +313 -0
  128. data/lib/onesignal/models/purchase.rb +17 -7
  129. data/lib/onesignal/models/rate_limiter_error.rb +221 -0
  130. data/lib/onesignal/models/segment.rb +3 -2
  131. data/lib/onesignal/models/segment_notification_target.rb +3 -2
  132. data/lib/onesignal/models/string_map.rb +3 -7
  133. data/lib/onesignal/models/{filter_notification_target.rb → subscription_object.rb} +147 -79
  134. data/lib/onesignal/models/transfer_subscription_request_body.rb +221 -0
  135. data/lib/onesignal/models/update_live_activity_request.rb +309 -0
  136. data/lib/onesignal/models/update_live_activity_success_response.rb +228 -0
  137. data/lib/onesignal/models/update_player_success_response.rb +219 -0
  138. data/lib/onesignal/models/update_player_tags_request_body.rb +3 -2
  139. data/lib/onesignal/models/update_player_tags_success_response.rb +219 -0
  140. data/lib/onesignal/models/update_subscription_request_body.rb +219 -0
  141. data/lib/onesignal/models/update_user_request.rb +239 -0
  142. data/lib/onesignal/models/user.rb +250 -0
  143. data/lib/onesignal/models/user_identity_request_body.rb +221 -0
  144. data/lib/onesignal/models/user_identity_response.rb +221 -0
  145. data/lib/onesignal/models/user_subscription_options.rb +219 -0
  146. data/lib/onesignal/version.rb +3 -3
  147. data/lib/onesignal.rb +111 -0
  148. data/onesignal.gemspec +5 -4
  149. data/spec/api/default_api_spec.rb +263 -26
  150. data/spec/api_client_spec.rb +4 -4
  151. data/spec/configuration_spec.rb +5 -5
  152. data/spec/models/app_spec.rb +26 -2
  153. data/spec/models/{notification_all_of_android_background_layout_spec.rb → basic_notification_all_of_android_background_layout_spec.rb} +8 -8
  154. data/spec/models/basic_notification_all_of_spec.rb +590 -0
  155. data/spec/models/basic_notification_spec.rb +678 -0
  156. data/spec/models/begin_live_activity_request_spec.rb +40 -0
  157. data/spec/models/button_spec.rb +2 -2
  158. data/spec/models/cancel_notification_success_response_spec.rb +34 -0
  159. data/spec/models/create_notification_success_response_spec.rb +52 -0
  160. data/spec/models/{inline_response2004_spec.rb → create_player_success_response_spec.rb} +8 -8
  161. data/spec/models/{inline_response4001_spec.rb → create_segment_conflict_response_spec.rb} +8 -8
  162. data/spec/models/{inline_response409_spec.rb → create_segment_success_response_spec.rb} +9 -9
  163. data/spec/models/create_subscription_request_body_spec.rb +40 -0
  164. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +46 -0
  165. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +34 -0
  166. data/spec/models/create_user_conflict_response_spec.rb +34 -0
  167. data/spec/models/delete_player_not_found_response_spec.rb +34 -0
  168. data/spec/models/{inline_response2001_spec.rb → delete_player_success_response_spec.rb} +8 -8
  169. data/spec/models/delete_segment_not_found_response_spec.rb +34 -0
  170. data/spec/models/delete_segment_success_response_spec.rb +34 -0
  171. data/spec/models/delivery_data_spec.rb +2 -2
  172. data/spec/models/{inline_response2005_spec.rb → export_events_success_response_spec.rb} +8 -8
  173. data/spec/models/export_players_request_body_spec.rb +2 -2
  174. data/spec/models/export_players_success_response_spec.rb +34 -0
  175. data/spec/models/filter_expressions_spec.rb +2 -2
  176. data/spec/models/filter_spec.rb +2 -2
  177. data/spec/models/generic_error_errors_inner_spec.rb +40 -0
  178. data/spec/models/{inline_response4002_spec.rb → generic_error_spec.rb} +9 -9
  179. data/spec/models/get_notification_request_body_spec.rb +2 -2
  180. data/spec/models/inline_response2003_spec.rb +3 -3
  181. data/spec/models/inline_response200_spec.rb +3 -21
  182. data/spec/models/inline_response201_spec.rb +3 -9
  183. data/spec/models/{inline_response400_spec.rb → inline_response202_spec.rb} +9 -9
  184. data/spec/models/invalid_identifier_error_spec.rb +40 -0
  185. data/spec/models/notification200_errors_spec.rb +31 -0
  186. data/spec/models/notification_all_of_spec.rb +2 -528
  187. data/spec/models/{inline_response2002_spec.rb → notification_history_success_response_spec.rb} +8 -8
  188. data/spec/models/notification_slice_spec.rb +2 -2
  189. data/spec/models/notification_spec.rb +58 -78
  190. data/spec/models/notification_target_spec.rb +18 -74
  191. data/spec/models/notification_with_meta_all_of_spec.rb +94 -0
  192. data/spec/models/notification_with_meta_spec.rb +744 -0
  193. data/spec/models/operator_spec.rb +2 -2
  194. data/spec/models/outcome_data_spec.rb +2 -2
  195. data/spec/models/outcomes_data_spec.rb +34 -0
  196. data/spec/models/platform_delivery_data_email_all_of_spec.rb +70 -0
  197. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +46 -0
  198. data/spec/models/platform_delivery_data_spec.rb +14 -2
  199. data/spec/models/player_notification_target_include_aliases_spec.rb +34 -0
  200. data/spec/models/player_notification_target_spec.rb +18 -2
  201. data/spec/models/player_slice_spec.rb +2 -2
  202. data/spec/models/player_spec.rb +2 -2
  203. data/spec/models/properties_deltas_spec.rb +46 -0
  204. data/spec/models/{filter_notification_target_spec.rb → properties_object_spec.rb} +19 -25
  205. data/spec/models/purchase_spec.rb +8 -2
  206. data/spec/models/rate_limiter_error_spec.rb +34 -0
  207. data/spec/models/segment_notification_target_spec.rb +2 -2
  208. data/spec/models/segment_spec.rb +2 -2
  209. data/spec/models/string_map_spec.rb +2 -2
  210. data/spec/models/subscription_object_spec.rb +134 -0
  211. data/spec/models/transfer_subscription_request_body_spec.rb +34 -0
  212. data/spec/models/update_live_activity_request_spec.rb +60 -0
  213. data/spec/models/update_live_activity_success_response_spec.rb +40 -0
  214. data/spec/models/update_player_success_response_spec.rb +34 -0
  215. data/spec/models/update_player_tags_request_body_spec.rb +2 -2
  216. data/spec/models/update_player_tags_success_response_spec.rb +34 -0
  217. data/spec/models/update_subscription_request_body_spec.rb +34 -0
  218. data/spec/models/update_user_request_spec.rb +46 -0
  219. data/spec/models/user_identity_request_body_spec.rb +34 -0
  220. data/spec/models/user_identity_response_spec.rb +34 -0
  221. data/spec/models/user_spec.rb +52 -0
  222. data/spec/models/user_subscription_options_spec.rb +34 -0
  223. data/spec/spec_helper.rb +2 -2
  224. metadata +198 -51
  225. data/docs/FilterNotificationTarget.md +0 -40
  226. data/docs/InlineResponse400.md +0 -18
  227. data/docs/InlineResponse4001.md +0 -20
  228. data/docs/InlineResponse4002.md +0 -18
  229. data/git_push.sh +0 -58
  230. data/lib/OneSignal.rb +0 -75
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d21c45ad6dc835a3d618d705c0abad6b42cb5d81733232519ff6305f444736cd
4
- data.tar.gz: cb84fa7dcfbf2dbbce153806f056f059587aa45fda020451f2df01ffe496b235
3
+ metadata.gz: d087519e511c69b765b35d1f1c3ba69a245465c670d80e3dd1a69e3c50052a53
4
+ data.tar.gz: 6f87d39ff098997f9b4a13a1ed3f65ca570a802ac59934dc627fa79481b8678c
5
5
  SHA512:
6
- metadata.gz: 798df78ec20c50fddf2cc396900b83209d684e15f4a978b1c15a2a6fe33eb8b6bd33c149806a3984bc837ce79e4610da405d1774252cd4f8c7261b96846c3d39
7
- data.tar.gz: 2091ac298b863f0658ecb69eb20009231216f4ad4a044a55ee67f356ea0d19038953ebfdbffc28731cb110e58ac8a4ede9b8f5f411904ef5e86bda9f2abb9549
6
+ metadata.gz: 5572c14f560b567879b7ad5b9566bcd0fcb2ff907b695b0ac3d0e75d77856929563e73e4ffd8d0358713449f67dc8e8154ac42f34d99ff795f504a9fbab0aee5
7
+ data.tar.gz: 6adfcc757e606b4ac159bd6858e2a6b5e9e4af3fca4ee719d52a5608162c0088abd31f31622c61561363e1e10d863d445b4964a7238f72b096d99c0c56f495bc
data/CHANGELOG.md ADDED
@@ -0,0 +1,31 @@
1
+ # Change Log
2
+ All notable changes to this project will be documented in this file.
3
+ This project adheres to [Semantic Versioning](http://semver.org/).
4
+
5
+ ## [1.0.0.beta1] - 2021-10-13
6
+ ### Major Release
7
+ **INCLUDES BREAKING CHANGES**
8
+ This release is the code-generated Ruby client made with OpenAPI Generator.
9
+ The release is a complete overhaul and includes a new API.
10
+ See README for full documentation.
11
+
12
+ **Full Changelog**: https://github.com/OneSignal/onesignal-ruby-client/compare/v0.3.0...1.0.0.beta1
13
+
14
+ ## [0.3.0] - 2016-05-10
15
+ ### Added
16
+ * Models dynamically create attributes on initialization
17
+
18
+ ## [0.2.0] - 2016-04-29
19
+ ### Added
20
+ * Ruby 2.0 compatibility
21
+ * CHANGELOG
22
+
23
+ ### Fixed
24
+ * Typos in README
25
+
26
+ ## 0.1.0 - 2016-03-29
27
+ ### Added
28
+ * Methods for all OneSignal resources
29
+
30
+ [0.3.0]: https://github.com/coding-chimp/onesignal/compare/v0.2.0...v0.3.0
31
+ [0.2.0]: https://github.com/coding-chimp/onesignal/compare/v0.1.0...v0.2.0
data/Gemfile.lock ADDED
@@ -0,0 +1,74 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ onesignal (2.2.0)
5
+ typhoeus (~> 1.0, >= 1.0.1)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ ast (2.4.3)
11
+ byebug (11.1.3)
12
+ coderay (1.1.3)
13
+ date (3.4.1)
14
+ diff-lcs (1.6.1)
15
+ ethon (0.16.0)
16
+ ffi (>= 1.15.0)
17
+ ffi (1.17.1)
18
+ jaro_winkler (1.5.6)
19
+ method_source (1.1.0)
20
+ parallel (1.24.0)
21
+ parser (3.3.7.4)
22
+ ast (~> 2.4.1)
23
+ racc
24
+ pry (0.13.1)
25
+ coderay (~> 1.1)
26
+ method_source (~> 1.0)
27
+ pry-byebug (3.9.0)
28
+ byebug (~> 11.0)
29
+ pry (~> 0.13.0)
30
+ psych (5.2.3)
31
+ date
32
+ stringio
33
+ racc (1.8.1)
34
+ rainbow (3.1.1)
35
+ rake (13.0.6)
36
+ rspec (3.13.0)
37
+ rspec-core (~> 3.13.0)
38
+ rspec-expectations (~> 3.13.0)
39
+ rspec-mocks (~> 3.13.0)
40
+ rspec-core (3.13.3)
41
+ rspec-support (~> 3.13.0)
42
+ rspec-expectations (3.13.3)
43
+ diff-lcs (>= 1.2.0, < 2.0)
44
+ rspec-support (~> 3.13.0)
45
+ rspec-mocks (3.13.2)
46
+ diff-lcs (>= 1.2.0, < 2.0)
47
+ rspec-support (~> 3.13.0)
48
+ rspec-support (3.13.2)
49
+ rubocop (0.66.0)
50
+ jaro_winkler (~> 1.5.1)
51
+ parallel (~> 1.10)
52
+ parser (>= 2.5, != 2.5.1.1)
53
+ psych (>= 3.1.0)
54
+ rainbow (>= 2.2.2, < 4.0)
55
+ ruby-progressbar (~> 1.7)
56
+ unicode-display_width (>= 1.4.0, < 1.6)
57
+ ruby-progressbar (1.13.0)
58
+ stringio (3.0.6)
59
+ typhoeus (1.4.1)
60
+ ethon (>= 0.9.0)
61
+ unicode-display_width (1.5.0)
62
+
63
+ PLATFORMS
64
+ ruby
65
+
66
+ DEPENDENCIES
67
+ onesignal!
68
+ pry-byebug
69
+ rake (~> 13.0.1)
70
+ rspec (~> 3.6, >= 3.6.0)
71
+ rubocop (~> 0.66.0)
72
+
73
+ BUNDLED WITH
74
+ 1.17.2
data/LICENSE ADDED
@@ -0,0 +1,24 @@
1
+ Modified MIT License
2
+
3
+ Copyright 2022 OneSignal
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ 1. The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ 2. All copies of substantial portions of the Software may only be used in connection
16
+ with services provided by OneSignal.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
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.0.0
10
- - Package version: 1.0.0
9
+ - API version: 1.4.0
10
+ - Package version: 2.2.0
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-1.0.0.gem
27
+ gem install ./onesignal-2.2.0.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./onesignal-1.0.0.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./onesignal-2.2.0.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', '~> 1.0.0'
36
+ gem 'onesignal', '~> 2.2.0'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -64,83 +64,137 @@ OneSignal.configure do |config|
64
64
  end
65
65
 
66
66
  api_instance = OneSignal::DefaultApi.new
67
- app_id = 'app_id_example' # String |
68
- notification_id = 'notification_id_example' # String |
67
+ app_id = 'app_id_example' # String | The OneSignal App ID for your app. Available in Keys & IDs.
68
+ activity_id = 'activity_id_example' # String | Live Activity record ID
69
+ begin_live_activity_request = OneSignal::BeginLiveActivityRequest.new({push_token: 'push_token_example', subscription_id: 'subscription_id_example'}) # BeginLiveActivityRequest |
69
70
 
70
71
  begin
71
- #Stop a scheduled or currently outgoing notification
72
- result = api_instance.cancel_notification(app_id, notification_id)
73
- p result
72
+ #Start Live Activity
73
+ api_instance.begin_live_activity(app_id, activity_id, begin_live_activity_request)
74
74
  rescue OneSignal::ApiError => e
75
- puts "Exception when calling DefaultApi->cancel_notification: #{e}"
75
+ puts "Exception when calling DefaultApi->begin_live_activity: #{e}"
76
76
  end
77
77
 
78
78
  ```
79
79
 
80
80
  ## Documentation for API Endpoints
81
81
 
82
- All URIs are relative to *https://onesignal.com/api/v1*
82
+ All URIs are relative to *https://api.onesignal.com*
83
83
 
84
84
  Class | Method | HTTP request | Description
85
85
  ------------ | ------------- | ------------- | -------------
86
+ *OneSignal::DefaultApi* | [**begin_live_activity**](docs/DefaultApi.md#begin_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity
86
87
  *OneSignal::DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
87
88
  *OneSignal::DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app
88
89
  *OneSignal::DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification
89
90
  *OneSignal::DefaultApi* | [**create_player**](docs/DefaultApi.md#create_player) | **POST** /players | Add a device
90
91
  *OneSignal::DefaultApi* | [**create_segments**](docs/DefaultApi.md#create_segments) | **POST** /apps/{app_id}/segments | Create Segments
92
+ *OneSignal::DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
93
+ *OneSignal::DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users |
94
+ *OneSignal::DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
91
95
  *OneSignal::DefaultApi* | [**delete_player**](docs/DefaultApi.md#delete_player) | **DELETE** /players/{player_id} | Delete a user record
92
96
  *OneSignal::DefaultApi* | [**delete_segments**](docs/DefaultApi.md#delete_segments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
93
- *OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id&#x3D;{app_id} | CSV export
97
+ *OneSignal::DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
98
+ *OneSignal::DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
99
+ *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
100
+ *OneSignal::DefaultApi* | [**export_events**](docs/DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events?app_id&#x3D;{app_id} | Export CSV of Events
101
+ *OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id&#x3D;{app_id} | Export CSV of Players
102
+ *OneSignal::DefaultApi* | [**fetch_aliases**](docs/DefaultApi.md#fetch_aliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
103
+ *OneSignal::DefaultApi* | [**fetch_user**](docs/DefaultApi.md#fetch_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
104
+ *OneSignal::DefaultApi* | [**fetch_user_identity**](docs/DefaultApi.md#fetch_user_identity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
94
105
  *OneSignal::DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app
95
106
  *OneSignal::DefaultApi* | [**get_apps**](docs/DefaultApi.md#get_apps) | **GET** /apps | View apps
107
+ *OneSignal::DefaultApi* | [**get_eligible_iams**](docs/DefaultApi.md#get_eligible_iams) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/iams |
96
108
  *OneSignal::DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification
97
109
  *OneSignal::DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History
98
110
  *OneSignal::DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications
99
111
  *OneSignal::DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
100
112
  *OneSignal::DefaultApi* | [**get_player**](docs/DefaultApi.md#get_player) | **GET** /players/{player_id} | View device
101
113
  *OneSignal::DefaultApi* | [**get_players**](docs/DefaultApi.md#get_players) | **GET** /players | View devices
114
+ *OneSignal::DefaultApi* | [**identify_user_by_alias**](docs/DefaultApi.md#identify_user_by_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
115
+ *OneSignal::DefaultApi* | [**identify_user_by_subscription_id**](docs/DefaultApi.md#identify_user_by_subscription_id) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
116
+ *OneSignal::DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
102
117
  *OneSignal::DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app
118
+ *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
103
119
  *OneSignal::DefaultApi* | [**update_player**](docs/DefaultApi.md#update_player) | **PUT** /players/{player_id} | Edit device
104
120
  *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
121
+ *OneSignal::DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
122
+ *OneSignal::DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
105
123
 
106
124
 
107
125
  ## Documentation for Models
108
126
 
109
127
  - [OneSignal::App](docs/App.md)
128
+ - [OneSignal::BasicNotification](docs/BasicNotification.md)
129
+ - [OneSignal::BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
130
+ - [OneSignal::BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
131
+ - [OneSignal::BeginLiveActivityRequest](docs/BeginLiveActivityRequest.md)
110
132
  - [OneSignal::Button](docs/Button.md)
133
+ - [OneSignal::CancelNotificationSuccessResponse](docs/CancelNotificationSuccessResponse.md)
134
+ - [OneSignal::CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md)
135
+ - [OneSignal::CreatePlayerSuccessResponse](docs/CreatePlayerSuccessResponse.md)
136
+ - [OneSignal::CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
137
+ - [OneSignal::CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
138
+ - [OneSignal::CreateSubscriptionRequestBody](docs/CreateSubscriptionRequestBody.md)
139
+ - [OneSignal::CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
140
+ - [OneSignal::CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
141
+ - [OneSignal::CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md)
142
+ - [OneSignal::DeletePlayerNotFoundResponse](docs/DeletePlayerNotFoundResponse.md)
143
+ - [OneSignal::DeletePlayerSuccessResponse](docs/DeletePlayerSuccessResponse.md)
144
+ - [OneSignal::DeleteSegmentNotFoundResponse](docs/DeleteSegmentNotFoundResponse.md)
145
+ - [OneSignal::DeleteSegmentSuccessResponse](docs/DeleteSegmentSuccessResponse.md)
111
146
  - [OneSignal::DeliveryData](docs/DeliveryData.md)
147
+ - [OneSignal::ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
112
148
  - [OneSignal::ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
149
+ - [OneSignal::ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
113
150
  - [OneSignal::Filter](docs/Filter.md)
114
151
  - [OneSignal::FilterExpressions](docs/FilterExpressions.md)
115
- - [OneSignal::FilterNotificationTarget](docs/FilterNotificationTarget.md)
152
+ - [OneSignal::GenericError](docs/GenericError.md)
153
+ - [OneSignal::GenericErrorErrorsInner](docs/GenericErrorErrorsInner.md)
116
154
  - [OneSignal::GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
117
155
  - [OneSignal::InlineResponse200](docs/InlineResponse200.md)
118
- - [OneSignal::InlineResponse2001](docs/InlineResponse2001.md)
119
- - [OneSignal::InlineResponse2002](docs/InlineResponse2002.md)
120
156
  - [OneSignal::InlineResponse2003](docs/InlineResponse2003.md)
121
- - [OneSignal::InlineResponse2004](docs/InlineResponse2004.md)
122
- - [OneSignal::InlineResponse2005](docs/InlineResponse2005.md)
123
157
  - [OneSignal::InlineResponse201](docs/InlineResponse201.md)
124
- - [OneSignal::InlineResponse400](docs/InlineResponse400.md)
125
- - [OneSignal::InlineResponse4001](docs/InlineResponse4001.md)
126
- - [OneSignal::InlineResponse4002](docs/InlineResponse4002.md)
127
- - [OneSignal::InlineResponse409](docs/InlineResponse409.md)
158
+ - [OneSignal::InlineResponse202](docs/InlineResponse202.md)
159
+ - [OneSignal::InvalidIdentifierError](docs/InvalidIdentifierError.md)
128
160
  - [OneSignal::Notification](docs/Notification.md)
161
+ - [OneSignal::Notification200Errors](docs/Notification200Errors.md)
129
162
  - [OneSignal::NotificationAllOf](docs/NotificationAllOf.md)
130
- - [OneSignal::NotificationAllOfAndroidBackgroundLayout](docs/NotificationAllOfAndroidBackgroundLayout.md)
163
+ - [OneSignal::NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md)
131
164
  - [OneSignal::NotificationSlice](docs/NotificationSlice.md)
132
165
  - [OneSignal::NotificationTarget](docs/NotificationTarget.md)
166
+ - [OneSignal::NotificationWithMeta](docs/NotificationWithMeta.md)
167
+ - [OneSignal::NotificationWithMetaAllOf](docs/NotificationWithMetaAllOf.md)
133
168
  - [OneSignal::Operator](docs/Operator.md)
134
169
  - [OneSignal::OutcomeData](docs/OutcomeData.md)
170
+ - [OneSignal::OutcomesData](docs/OutcomesData.md)
135
171
  - [OneSignal::PlatformDeliveryData](docs/PlatformDeliveryData.md)
172
+ - [OneSignal::PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md)
173
+ - [OneSignal::PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md)
136
174
  - [OneSignal::Player](docs/Player.md)
137
175
  - [OneSignal::PlayerNotificationTarget](docs/PlayerNotificationTarget.md)
176
+ - [OneSignal::PlayerNotificationTargetIncludeAliases](docs/PlayerNotificationTargetIncludeAliases.md)
138
177
  - [OneSignal::PlayerSlice](docs/PlayerSlice.md)
178
+ - [OneSignal::PropertiesDeltas](docs/PropertiesDeltas.md)
179
+ - [OneSignal::PropertiesObject](docs/PropertiesObject.md)
139
180
  - [OneSignal::Purchase](docs/Purchase.md)
181
+ - [OneSignal::RateLimiterError](docs/RateLimiterError.md)
140
182
  - [OneSignal::Segment](docs/Segment.md)
141
183
  - [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
142
184
  - [OneSignal::StringMap](docs/StringMap.md)
185
+ - [OneSignal::SubscriptionObject](docs/SubscriptionObject.md)
186
+ - [OneSignal::TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md)
187
+ - [OneSignal::UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
188
+ - [OneSignal::UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
189
+ - [OneSignal::UpdatePlayerSuccessResponse](docs/UpdatePlayerSuccessResponse.md)
143
190
  - [OneSignal::UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
191
+ - [OneSignal::UpdatePlayerTagsSuccessResponse](docs/UpdatePlayerTagsSuccessResponse.md)
192
+ - [OneSignal::UpdateSubscriptionRequestBody](docs/UpdateSubscriptionRequestBody.md)
193
+ - [OneSignal::UpdateUserRequest](docs/UpdateUserRequest.md)
194
+ - [OneSignal::User](docs/User.md)
195
+ - [OneSignal::UserIdentityRequestBody](docs/UserIdentityRequestBody.md)
196
+ - [OneSignal::UserIdentityResponse](docs/UserIdentityResponse.md)
197
+ - [OneSignal::UserSubscriptionOptions](docs/UserSubscriptionOptions.md)
144
198
 
145
199
 
146
200
  ## Documentation for Authorization
@@ -0,0 +1,11 @@
1
+ # Release Instructions
2
+ 1. Generate new client version using OpenApi Generator
3
+ 2. Make sure `ruby.yml` has the correct gem version
4
+ 2. Create a new PR and merge
5
+ * Carefully review the PR to ensure nothing is overwritten and you are including all desired changes
6
+ * Ensure the correct version number is being sent in the header params `OS-Usage-Data` (`api_client.rb`)
7
+ 3. Generate the gem: `gem build onesignal`
8
+ 4. Publish to RubyGems
9
+ * To publish version 0.1.0 of a new gem called 'squid-utils', run: `gem push squid-utils-0.1.0.gem`
10
+ * To publish a beta version, simply add `.beta1`, `.beta2` etc... after the semantic version (e.g: `1.0.0.beta1`)
11
+
data/docs/App.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [readonly] |
7
+ | **id** | **String** | | [optional][readonly] |
8
8
  | **name** | **String** | The name of your app, as displayed on your apps list on the dashboard. This can be renamed. | [optional] |
9
9
  | **players** | **Integer** | | [optional][readonly] |
10
10
  | **messageable_players** | **Integer** | | [optional][readonly] |
@@ -23,6 +23,10 @@
23
23
  | **safari_apns_certificates** | **String** | | [optional][readonly] |
24
24
  | **safari_apns_p12** | **String** | Safari: Your apple push notification p12 certificate file for Safari Push Notifications, converted to a string and Base64 encoded. | [optional] |
25
25
  | **safari_apns_p12_password** | **String** | Safari: Password for safari_apns_p12 file | [optional] |
26
+ | **apns_key_id** | **String** | iOS: Required if using p8. Unique identifier for the p8 authentication key. | [optional] |
27
+ | **apns_team_id** | **String** | iOS: Required if using p8. Team ID generated by Apple for your developer account. | [optional] |
28
+ | **apns_bundle_id** | **String** | iOS: Required if using p8. Bundle ID for your app in the Apple ecosystem. | [optional] |
29
+ | **apns_p8** | **String** | iOS: Required if using p8. Base64 encoded p8 key | [optional] |
26
30
  | **safari_site_origin** | **String** | Safari (Recommended): The hostname to your website including http(s):// | [optional] |
27
31
  | **safari_push_id** | **String** | | [optional][readonly] |
28
32
  | **safari_icon_16_16** | **String** | | [optional][readonly] |
@@ -60,6 +64,10 @@ instance = OneSignal::App.new(
60
64
  safari_apns_certificates: null,
61
65
  safari_apns_p12: null,
62
66
  safari_apns_p12_password: null,
67
+ apns_key_id: null,
68
+ apns_team_id: null,
69
+ apns_bundle_id: null,
70
+ apns_p8: null,
63
71
  safari_site_origin: null,
64
72
  safari_push_id: null,
65
73
  safari_icon_16_16: null,