onesignal 0.3.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d3ca7d6cbaf4ccca38afdf280d06402bc5249ba
-  data.tar.gz: fe9bd8ead86744e0c1e2a7abc955645d58681a55
+SHA256:
+  metadata.gz: d21c45ad6dc835a3d618d705c0abad6b42cb5d81733232519ff6305f444736cd
+  data.tar.gz: cb84fa7dcfbf2dbbce153806f056f059587aa45fda020451f2df01ffe496b235
 SHA512:
-  metadata.gz: de637cf8ca145013e3d15e839a65ce44c96c829e3ae85fea3398c5748f897b414ea12966142f1b281eef8ba107723ddfc8005bc31651a69760fd151c725ee277
-  data.tar.gz: 0cdbbc1d1a4814a2a678f45f57eb6649a6cba7743af3d1306e7e8bcfc98860148fcc08e9d0bc3a148c4a66b52799c98a8513248e3bcb07679e38f2e09bd7a40e
+  metadata.gz: 798df78ec20c50fddf2cc396900b83209d684e15f4a978b1c15a2a6fe33eb8b6bd33c149806a3984bc837ce79e4610da405d1774252cd4f8c7261b96846c3d39
+  data.tar.gz: 2091ac298b863f0658ecb69eb20009231216f4ad4a044a55ee67f356ea0d19038953ebfdbffc28731cb110e58ac8a4ede9b8f5f411904ef5e86bda9f2abb9549

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in onesignal.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -1,141 +1,156 @@
-# OneSignal
+# onesignal
 
-[![Gem Version][rgb]][rgl] [![Build Status][trb]][trl] [![Code Climate][ccb]][ccl]
+OneSignal - the Ruby gem for the OneSignal
 
-OneSignal is a simple ruby wrapper for the [OneSignal API][osa].
+A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'onesignal'
-```
-
-And then execute:
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-    $ bundle
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://onesignal.com](https://onesignal.com)
 
-Or install it yourself as:
-
-    $ gem install onesignal
+## Installation
 
-## Usage
+### Build a gem
 
-You can find your auth keys and app IDs on the Account Management page when
-you're logged into OneSignal. With those at hand, you can create a client.
+To build the Ruby code into a gem:
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN', app_id: 'APP_ID')
+```shell
+gem build onesignal.gemspec
 ```
 
-### Design
-
-This gem follows a strict design of resources as methods on your client. For
-examples, for apps, you will call your client like this:
+Then either install the gem locally:
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-client.apps #=> AppResource
+```shell
+gem install ./onesignal-1.0.0.gem
 ```
 
-It will return objects that contain the information provided by the API. For
-example:
+(for development, run `gem install --dev ./onesignal-1.0.0.gem` to install the development dependencies)
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-client.apps.all
-# => [ OneSignal::App(id: '92911750-242d-4260-9e00-9d9034f139ce', name: 'Your App 1', ...), OneSignal::App(id: 'e4e87830-b954-11e3-811d-f3b376925f15', name: Your app 2', ...) ]
-```
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-To retrieve objects, you can perform this type of action on the resource (if
-the API supports it):
+Finally add this to the Gemfile:
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-app = client.apps.find(id: 'e4e87830-b954-11e3-811d-f3b376925f15')
-# => OneSignal::App(id: 'e4e87830-b954-11e3-811d-f3b376925f15', name: 'Your app', ...)
-```
+    gem 'onesignal', '~> 1.0.0'
 
-To create objects, you just have to build a params hash and pass it to the
-action on the resource:
+### Install from Git
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-params = { name: 'Your app', apns_env: 'sandbox', ... }
-app = client.apps.create(params)
-# => OneSignal::App(id: 'e4e87830-b954-11e3-811d-f3b376925f15', name: 'Your app', ...)
-```
-
-### All Resources and actions
-
-#### App resource
-
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-client.apps #=> OneSignal::AppResource
-```
+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:
 
-Actions supported:
+    gem 'onesignal', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
 
-* `client.apps.all`
-* `client.apps.find(id)`
-* `client.apps.create(params)`
-* `client.apps.update(id, params)`
+### Include the Ruby code directly
 
-#### Player resource
+Include the Ruby code directly using `-I` as follows:
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN', app_id: 'APP_ID')
-client.players #=> OneSignal::PlayerResource
+```shell
+ruby -Ilib script.rb
 ```
 
-Actions supported:
-
-* `client.players.all`
-* `client.players.all(params)`
-* `client.players.find(id)`
-* `client.players.create(params)`
-* `client.players.update(id, params)`
-* `client.players.on_session(id, params)`
-* `client.players.on_purchase(id, params)`
-* `client.players.on_focus(id, params)`
-* `client.players.csv_export(id)`
+## Getting Started
 
-#### Notification resource
+Please follow the [installation](#installation) procedure and then run the following code:
 
 ```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN', app_id: 'APP_ID')
