onesignal 1.0.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +74 -0
  3. data/README.md +112 -88
  4. data/docs/App.md +9 -1
  5. data/docs/BasicNotification.md +230 -0
  6. data/docs/BasicNotificationAllOf.md +202 -0
  7. data/docs/{NotificationAllOfAndroidBackgroundLayout.md → BasicNotificationAllOfAndroidBackgroundLayout.md} +2 -2
  8. data/docs/BeginLiveActivityRequest.md +20 -0
  9. data/docs/CancelNotificationSuccessResponse.md +18 -0
  10. data/docs/CreateNotificationSuccessResponse.md +24 -0
  11. data/docs/{InlineResponse2005.md → CreatePlayerSuccessResponse.md} +2 -2
  12. data/docs/{InlineResponse4002.md → CreateSegmentConflictResponse.md} +2 -2
  13. data/docs/CreateSegmentSuccessResponse.md +20 -0
  14. data/docs/CreateSubscriptionRequestBody.md +20 -0
  15. data/docs/CreateUserConflictResponse.md +18 -0
  16. data/docs/CreateUserConflictResponseErrorsInner.md +22 -0
  17. data/docs/CreateUserConflictResponseErrorsItemsMeta.md +18 -0
  18. data/docs/DefaultApi.md +1591 -266
  19. data/docs/DeletePlayerNotFoundResponse.md +18 -0
  20. data/docs/{InlineResponse2001.md → DeletePlayerSuccessResponse.md} +2 -2
  21. data/docs/DeleteSegmentNotFoundResponse.md +18 -0
  22. data/docs/DeleteSegmentSuccessResponse.md +18 -0
  23. data/docs/DeliveryData.md +5 -5
  24. data/docs/{InlineResponse2008.md → ExportEventsSuccessResponse.md} +2 -2
  25. data/docs/ExportPlayersRequestBody.md +2 -2
  26. data/docs/ExportPlayersSuccessResponse.md +18 -0
  27. data/docs/Filter.md +1 -1
  28. data/docs/FilterExpressions.md +1 -1
  29. data/docs/GenericError.md +18 -0
  30. data/docs/GenericErrorErrorsInner.md +20 -0
  31. data/docs/InlineResponse200.md +2 -8
  32. data/docs/InlineResponse2003.md +18 -0
  33. data/docs/InlineResponse201.md +2 -4
  34. data/docs/InlineResponse202.md +18 -0
  35. data/docs/Notification.md +22 -30
  36. data/docs/NotificationAllOf.md +1 -175
  37. data/docs/{InlineResponse2002.md → NotificationHistorySuccessResponse.md} +2 -2
  38. data/docs/NotificationTarget.md +5 -25
  39. data/docs/NotificationWithMeta.md +21 -29
  40. data/docs/PlatformDeliveryData.md +5 -1
  41. data/docs/PlatformDeliveryDataEmailAllOf.md +30 -0
  42. data/docs/PlatformDeliveryDataSmsAllOf.md +22 -0
  43. data/docs/Player.md +1 -1
  44. data/docs/PlayerNotificationTarget.md +5 -1
  45. data/docs/PlayerNotificationTargetIncludeAliases.md +18 -0
  46. data/docs/PropertiesDeltas.md +22 -0
  47. data/docs/PropertiesObject.md +38 -0
  48. data/docs/Purchase.md +4 -2
  49. data/docs/RateLimiterError.md +18 -0
  50. data/docs/SubscriptionObject.md +50 -0
  51. data/docs/TransferSubscriptionRequestBody.md +18 -0
  52. data/docs/UpdateLiveActivityRequest.md +24 -0
  53. data/docs/UpdateLiveActivitySuccessResponse.md +20 -0
  54. data/docs/{InlineResponse2007.md → UpdatePlayerSuccessResponse.md} +3 -3
  55. data/docs/UpdatePlayerTagsSuccessResponse.md +18 -0
  56. data/docs/UpdateSubscriptionRequestBody.md +18 -0
  57. data/docs/UpdateUserRequest.md +22 -0
  58. data/docs/User.md +24 -0
  59. data/docs/UserIdentityRequestBody.md +18 -0
  60. data/docs/UserIdentityResponse.md +18 -0
  61. data/docs/UserSubscriptionOptions.md +18 -0
  62. data/lib/onesignal/api/default_api.rb +1583 -221
  63. data/lib/onesignal/api_client.rb +2 -2
  64. data/lib/onesignal/api_error.rb +1 -1
  65. data/lib/onesignal/configuration.rb +6 -6
  66. data/lib/onesignal/models/app.rb +57 -7
  67. data/lib/onesignal/models/basic_notification.rb +1442 -0
  68. data/lib/onesignal/models/basic_notification_all_of.rb +1252 -0
  69. data/lib/onesignal/models/{notification_all_of_android_background_layout.rb → basic_notification_all_of_android_background_layout.rb} +4 -4
  70. data/lib/onesignal/models/begin_live_activity_request.rb +238 -0
  71. data/lib/onesignal/models/button.rb +1 -1
  72. data/lib/onesignal/models/cancel_notification_success_response.rb +219 -0
  73. data/lib/onesignal/models/create_notification_success_response.rb +248 -0
  74. data/lib/onesignal/models/{inline_response2005.rb → create_player_success_response.rb} +4 -4
  75. data/lib/onesignal/models/{inline_response4002.rb → create_segment_conflict_response.rb} +4 -4
  76. data/lib/onesignal/models/create_segment_success_response.rb +229 -0
  77. data/lib/onesignal/models/create_subscription_request_body.rb +228 -0
  78. data/lib/onesignal/models/{inline_response4001.rb → create_user_conflict_response.rb} +6 -15
  79. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +237 -0
  80. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +219 -0
  81. data/lib/onesignal/models/delete_player_not_found_response.rb +219 -0
  82. data/lib/onesignal/models/{inline_response2001.rb → delete_player_success_response.rb} +4 -4
  83. data/lib/onesignal/models/delete_segment_not_found_response.rb +219 -0
  84. data/lib/onesignal/models/delete_segment_success_response.rb +219 -0
  85. data/lib/onesignal/models/delivery_data.rb +6 -1
  86. data/lib/onesignal/models/{inline_response2008.rb → export_events_success_response.rb} +4 -4
  87. data/lib/onesignal/models/export_players_request_body.rb +3 -3
  88. data/lib/onesignal/models/export_players_success_response.rb +219 -0
  89. data/lib/onesignal/models/filter.rb +2 -2
  90. data/lib/onesignal/models/filter_expressions.rb +2 -2
  91. data/lib/onesignal/models/{inline_response400.rb → generic_error.rb} +5 -5
  92. data/lib/onesignal/models/generic_error_errors_inner.rb +228 -0
  93. data/lib/onesignal/models/get_notification_request_body.rb +1 -1
  94. data/lib/onesignal/models/inline_response200.rb +10 -46
  95. data/lib/onesignal/models/{inline_response4003.rb → inline_response2003.rb} +12 -12
  96. data/lib/onesignal/models/inline_response201.rb +8 -18
  97. data/lib/onesignal/models/inline_response202.rb +219 -0
  98. data/lib/onesignal/models/invalid_identifier_error.rb +1 -1
  99. data/lib/onesignal/models/notification.rb +173 -141
  100. data/lib/onesignal/models/notification200_errors.rb +1 -1
  101. data/lib/onesignal/models/notification_all_of.rb +6 -929
  102. data/lib/onesignal/models/{inline_response2002.rb → notification_history_success_response.rb} +4 -4
  103. data/lib/onesignal/models/notification_slice.rb +1 -1
  104. data/lib/onesignal/models/notification_target.rb +60 -126
  105. data/lib/onesignal/models/notification_with_meta.rb +168 -137
  106. data/lib/onesignal/models/notification_with_meta_all_of.rb +2 -1
  107. data/lib/onesignal/models/operator.rb +1 -1
  108. data/lib/onesignal/models/outcome_data.rb +1 -1
  109. data/lib/onesignal/models/outcomes_data.rb +1 -1
  110. data/lib/onesignal/models/platform_delivery_data.rb +25 -5
  111. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +287 -0
  112. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +243 -0
  113. data/lib/onesignal/models/player.rb +9 -6
  114. data/lib/onesignal/models/player_notification_target.rb +60 -5
  115. data/lib/onesignal/models/player_notification_target_include_aliases.rb +221 -0
  116. data/lib/onesignal/models/player_slice.rb +1 -1
  117. data/lib/onesignal/models/properties_deltas.rb +239 -0
  118. data/lib/onesignal/models/properties_object.rb +313 -0
  119. data/lib/onesignal/models/purchase.rb +15 -6
  120. data/lib/onesignal/models/rate_limiter_error.rb +221 -0
  121. data/lib/onesignal/models/segment.rb +1 -1
  122. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  123. data/lib/onesignal/models/string_map.rb +1 -1
  124. data/lib/onesignal/models/{filter_notification_target.rb → subscription_object.rb} +145 -78
  125. data/lib/onesignal/models/transfer_subscription_request_body.rb +221 -0
  126. data/lib/onesignal/models/update_live_activity_request.rb +309 -0
  127. data/lib/onesignal/models/update_live_activity_success_response.rb +228 -0
  128. data/lib/onesignal/models/{inline_response2007.rb → update_player_success_response.rb} +5 -5
  129. data/lib/onesignal/models/update_player_tags_request_body.rb +1 -1
  130. data/lib/onesignal/models/update_player_tags_success_response.rb +219 -0
  131. data/lib/onesignal/models/update_subscription_request_body.rb +219 -0
  132. data/lib/onesignal/models/update_user_request.rb +239 -0
  133. data/lib/onesignal/models/user.rb +250 -0
  134. data/lib/onesignal/models/user_identity_request_body.rb +221 -0
  135. data/lib/onesignal/models/user_identity_response.rb +221 -0
  136. data/lib/onesignal/models/user_subscription_options.rb +219 -0
  137. data/lib/onesignal/version.rb +2 -2
  138. data/lib/onesignal.rb +43 -12
  139. data/onesignal.gemspec +1 -1
  140. data/spec/api/default_api_spec.rb +249 -12
  141. data/spec/api_client_spec.rb +1 -1
  142. data/spec/configuration_spec.rb +4 -4
  143. data/spec/models/app_spec.rb +25 -1
  144. data/spec/models/{notification_all_of_android_background_layout_spec.rb → basic_notification_all_of_android_background_layout_spec.rb} +7 -7
  145. data/spec/models/basic_notification_all_of_spec.rb +590 -0
  146. data/spec/models/basic_notification_spec.rb +678 -0
  147. data/spec/models/begin_live_activity_request_spec.rb +40 -0
  148. data/spec/models/button_spec.rb +1 -1
  149. data/spec/models/cancel_notification_success_response_spec.rb +34 -0
  150. data/spec/models/create_notification_success_response_spec.rb +52 -0
  151. data/spec/models/{inline_response2005_spec.rb → create_player_success_response_spec.rb} +7 -7
  152. data/spec/models/{inline_response4001_spec.rb → create_segment_conflict_response_spec.rb} +7 -7
  153. data/spec/models/{inline_response4002_spec.rb → create_segment_success_response_spec.rb} +8 -8
  154. data/spec/models/create_subscription_request_body_spec.rb +40 -0
  155. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +46 -0
  156. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +34 -0
  157. data/spec/models/create_user_conflict_response_spec.rb +34 -0
  158. data/spec/models/delete_player_not_found_response_spec.rb +34 -0
  159. data/spec/models/{inline_response2001_spec.rb → delete_player_success_response_spec.rb} +7 -7
  160. data/spec/models/delete_segment_not_found_response_spec.rb +34 -0
  161. data/spec/models/delete_segment_success_response_spec.rb +34 -0
  162. data/spec/models/delivery_data_spec.rb +1 -1
  163. data/spec/models/{inline_response2008_spec.rb → export_events_success_response_spec.rb} +7 -7
  164. data/spec/models/export_players_request_body_spec.rb +1 -1
  165. data/spec/models/export_players_success_response_spec.rb +34 -0
  166. data/spec/models/filter_expressions_spec.rb +1 -1
  167. data/spec/models/filter_spec.rb +1 -1
  168. data/spec/models/generic_error_errors_inner_spec.rb +40 -0
  169. data/spec/models/{inline_response4003_spec.rb → generic_error_spec.rb} +8 -8
  170. data/spec/models/get_notification_request_body_spec.rb +1 -1
  171. data/spec/models/{inline_response2007_spec.rb → inline_response2003_spec.rb} +8 -8
  172. data/spec/models/inline_response200_spec.rb +2 -20
  173. data/spec/models/inline_response201_spec.rb +2 -8
  174. data/spec/models/{inline_response400_spec.rb → inline_response202_spec.rb} +8 -8
  175. data/spec/models/invalid_identifier_error_spec.rb +1 -1
  176. data/spec/models/notification200_errors_spec.rb +1 -1
  177. data/spec/models/notification_all_of_spec.rb +1 -527
  178. data/spec/models/{inline_response2002_spec.rb → notification_history_success_response_spec.rb} +7 -7
  179. data/spec/models/notification_slice_spec.rb +1 -1
  180. data/spec/models/notification_spec.rb +56 -76
  181. data/spec/models/notification_target_spec.rb +17 -73
  182. data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
  183. data/spec/models/notification_with_meta_spec.rb +56 -76
  184. data/spec/models/operator_spec.rb +1 -1
  185. data/spec/models/outcome_data_spec.rb +1 -1
  186. data/spec/models/outcomes_data_spec.rb +1 -1
  187. data/spec/models/platform_delivery_data_email_all_of_spec.rb +70 -0
  188. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +46 -0
  189. data/spec/models/platform_delivery_data_spec.rb +13 -1
  190. data/spec/models/player_notification_target_include_aliases_spec.rb +34 -0
  191. data/spec/models/player_notification_target_spec.rb +17 -1
  192. data/spec/models/player_slice_spec.rb +1 -1
  193. data/spec/models/player_spec.rb +1 -1
  194. data/spec/models/properties_deltas_spec.rb +46 -0
  195. data/spec/models/{filter_notification_target_spec.rb → properties_object_spec.rb} +18 -24
  196. data/spec/models/purchase_spec.rb +7 -1
  197. data/spec/models/rate_limiter_error_spec.rb +34 -0
  198. data/spec/models/segment_notification_target_spec.rb +1 -1
  199. data/spec/models/segment_spec.rb +1 -1
  200. data/spec/models/string_map_spec.rb +1 -1
  201. data/spec/models/subscription_object_spec.rb +134 -0
  202. data/spec/models/transfer_subscription_request_body_spec.rb +34 -0
  203. data/spec/models/update_live_activity_request_spec.rb +60 -0
  204. data/spec/models/update_live_activity_success_response_spec.rb +40 -0
  205. data/spec/models/update_player_success_response_spec.rb +34 -0
  206. data/spec/models/update_player_tags_request_body_spec.rb +1 -1
  207. data/spec/models/update_player_tags_success_response_spec.rb +34 -0
  208. data/spec/models/update_subscription_request_body_spec.rb +34 -0
  209. data/spec/models/update_user_request_spec.rb +46 -0
  210. data/spec/models/user_identity_request_body_spec.rb +34 -0
  211. data/spec/models/user_identity_response_spec.rb +34 -0
  212. data/spec/models/user_spec.rb +52 -0
  213. data/spec/models/user_subscription_options_spec.rb +34 -0
  214. data/spec/spec_helper.rb +1 -1
  215. metadata +178 -53
  216. data/docs/FilterNotificationTarget.md +0 -40
  217. data/docs/InlineResponse400.md +0 -18
  218. data/docs/InlineResponse4001.md +0 -20
  219. data/docs/InlineResponse4003.md +0 -18
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -32,13 +32,27 @@ describe 'DefaultApi' do
32
32
  end
