Update Ruby API

Author: OneSignal

README.md

@@ -1,74 +1,80 @@
-<h1 align="center">Welcome to the official OneSignal Ruby Client 👋</h1>
-
-[![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
 
 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)
+- API version: 1.0.2
+- Package version: 1.0.2
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://onesignal.com](https://onesignal.com)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### Build a gem
 
-```ruby
-gem 'onesignal', '~> 1.0.1'
+To build the Ruby code into a gem:
+
+```shell
+gem build onesignal.gemspec
 ```
 
-And then execute:
+Then either install the gem locally:
+
+```shell
+gem install ./onesignal-1.0.2.gem
+```
+
+(for development, run `gem install --dev ./onesignal-1.0.2.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-    $ bundle
+Finally add this to the Gemfile:
 
-Or install it yourself as:
+    gem 'onesignal', '~> 1.0.2'
 
-    $ gem install onesignal
+### Install from Git
 
-Or install from Github:
+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:
 
-    $ gem "onesignal", '~> 1.0.1', git: 'git://github.com/OneSignal/onesignal-ruby-api.git'
+    gem 'onesignal', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
 
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
 
 ```ruby
-require 'time'
+# Load the gem
 require 'onesignal'
-# setup authorization
+
+# 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'
+  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = OneSignal::DefaultApi.new
-notification = OneSignal::Notification.new({app_id: 'YOUR APP ID'}) # Notification
+app_id = 'app_id_example' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+activity_id = 'activity_id_example' # String | Live Activity record ID
+begin_live_activity_request = OneSignal::BeginLiveActivityRequest.new({push_token: 'push_token_example', subscription_id: 'subscription_id_example'}) # BeginLiveActivityRequest | 
 
 begin
-  # Create notification
-  result = api_instance.create_notification(notification)
-  p result
+  #Start Live Activity
+  api_instance.begin_live_activity(app_id, activity_id, begin_live_activity_request)
 rescue OneSignal::ApiError => e
-  puts "Error when calling DefaultApi->create_notification: #{e}"
+  puts "Exception when calling DefaultApi->begin_live_activity: #{e}"
 end
+
 ```
 
 ## Documentation for API Endpoints
@@ -77,13 +83,15 @@ All URIs are relative to *https://onesignal.com/api/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*OneSignal::DefaultApi* | [**begin_live_activity**](docs/DefaultApi.md#begin_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/token | Start Live Activity
 *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* | [**end_live_activity**](docs/DefaultApi.md#end_live_activity) | **DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
 *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
@@ -94,93 +102,72 @@ Class | Method | HTTP request | Description
 *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_live_activity**](docs/DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
 *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::BadRequestError](docs/BadRequestError.md)
+ - [OneSignal::BasicNotification](docs/BasicNotification.md)
+ - [OneSignal::BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
+ - [OneSignal::BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
+ - [OneSignal::BeginLiveActivityRequest](docs/BeginLiveActivityRequest.md)
  - [OneSignal::Button](docs/Button.md)
+ - [OneSignal::CancelNotificationSuccessResponse](docs/CancelNotificationSuccessResponse.md)
+ - [OneSignal::CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md)
+ - [OneSignal::CreatePlayerSuccessResponse](docs/CreatePlayerSuccessResponse.md)
+ - [OneSignal::CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
+ - [OneSignal::CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
+ - [OneSignal::DeletePlayerNotFoundResponse](docs/DeletePlayerNotFoundResponse.md)
+ - [OneSignal::DeletePlayerSuccessResponse](docs/DeletePlayerSuccessResponse.md)
+ - [OneSignal::DeleteSegmentNotFoundResponse](docs/DeleteSegmentNotFoundResponse.md)
+ - [OneSignal::DeleteSegmentSuccessResponse](docs/DeleteSegmentSuccessResponse.md)
  - [OneSignal::DeliveryData](docs/DeliveryData.md)
  - [OneSignal::ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
+ - [OneSignal::ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.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::InvalidIdentifierError](docs/InvalidIdentifierError.md)
  - [OneSignal::Notification](docs/Notification.md)
+ - [OneSignal::Notification200Errors](docs/Notification200Errors.md)
  - [OneSignal::NotificationAllOf](docs/NotificationAllOf.md)
- - [OneSignal::NotificationAllOfAndroidBackgroundLayout](docs/NotificationAllOfAndroidBackgroundLayout.md)
+ - [OneSignal::NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md)
  - [OneSignal::NotificationSlice](docs/NotificationSlice.md)
  - [OneSignal::NotificationTarget](docs/NotificationTarget.md)
+ - [OneSignal::NotificationWithMeta](docs/NotificationWithMeta.md)
+ - [OneSignal::NotificationWithMetaAllOf](docs/NotificationWithMetaAllOf.md)
  - [OneSignal::Operator](docs/Operator.md)
  - [OneSignal::OutcomeData](docs/OutcomeData.md)
+ - [OneSignal::OutcomesData](docs/OutcomesData.md)
  - [OneSignal::PlatformDeliveryData](docs/PlatformDeliveryData.md)
+ - [OneSignal::PlatformDeliveryDataEmailAllOf](docs/PlatformDeliveryDataEmailAllOf.md)
+ - [OneSignal::PlatformDeliveryDataSmsAllOf](docs/PlatformDeliveryDataSmsAllOf.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::UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
+ - [OneSignal::UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
+ - [OneSignal::UpdatePlayerSuccessResponse](docs/UpdatePlayerSuccessResponse.md)
  - [OneSignal::UpdatePlayerTagsRequestBody](docs/UpdatePlayerTagsRequestBody.md)
+ - [OneSignal::UpdatePlayerTagsSuccessResponse](docs/UpdatePlayerTagsSuccessResponse.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
-```
-
 ### user_key
 
 - **Type**: Bearer authentication
 
-```rb
-OneSignal.configure do |config|
-  config.user_key = 'USER_KEY' # replace with your user key
-end
-```
-
-## License
-
-The gem is available as open source under the terms of the [MIT License][mit].
-
-[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
-
-## Author
-
-* Website: https://onesignal.com
-* Twitter: [@onesignal](https://twitter.com/onesignal)
-* Github: [@OneSignal](https://github.com/OneSignal)
-
-## 🤝 Contributing
-
-Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/onesignal-ruby-client/issues).
-
-## Show your support
-
-Give a ⭐️ if this project helped you!
-
-## 📝 License
-
-Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
-This project is [MIT](https://opensource.org/licenses/MIT) licensed.

docs/App.md

@@ -23,6 +23,10 @@
 | **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] |
+| **apns_key_id** | **String** | iOS: Required if using p8. Unique identifier for the p8 authentication key. | [optional] |
+| **apns_team_id** | **String** | iOS: Required if using p8. Team ID generated by Apple for your developer account. | [optional] |
+| **apns_bundle_id** | **String** | iOS: Required if using p8. Bundle ID for your app in the Apple ecosystem. | [optional] |
+| **apns_p8** | **String** | iOS: Required if using p8. Base64 encoded p8 key | [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] |
@@ -60,6 +64,10 @@ instance = OneSignal::App.new(
   safari_apns_certificates: null,
   safari_apns_p12: null,
   safari_apns_p12_password: null,
+  apns_key_id: null,
+  apns_team_id: null,
+  apns_bundle_id: null,
+  apns_p8: null,
   safari_site_origin: null,
   safari_push_id: null,
   safari_icon_16_16: null,

docs/BadRequestError.md

@@ -0,0 +1,18 @@
+# OneSignal::BadRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::BadRequestError.new(
+  errors: null
+)
+```
+

docs/BeginLiveActivityRequest.md

@@ -0,0 +1,20 @@
+# OneSignal::BeginLiveActivityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **push_token** | **String** |  |  |
+| **subscription_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::BeginLiveActivityRequest.new(
+  push_token: null,
+  subscription_id: null
+)
+```
+