onesignal 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d1a29d0d02ff0e3b749a77da48c9af71fef56a9
-  data.tar.gz: 4ac7e0a67d93f3239ef27fc72da955718c7a1741
+SHA256:
+  metadata.gz: 5ed573134bbb56b24a52664d42154e91205f9ea004d945816cece64b091f70a0
+  data.tar.gz: 9216667b6c7d0b68e7fd13556a27f88006bab0ed59747b3bf2e17a095c95afa3
 SHA512:
-  metadata.gz: 2661a29b31b7710a63b0441a39973f20c3b66c16c712974b1bd15aad0f9b349d849909540217c07f5de43f06be1c6551b8029da13d56987d1ebe3e342209f6de
-  data.tar.gz: 8738408d1d19eda8d65bc42995d8445fd46941e074fb4478f982feaec37a86a9832998a121124c71466e90023cd463b31f68ebd83f0553ebf23a640b7e2e4794
+  metadata.gz: b57b8d0ed69672c664b0ec114576d702b0c601eef83e8c2db0a32d483a9bd79ecb5cfe27e442ede4785bd7fd18d039f4d3389487c20966ad22319f3198922dd5
+  data.tar.gz: d8f30f8aa642aab8150a908fc594d8c1c3e7e1f9da56999ed5b7f0c122682b741ab66c29f6beabe6c531b64c97c253ed062f9cf0c67794ee94e86cd6c7279972

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0.beta1] - 2021-10-13
+### Major Release
+**INCLUDES BREAKING CHANGES**
+This release is the code-generated Ruby client made with OpenAPI Generator.
+The release is a complete overhaul and includes a new API.
+See README for full documentation.
+
+**Full Changelog**: https://github.com/OneSignal/onesignal-ruby-client/compare/v0.3.0...1.0.0.beta1
+
+## [0.3.0] - 2016-05-10
+### Added
+* Models dynamically create attributes on initialization
+
 ## [0.2.0] - 2016-04-29
 ### Added
 * Ruby 2.0 compatibility
@@ -14,4 +27,5 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 * Methods for all OneSignal resources
 
+[0.3.0]: https://github.com/coding-chimp/onesignal/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/coding-chimp/onesignal/compare/v0.1.0...v0.2.0

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/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Modified MIT License
 
-Copyright (c) 2016 Bastian Bartmann
+Copyright 2022 OneSignal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,9 +9,12 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
+1. The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
+2. All copies of substantial portions of the Software may only be used in connection
+with services provided by OneSignal.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

data/README.md

@@ -1,15 +1,36 @@
-# OneSignal
+<h1 align="center">Welcome to the official OneSignal Ruby Client 👋</h1>
 
-[![Gem Version][rgb]][rgl] [![Build Status][trb]][trl] [![Code Climate][ccb]][ccl]
+[![Gem Version][rgb]][rgl]
+
+<p>
+  <a href="https://github.com/OneSignal/onesignal-ruby-client/blob/master/README.md" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/OneSignal/onesignal-ruby-client/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+  <a href="https://twitter.com/onesignal" target="_blank">
+    <img alt="Twitter: onesignal" src="https://img.shields.io/twitter/follow/onesignal.svg?style=social" />
+  </a>
+</p>
+
+
+OneSignal - the Ruby gem for the OneSignal
+
+A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 OneSignal is a simple ruby wrapper for the [OneSignal API][osa].
 
+### 🖤 [RubyGems](https://rubygems.org/gems/onesignal)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'onesignal'
+gem 'onesignal', '~> 1.0.1'
 ```
 
 And then execute:
@@ -20,122 +41,146 @@ Or install it yourself as:
 
     $ gem install onesignal
 
-## Usage
-
-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.
-
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN', app_id: 'APP_ID')
-```
-
-### 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:
-
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-client.apps #=> AppResource
-```
+Or install from Github:
 
-It will return objects that contain the information provided by the API. For
-example:
+    $ gem "onesignal", '~> 1.0.1', git: 'git://github.com/OneSignal/onesignal-ruby-api.git'
 
-```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', ...) ]
-```
+## Getting Started
 
-To retrieve objects, you can perform this type of action on the resource (if
-the API supports it):
+Please follow the [installation](#installation) procedure and then run the following code:
 
 ```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', ...)