33
33
  end
34
34
 
35
+ # unit tests for begin_live_activity
36
+ # Start Live Activity
37
+ # Starts a Live Activity
38
+ # @param app_id The OneSignal App ID for your app. Available in Keys & IDs.
39
+ # @param activity_id Live Activity record ID
40
+ # @param begin_live_activity_request
41
+ # @param [Hash] opts the optional parameters
42
+ # @return [nil]
43
+ describe 'begin_live_activity test' do
44
+ it 'should work' do
45
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
46
+ end
47
+ end
48
+
35
49
  # unit tests for cancel_notification
36
50
  # Stop a scheduled or currently outgoing notification
37
51
  # Used to stop a scheduled or currently outgoing notification
38
52
  # @param app_id
39
53
  # @param notification_id
40
54
  # @param [Hash] opts the optional parameters
41
- # @return [InlineResponse2001]
55
+ # @return [CancelNotificationSuccessResponse]
42
56
  describe 'cancel_notification test' do
43
57
  it 'should work' do
44
58
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -62,7 +76,7 @@ describe 'DefaultApi' do
62
76
  # Sends notifications to your users
63
77
  # @param notification
64
78
  # @param [Hash] opts the optional parameters
65
- # @return [InlineResponse200]
79
+ # @return [CreateNotificationSuccessResponse]
66
80
  describe 'create_notification test' do
