onesignal_sdk 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +31 -0
- data/Gemfile +9 -0
- data/LICENSE +24 -0
- data/README.md +210 -0
- data/RELEASE_INSTRUCTIONS.md +11 -0
- data/Rakefile +10 -0
- data/docs/App.md +84 -0
- data/docs/BasicNotification.md +228 -0
- data/docs/BasicNotificationAllOf.md +200 -0
- data/docs/BasicNotificationAllOfAndroidBackgroundLayout.md +22 -0
- data/docs/BeginLiveActivityRequest.md +20 -0
- data/docs/Button.md +22 -0
- data/docs/CancelNotificationSuccessResponse.md +18 -0
- data/docs/CreateNotificationSuccessResponse.md +24 -0
- data/docs/CreatePlayerSuccessResponse.md +20 -0
- data/docs/CreateSegmentConflictResponse.md +20 -0
- data/docs/CreateSegmentSuccessResponse.md +20 -0
- data/docs/CreateSubscriptionRequestBody.md +20 -0
- data/docs/CreateUserConflictResponse.md +18 -0
- data/docs/CreateUserConflictResponseErrorsInner.md +22 -0
- data/docs/CreateUserConflictResponseErrorsItemsMeta.md +18 -0
- data/docs/DefaultApi.md +2713 -0
- data/docs/DeletePlayerNotFoundResponse.md +18 -0
- data/docs/DeletePlayerSuccessResponse.md +18 -0
- data/docs/DeleteSegmentNotFoundResponse.md +18 -0
- data/docs/DeleteSegmentSuccessResponse.md +18 -0
- data/docs/DeliveryData.md +26 -0
- data/docs/ExportEventsSuccessResponse.md +18 -0
- data/docs/ExportPlayersRequestBody.md +22 -0
- data/docs/ExportPlayersSuccessResponse.md +18 -0
- data/docs/Filter.md +24 -0
- data/docs/FilterExpressions.md +26 -0
- data/docs/GenericError.md +18 -0
- data/docs/GenericErrorErrorsInner.md +20 -0
- data/docs/GetNotificationRequestBody.md +22 -0
- data/docs/InlineResponse200.md +18 -0
- data/docs/InlineResponse2003.md +18 -0
- data/docs/InlineResponse201.md +18 -0
- data/docs/InlineResponse202.md +18 -0
- data/docs/InvalidIdentifierError.md +20 -0
- data/docs/Notification.md +230 -0
- data/docs/Notification200Errors.md +49 -0
- data/docs/NotificationAllOf.md +18 -0
- data/docs/NotificationHistorySuccessResponse.md +20 -0
- data/docs/NotificationSlice.md +24 -0
- data/docs/NotificationTarget.md +44 -0
- data/docs/NotificationWithMeta.md +250 -0
- data/docs/NotificationWithMetaAllOf.md +38 -0
- data/docs/Operator.md +18 -0
- data/docs/OutcomeData.md +22 -0
- data/docs/OutcomesData.md +18 -0
- data/docs/PlatformDeliveryData.md +32 -0
- data/docs/PlatformDeliveryDataEmailAllOf.md +30 -0
- data/docs/PlatformDeliveryDataSmsAllOf.md +22 -0
- data/docs/Player.md +70 -0
- data/docs/PlayerNotificationTarget.md +40 -0
- data/docs/PlayerNotificationTargetIncludeAliases.md +18 -0
- data/docs/PlayerSlice.md +24 -0
- data/docs/PropertiesDeltas.md +22 -0
- data/docs/PropertiesObject.md +38 -0
- data/docs/Purchase.md +24 -0
- data/docs/RateLimiterError.md +18 -0
- data/docs/Segment.md +22 -0
- data/docs/SegmentNotificationTarget.md +20 -0
- data/docs/StringMap.md +102 -0
- data/docs/SubscriptionObject.md +50 -0
- data/docs/TransferSubscriptionRequestBody.md +18 -0
- data/docs/UpdateLiveActivityRequest.md +24 -0
- data/docs/UpdateLiveActivitySuccessResponse.md +20 -0
- data/docs/UpdatePlayerSuccessResponse.md +18 -0
- data/docs/UpdatePlayerTagsRequestBody.md +18 -0
- data/docs/UpdatePlayerTagsSuccessResponse.md +18 -0
- data/docs/UpdateSubscriptionRequestBody.md +18 -0
- data/docs/UpdateUserRequest.md +22 -0
- data/docs/User.md +24 -0
- data/docs/UserIdentityRequestBody.md +18 -0
- data/docs/UserIdentityResponse.md +18 -0
- data/docs/UserSubscriptionOptions.md +18 -0
- data/lib/onesignal/api/default_api.rb +2727 -0
- data/lib/onesignal/api_client.rb +393 -0
- data/lib/onesignal/api_error.rb +57 -0
- data/lib/onesignal/configuration.rb +245 -0
- data/lib/onesignal/models/app.rb +586 -0
- data/lib/onesignal/models/basic_notification.rb +1431 -0
- data/lib/onesignal/models/basic_notification_all_of.rb +1241 -0
- data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +241 -0
- data/lib/onesignal/models/begin_live_activity_request.rb +238 -0
- data/lib/onesignal/models/button.rb +242 -0
- data/lib/onesignal/models/cancel_notification_success_response.rb +219 -0
- data/lib/onesignal/models/create_notification_success_response.rb +248 -0
- data/lib/onesignal/models/create_player_success_response.rb +228 -0
- data/lib/onesignal/models/create_segment_conflict_response.rb +230 -0
- data/lib/onesignal/models/create_segment_success_response.rb +229 -0
- data/lib/onesignal/models/create_subscription_request_body.rb +228 -0
- data/lib/onesignal/models/create_user_conflict_response.rb +221 -0
- data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +237 -0
- data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +219 -0
- data/lib/onesignal/models/delete_player_not_found_response.rb +219 -0
- data/lib/onesignal/models/delete_player_success_response.rb +219 -0
- data/lib/onesignal/models/delete_segment_not_found_response.rb +219 -0
- data/lib/onesignal/models/delete_segment_success_response.rb +219 -0
- data/lib/onesignal/models/delivery_data.rb +265 -0
- data/lib/onesignal/models/export_events_success_response.rb +219 -0
- data/lib/onesignal/models/export_players_request_body.rb +242 -0
- data/lib/onesignal/models/export_players_success_response.rb +219 -0
- data/lib/onesignal/models/filter.rb +294 -0
- data/lib/onesignal/models/filter_expressions.rb +336 -0
- data/lib/onesignal/models/generic_error.rb +221 -0
- data/lib/onesignal/models/generic_error_errors_inner.rb +228 -0
- data/lib/onesignal/models/get_notification_request_body.rb +273 -0
- data/lib/onesignal/models/inline_response200.rb +221 -0
- data/lib/onesignal/models/inline_response2003.rb +221 -0
- data/lib/onesignal/models/inline_response201.rb +219 -0
- data/lib/onesignal/models/inline_response202.rb +219 -0
- data/lib/onesignal/models/invalid_identifier_error.rb +234 -0
- data/lib/onesignal/models/notification.rb +1442 -0
- data/lib/onesignal/models/notification200_errors.rb +105 -0
- data/lib/onesignal/models/notification_all_of.rb +221 -0
- data/lib/onesignal/models/notification_history_success_response.rb +228 -0
- data/lib/onesignal/models/notification_slice.rb +248 -0
- data/lib/onesignal/models/notification_target.rb +429 -0
- data/lib/onesignal/models/notification_with_meta.rb +1546 -0
- data/lib/onesignal/models/notification_with_meta_all_of.rb +323 -0
- data/lib/onesignal/models/operator.rb +254 -0
- data/lib/onesignal/models/outcome_data.rb +286 -0
- data/lib/onesignal/models/outcomes_data.rb +221 -0
- data/lib/onesignal/models/platform_delivery_data.rb +285 -0
- data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +287 -0
- data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +243 -0
- data/lib/onesignal/models/player.rb +494 -0
- data/lib/onesignal/models/player_notification_target.rb +385 -0
- data/lib/onesignal/models/player_notification_target_include_aliases.rb +221 -0
- data/lib/onesignal/models/player_slice.rb +248 -0
- data/lib/onesignal/models/properties_deltas.rb +239 -0
- data/lib/onesignal/models/properties_object.rb +313 -0
- data/lib/onesignal/models/purchase.rb +264 -0
- data/lib/onesignal/models/rate_limiter_error.rb +221 -0
- data/lib/onesignal/models/segment.rb +252 -0
- data/lib/onesignal/models/segment_notification_target.rb +234 -0
- data/lib/onesignal/models/string_map.rb +640 -0
- data/lib/onesignal/models/subscription_object.rb +397 -0
- data/lib/onesignal/models/transfer_subscription_request_body.rb +221 -0
- data/lib/onesignal/models/update_live_activity_request.rb +309 -0
- data/lib/onesignal/models/update_live_activity_success_response.rb +228 -0
- data/lib/onesignal/models/update_player_success_response.rb +219 -0
- data/lib/onesignal/models/update_player_tags_request_body.rb +220 -0
- data/lib/onesignal/models/update_player_tags_success_response.rb +219 -0
- data/lib/onesignal/models/update_subscription_request_body.rb +219 -0
- data/lib/onesignal/models/update_user_request.rb +239 -0
- data/lib/onesignal/models/user.rb +250 -0
- data/lib/onesignal/models/user_identity_request_body.rb +221 -0
- data/lib/onesignal/models/user_identity_response.rb +221 -0
- data/lib/onesignal/models/user_subscription_options.rb +219 -0
- data/lib/onesignal/version.rb +15 -0
- data/lib/onesignal.rb +111 -0
- data/onesignal.gemspec +38 -0
- data/spec/api/default_api_spec.rb +522 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/app_spec.rb +236 -0
- data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +46 -0
- data/spec/models/basic_notification_all_of_spec.rb +584 -0
- data/spec/models/basic_notification_spec.rb +672 -0
- data/spec/models/begin_live_activity_request_spec.rb +40 -0
- data/spec/models/button_spec.rb +46 -0
- data/spec/models/cancel_notification_success_response_spec.rb +34 -0
- data/spec/models/create_notification_success_response_spec.rb +52 -0
- data/spec/models/create_player_success_response_spec.rb +40 -0
- data/spec/models/create_segment_conflict_response_spec.rb +40 -0
- data/spec/models/create_segment_success_response_spec.rb +40 -0
- data/spec/models/create_subscription_request_body_spec.rb +40 -0
- data/spec/models/create_user_conflict_response_errors_inner_spec.rb +46 -0
- data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +34 -0
- data/spec/models/create_user_conflict_response_spec.rb +34 -0
- data/spec/models/delete_player_not_found_response_spec.rb +34 -0
- data/spec/models/delete_player_success_response_spec.rb +34 -0
- data/spec/models/delete_segment_not_found_response_spec.rb +34 -0
- data/spec/models/delete_segment_success_response_spec.rb +34 -0
- data/spec/models/delivery_data_spec.rb +58 -0
- data/spec/models/export_events_success_response_spec.rb +34 -0
- data/spec/models/export_players_request_body_spec.rb +46 -0
- data/spec/models/export_players_success_response_spec.rb +34 -0
- data/spec/models/filter_expressions_spec.rb +66 -0
- data/spec/models/filter_spec.rb +56 -0
- data/spec/models/generic_error_errors_inner_spec.rb +40 -0
- data/spec/models/generic_error_spec.rb +34 -0
- data/spec/models/get_notification_request_body_spec.rb +50 -0
- data/spec/models/inline_response2003_spec.rb +34 -0
- data/spec/models/inline_response200_spec.rb +34 -0
- data/spec/models/inline_response201_spec.rb +34 -0
- data/spec/models/inline_response202_spec.rb +34 -0
- data/spec/models/invalid_identifier_error_spec.rb +40 -0
- data/spec/models/notification200_errors_spec.rb +31 -0
- data/spec/models/notification_all_of_spec.rb +34 -0
- data/spec/models/notification_history_success_response_spec.rb +40 -0
- data/spec/models/notification_slice_spec.rb +52 -0
- data/spec/models/notification_spec.rb +678 -0
- data/spec/models/notification_target_spec.rb +116 -0
- data/spec/models/notification_with_meta_all_of_spec.rb +94 -0
- data/spec/models/notification_with_meta_spec.rb +738 -0
- data/spec/models/operator_spec.rb +38 -0
- data/spec/models/outcome_data_spec.rb +50 -0
- data/spec/models/outcomes_data_spec.rb +34 -0
- data/spec/models/platform_delivery_data_email_all_of_spec.rb +70 -0
- data/spec/models/platform_delivery_data_sms_all_of_spec.rb +46 -0
- data/spec/models/platform_delivery_data_spec.rb +76 -0
- data/spec/models/player_notification_target_include_aliases_spec.rb +34 -0
- data/spec/models/player_notification_target_spec.rb +104 -0
- data/spec/models/player_slice_spec.rb +52 -0
- data/spec/models/player_spec.rb +190 -0
- data/spec/models/properties_deltas_spec.rb +46 -0
- data/spec/models/properties_object_spec.rb +94 -0
- data/spec/models/purchase_spec.rb +52 -0
- data/spec/models/rate_limiter_error_spec.rb +34 -0
- data/spec/models/segment_notification_target_spec.rb +40 -0
- data/spec/models/segment_spec.rb +46 -0
- data/spec/models/string_map_spec.rb +286 -0
- data/spec/models/subscription_object_spec.rb +134 -0
- data/spec/models/transfer_subscription_request_body_spec.rb +34 -0
- data/spec/models/update_live_activity_request_spec.rb +60 -0
- data/spec/models/update_live_activity_success_response_spec.rb +40 -0
- data/spec/models/update_player_success_response_spec.rb +34 -0
- data/spec/models/update_player_tags_request_body_spec.rb +34 -0
- data/spec/models/update_player_tags_success_response_spec.rb +34 -0
- data/spec/models/update_subscription_request_body_spec.rb +34 -0
- data/spec/models/update_user_request_spec.rb +46 -0
- data/spec/models/user_identity_request_body_spec.rb +34 -0
- data/spec/models/user_identity_response_spec.rb +34 -0
- data/spec/models/user_spec.rb +52 -0
- data/spec/models/user_subscription_options_spec.rb +34 -0
- data/spec/spec_helper.rb +111 -0
- metadata +389 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b809baa7353136d4582097d65814fffe4b7961b89b8c3c43bb667cd6e50922ac
|
4
|
+
data.tar.gz: 1451825c3431ae7716be099f483c4e2830ef682c8098a53238eea13c2a1a44d2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 4611d097d04b6f22f16b7dc02a2070558ee9562919ded28a7b9eb60ff6882d64e20291ffe0dcb9cc10772e65947cad7f0bc9c918b2cd329583080c1045dfb37f
|
7
|
+
data.tar.gz: 5eebfff135da4dcb398dd9d567ea5cd6cc253487d6173db38ff8549d42aca36afaac0f9507cddbd41d346b943b4fe8b44904288892c2594bbb317b330309f7fc
|
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
ADDED
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
ADDED
@@ -0,0 +1,210 @@
|
|
1
|
+
# onesignal
|
2
|
+
|
3
|
+
OneSignal - the Ruby gem for the OneSignal
|
4
|
+
|
5
|
+
A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 1.2.2
|
10
|
+
- Package version: 2.0.2
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://onesignal.com](https://onesignal.com)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build onesignal.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./onesignal-2.0.2.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./onesignal-2.0.2.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'onesignal', '~> 2.0.2'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'onesignal', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'onesignal'
|
59
|
+
|
60
|
+
# Setup authorization
|
61
|
+
OneSignal.configure do |config|
|
62
|
+
# Configure Bearer authorization: app_key
|
63
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
64
|
+
end
|
65
|
+
|
66
|
+
api_instance = OneSignal::DefaultApi.new
|
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 |
|
70
|
+
|
71
|
+
begin
|
72
|
+
#Start Live Activity
|
73
|
+
api_instance.begin_live_activity(app_id, activity_id, begin_live_activity_request)
|
74
|
+
rescue OneSignal::ApiError => e
|
75
|
+
puts "Exception when calling DefaultApi->begin_live_activity: #{e}"
|
76
|
+
end
|
77
|
+
|
78
|
+
```
|
79
|
+
|
80
|
+
## Documentation for API Endpoints
|
81
|
+
|
82
|
+
All URIs are relative to *https://onesignal.com/api/v1*
|
83
|
+
|
84
|
+
Class | Method | HTTP request | Description
|
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
|
87
|
+
*OneSignal::DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
|
88
|
+
*OneSignal::DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app
|
89
|
+
*OneSignal::DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification
|
90
|
+
*OneSignal::DefaultApi* | [**create_player**](docs/DefaultApi.md#create_player) | **POST** /players | Add a device
|
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} |
|
95
|
+
*OneSignal::DefaultApi* | [**delete_player**](docs/DefaultApi.md#delete_player) | **DELETE** /players/{player_id} | Delete a user record
|
96
|
+
*OneSignal::DefaultApi* | [**delete_segments**](docs/DefaultApi.md#delete_segments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
|
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={app_id} | Export CSV of Events
|
101
|
+
*OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id={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 |
|
105
|
+
*OneSignal::DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app
|
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 |
|
108
|
+
*OneSignal::DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification
|
109
|
+
*OneSignal::DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History
|
110
|
+
*OneSignal::DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications
|
111
|
+
*OneSignal::DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
|
112
|
+
*OneSignal::DefaultApi* | [**get_player**](docs/DefaultApi.md#get_player) | **GET** /players/{player_id} | View device
|
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 |
|
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
|
119
|
+
*OneSignal::DefaultApi* | [**update_player**](docs/DefaultApi.md#update_player) | **PUT** /players/{player_id} | Edit device
|
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} |
|
123
|
+
|
124
|
+
|
125
|
+
## Documentation for Models
|
126
|
+
|
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)
|
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)
|
146
|
+
- [OneSignal::DeliveryData](docs/DeliveryData.md)
|
147
|
+
- [OneSignal::ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
|
148
|
+
- [OneSignal::ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
|
149
|
+
- [OneSignal::ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
|
150
|
+
- [OneSignal::Filter](docs/Filter.md)
|
151
|
+
- [OneSignal::FilterExpressions](docs/FilterExpressions.md)
|
152
|
+
- [OneSignal::GenericError](docs/GenericError.md)
|
153
|
+
- [OneSignal::GenericErrorErrorsInner](docs/GenericErrorErrorsInner.md)
|
154
|
+
- [OneSignal::GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
|
155
|
+
- [OneSignal::InlineResponse200](docs/InlineResponse200.md)
|
156
|
+
- [OneSignal::InlineResponse2003](docs/InlineResponse2003.md)
|
157
|
+
- [OneSignal::InlineResponse201](docs/InlineResponse201.md)
|
158
|
+
- [OneSignal::InlineResponse202](docs/InlineResponse202.md)
|
159
|
+
- [OneSignal::InvalidIdentifierError](docs/InvalidIdentifierError.md)
|
160
|
+
- [OneSignal::Notification](docs/Notification.md)
|
161
|
+
- [OneSignal::Notification200Errors](docs/Notification200Errors.md)
|
162
|
+
- [OneSignal::NotificationAllOf](docs/NotificationAllOf.md)
|
163
|
+
- [OneSignal::NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md)
|
164
|
+
- [OneSignal::NotificationSlice](docs/NotificationSlice.md)
|
165
|
+
- [OneSignal::NotificationTarget](docs/NotificationTarget.md)
|
166
|
+
- [OneSignal::NotificationWithMeta](docs/NotificationWithMeta.md)
|
167
|
+
- [OneSignal::NotificationWithMetaAllOf](docs/NotificationWithMetaAllOf.md)
|
168
|
+
- [OneSignal::Operator](docs/Operator.md)
|
169
|
+
- [OneSignal::OutcomeData](docs/OutcomeData.md)
|
170
|
+
- [OneSignal::OutcomesData](docs/OutcomesData.md)
|
171
|
+
- [OneSignal::PlatformDeliveryData](docs/PlatformDeliveryData.md)
|
172
|
+
- [OneSignal::PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md)
|
173
|
+
- [OneSignal::PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.md)
|
174
|
+
- [OneSignal::Player](docs/Player.md)
|
175
|
+
- [OneSignal::PlayerNotificationTarget](docs/PlayerNotificationTarget.md)
|
176
|
+
- [OneSignal::PlayerNotificationTargetIncludeAliases](docs/PlayerNotificationTargetIncludeAliases.md)
|
177
|
+
- [OneSignal::PlayerSlice](docs/PlayerSlice.md)
|
178
|
+
- [OneSignal::PropertiesDeltas](docs/PropertiesDeltas.md)
|
179
|
+
- [OneSignal::PropertiesObject](docs/PropertiesObject.md)
|
180
|
+
- [OneSignal::Purchase](docs/Purchase.md)
|
181
|
+
- [OneSignal::RateLimiterError](docs/RateLimiterError.md)
|
182
|
+
- [OneSignal::Segment](docs/Segment.md)
|
183
|
+
- [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
|
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)
|
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)
|
198
|
+
|
199
|
+
|
200
|
+
## Documentation for Authorization
|
201
|
+
|
202
|
+
|
203
|
+
### app_key
|
204
|
+
|
205
|
+
- **Type**: Bearer authentication
|
206
|
+
|
207
|
+
### user_key
|
208
|
+
|
209
|
+
- **Type**: Bearer authentication
|
210
|
+
|
@@ -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/Rakefile
ADDED
data/docs/App.md
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
# OneSignal::App
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **name** | **String** | The name of your app, as displayed on your apps list on the dashboard. This can be renamed. | [optional] |
|
9
|
+
| **players** | **Integer** | | [optional][readonly] |
|
10
|
+
| **messageable_players** | **Integer** | | [optional][readonly] |
|
11
|
+
| **updated_at** | **Time** | | [optional][readonly] |
|
12
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
13
|
+
| **android_gcm_sender_id** | **String** | Android: Your Google Project number. Also known as Sender ID. | [optional] |
|
14
|
+
| **gcm_key** | **String** | Android: Your Google Push Messaging Auth Key | [optional] |
|
15
|
+
| **chrome_web_origin** | **String** | Chrome (All Browsers except Safari) (Recommended): The URL to your website. This field is required if you wish to enable web push and specify other web push parameters. | [optional] |
|
16
|
+
| **chrome_key** | **String** | Not for web push. Your Google Push Messaging Auth Key if you use Chrome Apps / Extensions. | [optional] |
|
17
|
+
| **chrome_web_default_notification_icon** | **String** | Chrome (All Browsers except Safari): Your default notification icon. Should be 256x256 pixels, min 80x80. | [optional] |
|
18
|
+
| **chrome_web_sub_domain** | **String** | Chrome (All Browsers except Safari): A subdomain of your choice in order to support Web Push on non-HTTPS websites. This field must be set in order for the chrome_web_gcm_sender_id property to be processed. | [optional] |
|
19
|
+
| **apns_env** | **String** | iOS: Either sandbox or production | [optional] |
|
20
|
+
| **apns_p12** | **String** | iOS: Your apple push notification p12 certificate file, converted to a string and Base64 encoded. | [optional] |
|
21
|
+
| **apns_p12_password** | **String** | iOS: Required if using p12 certificate. Password for the apns_p12 file. | [optional] |
|
22
|
+
| **apns_certificates** | **String** | | [optional][readonly] |
|
23
|
+
| **safari_apns_certificates** | **String** | | [optional][readonly] |
|
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
|
+
| **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] |
|
30
|
+
| **safari_site_origin** | **String** | Safari (Recommended): The hostname to your website including http(s):// | [optional] |
|
31
|
+
| **safari_push_id** | **String** | | [optional][readonly] |
|
32
|
+
| **safari_icon_16_16** | **String** | | [optional][readonly] |
|
33
|
+
| **safari_icon_32_32** | **String** | | [optional][readonly] |
|
34
|
+
| **safari_icon_64_64** | **String** | | [optional][readonly] |
|
35
|
+
| **safari_icon_128_128** | **String** | | [optional][readonly] |
|
36
|
+
| **safari_icon_256_256** | **String** | Safari: A url for a 256x256 png notification icon. This is the only Safari icon URL you need to provide. | [optional] |
|
37
|
+
| **site_name** | **String** | All Browsers (Recommended): The Site Name. Requires both chrome_web_origin and safari_site_origin to be set to add or update it. | [optional] |
|
38
|
+
| **basic_auth_key** | **String** | | [optional][readonly] |
|
39
|
+
| **organization_id** | **String** | The Id of the Organization you would like to add this app to. | [optional] |
|
40
|
+
| **additional_data_is_root_payload** | **Boolean** | iOS: Notification data (additional data) values will be added to the root of the apns payload when sent to the device. Ignore if you're not using any other plugins, or not using OneSignal SDK methods to read the payload. | [optional] |
|
41
|
+
|
42
|
+
## Example
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
require 'onesignal'
|
46
|
+
|
47
|
+
instance = OneSignal::App.new(
|
48
|
+
id: null,
|
49
|
+
name: null,
|
50
|
+
players: null,
|
51
|
+
messageable_players: null,
|
52
|
+
updated_at: null,
|
53
|
+
created_at: null,
|
54
|
+
android_gcm_sender_id: null,
|
55
|
+
gcm_key: null,
|
56
|
+
chrome_web_origin: null,
|
57
|
+
chrome_key: null,
|
58
|
+
chrome_web_default_notification_icon: null,
|
59
|
+
chrome_web_sub_domain: null,
|
60
|
+
apns_env: null,
|
61
|
+
apns_p12: null,
|
62
|
+
apns_p12_password: null,
|
63
|
+
apns_certificates: null,
|
64
|
+
safari_apns_certificates: null,
|
65
|
+
safari_apns_p12: null,
|
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,
|
71
|
+
safari_site_origin: null,
|
72
|
+
safari_push_id: null,
|
73
|
+
safari_icon_16_16: null,
|
74
|
+
safari_icon_32_32: null,
|
75
|
+
safari_icon_64_64: null,
|
76
|
+
safari_icon_128_128: null,
|
77
|
+
safari_icon_256_256: null,
|
78
|
+
site_name: null,
|
79
|
+
basic_auth_key: null,
|
80
|
+
organization_id: null,
|
81
|
+
additional_data_is_root_payload: null
|
82
|
+
)
|
83
|
+
```
|
84
|
+
|