Skip to content

Add v5.0.0-beta1 package updates #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/ask-question.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🙋‍♂️ Ask a question
description: Tell us what's on your mind
title: "[question]: "
labels: ["triage"]
title: "[Question]: "
labels: ["Question"]
body:
- type: markdown
attributes:
Expand All @@ -22,4 +22,4 @@ body:
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🪳 Bug report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
labels: ["Bug"]
body:
- type: markdown
attributes:
Expand Down Expand Up @@ -48,4 +48,4 @@ body:
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
required: true
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/general-feedback.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 📣 General feedback
description: Tell us what's on your mind
title: "[Bug]: "
labels: ["triage"]
title: "[Feedback]: "
labels: ["Feedback"]
body:
- type: markdown
attributes:
Expand All @@ -22,4 +22,4 @@ body:
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
required: true
17 changes: 17 additions & 0 deletions .github/workflows/project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Add issues to project

on:
issues:
types:
- opened

jobs:
add-to-project:
runs-on: ubuntu-latest
steps:
- name: Add issue to project
uses: actions/[email protected]
with:
# SDK Server Project
project-url: https://github.com/orgs/OneSignal/projects/11
github-token: ${{ secrets.GH_PROJECTS_TOKEN }}
107 changes: 40 additions & 67 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ A powerful way to send personalized messages at scale and build effective custom

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.4.0
- Package version: 2.2.0
- API version: 5.0.1
- Package version: 5.0.0-beta1
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
For more information, please visit [https://onesignal.com](https://onesignal.com)

Expand All @@ -24,16 +24,16 @@ gem build onesignal.gemspec
Then either install the gem locally:

```shell
gem install ./onesignal-2.2.0.gem
gem install ./onesignal-5.0.0-beta1.gem
```

(for development, run `gem install --dev ./onesignal-2.2.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./onesignal-5.0.0-beta1.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

gem 'onesignal', '~> 2.2.0'
gem 'onesignal', '~> 5.0.0-beta1'

### Install from Git

Expand All @@ -59,22 +59,20 @@ require 'onesignal'

# Setup authorization
OneSignal.configure do |config|
# Configure Bearer authorization: user_key
config.user_key = 'ORGANIZATION_API_KEY' # Organization key is only required for creating new apps and other top-level endpoints
# Configure Bearer authorization: app_key
config.app_key = 'REST_API_KEY' # App REST API key required for most endpoints
# Configure Bearer authorization: rest_api_key
config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OneSignal::DefaultApi.new
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 |
app_id = 'app_id_example' # String |
notification_id = 'notification_id_example' # String |

begin
#Start Live Activity
api_instance.begin_live_activity(app_id, activity_id, begin_live_activity_request)
#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->begin_live_activity: #{e}"
puts "Exception when calling DefaultApi->cancel_notification: #{e}"
end

```
Expand All @@ -85,41 +83,34 @@ All URIs are relative to *https://api.onesignal.com*

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_alias**](docs/DefaultApi.md#create_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
*OneSignal::DefaultApi* | [**create_alias_by_subscription**](docs/DefaultApi.md#create_alias_by_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
*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* | [**create_segment**](docs/DefaultApi.md#create_segment) | **POST** /apps/{app_id}/segments | Create Segment
*OneSignal::DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
*OneSignal::DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users |
*OneSignal::DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
*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* | [**delete_segment**](docs/DefaultApi.md#delete_segment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment
*OneSignal::DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
*OneSignal::DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
*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_events**](docs/DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events
*OneSignal::DefaultApi* | [**export_players**](docs/DefaultApi.md#export_players) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Players
*OneSignal::DefaultApi* | [**fetch_aliases**](docs/DefaultApi.md#fetch_aliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
*OneSignal::DefaultApi* | [**fetch_user**](docs/DefaultApi.md#fetch_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
*OneSignal::DefaultApi* | [**fetch_user_identity**](docs/DefaultApi.md#fetch_user_identity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
*OneSignal::DefaultApi* | [**export_subscriptions**](docs/DefaultApi.md#export_subscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions
*OneSignal::DefaultApi* | [**get_aliases**](docs/DefaultApi.md#get_aliases) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
*OneSignal::DefaultApi* | [**get_aliases_by_subscription**](docs/DefaultApi.md#get_aliases_by_subscription) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
*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_eligible_iams**](docs/DefaultApi.md#get_eligible_iams) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/iams |
*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* | [**identify_user_by_alias**](docs/DefaultApi.md#identify_user_by_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
*OneSignal::DefaultApi* | [**identify_user_by_subscription_id**](docs/DefaultApi.md#identify_user_by_subscription_id) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
*OneSignal::DefaultApi* | [**get_segments**](docs/DefaultApi.md#get_segments) | **GET** /apps/{app_id}/segments | Get Segments
*OneSignal::DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
*OneSignal::DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
*OneSignal::DefaultApi* | [**unsubscribe_email_with_token**](docs/DefaultApi.md#unsubscribe_email_with_token) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token
*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
*OneSignal::DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
*OneSignal::DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |

Expand All @@ -130,37 +121,25 @@ Class | Method | HTTP request | Description
- [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::CreateSubscriptionRequestBody](docs/CreateSubscriptionRequestBody.md)
- [OneSignal::CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
- [OneSignal::CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
- [OneSignal::CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.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::ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
- [OneSignal::ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
- [OneSignal::ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
- [OneSignal::ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md)
- [OneSignal::ExportSubscriptionsSuccessResponse](docs/ExportSubscriptionsSuccessResponse.md)
- [OneSignal::Filter](docs/Filter.md)
- [OneSignal::FilterExpressions](docs/FilterExpressions.md)
- [OneSignal::FilterExpression](docs/FilterExpression.md)
- [OneSignal::GenericError](docs/GenericError.md)
- [OneSignal::GenericErrorErrorsInner](docs/GenericErrorErrorsInner.md)
- [OneSignal::GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
- [OneSignal::InlineResponse200](docs/InlineResponse200.md)
- [OneSignal::InlineResponse2003](docs/InlineResponse2003.md)
- [OneSignal::InlineResponse201](docs/InlineResponse201.md)
- [OneSignal::InlineResponse202](docs/InlineResponse202.md)
- [OneSignal::InvalidIdentifierError](docs/InvalidIdentifierError.md)
- [OneSignal::GenericSuccessBoolResponse](docs/GenericSuccessBoolResponse.md)
- [OneSignal::GetNotificationHistoryRequestBody](docs/GetNotificationHistoryRequestBody.md)
- [OneSignal::GetSegmentsSuccessResponse](docs/GetSegmentsSuccessResponse.md)
- [OneSignal::LanguageStringMap](docs/LanguageStringMap.md)
- [OneSignal::Notification](docs/Notification.md)
- [OneSignal::Notification200Errors](docs/Notification200Errors.md)
- [OneSignal::NotificationAllOf](docs/NotificationAllOf.md)
- [OneSignal::NotificationHistorySuccessResponse](docs/NotificationHistorySuccessResponse.md)
- [OneSignal::NotificationSlice](docs/NotificationSlice.md)
Expand All @@ -173,40 +152,34 @@ Class | Method | HTTP request | Description
- [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::PlayerNotificationTargetIncludeAliases](docs/PlayerNotificationTargetIncludeAliases.md)
- [OneSignal::PlayerSlice](docs/PlayerSlice.md)
- [OneSignal::PropertiesBody](docs/PropertiesBody.md)
- [OneSignal::PropertiesDeltas](docs/PropertiesDeltas.md)
- [OneSignal::PropertiesObject](docs/PropertiesObject.md)
- [OneSignal::Purchase](docs/Purchase.md)
- [OneSignal::RateLimiterError](docs/RateLimiterError.md)
- [OneSignal::RateLimitError](docs/RateLimitError.md)
- [OneSignal::Segment](docs/Segment.md)
- [OneSignal::SegmentData](docs/SegmentData.md)
- [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
- [OneSignal::StringMap](docs/StringMap.md)
- [OneSignal::SubscriptionObject](docs/SubscriptionObject.md)
- [OneSignal::Subscription](docs/Subscription.md)
- [OneSignal::SubscriptionBody](docs/SubscriptionBody.md)
- [OneSignal::SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md)
- [OneSignal::TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.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)
- [OneSignal::UpdateSubscriptionRequestBody](docs/UpdateSubscriptionRequestBody.md)
- [OneSignal::UpdateUserRequest](docs/UpdateUserRequest.md)
- [OneSignal::User](docs/User.md)
- [OneSignal::UserIdentityRequestBody](docs/UserIdentityRequestBody.md)
- [OneSignal::UserIdentityResponse](docs/UserIdentityResponse.md)
- [OneSignal::UserSubscriptionOptions](docs/UserSubscriptionOptions.md)
- [OneSignal::UserIdentityBody](docs/UserIdentityBody.md)
- [OneSignal::WebButton](docs/WebButton.md)


## Documentation for Authorization


### app_key
### rest_api_key

- **Type**: Bearer authentication

### user_key
### user_auth_key

- **Type**: Bearer authentication

Loading