67
81
  it 'should work' do
68
82
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -74,7 +88,7 @@ describe 'DefaultApi' do
74
88
  # Register a new device to one of your OneSignal apps 🚧 Don't use this This API endpoint is designed to be used from our open source Mobile and Web Push SDKs. It is not designed for developers to use it directly, unless instructed to do so by OneSignal support. If you use this method instead of our SDKs, many OneSignal features such as conversion tracking, timezone tracking, language detection, and rich-push won't work out of the box. It will also make it harder to identify possible setup issues. This method is used to register a new device with OneSignal. If a device is already registered with the specified identifier, then this will update the existing device record instead of creating a new one. The returned player is a player / user ID. Use the returned ID to send push notifications to this specific user later, or to include this player when sending to a set of users. 🚧 iOS Must set test_type to 1 when building your iOS app as development. Omit this field in your production app builds.
75
89
  # @param player
76
90
  # @param [Hash] opts the optional parameters
77
- # @return [InlineResponse2005]
91
+ # @return [CreatePlayerSuccessResponse]
78
92
  describe 'create_player test' do
79
93
  it 'should work' do
80
94
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -87,20 +101,60 @@ describe 'DefaultApi' do
87
101
  # @param app_id The OneSignal App ID for your app. Available in Keys & IDs.
