sidorchukandrew / onesignal-ruby-client

Welcome to the official OneSignal Ruby Client 👋

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 project:

OneSignal is a simple ruby wrapper for the OneSignal API.

🖤 RubyGems

🚧 In Beta 🚧

Installation

Add this line to your application's Gemfile:

gem 'onesignal', '~> 1.0.0.beta1'

And then execute:

$ bundle

Or install it yourself as:

$ gem install onesignal --pre

Or install from Github: $ gem "onesignal", '~> 1.0.0.beta1', git: 'git://github.com/OneSignal/onesignal-ruby-client.git'

Getting Started

Please follow the installation procedure and then run the following code:

require 'time'
require 'onesignal'
# setup authorization
OneSignal.configure do |config|
  # Configure Bearer authorization: app_key
  config.app_key = 'YOUR BEARER TOKEN' # Change this
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

Documentation for API Endpoints

All URIs are relative to https://onesignal.com/api/v1

Class	Method	HTTP request	Description
OneSignal::DefaultApi	cancel_notification	DELETE /notifications/{notification_id}	Stop a scheduled or currently outgoing notification
OneSignal::DefaultApi	create_app	POST /apps	Create an app
OneSignal::DefaultApi	create_notification	POST /notifications	Create notification
OneSignal::DefaultApi	create_player	POST /players	Add a device
OneSignal::DefaultApi	create_segments	POST /apps/{app_id}/segments	Create Segments
OneSignal::DefaultApi	delete_player	DELETE /players/{player_id}	Delete a user record
OneSignal::DefaultApi	delete_segments	DELETE /apps/{app_id}/segments/{segment_id}	Delete Segments
OneSignal::DefaultApi	export_players	POST /players/csv_export?app_id={app_id}	CSV export
OneSignal::DefaultApi	get_app	GET /apps/{app_id}	View an app
OneSignal::DefaultApi	get_apps	GET /apps	View apps
OneSignal::DefaultApi	get_notification	GET /notifications/{notification_id}	View notification
OneSignal::DefaultApi	get_notification_history	POST /notifications/{notification_id}/history	Notification History
OneSignal::DefaultApi	get_notifications	GET /notifications	View notifications
OneSignal::DefaultApi	get_outcomes	GET /apps/{app_id}/outcomes	View Outcomes
OneSignal::DefaultApi	get_player	GET /players/{player_id}	View device
OneSignal::DefaultApi	get_players	GET /players	View devices
OneSignal::DefaultApi	update_app	PUT /apps/{app_id}	Update an app
OneSignal::DefaultApi	update_player	PUT /players/{player_id}	Edit device
OneSignal::DefaultApi	update_player_tags	PUT /apps/{app_id}/users/{external_user_id}	Edit tags with external user id

Documentation for Models

• OneSignal::App
• OneSignal::Button
• OneSignal::DeliveryData
• OneSignal::ExportPlayersRequestBody
• OneSignal::Filter
• OneSignal::FilterExpressions
• OneSignal::FilterNotificationTarget
• OneSignal::GetNotificationRequestBody
• OneSignal::InlineResponse200
• OneSignal::InlineResponse2001
• OneSignal::InlineResponse2002
• OneSignal::InlineResponse2003
• OneSignal::InlineResponse2004
• OneSignal::InlineResponse2005
• OneSignal::InlineResponse201
• OneSignal::InlineResponse400
• OneSignal::InlineResponse4001
• OneSignal::InlineResponse4002
• OneSignal::InlineResponse409
• OneSignal::Notification
• OneSignal::NotificationAllOf
• OneSignal::NotificationAllOfAndroidBackgroundLayout
• OneSignal::NotificationSlice
• OneSignal::NotificationTarget
• OneSignal::Operator
• OneSignal::OutcomeData
• OneSignal::PlatformDeliveryData
• OneSignal::Player
• OneSignal::PlayerNotificationTarget
• OneSignal::PlayerSlice
• OneSignal::Purchase
• OneSignal::Segment
• OneSignal::SegmentNotificationTarget
• OneSignal::StringMap
• OneSignal::UpdatePlayerTagsRequestBody

Documentation for Authorization

app_key

• Type: Bearer authentication

user_key

• Type: Bearer authentication

License

The gem is available as open source under the terms of the MIT License.

Author

• Website: https://onesignal.com
• Twitter: @onesignal
• Github: @OneSignal

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 OneSignal.
This project is MIT licensed.