-client.notifications #=> OneSignal::NotificationResource
-```
-
-Actions supported:
-
-* `client.notifications.all`
-* `client.notifications.all(params)`
-* `client.notifications.find(id)`
-* `client.notifications.track_open(id, params)`
-* `client.notifications.create(params)`
-* `client.notifications.cancel(id)`
-
-## Contributing
+# Load the gem
+require 'onesignal'
+
+# Setup authorization
+OneSignal.configure do |config|
+  # Configure Bearer authorization: app_key
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OneSignal::DefaultApi.new
+app_id = 'app_id_example' # String | 
+notification_id = 'notification_id_example' # String | 
+
+begin
+  #Stop a scheduled or currently outgoing notification
+  result = api_instance.cancel_notification(app_id, notification_id)
+  p result
+rescue OneSignal::ApiError => e
+  puts "Exception when calling DefaultApi->cancel_notification: #{e}"
+end
 
-Bug reports and pull requests are welcome on [GitHub][gh].
-
-This project is intended to be a safe, welcoming space for collaboration, and
-contributors are expected to adhere to the [Contributor Covenant][cc] code of conduct.
-
-## License
+```
 
-The gem is available as open source under the terms of the [MIT License][mit].
+## Documentation for API Endpoints
+
+All URIs are relative to *https://onesignal.com/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OneSignal::DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
+*OneSignal::DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app
+*OneSignal::DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification
+*OneSignal::DefaultApi* | [**create_player**](docs/DefaultApi.md#create_player) | **POST** /players | Add a device
+*OneSignal::DefaultApi* | [**create_segments**](docs/DefaultApi.md#create_segments) | **POST** /apps/{app_id}/segments | Create Segments
+*OneSignal::DefaultApi* | [**delete_player**](docs/DefaultApi.md#delete_player) | **DELETE** /players/{player_id} | Delete a user record
+*OneSignal::DefaultApi* | [**delete_segments**](docs/DefaultApi.md#delete_segments) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segments
+*OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id={app_id} | CSV export
+*OneSignal::DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /apps/{app_id} | View an app
+*OneSignal::DefaultApi* | [**get_apps**](docs/DefaultApi.md#get_apps) | **GET** /apps | View apps
+*OneSignal::DefaultApi* | [**get_notification**](docs/DefaultApi.md#get_notification) | **GET** /notifications/{notification_id} | View notification
+*OneSignal::DefaultApi* | [**get_notification_history**](docs/DefaultApi.md#get_notification_history) | **POST** /notifications/{notification_id}/history | Notification History
+*OneSignal::DefaultApi* | [**get_notifications**](docs/DefaultApi.md#get_notifications) | **GET** /notifications | View notifications
+*OneSignal::DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
+*OneSignal::DefaultApi* | [**get_player**](docs/DefaultApi.md#get_player) | **GET** /players/{player_id} | View device
+*OneSignal::DefaultApi* | [**get_players**](docs/DefaultApi.md#get_players) | **GET** /players | View devices
+*OneSignal::DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app
+*OneSignal::DefaultApi* | [**update_player**](docs/DefaultApi.md#update_player) | **PUT** /players/{player_id} | Edit device
+*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
+
+
+## Documentation for Models
+
+ - [OneSignal::App](docs/App.md)
+ - [OneSignal::Button](docs/Button.md)
+ - [OneSignal::DeliveryData](docs/DeliveryData.md)
+ - [OneSignal::ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
+ - [OneSignal::Filter](docs/Filter.md)
+ - [OneSignal::FilterExpressions](docs/FilterExpressions.md)
+ - [OneSignal::FilterNotificationTarget](docs/FilterNotificationTarget.md)
+ - [OneSignal::GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
+ - [OneSignal::InlineResponse200](docs/InlineResponse200.md)
+ - [OneSignal::InlineResponse2001](docs/InlineResponse2001.md)
+ - [OneSignal::InlineResponse2002](docs/InlineResponse2002.md)
+ - [OneSignal::InlineResponse2003](docs/InlineResponse2003.md)
+ - [OneSignal::InlineResponse2004](docs/InlineResponse2004.md)
+ - [OneSignal::InlineResponse2005](docs/InlineResponse2005.md)
+ - [OneSignal::InlineResponse201](docs/InlineResponse201.md)
+ - [OneSignal::InlineResponse400](docs/InlineResponse400.md)
+ - [OneSignal::InlineResponse4001](docs/InlineResponse4001.md)
+ - [OneSignal::InlineResponse4002](docs/InlineResponse4002.md)
+ - [OneSignal::InlineResponse409](docs/InlineResponse409.md)
+ - [OneSignal::Notification](docs/Notification.md)
+ - [OneSignal::NotificationAllOf](docs/NotificationAllOf.md)
+ - [OneSignal::NotificationAllOfAndroidBackgroundLayout](docs/NotificationAllOfAndroidBackgroundLayout.md)
+ - [OneSignal::NotificationSlice](docs/NotificationSlice.md)
+ - [OneSignal::NotificationTarget](docs/NotificationTarget.md)
+ - [OneSignal::Operator](docs/Operator.md)
+ - [OneSignal::OutcomeData](docs/OutcomeData.md)
+ - [OneSignal::PlatformDeliveryData](docs/PlatformDeliveryData.md)
+ - [OneSignal::Player](docs/Player.md)
+ - [OneSignal::PlayerNotificationTarget](docs/PlayerNotificationTarget.md)
+ - [OneSignal::PlayerSlice](docs/PlayerSlice.md)
+ - [OneSignal::Purchase](docs/Purchase.md)
+ - [OneSignal::Segment](docs/Segment.md)
+ - [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
+ - [OneSignal::StringMap](docs/StringMap.md)
+ - [OneSignal::UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
+
+
+## Documentation for Authorization
+
+
+### app_key
+
+- **Type**: Bearer authentication
+
+### user_key
+
+- **Type**: Bearer authentication
 
-[rgb]: https://img.shields.io/gem/v/onesignal.svg
-[rgl]: https://rubygems.org/gems/onesignal
-[trb]: https://travis-ci.org/coding-chimp/onesignal.svg?branch=master
-[trl]: https://travis-ci.org/coding-chimp/onesignal
-[ccb]: https://codeclimate.com/github/coding-chimp/onesignal/badges/gpa.svg
-[ccl]: https://codeclimate.com/github/coding-chimp/onesignal
-[osa]: https://documentation.onesignal.com/docs/server-api-overview
-[cc]: http://contributor-covenant.org
-[gh]: https://github.com/coding-chimp/onesignal
-[mit]: http://opensource.org/licenses/MIT

data/Rakefile

@@ -1,10 +1,10 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
+begin
+  require 'rspec/core/rake_task'
 
-task default: :test
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/App.md

@@ -0,0 +1,76 @@
+# OneSignal::App
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **name** | **String** | The name of your app, as displayed on your apps list on the dashboard.  This can be renamed. | [optional] |
+| **players** | **Integer** |  | [optional][readonly] |
+| **messageable_players** | **Integer** |  | [optional][readonly] |
+| **updated_at** | **Time** |  | [optional][readonly] |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **android_gcm_sender_id** | **String** | Android: Your Google Project number.  Also known as Sender ID. | [optional] |
+| **gcm_key** | **String** | Android: Your Google Push Messaging Auth Key | [optional] |
+| **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] |
+| **chrome_key** | **String** | Not for web push.  Your Google Push Messaging Auth Key if you use Chrome Apps / Extensions. | [optional] |
+| **chrome_web_default_notification_icon** | **String** | Chrome (All Browsers except Safari): Your default notification icon. Should be 256x256 pixels, min 80x80. | [optional] |
+| **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] |
+| **apns_env** | **String** | iOS: Either sandbox or production | [optional] |
+| **apns_p12** | **String** | iOS: Your apple push notification p12 certificate file, converted to a string and Base64 encoded. | [optional] |
+| **apns_p12_password** | **String** | iOS: Required if using p12 certificate.  Password for the apns_p12 file. | [optional] |
+| **apns_certificates** | **String** |  | [optional][readonly] |
+| **safari_apns_certificates** | **String** |  | [optional][readonly] |
+| **safari_apns_p12** | **String** | Safari: Your apple push notification p12 certificate file for Safari Push Notifications, converted to a string and Base64 encoded. | [optional] |
+| **safari_apns_p12_password** | **String** | Safari: Password for safari_apns_p12 file | [optional] |
+| **safari_site_origin** | **String** | Safari (Recommended): The hostname to your website including http(s):// | [optional] |
+| **safari_push_id** | **String** |  | [optional][readonly] |
+| **safari_icon_16_16** | **String** |  | [optional][readonly] |
+| **safari_icon_32_32** | **String** |  | [optional][readonly] |
+| **safari_icon_64_64** | **String** |  | [optional][readonly] |
+| **safari_icon_128_128** | **String** |  | [optional][readonly] |
+| **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] |
+| **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] |
+| **basic_auth_key** | **String** |  | [optional][readonly] |
+| **organization_id** | **String** | The Id of the Organization you would like to add this app to. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::App.new(
+  id: null,
+  name: null,
+  players: null,
+  messageable_players: null,
+  updated_at: null,
+  created_at: null,
+  android_gcm_sender_id: null,
+  gcm_key: null,
+  chrome_web_origin: null,
+  chrome_key: null,
+  chrome_web_default_notification_icon: null,
+  chrome_web_sub_domain: null,
+  apns_env: null,
+  apns_p12: null,
+  apns_p12_password: null,
+  apns_certificates: null,
+  safari_apns_certificates: null,
+  safari_apns_p12: null,
+  safari_apns_p12_password: null,
+  safari_site_origin: null,
+  safari_push_id: null,
+  safari_icon_16_16: null,
+  safari_icon_32_32: null,
+  safari_icon_64_64: null,
+  safari_icon_128_128: null,
+  safari_icon_256_256: null,
+  site_name: null,
+  basic_auth_key: null,
+  organization_id: null,
+  additional_data_is_root_payload: null
+)
+```
+

data/docs/Button.md

@@ -0,0 +1,22 @@
+# OneSignal::Button
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **text** | **String** |  | [optional] |
+| **icon** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Button.new(
+  id: null,
+  text: null,
+  icon: null
+)
+```
+