88
102
  # @param [Hash] opts the optional parameters
89
103
  # @option opts [Segment] :segment
90
- # @return [InlineResponse201]
104
+ # @return [CreateSegmentSuccessResponse]
91
105
  describe 'create_segments test' do
92
106
  it 'should work' do
93
107
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
94
108
  end
95
109
  end
96
110
 
111
+ # unit tests for create_subscription
112
+ # Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
113
+ # @param app_id
114
+ # @param alias_label
115
+ # @param alias_id
116
+ # @param create_subscription_request_body
117
+ # @param [Hash] opts the optional parameters
118
+ # @return [InlineResponse201]
119
+ describe 'create_subscription test' do
120
+ it 'should work' do
121
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
122
+ end
123
+ end
124
+
125
+ # unit tests for create_user
126
+ # Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.
127
+ # @param app_id
128
+ # @param user
129
+ # @param [Hash] opts the optional parameters
130
+ # @return [User]
131
+ describe 'create_user test' do
132
+ it 'should work' do
133
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
+ end
135
+ end
136
+
137
+ # unit tests for delete_alias
138
+ # Deletes an alias by alias label
139
+ # @param app_id
140
+ # @param alias_label
141
+ # @param alias_id
142
+ # @param alias_label_to_delete
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [InlineResponse200]
145
+ describe 'delete_alias test' do
146
+ it 'should work' do
147
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
148
+ end
149
+ end
150
+
97
151
  # unit tests for delete_player