+require 'time'
+require 'onesignal'
+# setup authorization
+OneSignal.configure do |config|
+  # Configure Bearer authorization: app_key
+  config.user_key = 'YOUR_USER_KEY' # Change this
+  config.app_key = 'YOUR_APP_KEY'
+end
+
+api_instance = OneSignal::DefaultApi.new
+notification = OneSignal::Notification.new({app_id: 'YOUR APP ID'}) # Notification
+
+begin
+  # Create notification
+  result = api_instance.create_notification(notification)
+  p result
+rescue OneSignal::ApiError => e
+  puts "Error when calling DefaultApi->create_notification: #{e}"
+end
 ```
 
-To create objects, you just have to build a params hash and pass it to the
-action on the resource:
-
-```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', ...)
+## 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&#x3D;{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
+
+```rb
+OneSignal.configure do |config|
+  config.app_key = 'APP_KEY' # replace with your app key
+end
 ```
 
-### All Resources and actions
+### user_key
 
-#### App resource
+- **Type**: Bearer authentication
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN')
-client.apps #=> OneSignal::AppResource
+```rb
+OneSignal.configure do |config|
+  config.user_key = 'USER_KEY' # replace with your user key
+end
 ```
 
-Actions supported:
-
-* `client.apps.all`
-* `client.apps.find(id)`
-* `client.apps.create(params)`
-* `client.apps.update(id, params)`
-
-#### Player resource
-
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN', app_id: 'APP_ID')
-client.players #=> OneSignal::PlayerResource
-```
-
-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)`
+## License
 
-#### Notification resource
+The gem is available as open source under the terms of the [MIT License][mit].
 
-```ruby
-client = OneSignal::Client.new(auth_token: 'AUTH_TOKEN', app_id: 'APP_ID')
-client.notifications #=> OneSignal::NotificationResource
-```
+[rgb]: https://img.shields.io/gem/v/onesignal.svg
+[rgl]: https://rubygems.org/gems/onesignal
+[osa]: https://documentation.onesignal.com/reference/
+[mit]: http://opensource.org/licenses/MIT
 
-Actions supported:
+## Author
 
-* `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)`
+* Website: https://onesignal.com
+* Twitter: [@onesignal](https://twitter.com/onesignal)
+* Github: [@OneSignal](https://github.com/OneSignal)
 
-## Contributing
+## 🤝 Contributing
 
-Bug reports and pull requests are welcome on [GitHub][gh].
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/onesignal-ruby-client/issues).
 
-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.
+## Show your support
 
-## License
+Give a ⭐️ if this project helped you!
 
-The gem is available as open source under the terms of the [MIT License][mit].
+## 📝 License
 
-[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
+Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
+This project is [MIT](https://opensource.org/licenses/MIT) licensed.

data/RELEASE_INSTRUCTIONS.md

@@ -0,0 +1,11 @@
+# Release Instructions
+1. Generate new client version using OpenApi Generator
+2. Make sure `ruby.yml` has the correct gem version
+2. Create a new PR and merge
+   * Carefully review the PR to ensure nothing is overwritten and you are including all desired changes
+   * Ensure the correct version number is being sent in the header params `OS-Usage-Data` (`api_client.rb`)
+3. Generate the gem: `gem build onesignal`
+4. Publish to RubyGems
+   * To publish version 0.1.0 of a new gem called 'squid-utils', run: `gem push squid-utils-0.1.0.gem`
+   * To publish a beta version, simply add `.beta1`, `.beta2` etc... after the semantic version (e.g: `1.0.0.beta1`)
+

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
+)
+```
+