98
152
  # Delete a user record
99
153
  # Delete player - Required: Used to delete a single, specific Player ID record from a specific OneSignal app.
100
154
  # @param app_id The OneSignal App ID for your app. Available in Keys & IDs.
101
155
  # @param player_id The OneSignal player_id
102
156
  # @param [Hash] opts the optional parameters
103
- # @return [InlineResponse2007]
157
+ # @return [DeletePlayerSuccessResponse]
104
158
  describe 'delete_player test' do
105
159
  it 'should work' do
106
160
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -113,26 +167,116 @@ describe 'DefaultApi' do
113
167
  # @param app_id The OneSignal App ID for your app. Available in Keys & IDs.
114
168
  # @param segment_id The segment_id can be found in the URL of the segment when viewing it in the dashboard.
115
169
  # @param [Hash] opts the optional parameters
116
- # @return [InlineResponse2001]
170
+ # @return [DeleteSegmentSuccessResponse]
117
171
  describe 'delete_segments test' do
118
172
  it 'should work' do
119
173
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
120
174
  end
121
175
  end
122
176
 
177
+ # unit tests for delete_subscription
178
+ # Deletes the Subscription.
179
+ # @param app_id
180
+ # @param subscription_id
181
+ # @param [Hash] opts the optional parameters
182
+ # @return [nil]
183
+ describe 'delete_subscription test' do
184
+ it 'should work' do
185
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
186
+ end
187
+ end
188
+
189
+ # unit tests for delete_user
190
+ # Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases
191
+ # @param app_id
192
+ # @param alias_label
193
+ # @param alias_id
194
+ # @param [Hash] opts the optional parameters
195
+ # @return [nil]
196
+ describe 'delete_user test' do
197
+ it 'should work' do
198
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
199
+ end
200
+ end
201
+
202
+ # unit tests for end_live_activity
203
+ # Stop Live Activity
204
+ # Stops a Live Activity
205
+ # @param app_id The OneSignal App ID for your app. Available in Keys & IDs.
206
+ # @param activity_id Live Activity record ID
207
+ # @param subscription_id Subscription ID
208
+ # @param [Hash] opts the optional parameters
209
+ # @return [nil]
210
+ describe 'end_live_activity test' do
211
+ it 'should work' do
212
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
213
+ end
214
+ end
215
+
216
+ # unit tests for export_events
217
+ # Export CSV of Events
218
+ # Generate a compressed CSV report of all of the events data for a notification. This will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.
219
+ # @param notification_id The ID of the notification to export events from.
220
+ # @param app_id The ID of the app that the notification belongs to.
221
+ # @param [Hash] opts the optional parameters
222
+ # @return [ExportEventsSuccessResponse]
223
+ describe 'export_events test' do
224
+ it 'should work' do
225
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
226
+ end
227
+ end
228
+
123
229
  # unit tests for export_players
124
- # CSV export
230
+ # Export CSV of Players
125
231
  # Generate a compressed CSV export of all of your current user data This method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint. The file will be compressed using GZip. The file may take several minutes to generate depending on the number of users in your app. The URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable. 🚧 403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned. 🚧 Requires Authentication Key Requires your OneSignal App's REST API Key, available in Keys & IDs. 🚧 Concurrent Exports Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app. CSV File Format: - Default Columns: | Field | Details | | --- | --- | | id | OneSignal Player Id | | identifier | Push Token | | session_count | Number of times they visited the app or site | language | Device language code | | timezone | Number of seconds away from UTC. Example: -28800 | | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. | | device_os | Device Operating System Version. Example: 80 = Chrome 80, 9 = Android 9 | | device_type | Device Operating System Type | | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have `Linux armv` | | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. | | tags | Current OneSignal Data Tags on the device. | | last_active | Date and time the user last opened the mobile app or visited the site. | | playtime | Total amount of time in seconds the user had the mobile app open. | | amount_spent | Mobile only - amount spent in USD on In-App Purchases. | | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. | | invalid_identifier | t = unsubscribed, f = subscibed | | badge_count | Current number of badges on the device | - Extra Columns: | Field | Details | | --- | --- | | external_user_id | Your User Id set on the device | | notification_types | Notification types | | location | Location points (Latitude and Longitude) set on the device. | | country | Country code | | rooted | Android device rooted or not | | ip | IP Address of the device if being tracked. See Handling Personal Data. | | web_auth | Web Only authorization key. | | web_p256 | Web Only p256 key. |
126
232
  # @param app_id The app ID that you want to export devices from
127
233
  # @param [Hash] opts the optional parameters
128
234
  # @option opts [ExportPlayersRequestBody] :export_players_request_body
129
- # @return [InlineResponse2008]
235
+ # @return [ExportPlayersSuccessResponse]
130
236
  describe 'export_players test' do
131
237
  it 'should work' do
132
238
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
133
239
  end
134
240
  end
135
241
 
242
+ # unit tests for fetch_aliases
243
+ # Lists all Aliases for the User identified by :subscription_id.
244
+ # @param app_id
245
+ # @param subscription_id
246
+ # @param [Hash] opts the optional parameters
247
+ # @return [UserIdentityResponse]
248
+ describe 'fetch_aliases test' do
249
+ it 'should work' do
250
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
251
+ end
252
+ end
253
+
254
+ # unit tests for fetch_user
255
+ # Returns the User’s properties, Aliases, and Subscriptions.
256
+ # @param app_id
257
+ # @param alias_label
258
+ # @param alias_id
259
+ # @param [Hash] opts the optional parameters
260
+ # @return [User]
261
+ describe 'fetch_user test' do
262
+ it 'should work' do
263
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
264
+ end
265
+ end
266
+
267
+ # unit tests for fetch_user_identity
268
+ # Lists all Aliases for the User identified by (:alias_label, :alias_id).
269
+ # @param app_id
270
+ # @param alias_label
271
+ # @param alias_id
272
+ # @param [Hash] opts the optional parameters
273
+ # @return [InlineResponse200]
274
+ describe 'fetch_user_identity test' do
275
+ it 'should work' do
276
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
277
+ end
278
+ end
279
+
136
280
  # unit tests for get_app
137
281
  # View an app
138
282
  # View the details of a single OneSignal app
@@ -156,6 +300,18 @@ describe 'DefaultApi' do
156
300
  end
157
301
  end
158
302
 
303
+ # unit tests for get_eligible_iams
304
+ # Manifest of In-App Messages the Subscription is eligible to display by the SDK.
305
+ # @param app_id
306
+ # @param subscription_id
307
+ # @param [Hash] opts the optional parameters
308
+ # @return [InlineResponse2003]
309
+ describe 'get_eligible_iams test' do
310
+ it 'should work' do
311
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
312
+ end
313
+ end
314
+
159
315
  # unit tests for get_notification
160
316
  # View notification
161
317
  # View the details of a single notification and outcomes associated with it
@@ -175,7 +331,7 @@ describe 'DefaultApi' do
175
331
  # @param notification_id The \"id\" of the message found in the Notification object
176
332
  # @param get_notification_request_body
177
333
  # @param [Hash] opts the optional parameters
178
- # @return [InlineResponse2002]
334
+ # @return [NotificationHistorySuccessResponse]
179
335
  describe 'get_notification_history test' do
180
336
  it 'should work' do
181
337
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -242,6 +398,46 @@ describe 'DefaultApi' do
242
398
  end
243
399
  end
244
400
 
401
+ # unit tests for identify_user_by_alias
402
+ # Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).
403
+ # @param app_id
404
+ # @param alias_label
405
+ # @param alias_id
406
+ # @param user_identity_request_body
407
+ # @param [Hash] opts the optional parameters
408
+ # @return [InlineResponse200]
409
+ describe 'identify_user_by_alias test' do
410
+ it 'should work' do
411
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
412
+ end
413
+ end
414
+
415
+ # unit tests for identify_user_by_subscription_id
416
+ # Upserts one or more Aliases for the User identified by :subscription_id.
417
+ # @param app_id
418
+ # @param subscription_id
419
+ # @param user_identity_request_body
420
+ # @param [Hash] opts the optional parameters
421
+ # @return [UserIdentityResponse]
422
+ describe 'identify_user_by_subscription_id test' do
423
+ it 'should work' do
424
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
425
+ end
426
+ end
427
+
428
+ # unit tests for transfer_subscription
429
+ # Transfers this Subscription to the User identified by the identity in the payload.
430
+ # @param app_id
431
+ # @param subscription_id
432
+ # @param transfer_subscription_request_body
433
+ # @param [Hash] opts the optional parameters
434
+ # @return [UserIdentityResponse]
435
+ describe 'transfer_subscription test' do
436
+ it 'should work' do
437
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
438
+ end
439
+ end
440
+
245
441
  # unit tests for update_app
246
442
  # Update an app
247
443
  # Updates the name or configuration settings of an existing OneSignal app
@@ -255,13 +451,27 @@ describe 'DefaultApi' do
255
451
  end
256
452
  end
257
453
 
454
+ # unit tests for update_live_activity
455
+ # Update a Live Activity via Push
456
+ # Updates a specified live activity.
457
+ # @param app_id The OneSignal App ID for your app. Available in Keys & IDs.
458
+ # @param activity_id Live Activity record ID
459
+ # @param update_live_activity_request
460
+ # @param [Hash] opts the optional parameters
461
+ # @return [UpdateLiveActivitySuccessResponse]
462
+ describe 'update_live_activity test' do
463
+ it 'should work' do
464
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
465
+ end
466
+ end
467
+
258
468
  # unit tests for update_player
259
469
  # Edit device
260
470
  # Update an existing device in one of your OneSignal apps
261
471
  # @param player_id Player's OneSignal ID
262
472
  # @param player
263
473
  # @param [Hash] opts the optional parameters
264
- # @return [InlineResponse2001]
474
+ # @return [UpdatePlayerSuccessResponse]
265
475
  describe 'update_player test' do
266
476
  it 'should work' do
267
477
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -275,11 +485,38 @@ describe 'DefaultApi' do
275
485
  # @param external_user_id The External User ID mapped to teh device record in OneSignal. Must be actively set on the device to be updated.
276
486
  # @param [Hash] opts the optional parameters
277
487
  # @option opts [UpdatePlayerTagsRequestBody] :update_player_tags_request_body
278
- # @return [InlineResponse2001]
488
+ # @return [UpdatePlayerTagsSuccessResponse]
279
489
  describe 'update_player_tags test' do
280
490
  it 'should work' do
281
491
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
282
492
  end
283
493
  end
284
494
 
495
+ # unit tests for update_subscription
496
+ # Updates an existing Subscription’s properties.
497
+ # @param app_id
498
+ # @param subscription_id
499
+ # @param update_subscription_request_body
500
+ # @param [Hash] opts the optional parameters
501
+ # @return [nil]
502
+ describe 'update_subscription test' do
503
+ it 'should work' do
504
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
505
+ end
506
+ end
507
+
508
+ # unit tests for update_user
509
+ # Updates an existing User’s properties.
510
+ # @param app_id
511
+ # @param alias_label
512
+ # @param alias_id
513
+ # @param update_user_request
514
+ # @param [Hash] opts the optional parameters
515
+ # @return [InlineResponse202]
516
+ describe 'update_user test' do
517
+ it 'should work' do
518
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
519
+ end
520
+ end
521
+
285
522
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -18,7 +18,7 @@ describe OneSignal::Configuration do
18
18
  before(:each) do
19
19
  # uncomment below to setup host and base_path
20
20
  # require 'URI'
21
- # uri = URI.parse("https://onesignal.com/api/v1")
21
+ # uri = URI.parse("https://api.onesignal.com")
22
22
  # OneSignal.configure do |c|
23
23
  # c.host = uri.host
24
24
  # c.base_path = uri.path
@@ -28,14 +28,14 @@ describe OneSignal::Configuration do
28
28
  describe '#base_url' do
29
29
  it 'should have the default value' do
30
30
  # uncomment below to test default value of the base path
31
- # expect(config.base_url).to eq("https://onesignal.com/api/v1")
31
+ # expect(config.base_url).to eq("https://api.onesignal.com")
32
32
  end
33
33
 
34
34
  it 'should remove trailing slashes' do
35
35
  [nil, '', '/', '//'].each do |base_path|
36
36
  config.base_path = base_path
37
37
  # uncomment below to test trailing slashes
38
- # expect(config.base_url).to eq("https://onesignal.com/api/v1")
38
+ # expect(config.base_url).to eq("https://api.onesignal.com")
39
39
  end
40
40
  end
41
41
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -143,6 +143,30 @@ describe OneSignal::App do
143
143
  end
144
144
  end
145
145
 
146
+ describe 'test attribute "apns_key_id"' do
147
+ it 'should work' do
148
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
149
+ end
150
+ end
151
+
152
+ describe 'test attribute "apns_team_id"' do
153
+ it 'should work' do
154
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
155
+ end
156
+ end
157
+
158
+ describe 'test attribute "apns_bundle_id"' do
159
+ it 'should work' do
160
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
161
+ end
162
+ end
163
+
164
+ describe 'test attribute "apns_p8"' do
165
+ it 'should work' do
166
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
167
+ end
168
+ end
169
+
146
170
  describe 'test attribute "safari_site_origin"' do
147
171
  it 'should work' do
148
172
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -3,7 +3,7 @@
3
3
 
4
4
  #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.4.0
7
7
  Contact: devrel@onesignal.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -14,15 +14,15 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for OneSignal::NotificationAllOfAndroidBackgroundLayout
17
+ # Unit tests for OneSignal::BasicNotificationAllOfAndroidBackgroundLayout
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe OneSignal::NotificationAllOfAndroidBackgroundLayout do
21
- let(:instance) { OneSignal::NotificationAllOfAndroidBackgroundLayout.new }
20
+ describe OneSignal::BasicNotificationAllOfAndroidBackgroundLayout do
21
+ let(:instance) { OneSignal::BasicNotificationAllOfAndroidBackgroundLayout.new }
22
22
 
23
- describe 'test an instance of NotificationAllOfAndroidBackgroundLayout' do
24
- it 'should create an instance of NotificationAllOfAndroidBackgroundLayout' do
25
- expect(instance).to be_instance_of(OneSignal::NotificationAllOfAndroidBackgroundLayout)
23
+ describe 'test an instance of BasicNotificationAllOfAndroidBackgroundLayout' do
24
+ it 'should create an instance of BasicNotificationAllOfAndroidBackgroundLayout' do
25
+ expect(instance).to be_instance_of(OneSignal::BasicNotificationAllOfAndroidBackgroundLayout)
26
26
  end
27
27
  end
28
28
  describe 'test attribute "image"' do